Tee precompile and preinstall upgrade handler (#31)

dixitaniket · web-flow · commit fb5b450f8043 · 2026-03-10T21:06:13.000+05:30
* init updates

* cleanup

* test script

* updates

* updates
diff --git a/contrib/images/evmd-env/Dockerfile b/contrib/images/evmd-env/Dockerfile
@@ -31,15 +31,17 @@ WORKDIR /evmd
 COPY contrib/images/evmd-env/wrapper.sh /usr/bin/wrapper.sh
 COPY test_deployment.sh /usr/bin/test_deployment.sh
 COPY multi_node_startup.sh /usr/bin/multi_node_startup.sh
+COPY scripts/create_software_upgrade_proposal.sh /usr/bin/create_software_upgrade_proposal.sh
 COPY --from=evmd-builder /work/build/evmd /evmd/
 COPY --from=evmd-builder /work/build/evmd /usr/local/bin/
 
 # Set proper ownership and permissions before switching to nonroot user
 RUN chown nonroot:nonroot /usr/bin/wrapper.sh && chmod +x /usr/bin/wrapper.sh
 RUN chown nonroot:nonroot /usr/bin/test_deployment.sh && chmod +x /usr/bin/test_deployment.sh
 RUN chown nonroot:nonroot /usr/bin/multi_node_startup.sh && chmod +x /usr/bin/multi_node_startup.sh
+RUN chown nonroot:nonroot /usr/bin/create_software_upgrade_proposal.sh && chmod +x /usr/bin/create_software_upgrade_proposal.sh
 RUN chown -R nonroot:nonroot /evmd
 
 USER nonroot
 
-ENTRYPOINT ["/usr/bin/multi_node_startup.sh"]
+ENTRYPOINT ["/usr/bin/multi_node_startup.sh"]
diff --git a/evmd/upgrades.go b/evmd/upgrades.go
@@ -2,8 +2,11 @@ package evmd
 
 import (
 	"context"
+	"fmt"
+	"slices"
 
-	"github.com/cosmos/evm/x/vm/types"
+	vmtypes "github.com/cosmos/evm/x/vm/types"
+	"github.com/ethereum/go-ethereum/common"
 
 	storetypes "cosmossdk.io/store/types"
 	upgradetypes "cosmossdk.io/x/upgrade/types"
@@ -13,17 +16,24 @@ import (
 	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
 )
 
-// UpgradeName defines the on-chain upgrade name for the sample EVMD upgrade
-// from v0.5.0 to v0.6.0.
-//
-// NOTE: This upgrade defines a reference implementation of what an upgrade
-// could look like when an application is migrating from EVMD version
-// v0.4.0 to v0.5.x
-const UpgradeName = "v0.5.0-to-v0.6.0"
+const (
+	// LegacyUpgradeName is kept to preserve compatibility with already-published
+	// upgrade proposal names from earlier deployments.
+	LegacyUpgradeName = "v0.5.0-to-v0.6.0"
+
+	// UpgradeName defines the on-chain upgrade name for enabling missing EVM
+	// preinstalls on an already-running network and optionally activating the
+	// latest static precompile.
+	UpgradeName = "v0.6.0-enable-missing-preinstalls"
+
+	// OptionalStaticPrecompileAddress is enabled during the upgrade if missing.
+	OptionalStaticPrecompileAddress = vmtypes.TEEPrecompileAddress
+)
 
 func (app EVMD) RegisterUpgradeHandlers() {
+	// Legacy sample upgrade (kept intact for compatibility with existing plans).
 	app.UpgradeKeeper.SetUpgradeHandler(
-		UpgradeName,
+		LegacyUpgradeName,
 		func(ctx context.Context, _ upgradetypes.Plan, fromVM module.VersionMap) (module.VersionMap, error) {
 			sdkCtx := sdk.UnwrapSDKContext(ctx)
 			sdkCtx.Logger().Debug("this is a debug level message to test that verbose logging mode has properly been enabled during a chain upgrade")
@@ -53,16 +63,77 @@ func (app EVMD) RegisterUpgradeHandlers() {
 			// (Required for NON-18 denom chains *only)
 			// Update EVM params to add Extended denom options
 			// Ensure that this corresponds to the EVM denom
-			// (tyically the bond denom)
+			// (typically the bond denom)
 			evmParams := app.EVMKeeper.GetParams(sdkCtx)
-			evmParams.ExtendedDenomOptions = &types.ExtendedDenomOptions{ExtendedDenom: "atest"}
-			err := app.EVMKeeper.SetParams(sdkCtx, evmParams)
-			if err != nil {
+			evmParams.ExtendedDenomOptions = &vmtypes.ExtendedDenomOptions{ExtendedDenom: "atest"}
+			if err := app.EVMKeeper.SetParams(sdkCtx, evmParams); err != nil {
+				return nil, err
+			}
+
+			// Initialize EvmCoinInfo in the module store. Chains bootstrapped before
+			// v0.5.0 binaries never stored this information (it lived only in process
+			// globals), so migrating nodes would otherwise see an empty EvmCoinInfo on
+			// upgrade.
+			if err := app.EVMKeeper.InitEvmCoinInfo(sdkCtx); err != nil {
 				return nil, err
 			}
-			// Initialize EvmCoinInfo in the module store. Chains bootstrapped before v0.5.0
-			// binaries never stored this information (it lived only in process globals),
-			// so migrating nodes would otherwise see an empty EvmCoinInfo on upgrade.
+
+			return app.ModuleManager.RunMigrations(ctx, app.Configurator(), fromVM)
+		},
+	)
+
+	// New upgrade to backfill preinstalls and optionally activate new static precompile.
+	app.UpgradeKeeper.SetUpgradeHandler(
+		UpgradeName,
+		func(ctx context.Context, _ upgradetypes.Plan, fromVM module.VersionMap) (module.VersionMap, error) {
+			sdkCtx := sdk.UnwrapSDKContext(ctx)
+
+			// Optionally activate a new static precompile if it is available in
+			// the binary and not yet active in chain state.
+			evmParams := app.EVMKeeper.GetParams(sdkCtx)
+			if !slices.Contains(evmParams.ActiveStaticPrecompiles, OptionalStaticPrecompileAddress) {
+				if !slices.Contains(vmtypes.AvailableStaticPrecompiles, OptionalStaticPrecompileAddress) {
+					return nil, fmt.Errorf("cannot activate static precompile %s: address not available in binary", OptionalStaticPrecompileAddress)
+				}
+				evmParams.ActiveStaticPrecompiles = append(evmParams.ActiveStaticPrecompiles, OptionalStaticPrecompileAddress)
+				if err := app.EVMKeeper.SetParams(sdkCtx, evmParams); err != nil {
+					return nil, err
+				}
+			}
+
+			// Add only missing default preinstalls. If an address has no code hash
+			// but already has an account, abort to avoid mutating unknown state.
+			missingPreinstalls := make([]vmtypes.Preinstall, 0, len(vmtypes.DefaultPreinstalls))
+			for _, preinstall := range vmtypes.DefaultPreinstalls {
+				addr := common.HexToAddress(preinstall.Address)
+				codeHash := app.EVMKeeper.GetCodeHash(sdkCtx, addr)
+				if !vmtypes.IsEmptyCodeHash(codeHash.Bytes()) {
+					continue
+				}
+
+				accAddress := sdk.AccAddress(addr.Bytes())
+				if acc := app.AccountKeeper.GetAccount(sdkCtx, accAddress); acc != nil {
+					// Skip addresses that already have an account (e.g. a funded EOA)
+					// rather than halting the chain
+					sdkCtx.Logger().Warn(
+						"skipping preinstall: account exists with empty code hash",
+						"address", preinstall.Address,
+					)
+					continue
+				}
+
+				missingPreinstalls = append(missingPreinstalls, preinstall)
+			}
+
+			if len(missingPreinstalls) > 0 {
+				if err := app.EVMKeeper.AddPreinstalls(sdkCtx, missingPreinstalls); err != nil {
+					return nil, err
+				}
+			}
+
+			// Ensure EvmCoinInfo is present in the module store. This is idempotent
+			// and required because this upgrade path may run on chains that never
+			// executed the LegacyUpgradeName handler (which also calls this).
 			if err := app.EVMKeeper.InitEvmCoinInfo(sdkCtx); err != nil {
 				return nil, err
 			}
@@ -75,7 +146,7 @@ func (app EVMD) RegisterUpgradeHandlers() {
 		panic(err)
 	}
 
-	if upgradeInfo.Name == UpgradeName && !app.UpgradeKeeper.IsSkipHeight(upgradeInfo.Height) {
+	if (upgradeInfo.Name == LegacyUpgradeName || upgradeInfo.Name == UpgradeName) && !app.UpgradeKeeper.IsSkipHeight(upgradeInfo.Height) {
 		storeUpgrades := storetypes.StoreUpgrades{
 			Added: []string{},
 		}
diff --git a/multi_node_startup.sh b/multi_node_startup.sh
@@ -6,7 +6,6 @@ KEYRING="test"
 KEYALGO="eth_secp256k1"
 LOGLEVEL="info"
 BASEFEE=10000000
-
 BASEDIR="${BASEDIR:-"$HOME/.og-evm-devnet"}"
 
 NODE_NUMBER="${NODE_NUMBER:-}"
@@ -364,14 +363,17 @@ start_validator() {
   echo "JSON-RPC:  $JSONRPC_PORT"
   echo "=========================================="
 
-  evmd start \
-    --pruning nothing \
-    --log_level "$LOGLEVEL" \
-    --minimum-gas-prices=0ogwei \
-    --evm.min-tip=0 \
-    --home "$HOME_DIR" \
-    --json-rpc.api eth,txpool,personal,net,debug,web3 \
+  START_ARGS=(
+    --pruning nothing
+    --log_level "$LOGLEVEL"
+    --minimum-gas-prices=0ogwei
+    --evm.min-tip=0
+    --home "$HOME_DIR"
+    --json-rpc.api eth,txpool,personal,net,debug,web3
     --chain-id "$CHAINID"
+  )
+
+  exec evmd start "${START_ARGS[@]}"
 }
 
 if [[ "$GENERATE_GENESIS" == "true" ]]; then
@@ -392,4 +394,4 @@ if [[ "$GENERATE_GENESIS" != "true" && "$START_VALIDATOR" != "true" ]]; then
   echo "  START_VALIDATOR=true NODE_NUMBER=0 $0"
   echo ""
   usage
-fi
+fi
diff --git a/precompiles/types/static_precompiles.go b/precompiles/types/static_precompiles.go
@@ -189,12 +189,10 @@ func (s StaticPrecompiles) WithSlashingPrecompile(
 }
 
 func (s StaticPrecompiles) WithTEEPrecompile() StaticPrecompiles {
-	fmt.Println("=== REGISTERING TEE PRECOMPILE ===")
 	teePrecompile, err := teeprecompile.NewPrecompile()
 	if err != nil {
 		panic(fmt.Errorf("failed to instantiate TEE precompile: %w", err))
 	}
-	fmt.Printf("TEE Address: %s\n", teePrecompile.Address().Hex())
 	s[teePrecompile.Address()] = teePrecompile
 	return s
 }
diff --git a/scripts/create_software_upgrade_proposal.sh b/scripts/create_software_upgrade_proposal.sh
@@ -0,0 +1,138 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+usage() {
+  cat <<'EOF'
+Create a governance software-upgrade proposal JSON, and optionally submit it.
+
+Usage:
+  create_software_upgrade_proposal.sh [options]
+
+Required:
+  --upgrade-name NAME          Upgrade plan name (must match UpgradeName in app binary)
+  --upgrade-height HEIGHT      Upgrade height
+  --from KEY_OR_ADDRESS        Key name/address used to submit the proposal
+
+Optional:
+  --chain-id ID                Chain ID (default: env CHAIN_ID or 10740)
+  --node NODE                  RPC node (default: env NODE or tcp://127.0.0.1:26657)
+  --home PATH                  Node home for keyring/query (default: env HOME_DIR or ~/.og-evm-devnet/val0)
+  --keyring-backend BACKEND    Keyring backend (default: env KEYRING_BACKEND or test)
+  --authority ADDRESS          Gov module authority address (auto-queried if omitted)
+  --title TEXT                 Proposal title (default: "Software Upgrade: <name>")
+  --summary TEXT               Proposal summary
+  --metadata URI               Proposal metadata URI (default: ipfs://CID)
+  --deposit COIN               Deposit (default: 10000000ogwei)
+  --fees COIN                  Tx fees when submitting (default: 2000000000000ogwei)
+  --proposal-file PATH         Output proposal JSON path
+  --submit                     Submit proposal tx after generating JSON
+  -h, --help                   Show this help
+EOF
+}
+
+CHAIN_ID="${CHAIN_ID:-10740}"
+NODE="${NODE:-tcp://127.0.0.1:26657}"
+HOME_DIR="${HOME_DIR:-$HOME/.og-evm-devnet/val0}"
+KEYRING_BACKEND="${KEYRING_BACKEND:-test}"
+
+UPGRADE_NAME=""
+UPGRADE_HEIGHT=""
+FROM=""
+AUTHORITY=""
+TITLE=""
+SUMMARY="Enable missing preinstalls and optional static precompile activation"
+METADATA="ipfs://CID"
+DEPOSIT="10000000ogwei"
+FEES="2000000000000ogwei"
+SUBMIT=false
+PROPOSAL_FILE=""
+
+while [[ $# -gt 0 ]]; do
+  case "$1" in
+    --upgrade-name) UPGRADE_NAME="$2"; shift 2 ;;
+    --upgrade-height) UPGRADE_HEIGHT="$2"; shift 2 ;;
+    --from) FROM="$2"; shift 2 ;;
+    --chain-id) CHAIN_ID="$2"; shift 2 ;;
+    --node) NODE="$2"; shift 2 ;;
+    --home) HOME_DIR="$2"; shift 2 ;;
+    --keyring-backend) KEYRING_BACKEND="$2"; shift 2 ;;
+    --authority) AUTHORITY="$2"; shift 2 ;;
+    --title) TITLE="$2"; shift 2 ;;
+    --summary) SUMMARY="$2"; shift 2 ;;
+    --metadata) METADATA="$2"; shift 2 ;;
+    --deposit) DEPOSIT="$2"; shift 2 ;;
+    --fees) FEES="$2"; shift 2 ;;
+    --proposal-file) PROPOSAL_FILE="$2"; shift 2 ;;
+    --submit) SUBMIT=true; shift ;;
+    -h|--help) usage; exit 0 ;;
+    *) echo "Unknown option: $1"; usage; exit 1 ;;
+  esac
+done
+
+if [[ -z "$UPGRADE_NAME" || -z "$UPGRADE_HEIGHT" || -z "$FROM" ]]; then
+  echo "Error: --upgrade-name, --upgrade-height, and --from are required."
+  usage
+  exit 1
+fi
+
+if [[ -z "$TITLE" ]]; then
+  TITLE="Software Upgrade: $UPGRADE_NAME"
+fi
+
+if [[ -z "$PROPOSAL_FILE" ]]; then
+  PROPOSAL_FILE="/tmp/software-upgrade-${UPGRADE_NAME}-${UPGRADE_HEIGHT}.json"
+fi
+
+if [[ -z "$AUTHORITY" ]]; then
+  command -v jq >/dev/null 2>&1 || { echo "Error: jq is required to auto-detect --authority."; exit 1; }
+  AUTHORITY_JSON="$(evmd query auth module-account gov --node "$NODE" --home "$HOME_DIR" -o json)"
+  AUTHORITY="$(echo "$AUTHORITY_JSON" | jq -r '.account.base_account.address // .account.value.address // empty')"
+  if [[ -z "$AUTHORITY" ]]; then
+    echo "Error: unable to determine gov authority address. Pass --authority explicitly."
+    exit 1
+  fi
+fi
+
+mkdir -p "$(dirname "$PROPOSAL_FILE")"
+
+cat >"$PROPOSAL_FILE" <<EOF
+{
+  "messages": [
+    {
+      "@type": "/cosmos.upgrade.v1beta1.MsgSoftwareUpgrade",
+      "authority": "$AUTHORITY",
+      "plan": {
+        "name": "$UPGRADE_NAME",
+        "height": "$UPGRADE_HEIGHT"
+      }
+    }
+  ],
+  "metadata": "$METADATA",
+  "deposit": "$DEPOSIT",
+  "title": "$TITLE",
+  "summary": "$SUMMARY"
+}
+EOF
+
+echo "Wrote proposal file: $PROPOSAL_FILE"
+echo "Upgrade Name:        $UPGRADE_NAME"
+echo "Upgrade Height:      $UPGRADE_HEIGHT"
+echo "Gov Authority:       $AUTHORITY"
+echo "Deposit:             $DEPOSIT"
+
+if [[ "$SUBMIT" == "true" ]]; then
+  echo "Submitting proposal..."
+  evmd tx gov submit-proposal "$PROPOSAL_FILE" \
+    --from "$FROM" \
+    --home "$HOME_DIR" \
+    --keyring-backend "$KEYRING_BACKEND" \
+    --chain-id "$CHAIN_ID" \
+    --node "$NODE" \
+    --fees "$FEES" \
+    -y
+else
+  echo ""
+  echo "Submit command:"
+  echo "  evmd tx gov submit-proposal \"$PROPOSAL_FILE\" --from \"$FROM\" --home \"$HOME_DIR\" --keyring-backend \"$KEYRING_BACKEND\" --chain-id \"$CHAIN_ID\" --node \"$NODE\" --fees \"$FEES\" -y"
+fi
diff --git a/scripts/test_local_upgrade.sh b/scripts/test_local_upgrade.sh

Original file line number	Diff line number	Diff line change
`@@ -189,12 +189,10 @@ func (s StaticPrecompiles) WithSlashingPrecompile(`
`189`	`189`	`}`
`190`	`190`
`191`	`191`	`func (s StaticPrecompiles) WithTEEPrecompile() StaticPrecompiles {`
`192`		`- fmt.Println("=== REGISTERING TEE PRECOMPILE ===")`
`193`	`192`	`teePrecompile, err := teeprecompile.NewPrecompile()`
`194`	`193`	`if err != nil {`
`195`	`194`	`panic(fmt.Errorf("failed to instantiate TEE precompile: %w", err))`
`196`	`195`	`}`
`197`		`- fmt.Printf("TEE Address: %s\n", teePrecompile.Address().Hex())`
`198`	`196`	`s[teePrecompile.Address()] = teePrecompile`
`199`	`197`	`return s`
`200`	`198`	`}`