feat: support preinstalls (#728)

* support preinstall

* fix proto

* fix build

* fix lint

* fix test

* change from error to log

* remove unecessary name

* register msg

* register msg

* add dummy log

* add dummy log

* add log

* debug

* cleanup

* some fixes

* somecleanup

* move set account

* add test

* fix logic

* add Changelog

* update deps

* remove dead code

* fix comments

* add check precompile

* add validate basic for MsgRegisterPreinstalls

* add more info in error

Author: thomas-nguy

.golangci.yml

@@ -62,6 +62,7 @@ linters:
       - third_party$
       - builtin$
       - examples$
+      - x/evm/types/preinstall.go
 issues:
   max-same-issues: 50
 formatters:
@@ -72,4 +73,4 @@ formatters:
     paths:
       - third_party$
       - builtin$
-      - examples$
+      - examples$

CHANGELOG.md

@@ -40,6 +40,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * (evm) [#725](https://github.com/crypto-org-chain/ethermint/pull/725) feat(RPC): add authorizationList from eth_getTransactionByHash response for EIP-7702 transactions
 * (evm) [#740](https://github.com/crypto-org-chain/ethermint/pull/740) fix: missing tx context during vm initialisation
 * (evm) [#742](https://github.com/crypto-org-chain/ethermint/pull/742) fix: prevent nil pointer dereference in tracer hooks
+* (evm) [#728](https://github.com/crypto-org-chain/ethermint/pull/728) feat: support preinstalls
 
 ## [v0.22.0] - 2025-08-12
 

evmd/app.go

@@ -191,8 +191,6 @@ var (
 	_ evmserver.AppWithPendingTxListener = (*EthermintApp)(nil)
 )
 
-type GenesisState map[string]json.RawMessage
-
 // var _ server.Application (*EthermintApp)(nil)
 
 // EthermintApp implements an extended ABCI application. It is an application
@@ -926,7 +924,11 @@ func (app *EthermintApp) InterfaceRegistry() types.InterfaceRegistry {
 
 // DefaultGenesis returns a default genesis from the registered AppModuleBasic's.
 func (app *EthermintApp) DefaultGenesis() map[string]json.RawMessage {
-	return app.BasicModuleManager.DefaultGenesis(app.appCodec)
+	genesis := app.BasicModuleManager.DefaultGenesis(app.appCodec)
+	evmGenState := NewEVMGenesisState()
+	genesis[evmtypes.ModuleName] = app.appCodec.MustMarshalJSON(evmGenState)
+
+	return genesis
 }
 
 func (app *EthermintApp) TxConfig() client.TxConfig {

evmd/genesis.go

@@ -0,0 +1,27 @@
+package evmd
+
+import (
+	"encoding/json"
+
+	evmtypes "github.com/evmos/ethermint/x/evm/types"
+)
+
+// GenesisState of the blockchain is represented here as a map of raw json
+// messages key'd by an identifier string.
+// The identifier is used to determine which module genesis information belongs
+// to so it may be appropriately routed during init chain.
+// Within this application default genesis information is retrieved from
+// the ModuleBasicManager which populates json from each BasicModule
+// object provided to it during init.
+type GenesisState map[string]json.RawMessage
+
+// NewEVMGenesisState returns the default genesis state for the EVM module.
+//
+// NOTE: for the example chain implementation we need to set the default EVM denomination,
+// enable ALL precompiles, and include default preinstalls.
+func NewEVMGenesisState() *evmtypes.GenesisState {
+	evmGenState := evmtypes.DefaultGenesisState()
+	evmGenState.Preinstalls = evmtypes.DefaultPreinstalls
+
+	return evmGenState
+}

go.mod

@@ -240,7 +240,7 @@ require (
 	github.com/tklauser/go-sysconf v0.3.12 // indirect
 	github.com/tklauser/numcpus v0.6.1 // indirect
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
-	github.com/ulikunitz/xz v0.5.14 // indirect
+	github.com/ulikunitz/xz v0.5.15 // indirect
 	github.com/zeebo/errs v1.4.0 // indirect
 	github.com/zondax/hid v0.9.2 // indirect
 	github.com/zondax/ledger-go v0.14.3 // indirect

go.sum

@@ -1701,8 +1701,8 @@ github.com/tyler-smith/go-bip39 v1.1.0/go.mod h1:gUYDtqQw1JS3ZJ8UWVcGTGqqr6YIN3C
 github.com/ugorji/go v1.1.7/go.mod h1:kZn38zHttfInRq0xu/PH0az30d+z6vm202qpg1oXVMw=
 github.com/ugorji/go/codec v1.1.7/go.mod h1:Ax+UKWsSmolVDwsd+7N3ZtXu+yMGCf907BLYF3GoBXY=
 github.com/ulikunitz/xz v0.5.10/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14=
-github.com/ulikunitz/xz v0.5.14 h1:uv/0Bq533iFdnMHZdRBTOlaNMdb1+ZxXIlHDZHIHcvg=
-github.com/ulikunitz/xz v0.5.14/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14=
+github.com/ulikunitz/xz v0.5.15 h1:9DNdB5s+SgV3bQ2ApL10xRc35ck0DuIX/isZvIk+ubY=
+github.com/ulikunitz/xz v0.5.15/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14=
 github.com/urfave/cli v1.20.0/go.mod h1:70zkFmudgCuE/ngEzBv17Jvp/497gISqfk5gWijbERA=
 github.com/urfave/cli v1.22.1 h1:+mkCCcOFKPnCmVYVcURKps1Xe+3zP90gSYGNfRkjoIY=
 github.com/urfave/cli v1.22.1/go.mod h1:Gos4lmkARVdJ6EkW0WaNv/tZAAMe9V7XWyB60NtXRu0=

proto/ethermint/evm/v1/genesis.proto

@@ -1,7 +1,9 @@
 syntax = "proto3";
 package ethermint.evm.v1;
 
+import "amino/amino.proto";
 import "ethermint/evm/v1/params.proto";
+import "ethermint/evm/v1/preinstall.proto";
 import "ethermint/evm/v1/state.proto";
 import "gogoproto/gogo.proto";
 
@@ -13,6 +15,9 @@ message GenesisState {
   repeated GenesisAccount accounts = 1 [(gogoproto.nullable) = false];
   // params defines all the parameters of the module.
   Params params = 2 [(gogoproto.nullable) = false];
+  // preinstalls defines a set of predefined contracts
+  repeated Preinstall preinstalls = 3
+  [ (gogoproto.nullable) = false, (amino.dont_omitempty) = true ];
 }
 
 // GenesisAccount defines an account to be initialized in the genesis state.

proto/ethermint/evm/v1/preinstall.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+package ethermint.evm.v1;
+
+option go_package = "github.com/evmos/ethermint/x/evm/types";
+
+// Preinstall defines a contract that is preinstalled on-chain with a specific
+// contract address and bytecode
+message Preinstall {
+  // name of the preinstall contract
+  string name = 1;
+  // address in hex format of the preinstall contract
+  string address = 2;
+  // code in hex format for the preinstall contract
+  string code = 3;
+}

proto/ethermint/evm/v1/tx.proto

@@ -1,6 +1,7 @@
 syntax = "proto3";
 package ethermint.evm.v1;
 
+import "amino/amino.proto";
 import "cosmos/msg/v1/msg.proto";
 import "cosmos_proto/cosmos.proto";
 import "gogoproto/gogo.proto";
@@ -9,6 +10,7 @@ import "google/protobuf/any.proto";
 import "ethermint/evm/v1/access_tuple.proto";
 import "ethermint/evm/v1/log.proto";
 import "ethermint/evm/v1/params.proto";
+import "ethermint/evm/v1/preinstall.proto";
 import "ethermint/evm/v1/set_code_authorization.proto";
 
 option go_package = "github.com/evmos/ethermint/x/evm/types";
@@ -23,6 +25,10 @@ service Msg {
   // UpdateParams defined a governance operation for updating the x/evm module parameters.
   // The authority is hard-coded to the Cosmos SDK x/gov module account
   rpc UpdateParams(MsgUpdateParams) returns (MsgUpdateParamsResponse);
+
+  // UpdateParams defined a governance operation for updating the x/evm module parameters.
+  // The authority is hard-coded to the Cosmos SDK x/gov module account
+  rpc RegisterPreinstalls(MsgRegisterPreinstalls) returns (MsgRegisterPreinstallsResponse);
 }
 
 // MsgEthereumTx encapsulates an Ethereum transaction as an SDK message.
@@ -225,3 +231,19 @@ message MsgUpdateParams {
 // MsgUpdateParamsResponse defines the response structure for executing a
 // MsgUpdateParams message.
 message MsgUpdateParamsResponse {}
+
+// MsgRegisterPreinstalls defines a Msg for creating preinstalls in evm state.
+message MsgRegisterPreinstalls {
+  option (cosmos.msg.v1.signer) = "authority";
+
+  // authority is the address of the governance account.
+  string authority = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString" ];
+
+  // preinstalls defines the preinstalls to create.
+  repeated Preinstall preinstalls = 2
+  [ (gogoproto.nullable) = false, (amino.dont_omitempty) = true ];
+}
+
+// MsgRegisterPreinstallsResponse defines the response structure for executing a
+// MsgRegisterPreinstalls message.
+message MsgRegisterPreinstallsResponse {}

x/evm/genesis.go

@@ -82,6 +82,10 @@ func InitGenesis(
 		}
 	}
 
+	if err := k.AddPreinstalls(ctx, data.Preinstalls); err != nil {
+		panic(fmt.Errorf("error adding preinstalls: %s", err))
+	}
+
 	return []abci.ValidatorUpdate{}
 }