fix(evm): Use a NibiruBankKeeper to automatically record ether balanc…

…e changes on the StateDB journal (#2095) * statedb: add cacheing for multistore before precompile runs * messy, working first version that allows for precompile reversion * wip!: Save checkpoint. 1. Created NibiruBankKeeper with safety around NIBI transfers inside of EthereumTx. 2. The "PrecompileCalled" JournalChange now has a propery implementation and a strong test case to show that reverting the precompile calls works as intended. 3. Remove unneeded functions created for testing with low-level struct fields. * chore: changelog * finalize bank keeper changes * chore changelog * reset cache * finalize bank keeper changes * revert to previous commit 7f904a0 * fix strange ignored file issue * fix strange ignored file issue * remove new bank keeper * chore: comments from self-review * chore: changelo g * fix(deps): update bank module to remove concrete type assertion on AppModule.RegisterServices This makes it possible to plug in an alternative bankkeeper.Keeper implementation instead of bankkeeper.BaseKeeper. * chore: merge conflicts * revert experiment * finishing touch * fix incorrect arugmetn * feat(evmtest-erc20: Add optional descriptions to the assertions
NibiruChain · Oct 31, 2024 · ecf3e47 · ecf3e47
1 parent ee5e29f
commit ecf3e47
Show file tree

Hide file tree

Showing 45 changed files with 496 additions and 266 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -68,7 +68,12 @@ consistent setup and dynamic gas calculations, addressing the following tickets.
   - <https://github.com/code-423n4/2024-10-nibiru-zenith/issues/47>
 - [#2088](https://github.com/NibiruChain/nibiru/pull/2088) - refactor(evm): remove outdated comment and improper error message text
 - [#2089](https://github.com/NibiruChain/nibiru/pull/2089) - better handling of gas consumption within erc20 contract execution
+- [#2090](https://github.com/NibiruChain/nibiru/pull/2090) - fix(evm): Account
+for (1) ERC20 transfers with tokens that return false success values instead of
+throwing an error and (2) ERC20 transfers with other operations that don't bring
+about the expected resulting balance for the transfer recipient.
 - [#2091](https://github.com/NibiruChain/nibiru/pull/2091) - feat(evm): add fun token creation fee validation
+- [#2092](https://github.com/NibiruChain/nibiru/pull/2092) - feat(evm): add validation for wasm multi message execution
 - [#2094](https://github.com/NibiruChain/nibiru/pull/2094) - fix(evm): Following
 from the changs in #2086, this pull request implements a new `JournalChange`
 struct that saves a deep copy of the state multi store before each
@@ -78,12 +83,17 @@ non-EVM and EVM state will be in sync even if there are complex, multi-step
 Ethereum transactions, such as in the case of an EthereumTx that influences the
 `StateDB`, then calls a precompile that also changes non-EVM state, and then EVM
 reverts inside of a try-catch.
-- [#2098](https://github.com/NibiruChain/nibiru/pull/2098) - test(evm): statedb tests for race conditions within funtoken precompile
-- [#2090](https://github.com/NibiruChain/nibiru/pull/2090) - fix(evm): Account
-for (1) ERC20 transfers with tokens that return false success values instead of
-throwing an error and (2) ERC20 transfers with other operations that don't bring
-about the expected resulting balance for the transfer recipient.
-- [#2092](https://github.com/NibiruChain/nibiru/pull/2092) - feat(evm): add validation for wasm multi message execution
+- [#2095](https://github.com/NibiruChain/nibiru/pull/2095) - fix(evm): This
+change records NIBI (ether) transfers on the `StateDB` during precompiled
+contract calls using the `NibiruBankKeeper`, which is struct extension of
+the `bankkeeper.BaseKeeper` that is used throughout Nibiru.
+The `NibiruBankKeeper` holds a reference to the current EVM `StateDB` and records
+balance changes in wei as journal changes automatically. This guarantees that
+commits and reversions of the `StateDB` do not misalign with the state of the
+Bank module. This code change uses the `NibiruBankKeeper` on all modules that
+depend on x/bank, such as the EVM and Wasm modules. 
+- [#2098](https://github.com/NibiruChain/nibiru/pull/2098) - test(evm): statedb
+tests for race conditions within funtoken precompile
 - [#2068](https://github.com/NibiruChain/nibiru/pull/2068) - feat: enable wasm light clients on IBC (08-wasm)
 - [#2101](https://github.com/NibiruChain/nibiru/pull/2101) - fix(evm): tx receipt proper marshalling
 

diff --git a/app/ante/gas_wanted_test.go b/app/ante/gas_wanted_test.go
@@ -83,7 +83,7 @@ func (s *AnteTestSuite) TestGasWantedDecorator() {
 	for _, tc := range testCases {
 		s.Run(tc.name, func() {
 			deps := evmtest.NewTestDeps()
-			stateDB := deps.StateDB()
+			stateDB := deps.NewStateDB()
 			anteDec := ante.AnteDecoratorGasWanted{}
 
 			tx := tc.txSetup(&deps)

diff --git a/app/ante/handler_opts.go b/app/ante/handler_opts.go
@@ -20,7 +20,7 @@ type AnteHandlerOptions struct {
 	IBCKeeper        *ibckeeper.Keeper
 	DevGasKeeper     *devgaskeeper.Keeper
 	DevGasBankKeeper devgasante.BankKeeper
-	EvmKeeper        evmkeeper.Keeper
+	EvmKeeper        *evmkeeper.Keeper
 	AccountKeeper    authkeeper.AccountKeeper
 
 	TxCounterStoreKey types.StoreKey

diff --git a/app/evmante/evmante_can_transfer.go b/app/evmante/evmante_can_transfer.go
@@ -72,9 +72,8 @@ func (ctd CanTransferDecorator) AnteHandle(
 			BaseFeeWei:    baseFeeWeiPerGas,
 		}
 
-		stateDB := statedb.New(
+		stateDB := ctd.NewStateDB(
 			ctx,
-			ctd.EVMKeeper,
 			statedb.NewEmptyTxConfig(gethcommon.BytesToHash(ctx.HeaderHash().Bytes())),
 		)
 		evmInstance := ctd.EVMKeeper.NewEVM(ctx, coreMsg, cfg, evm.NewNoOpTracer(), stateDB)

diff --git a/app/evmante/evmante_can_transfer_test.go b/app/evmante/evmante_can_transfer_test.go
@@ -88,8 +88,8 @@ func (s *TestSuite) TestCanTransferDecorator() {
 	for _, tc := range testCases {
 		s.Run(tc.name, func() {
 			deps := evmtest.NewTestDeps()
-			stateDB := deps.StateDB()
-			anteDec := evmante.CanTransferDecorator{&deps.App.AppKeepers.EvmKeeper}
+			stateDB := deps.NewStateDB()
+			anteDec := evmante.CanTransferDecorator{deps.App.AppKeepers.EvmKeeper}
 			tx := tc.txSetup(&deps)
 
 			if tc.ctxSetup != nil {

diff --git a/app/evmante/evmante_emit_event_test.go b/app/evmante/evmante_emit_event_test.go
@@ -41,8 +41,8 @@ func (s *TestSuite) TestEthEmitEventDecorator() {
 	for _, tc := range testCases {
 		s.Run(tc.name, func() {
 			deps := evmtest.NewTestDeps()
-			stateDB := deps.StateDB()
-			anteDec := evmante.NewEthEmitEventDecorator(&deps.App.AppKeepers.EvmKeeper)
+			stateDB := deps.NewStateDB()
+			anteDec := evmante.NewEthEmitEventDecorator(deps.App.AppKeepers.EvmKeeper)
 
 			tx := tc.txSetup(&deps)
 			s.Require().NoError(stateDB.Commit())

diff --git a/app/evmante/evmante_gas_consume_test.go b/app/evmante/evmante_gas_consume_test.go
@@ -59,9 +59,9 @@ func (s *TestSuite) TestAnteDecEthGasConsume() {
 	for _, tc := range testCases {
 		s.Run(tc.name, func() {
 			deps := evmtest.NewTestDeps()
-			stateDB := deps.StateDB()
+			stateDB := deps.NewStateDB()
 			anteDec := evmante.NewAnteDecEthGasConsume(
-				&deps.App.AppKeepers.EvmKeeper, tc.maxGasWanted,
+				deps.App.AppKeepers.EvmKeeper, tc.maxGasWanted,
 			)
 
 			tc.beforeTxSetup(&deps, stateDB)

diff --git a/app/evmante/evmante_handler.go b/app/evmante/evmante_handler.go
@@ -13,16 +13,16 @@ func NewAnteHandlerEVM(
 ) sdk.AnteHandler {
 	return sdk.ChainAnteDecorators(
 		// outermost AnteDecorator. SetUpContext must be called first
-		NewEthSetUpContextDecorator(&options.EvmKeeper),
-		NewMempoolGasPriceDecorator(&options.EvmKeeper),
-		NewEthValidateBasicDecorator(&options.EvmKeeper),
-		NewEthSigVerificationDecorator(&options.EvmKeeper),
-		NewAnteDecVerifyEthAcc(&options.EvmKeeper, options.AccountKeeper),
-		CanTransferDecorator{&options.EvmKeeper},
-		NewAnteDecEthGasConsume(&options.EvmKeeper, options.MaxTxGasWanted),
-		NewAnteDecEthIncrementSenderSequence(&options.EvmKeeper, options.AccountKeeper),
+		NewEthSetUpContextDecorator(options.EvmKeeper),
+		NewMempoolGasPriceDecorator(options.EvmKeeper),
+		NewEthValidateBasicDecorator(options.EvmKeeper),
+		NewEthSigVerificationDecorator(options.EvmKeeper),
+		NewAnteDecVerifyEthAcc(options.EvmKeeper, options.AccountKeeper),
+		CanTransferDecorator{options.EvmKeeper},
+		NewAnteDecEthGasConsume(options.EvmKeeper, options.MaxTxGasWanted),
+		NewAnteDecEthIncrementSenderSequence(options.EvmKeeper, options.AccountKeeper),
 		ante.AnteDecoratorGasWanted{},
 		// emit eth tx hash and index at the very last ante handler.
-		NewEthEmitEventDecorator(&options.EvmKeeper),
+		NewEthEmitEventDecorator(options.EvmKeeper),
 	)
 }
diff --git a/app/evmante/evmante_handler_test.go b/app/evmante/evmante_handler_test.go
@@ -69,7 +69,7 @@ func (s *TestSuite) TestAnteHandlerEVM() {
 	for _, tc := range testCases {
 		s.Run(tc.name, func() {
 			deps := evmtest.NewTestDeps()
-			stateDB := deps.StateDB()
+			stateDB := deps.NewStateDB()
 
 			anteHandlerEVM := evmante.NewAnteHandlerEVM(
 				ante.AnteHandlerOptions{

diff --git a/app/evmante/evmante_increment_sender_seq_test.go b/app/evmante/evmante_increment_sender_seq_test.go
@@ -66,8 +66,8 @@ func (s *TestSuite) TestAnteDecEthIncrementSenderSequence() {
 	for _, tc := range testCases {
 		s.Run(tc.name, func() {
 			deps := evmtest.NewTestDeps()
-			stateDB := deps.StateDB()
-			anteDec := evmante.NewAnteDecEthIncrementSenderSequence(&deps.App.EvmKeeper, deps.App.AccountKeeper)
+			stateDB := deps.NewStateDB()
+			anteDec := evmante.NewAnteDecEthIncrementSenderSequence(deps.App.EvmKeeper, deps.App.AccountKeeper)
 
 			if tc.beforeTxSetup != nil {
 				tc.beforeTxSetup(&deps, stateDB)

diff --git a/app/evmante/evmante_mempool_fees_test.go b/app/evmante/evmante_mempool_fees_test.go
@@ -82,7 +82,7 @@ func (s *TestSuite) TestMempoolGasFeeDecorator() {
 	for _, tc := range testCases {
 		s.Run(tc.name, func() {
 			deps := evmtest.NewTestDeps()
-			anteDec := evmante.NewMempoolGasPriceDecorator(&deps.App.AppKeepers.EvmKeeper)
+			anteDec := evmante.NewMempoolGasPriceDecorator(deps.App.AppKeepers.EvmKeeper)
 
 			tx := tc.txSetup(&deps)
 

diff --git a/app/evmante/evmante_setup_ctx_test.go b/app/evmante/evmante_setup_ctx_test.go
@@ -12,8 +12,8 @@ import (
 
 func (s *TestSuite) TestEthSetupContextDecorator() {
 	deps := evmtest.NewTestDeps()
-	stateDB := deps.StateDB()
-	anteDec := evmante.NewEthSetUpContextDecorator(&deps.App.EvmKeeper)
+	stateDB := deps.NewStateDB()
+	anteDec := evmante.NewEthSetUpContextDecorator(deps.App.EvmKeeper)
 
 	s.Require().NoError(stateDB.Commit())
 	tx := evmtest.HappyCreateContractTx(&deps)

diff --git a/app/evmante/evmante_sigverify_test.go b/app/evmante/evmante_sigverify_test.go
@@ -66,8 +66,8 @@ func (s *TestSuite) TestEthSigVerificationDecorator() {
 	for _, tc := range testCases {
 		s.Run(tc.name, func() {
 			deps := evmtest.NewTestDeps()
-			stateDB := deps.StateDB()
-			anteDec := evmante.NewEthSigVerificationDecorator(&deps.App.AppKeepers.EvmKeeper)
+			stateDB := deps.NewStateDB()
+			anteDec := evmante.NewEthSigVerificationDecorator(deps.App.AppKeepers.EvmKeeper)
 
 			tx := tc.txSetup(&deps)
 			s.Require().NoError(stateDB.Commit())

diff --git a/app/evmante/evmante_validate_basic_test.go b/app/evmante/evmante_validate_basic_test.go
@@ -198,8 +198,8 @@ func (s *TestSuite) TestEthValidateBasicDecorator() {
 	for _, tc := range testCases {
 		s.Run(tc.name, func() {
 			deps := evmtest.NewTestDeps()
-			stateDB := deps.StateDB()
-			anteDec := evmante.NewEthValidateBasicDecorator(&deps.App.AppKeepers.EvmKeeper)
+			stateDB := deps.NewStateDB()
+			anteDec := evmante.NewEthValidateBasicDecorator(deps.App.AppKeepers.EvmKeeper)
 
 			tx := tc.txSetup(&deps)
 			s.Require().NoError(stateDB.Commit())

diff --git a/app/evmante/evmante_verify_eth_acc_test.go b/app/evmante/evmante_verify_eth_acc_test.go
@@ -64,8 +64,8 @@ func (s *TestSuite) TestAnteDecoratorVerifyEthAcc_CheckTx() {
 	for _, tc := range testCases {
 		s.Run(tc.name, func() {
 			deps := evmtest.NewTestDeps()
-			stateDB := deps.StateDB()
-			anteDec := evmante.NewAnteDecVerifyEthAcc(&deps.App.AppKeepers.EvmKeeper, &deps.App.AppKeepers.AccountKeeper)
+			stateDB := deps.NewStateDB()
+			anteDec := evmante.NewAnteDecVerifyEthAcc(deps.App.AppKeepers.EvmKeeper, &deps.App.AppKeepers.AccountKeeper)
 
 			tc.beforeTxSetup(&deps, stateDB)
 			tx := tc.txSetup(&deps)

diff --git a/app/keepers.go b/app/keepers.go
@@ -146,7 +146,6 @@ type AppKeepers struct {
 }
 
 type privateKeepers struct {
-	bankBaseKeeper   bankkeeper.BaseKeeper
 	capabilityKeeper *capabilitykeeper.Keeper
 	slashingKeeper   slashingkeeper.Keeper
 	crisisKeeper     crisiskeeper.Keeper
@@ -271,14 +270,17 @@ func (app *NibiruApp) InitKeepers(
 		govModuleAddr,
 	)
 
-	app.bankBaseKeeper = bankkeeper.NewBaseKeeper(
-		appCodec,
-		keys[banktypes.StoreKey],
-		app.AccountKeeper,
-		BlockedAddresses(),
-		govModuleAddr,
-	)
-	app.BankKeeper = app.bankBaseKeeper
+	nibiruBankKeeper := &evmkeeper.NibiruBankKeeper{
+		BaseKeeper: bankkeeper.NewBaseKeeper(
+			appCodec,
+			keys[banktypes.StoreKey],
+			app.AccountKeeper,
+			BlockedAddresses(),
+			govModuleAddr,
+		),
+		StateDB: nil,
+	}
+	app.BankKeeper = nibiruBankKeeper
 	app.StakingKeeper = stakingkeeper.NewKeeper(
 		appCodec,
 		keys[stakingtypes.StoreKey],
@@ -374,16 +376,17 @@ func (app *NibiruApp) InitKeepers(
 		),
 	)
 
-	app.EvmKeeper = evmkeeper.NewKeeper(
+	evmKeeper := evmkeeper.NewKeeper(
 		appCodec,
 		keys[evm.StoreKey],
 		tkeys[evm.TransientKey],
 		authtypes.NewModuleAddress(govtypes.ModuleName),
 		app.AccountKeeper,
-		app.BankKeeper,
+		nibiruBankKeeper,
 		app.StakingKeeper,
 		cast.ToString(appOpts.Get("evm.tracer")),
 	)
+	app.EvmKeeper = &evmKeeper
 
 	// ---------------------------------- IBC keepers
 
@@ -631,7 +634,7 @@ func (app *NibiruApp) initAppModules(
 		),
 		auth.NewAppModule(appCodec, app.AccountKeeper, authsims.RandomGenesisAccounts, app.GetSubspace(authtypes.ModuleName)),
 		vesting.NewAppModule(app.AccountKeeper, app.BankKeeper),
-		bank.NewAppModule(appCodec, app.bankBaseKeeper, app.AccountKeeper, app.GetSubspace(banktypes.ModuleName)),
+		bank.NewAppModule(appCodec, app.BankKeeper, app.AccountKeeper, app.GetSubspace(banktypes.ModuleName)),
 		capability.NewAppModule(appCodec, *app.capabilityKeeper, false),
 		feegrantmodule.NewAppModule(appCodec, app.AccountKeeper, app.BankKeeper, app.FeeGrantKeeper, app.interfaceRegistry),
 		gov.NewAppModule(appCodec, &app.GovKeeper, app.AccountKeeper, app.BankKeeper, app.GetSubspace(govtypes.ModuleName)),
@@ -657,7 +660,7 @@ func (app *NibiruApp) initAppModules(
 		ica.NewAppModule(&app.icaControllerKeeper, &app.icaHostKeeper),
 		ibcwasm.NewAppModule(app.WasmClientKeeper),
 
-		evmmodule.NewAppModule(&app.EvmKeeper, app.AccountKeeper),
+		evmmodule.NewAppModule(app.EvmKeeper, app.AccountKeeper),
 
 		// wasm
 		wasm.NewAppModule(

diff --git a/app/keepers/all_keepers.go b/app/keepers/all_keepers.go
@@ -64,7 +64,7 @@ type PublicKeepers struct {
 	SudoKeeper         keeper.Keeper
 	DevGasKeeper       devgaskeeper.Keeper
 	TokenFactoryKeeper tokenfactorykeeper.Keeper
-	EvmKeeper          evmkeeper.Keeper
+	EvmKeeper          *evmkeeper.Keeper
 
 	// WASM keepers
 	WasmKeeper       wasmkeeper.Keeper

diff --git a/go.mod b/go.mod
@@ -246,7 +246,7 @@ replace (
 	cosmossdk.io/api => cosmossdk.io/api v0.3.1
 
 	github.com/CosmWasm/wasmd => github.com/NibiruChain/wasmd v0.44.0-nibiru
-	github.com/cosmos/cosmos-sdk => github.com/NibiruChain/cosmos-sdk v0.47.11-nibiru
+	github.com/cosmos/cosmos-sdk => github.com/NibiruChain/cosmos-sdk v0.47.11-nibiru.2
 
 	github.com/cosmos/iavl => github.com/cosmos/iavl v0.20.0
 

diff --git a/go.sum b/go.sum
@@ -235,8 +235,8 @@ github.com/Microsoft/go-winio v0.6.1 h1:9/kr64B9VUZrLm5YYwbGtUJnMgqWVOdUAXu6Migc
 github.com/Microsoft/go-winio v0.6.1/go.mod h1:LRdKpFKfdobln8UmuiYcKPot9D2v6svN5+sAH+4kjUM=
 github.com/NibiruChain/collections v0.5.0 h1:33pXpVTe1PK/tfdZlAJF1JF7AdzGNARG+iL9G/z3X7k=
 github.com/NibiruChain/collections v0.5.0/go.mod h1:43L6yjuF0BMre/mw4gqn/kUOZz1c2Y3huZ/RQfBFrOQ=
-github.com/NibiruChain/cosmos-sdk v0.47.11-nibiru h1:PgFpxDe+7+OzWHs4zXlml5j2i9sGq2Zpd3ndYQG29/0=
-github.com/NibiruChain/cosmos-sdk v0.47.11-nibiru/go.mod h1:ADjORYzUQqQv/FxDi0H0K5gW/rAk1CiDR3ZKsExfJV0=
+github.com/NibiruChain/cosmos-sdk v0.47.11-nibiru.2 h1:HtLNrkp0HhgxtbpdNwsasOod4uUNFpuwYpyceFtbj3E=
+github.com/NibiruChain/cosmos-sdk v0.47.11-nibiru.2/go.mod h1:ADjORYzUQqQv/FxDi0H0K5gW/rAk1CiDR3ZKsExfJV0=
 github.com/NibiruChain/go-ethereum v1.10.27-nibiru h1:o6lRFt57izoYwzN5cG8tnnBtJcaO3X7MjjN7PGGNCFg=
 github.com/NibiruChain/go-ethereum v1.10.27-nibiru/go.mod h1:kvvL3nDceUcB+1qGUBAsVf5dW23RBR77fqxgx2PGNrQ=
 github.com/NibiruChain/wasmd v0.44.0-nibiru h1:b+stNdbMFsl0+o4KedXyF83qRnEpB/jCiTGZZgv2h2U=