imp(erc20): ERC-20 registration

CHANGELOG.md

@@ -48,6 +48,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 - (erc20) [#1993](https://github.com/evmos/evmos/pull/1993) Add ERC-20 Precompile transactions.
 - (erc20) [#1995](https://github.com/evmos/evmos/pull/1995) Add ERC-20 precompile approvals and authorizations.
 - (osmosis-outpost) [#1986](https://github.com/evmos/evmos/pull/1986) Add Osmosis outpost transaction.
+- (erc20) [#1997](https://github.com/evmos/evmos/pull/1997) Add logic for ERC-20 precompile registration.
 
 ### Improvements
 

app/app.go

@@ -530,6 +530,7 @@ func NewEvmos(
 	app.Erc20Keeper = erc20keeper.NewKeeper(
 		keys[erc20types.StoreKey], appCodec, authtypes.NewModuleAddress(govtypes.ModuleName),
 		app.AccountKeeper, app.BankKeeper, app.EvmKeeper, app.StakingKeeper, app.ClaimsKeeper,
+		app.AuthzKeeper, &app.TransferKeeper,
 	)
 
 	app.IncentivesKeeper = incentiveskeeper.NewKeeper(

app/upgrades/v15/upgrades_test.go

@@ -54,7 +54,7 @@ func (s *UpgradesTestSuite) TestEnableEIPs() {
 			extraEIPs:   []int64{3860},
 			expEIPs:     []int64{},
 			expPass:     false,
-			errContains: "is not activateable, valid EIPS are",
+			errContains: "is not activateable, valid EIPs are",
 		},
 	}
 

precompiles/outposts/osmosis/osmosis.go

@@ -9,6 +9,7 @@ import (
 
 	storetypes "github.com/cosmos/cosmos-sdk/store/types"
 	authzkeeper "github.com/cosmos/cosmos-sdk/x/authz/keeper"
+	bankkeeper "github.com/cosmos/cosmos-sdk/x/bank/keeper"
 	stakingkeeper "github.com/cosmos/cosmos-sdk/x/staking/keeper"
 	clienttypes "github.com/cosmos/ibc-go/v7/modules/core/02-client/types"
 	"github.com/ethereum/go-ethereum/accounts/abi"
@@ -17,7 +18,6 @@ import (
 	cmn "github.com/evmos/evmos/v15/precompiles/common"
 	"github.com/evmos/evmos/v15/precompiles/ics20"
 	erc20keeper "github.com/evmos/evmos/v15/x/erc20/keeper"
-	erc20types "github.com/evmos/evmos/v15/x/erc20/types"
 	transferkeeper "github.com/evmos/evmos/v15/x/ibc/transfer/keeper"
 )
 
@@ -54,7 +54,7 @@ type Precompile struct {
 	osmosisXCSContract string
 
 	// Keepers
-	bankKeeper     erc20types.BankKeeper
+	bankKeeper     bankkeeper.Keeper
 	transferKeeper transferkeeper.Keeper
 	stakingKeeper  stakingkeeper.Keeper
 	erc20Keeper    erc20keeper.Keeper
@@ -65,7 +65,7 @@ type Precompile struct {
 func NewPrecompile(
 	portID, channelID string,
 	osmosisXCSContract string,
-	bankKeeper erc20types.BankKeeper,
+	bankKeeper bankkeeper.Keeper,
 	transferKeeper transferkeeper.Keeper,
 	stakingKeeper stakingkeeper.Keeper,
 	erc20Keeper erc20keeper.Keeper,

precompiles/werc20/werc20.go

@@ -18,7 +18,7 @@ import (
 )
 
 // abiPath defines the path to the WERC-20 precompile ABI JSON file.
-const abiPath = "./abi.json"
+const abiPath = "abi.json"
 
 // Embed abi json file to the executable binary. Needed when importing as dependency.
 //

x/erc20/keeper/evm_test.go

@@ -14,6 +14,7 @@ import (
 	"github.com/evmos/evmos/v15/contracts"
 	"github.com/evmos/evmos/v15/x/erc20/keeper"
 	"github.com/evmos/evmos/v15/x/erc20/types"
+	erc20mocks "github.com/evmos/evmos/v15/x/erc20/types/mocks"
 )
 
 func (suite *KeeperTestSuite) TestQueryERC20() {
@@ -53,7 +54,7 @@ func (suite *KeeperTestSuite) TestQueryERC20() {
 }
 
 func (suite *KeeperTestSuite) TestBalanceOf() {
-	var mockEVMKeeper *MockEVMKeeper
+	var mockEVMKeeper *erc20mocks.EVMKeeper
 	contract := utiltx.GenerateAddress()
 	testCases := []struct {
 		name       string
@@ -90,12 +91,14 @@ func (suite *KeeperTestSuite) TestBalanceOf() {
 	}
 	for _, tc := range testCases {
 		suite.SetupTest() // reset
-		mockEVMKeeper = &MockEVMKeeper{}
+		mockEVMKeeper = &erc20mocks.EVMKeeper{}
 		suite.app.Erc20Keeper = keeper.NewKeeper(
 			suite.app.GetKey("erc20"), suite.app.AppCodec(),
 			authtypes.NewModuleAddress(govtypes.ModuleName),
 			suite.app.AccountKeeper, suite.app.BankKeeper,
-			mockEVMKeeper, suite.app.StakingKeeper, suite.app.ClaimsKeeper)
+			mockEVMKeeper, suite.app.StakingKeeper, suite.app.ClaimsKeeper,
+			s.app.AuthzKeeper, &s.app.TransferKeeper,
+		)
 
 		tc.malleate()
 
@@ -240,7 +243,7 @@ func (suite *KeeperTestSuite) TestCallEVMWithData() {
 }
 
 func (suite *KeeperTestSuite) TestForceFail() {
-	var mockEVMKeeper *MockEVMKeeper
+	var mockEVMKeeper *erc20mocks.EVMKeeper
 	erc20 := contracts.ERC20MinterBurnerDecimalsContract.ABI
 	testCases := []struct {
 		name     string
@@ -279,11 +282,13 @@ func (suite *KeeperTestSuite) TestForceFail() {
 	for _, tc := range testCases {
 		suite.Run(fmt.Sprintf("Case %s", tc.name), func() {
 			suite.SetupTest() // reset
-			mockEVMKeeper = &MockEVMKeeper{}
+			mockEVMKeeper = &erc20mocks.EVMKeeper{}
 			suite.app.Erc20Keeper = keeper.NewKeeper(
 				suite.app.GetKey("erc20"), suite.app.AppCodec(),
 				authtypes.NewModuleAddress(govtypes.ModuleName), suite.app.AccountKeeper,
-				suite.app.BankKeeper, mockEVMKeeper, suite.app.StakingKeeper, suite.app.ClaimsKeeper)
+				suite.app.BankKeeper, mockEVMKeeper, suite.app.StakingKeeper, suite.app.ClaimsKeeper,
+				s.app.AuthzKeeper, &s.app.TransferKeeper,
+			)
 
 			tc.malleate()
 
@@ -304,7 +309,7 @@ func (suite *KeeperTestSuite) TestForceFail() {
 }
 
 func (suite *KeeperTestSuite) TestQueryERC20ForceFail() {
-	var mockEVMKeeper *MockEVMKeeper
+	var mockEVMKeeper *erc20mocks.EVMKeeper
 	contract := utiltx.GenerateAddress()
 	testCases := []struct {
 		name     string
@@ -368,11 +373,15 @@ func (suite *KeeperTestSuite) TestQueryERC20ForceFail() {
 	}
 	for _, tc := range testCases {
 		suite.SetupTest() // reset
-		mockEVMKeeper = &MockEVMKeeper{}
+
+		// TODO: what's the reason we are using mockEVMKeeper here? Instead of just passing the suite.app.EvmKeeper?
+		mockEVMKeeper = &erc20mocks.EVMKeeper{}
 		suite.app.Erc20Keeper = keeper.NewKeeper(
 			suite.app.GetKey("erc20"), suite.app.AppCodec(),
 			authtypes.NewModuleAddress(govtypes.ModuleName), suite.app.AccountKeeper,
-			suite.app.BankKeeper, mockEVMKeeper, suite.app.StakingKeeper, suite.app.ClaimsKeeper)
+			suite.app.BankKeeper, mockEVMKeeper, suite.app.StakingKeeper, suite.app.ClaimsKeeper,
+			s.app.AuthzKeeper, &s.app.TransferKeeper,
+		)
 
 		tc.malleate()
 

x/erc20/keeper/ibc_callbacks_test.go

@@ -349,6 +349,8 @@ func (suite *KeeperTestSuite) TestOnRecvPacket() {
 				suite.app.EvmKeeper,
 				suite.app.StakingKeeper,
 				suite.app.ClaimsKeeper,
+				suite.app.AuthzKeeper,
+				&suite.app.TransferKeeper,
 			)
 
 			// Fund receiver account with EVMOS, ERC20 coins and IBC vouchers

x/erc20/keeper/keeper.go

@@ -10,6 +10,9 @@ import (
 	"github.com/cosmos/cosmos-sdk/codec"
 	storetypes "github.com/cosmos/cosmos-sdk/store/types"
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	authzkeeper "github.com/cosmos/cosmos-sdk/x/authz/keeper"
+	bankkeeper "github.com/cosmos/cosmos-sdk/x/bank/keeper"
+	transferkeeper "github.com/evmos/evmos/v15/x/ibc/transfer/keeper"
 
 	"github.com/evmos/evmos/v15/x/erc20/types"
 )
@@ -21,11 +24,13 @@ type Keeper struct {
 	// the address capable of executing a MsgUpdateParams message. Typically, this should be the x/gov module account.
 	authority sdk.AccAddress
 
-	accountKeeper types.AccountKeeper
-	bankKeeper    types.BankKeeper
-	evmKeeper     types.EVMKeeper
-	stakingKeeper types.StakingKeeper
-	claimsKeeper  types.ClaimsKeeper
+	accountKeeper  types.AccountKeeper
+	bankKeeper     bankkeeper.Keeper
+	evmKeeper      types.EVMKeeper
+	stakingKeeper  types.StakingKeeper
+	claimsKeeper   types.ClaimsKeeper
+	authzKeeper    authzkeeper.Keeper
+	transferKeeper *transferkeeper.Keeper
 }
 
 // NewKeeper creates new instances of the erc20 Keeper
@@ -34,25 +39,29 @@ func NewKeeper(
 	cdc codec.BinaryCodec,
 	authority sdk.AccAddress,
 	ak types.AccountKeeper,
-	bk types.BankKeeper,
+	bk bankkeeper.Keeper,
 	evmKeeper types.EVMKeeper,
 	sk types.StakingKeeper,
 	ck types.ClaimsKeeper,
+	authzKeeper authzkeeper.Keeper,
+	transferKeeper *transferkeeper.Keeper,
 ) Keeper {
 	// ensure gov module account is set and is not nil
 	if err := sdk.VerifyAddressFormat(authority); err != nil {
 		panic(err)
 	}
 
 	return Keeper{
-		authority:     authority,
-		storeKey:      storeKey,
-		cdc:           cdc,
-		accountKeeper: ak,
-		bankKeeper:    bk,
-		evmKeeper:     evmKeeper,
-		stakingKeeper: sk,
-		claimsKeeper:  ck,
+		authority:      authority,
+		storeKey:       storeKey,
+		cdc:            cdc,
+		accountKeeper:  ak,
+		bankKeeper:     bk,
+		evmKeeper:      evmKeeper,
+		stakingKeeper:  sk,
+		claimsKeeper:   ck,
+		authzKeeper:    authzKeeper,
+		transferKeeper: transferKeeper,
 	}
 }
 

x/erc20/keeper/migrations_test.go

@@ -46,7 +46,7 @@ func (suite *KeeperTestSuite) TestMigrations() {
 	legacySubspace.GetParamSetIfExists(ctx, &outputParams)
 
 	// Added dummy keeper in order to use the test store and store key
-	mockKeeper := erc20keeper.NewKeeper(storeKey, nil, authtypes.NewModuleAddress(govtypes.ModuleName), nil, nil, nil, nil, nil)
+	mockKeeper := erc20keeper.NewKeeper(storeKey, nil, authtypes.NewModuleAddress(govtypes.ModuleName), nil, nil, nil, nil, nil, s.app.AuthzKeeper, nil)
 	mockSubspace := newMockSubspace(v3types.DefaultParams(), storeKey, tKey)
 	migrator := erc20keeper.NewMigrator(mockKeeper, mockSubspace)