refactor(evm): clean up erc20 and funtoken methods (#2000)

* refactor: simplify DeployERC20ForBankCoin * refactor: erc20 keeper methods * remove err array * clean up CallContractWithInput * refactor bankSend precompile * refactor PrecompileAddr_FuntokenGateway * clean up precompile * refactor: remove NibiruPrecompile * Update CHANGELOG.md * fix: DeployERC20ForBankCoin uses wrong nonce * fix: precompile tests * test(evm): fix TestDeployERC20ForBankCoin assertions * test(evm): refactor TestCreateFunTokenFromERC20 * refactor TestCreateFunTokenFromCoin * remove DoEthTx * simplify AssertERC20BalanceEqual * simplify CreateFunTokenForBankCoin * remove PrivKeyE from EthPrivKeyAcc * remove NewEthTxMsg * remove GoCtx * remove GethSigner * rename NewEthAccInfo to EthPrivAcc * remove CreateContractGethCoreMsg * rename to ExecuteContractMsgEthereumTx
NibiruChain · Aug 14, 2024 · fdcda38 · fdcda38
1 parent 7a20389
commit fdcda38
Show file tree

Hide file tree

Showing 37 changed files with 345 additions and 453 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -103,6 +103,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - [#1989](https://github.com/NibiruChain/nibiru/pull/1989) - refactor(evm): simplify evm module address
 - [#1996](https://github.com/NibiruChain/nibiru/pull/1996) - perf(evm-keeper-precompile): implement sorted map for `k.precompiles` to remove dead code
 - [#1997](https://github.com/NibiruChain/nibiru/pull/1997) - refactor(evm): Remove unnecessary params: "enable_call", "enable_create".
+- [#2000](https://github.com/NibiruChain/nibiru/pull/2000) - refactor(evm): simplify ERC-20 keeper methods
 
 #### Dapp modules: perp, spot, oracle, etc
 

diff --git a/app/evmante/evmante_can_transfer_test.go b/app/evmante/evmante_can_transfer_test.go
@@ -2,6 +2,7 @@ package evmante_test
 
 import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	gethcore "github.com/ethereum/go-ethereum/core/types"
 
 	"github.com/NibiruChain/nibiru/v2/app/evmante"
 	"github.com/NibiruChain/nibiru/v2/eth"
@@ -34,9 +35,8 @@ func (s *TestSuite) TestCanTransferDecorator() {
 				txMsg := evmtest.HappyTransferTx(deps, 0)
 				txBuilder := deps.EncCfg.TxConfig.NewTxBuilder()
 
-				gethSigner := deps.Sender.GethSigner(deps.App.EvmKeeper.EthChainID(deps.Ctx))
-				keyringSigner := deps.Sender.KeyringSigner
-				err := txMsg.Sign(gethSigner, keyringSigner)
+				gethSigner := gethcore.LatestSignerForChainID(deps.App.EvmKeeper.EthChainID(deps.Ctx))
+				err := txMsg.Sign(gethSigner, deps.Sender.KeyringSigner)
 				s.Require().NoError(err)
 
 				tx, err := txMsg.BuildTx(txBuilder, eth.EthBaseDenom)
@@ -52,9 +52,8 @@ func (s *TestSuite) TestCanTransferDecorator() {
 				txMsg := evmtest.HappyTransferTx(deps, 0)
 				txBuilder := deps.EncCfg.TxConfig.NewTxBuilder()
 
-				gethSigner := deps.Sender.GethSigner(deps.App.EvmKeeper.EthChainID(deps.Ctx))
-				keyringSigner := deps.Sender.KeyringSigner
-				err := txMsg.Sign(gethSigner, keyringSigner)
+				gethSigner := gethcore.LatestSignerForChainID(deps.App.EvmKeeper.EthChainID(deps.Ctx))
+				err := txMsg.Sign(gethSigner, deps.Sender.KeyringSigner)
 				s.Require().NoError(err)
 
 				tx, err := txMsg.BuildTx(txBuilder, eth.EthBaseDenom)

diff --git a/app/evmante/evmante_handler_test.go b/app/evmante/evmante_handler_test.go
@@ -7,6 +7,7 @@ import (
 	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	authante "github.com/cosmos/cosmos-sdk/x/auth/ante"
+	gethcore "github.com/ethereum/go-ethereum/core/types"
 
 	"github.com/NibiruChain/nibiru/v2/app/ante"
 	"github.com/NibiruChain/nibiru/v2/app/evmante"
@@ -52,9 +53,8 @@ func (s *TestSuite) TestAnteHandlerEVM() {
 				txMsg := evmtest.HappyTransferTx(deps, 0)
 				txBuilder := deps.EncCfg.TxConfig.NewTxBuilder()
 
-				gethSigner := deps.Sender.GethSigner(deps.App.EvmKeeper.EthChainID(deps.Ctx))
-				keyringSigner := deps.Sender.KeyringSigner
-				err := txMsg.Sign(gethSigner, keyringSigner)
+				gethSigner := gethcore.LatestSignerForChainID(deps.App.EvmKeeper.EthChainID(deps.Ctx))
+				err := txMsg.Sign(gethSigner, deps.Sender.KeyringSigner)
 				s.Require().NoError(err)
 
 				tx, err := txMsg.BuildTx(txBuilder, eth.EthBaseDenom)

diff --git a/app/evmante/evmante_mempool_fees_test.go b/app/evmante/evmante_mempool_fees_test.go
@@ -70,7 +70,7 @@ func (s *TestSuite) TestMempoolGasFeeDecorator() {
 				fees := sdk.NewCoins(sdk.NewInt64Coin("unibi", int64(gasLimit)))
 				msg := &banktypes.MsgSend{
 					FromAddress: deps.Sender.NibiruAddr.String(),
-					ToAddress:   evmtest.NewEthAccInfo().NibiruAddr.String(),
+					ToAddress:   evmtest.NewEthPrivAcc().NibiruAddr.String(),
 					Amount:      sdk.NewCoins(sdk.NewInt64Coin("unibi", 1)),
 				}
 				return buildTx(deps, true, msg, gasLimit, fees)

diff --git a/app/evmante/evmante_sigverify_test.go b/app/evmante/evmante_sigverify_test.go
@@ -5,6 +5,7 @@ import (
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/auth/migrations/legacytx"
+	gethcore "github.com/ethereum/go-ethereum/core/types"
 
 	"github.com/NibiruChain/nibiru/v2/app/evmante"
 	"github.com/NibiruChain/nibiru/v2/x/evm/evmtest"
@@ -42,9 +43,8 @@ func (s *TestSuite) TestEthSigVerificationDecorator() {
 			name: "sad: ethereum tx invalid chain id",
 			txSetup: func(deps *evmtest.TestDeps) sdk.Tx {
 				tx := evmtest.HappyCreateContractTx(deps)
-				gethSigner := deps.Sender.GethSigner(InvalidChainID)
-				keyringSigner := deps.Sender.KeyringSigner
-				err := tx.Sign(gethSigner, keyringSigner)
+				gethSigner := gethcore.LatestSignerForChainID(InvalidChainID)
+				err := tx.Sign(gethSigner, deps.Sender.KeyringSigner)
 				s.Require().NoError(err)
 				return tx
 			},
@@ -54,9 +54,8 @@ func (s *TestSuite) TestEthSigVerificationDecorator() {
 			name: "happy: signed ethereum tx",
 			txSetup: func(deps *evmtest.TestDeps) sdk.Tx {
 				tx := evmtest.HappyCreateContractTx(deps)
-				gethSigner := deps.Sender.GethSigner(deps.App.EvmKeeper.EthChainID(deps.Ctx))
-				keyringSigner := deps.Sender.KeyringSigner
-				err := tx.Sign(gethSigner, keyringSigner)
+				gethSigner := gethcore.LatestSignerForChainID(deps.App.EvmKeeper.EthChainID(deps.Ctx))
+				err := tx.Sign(gethSigner, deps.Sender.KeyringSigner)
 				s.Require().NoError(err)
 				return tx
 			},

diff --git a/app/evmante/evmante_validate_basic_test.go b/app/evmante/evmante_validate_basic_test.go
@@ -9,6 +9,7 @@ import (
 	authtx "github.com/cosmos/cosmos-sdk/x/auth/tx"
 	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
 	"github.com/ethereum/go-ethereum/common"
+	gethcore "github.com/ethereum/go-ethereum/core/types"
 
 	"github.com/NibiruChain/nibiru/v2/app/evmante"
 	"github.com/NibiruChain/nibiru/v2/eth"
@@ -56,9 +57,8 @@ func (s *TestSuite) TestEthValidateBasicDecorator() {
 			name: "sad: tx not implementing protoTxProvider",
 			txSetup: func(deps *evmtest.TestDeps) sdk.Tx {
 				tx := evmtest.HappyCreateContractTx(deps)
-				gethSigner := deps.Sender.GethSigner(InvalidChainID)
-				keyringSigner := deps.Sender.KeyringSigner
-				err := tx.Sign(gethSigner, keyringSigner)
+				gethSigner := gethcore.LatestSignerForChainID(InvalidChainID)
+				err := tx.Sign(gethSigner, deps.Sender.KeyringSigner)
 				s.Require().NoError(err)
 				return tx
 			},
@@ -113,9 +113,8 @@ func (s *TestSuite) TestEthValidateBasicDecorator() {
 				s.Require().NoError(err)
 				txMsg := evmtest.HappyCreateContractTx(deps)
 
-				gethSigner := deps.Sender.GethSigner(deps.App.EvmKeeper.EthChainID(deps.Ctx))
-				keyringSigner := deps.Sender.KeyringSigner
-				err = txMsg.Sign(gethSigner, keyringSigner)
+				gethSigner := gethcore.LatestSignerForChainID(deps.App.EvmKeeper.EthChainID(deps.Ctx))
+				err = txMsg.Sign(gethSigner, deps.Sender.KeyringSigner)
 				s.Require().NoError(err)
 
 				tx, err := txMsg.BuildTx(txBuilder, eth.EthBaseDenom)
@@ -142,7 +141,7 @@ func (s *TestSuite) TestEthValidateBasicDecorator() {
 				fees := sdk.NewCoins(sdk.NewInt64Coin("unibi", int64(gasLimit)))
 				msg := &banktypes.MsgSend{
 					FromAddress: deps.Sender.NibiruAddr.String(),
-					ToAddress:   evmtest.NewEthAccInfo().NibiruAddr.String(),
+					ToAddress:   evmtest.NewEthPrivAcc().NibiruAddr.String(),
 					Amount:      sdk.NewCoins(sdk.NewInt64Coin("unibi", 1)),
 				}
 				return buildTx(deps, true, msg, gasLimit, fees)

diff --git a/eth/assert_test.go b/eth/assert_test.go
@@ -72,7 +72,7 @@ func TestValidateAddress(t *testing.T) {
 			"zero address", common.Address{}.String(), false,
 		},
 		{
-			"valid address", evmtest.NewEthAccInfo().EthAddr.Hex(), false,
+			"valid address", evmtest.NewEthPrivAcc().EthAddr.Hex(), false,
 		},
 	}
 
@@ -103,7 +103,7 @@ func TestValidateNonZeroAddress(t *testing.T) {
 			"zero address", common.Address{}.String(), true,
 		},
 		{
-			"valid address", evmtest.NewEthAccInfo().EthAddr.Hex(), false,
+			"valid address", evmtest.NewEthPrivAcc().EthAddr.Hex(), false,
 		},
 	}
 

diff --git a/eth/encoding/config_test.go b/eth/encoding/config_test.go
@@ -15,7 +15,7 @@ import (
 )
 
 func TestTxEncoding(t *testing.T) {
-	ethAcc := evmtest.NewEthAccInfo()
+	ethAcc := evmtest.NewEthPrivAcc()
 	addr, key := ethAcc.EthAddr, ethAcc.PrivKey
 	signer := evmtest.NewSigner(key)
 

diff --git a/eth/eth_account_test.go b/eth/eth_account_test.go
@@ -6,7 +6,7 @@ import (
 )
 
 func (s *Suite) TestEthAddrToNibiruAddr() {
-	accInfo := evmtest.NewEthAccInfo()
+	accInfo := evmtest.NewEthPrivAcc()
 	s.Equal(
 		accInfo.EthAddr,
 		eth.NibiruAddrToEthAddr(accInfo.NibiruAddr),
@@ -18,7 +18,7 @@ func (s *Suite) TestEthAddrToNibiruAddr() {
 
 	s.T().Log("unit operation - hex -> nibi -> hex")
 	{
-		addr := evmtest.NewEthAccInfo().NibiruAddr
+		addr := evmtest.NewEthPrivAcc().NibiruAddr
 		s.Equal(
 			addr,
 			eth.EthAddrToNibiruAddr(
@@ -29,7 +29,7 @@ func (s *Suite) TestEthAddrToNibiruAddr() {
 
 	s.T().Log("unit operation - nibi -> hex -> nibi")
 	{
-		addr := evmtest.NewEthAccInfo().EthAddr
+		addr := evmtest.NewEthPrivAcc().EthAddr
 		s.Equal(
 			addr,
 			eth.NibiruAddrToEthAddr(

diff --git a/eth/rpc/backend/account_info_test.go b/eth/rpc/backend/account_info_test.go
@@ -33,15 +33,15 @@ func (s *BackendSuite) TestGetCode() {
 	}{
 		{
 			"fail - BlockHash and BlockNumber are both nil ",
-			evmtest.NewEthAccInfo().EthAddr,
+			evmtest.NewEthPrivAcc().EthAddr,
 			rpc.BlockNumberOrHash{},
 			func(addr common.Address) {},
 			false,
 			nil,
 		},
 		{
 			"fail - query client errors on getting Code",
-			evmtest.NewEthAccInfo().EthAddr,
+			evmtest.NewEthPrivAcc().EthAddr,
 			rpc.BlockNumberOrHash{BlockNumber: &blockNr},
 			func(addr common.Address) {
 				queryClient := s.backend.queryClient.QueryClient.(*mocks.EVMQueryClient)
@@ -52,7 +52,7 @@ func (s *BackendSuite) TestGetCode() {
 		},
 		{
 			"pass",
-			evmtest.NewEthAccInfo().EthAddr,
+			evmtest.NewEthPrivAcc().EthAddr,
 			rpc.BlockNumberOrHash{BlockNumber: &blockNr},
 			func(addr common.Address) {
 				queryClient := s.backend.queryClient.QueryClient.(*mocks.EVMQueryClient)
@@ -81,7 +81,7 @@ func (s *BackendSuite) TestGetCode() {
 func (s *BackendSuite) TestGetProof() {
 	blockNrInvalid := rpc.NewBlockNumber(big.NewInt(1))
 	blockNr := rpc.NewBlockNumber(big.NewInt(4))
-	address1 := evmtest.NewEthAccInfo().EthAddr
+	address1 := evmtest.NewEthPrivAcc().EthAddr
 
 	testCases := []struct {
 		name          string
@@ -199,7 +199,7 @@ func (s *BackendSuite) TestGetStorageAt() {
 	}{
 		{
 			"fail - BlockHash and BlockNumber are both nil",
-			evmtest.NewEthAccInfo().EthAddr,
+			evmtest.NewEthPrivAcc().EthAddr,
 			"0x0",
 			rpc.BlockNumberOrHash{},
 			func(addr common.Address, key string, storage string) {},
@@ -208,7 +208,7 @@ func (s *BackendSuite) TestGetStorageAt() {
 		},
 		{
 			"fail - query client errors on getting Storage",
-			evmtest.NewEthAccInfo().EthAddr,
+			evmtest.NewEthPrivAcc().EthAddr,
 			"0x0",
 			rpc.BlockNumberOrHash{BlockNumber: &blockNr},
 			func(addr common.Address, key string, storage string) {
@@ -220,7 +220,7 @@ func (s *BackendSuite) TestGetStorageAt() {
 		},
 		{
 			"pass",
-			evmtest.NewEthAccInfo().EthAddr,
+			evmtest.NewEthPrivAcc().EthAddr,
 			"0x0",
 			rpc.BlockNumberOrHash{BlockNumber: &blockNr},
 			func(addr common.Address, key string, storage string) {
@@ -260,7 +260,7 @@ func (s *BackendSuite) TestGetEvmGasBalance() {
 	}{
 		{
 			"fail - BlockHash and BlockNumber are both nil",
-			evmtest.NewEthAccInfo().EthAddr,
+			evmtest.NewEthPrivAcc().EthAddr,
 			rpc.BlockNumberOrHash{},
 			func(bn rpc.BlockNumber, addr common.Address) {
 			},
@@ -269,7 +269,7 @@ func (s *BackendSuite) TestGetEvmGasBalance() {
 		},
 		{
 			"fail - tendermint client failed to get block",
-			evmtest.NewEthAccInfo().EthAddr,
+			evmtest.NewEthPrivAcc().EthAddr,
 			rpc.BlockNumberOrHash{BlockNumber: &blockNr},
 			func(bn rpc.BlockNumber, addr common.Address) {
 				client := s.backend.clientCtx.Client.(*mocks.Client)
@@ -280,7 +280,7 @@ func (s *BackendSuite) TestGetEvmGasBalance() {
 		},
 		{
 			"fail - query client failed to get balance",
-			evmtest.NewEthAccInfo().EthAddr,
+			evmtest.NewEthPrivAcc().EthAddr,
 			rpc.BlockNumberOrHash{BlockNumber: &blockNr},
 			func(bn rpc.BlockNumber, addr common.Address) {
 				client := s.backend.clientCtx.Client.(*mocks.Client)
@@ -294,7 +294,7 @@ func (s *BackendSuite) TestGetEvmGasBalance() {
 		},
 		{
 			"fail - invalid balance",
-			evmtest.NewEthAccInfo().EthAddr,
+			evmtest.NewEthPrivAcc().EthAddr,
 			rpc.BlockNumberOrHash{BlockNumber: &blockNr},
 			func(bn rpc.BlockNumber, addr common.Address) {
 				client := s.backend.clientCtx.Client.(*mocks.Client)
@@ -308,7 +308,7 @@ func (s *BackendSuite) TestGetEvmGasBalance() {
 		},
 		{
 			"fail - pruned node state",
-			evmtest.NewEthAccInfo().EthAddr,
+			evmtest.NewEthPrivAcc().EthAddr,
 			rpc.BlockNumberOrHash{BlockNumber: &blockNr},
 			func(bn rpc.BlockNumber, addr common.Address) {
 				client := s.backend.clientCtx.Client.(*mocks.Client)
@@ -322,7 +322,7 @@ func (s *BackendSuite) TestGetEvmGasBalance() {
 		},
 		{
 			"pass",
-			evmtest.NewEthAccInfo().EthAddr,
+			evmtest.NewEthPrivAcc().EthAddr,
 			rpc.BlockNumberOrHash{BlockNumber: &blockNr},
 			func(bn rpc.BlockNumber, addr common.Address) {
 				client := s.backend.clientCtx.Client.(*mocks.Client)
@@ -393,7 +393,7 @@ func (s *BackendSuite) TestGetTransactionCount() {
 		s.Run(fmt.Sprintf("Case %s", tc.name), func() {
 			s.SetupTest()
 
-			addr := evmtest.NewEthAccInfo().EthAddr
+			addr := evmtest.NewEthPrivAcc().EthAddr
 			if tc.accExists {
 				addr = common.BytesToAddress(s.acc.Bytes())
 			}

diff --git a/eth/rpc/backend/backend_suite_test.go b/eth/rpc/backend/backend_suite_test.go
@@ -58,15 +58,15 @@ func (s *BackendSuite) SetupTest() {
 	}
 
 	// Create Account with set sequence
-	s.acc = sdk.AccAddress(evmtest.NewEthAccInfo().EthAddr.Bytes())
+	s.acc = sdk.AccAddress(evmtest.NewEthPrivAcc().EthAddr.Bytes())
 	accounts := map[string]client.TestAccount{}
 	accounts[s.acc.String()] = client.TestAccount{
 		Address: s.acc,
 		Num:     uint64(1),
 		Seq:     uint64(1),
 	}
 
-	ethAcc := evmtest.NewEthAccInfo()
+	ethAcc := evmtest.NewEthPrivAcc()
 	from, priv := ethAcc.EthAddr, ethAcc.PrivKey
 	s.from = from
 	s.signer = evmtest.NewSigner(priv)
@@ -180,7 +180,7 @@ func (s *BackendSuite) generateTestKeyring(clientDir string) (keyring.Keyring, e
 }
 
 func (s *BackendSuite) signAndEncodeEthTx(msgEthereumTx *evm.MsgEthereumTx) []byte {
-	ethAcc := evmtest.NewEthAccInfo()
+	ethAcc := evmtest.NewEthPrivAcc()
 	from, priv := ethAcc.EthAddr, ethAcc.PrivKey
 	signer := evmtest.NewSigner(priv)