fix(evm): StateDB multistore cache for precompile reversion and a safer Nibiru bank keeper that respects the EVM #2094
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| package keeper | ||
|
|
||
| import ( | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| auth "github.com/cosmos/cosmos-sdk/x/auth/types" | ||
| bankkeeper "github.com/cosmos/cosmos-sdk/x/bank/keeper" | ||
|
|
||
| "github.com/NibiruChain/nibiru/v2/eth" | ||
| "github.com/NibiruChain/nibiru/v2/x/evm" | ||
| "github.com/NibiruChain/nibiru/v2/x/evm/statedb" | ||
| ) | ||
|
|
||
| var ( | ||
| _ bankkeeper.Keeper = &NibiruBankKeeper{} | ||
| _ bankkeeper.SendKeeper = &NibiruBankKeeper{} | ||
| ) | ||
|
|
||
| type NibiruBankKeeper struct { | ||
| bankkeeper.BaseKeeper | ||
| StateDB *statedb.StateDB | ||
| balanceChangesForStateDB uint64 | ||
| } | ||
|
|
||
| func (evmKeeper *Keeper) NewStateDB( | ||
| ctx sdk.Context, txConfig statedb.TxConfig, | ||
| ) *statedb.StateDB { | ||
| stateDB := statedb.New(ctx, evmKeeper, txConfig) | ||
| bk := evmKeeper.bankKeeper | ||
| bk.StateDB = stateDB | ||
| bk.balanceChangesForStateDB = 0 | ||
| return stateDB | ||
| } | ||
|
|
||
| // BalanceChangesForStateDB returns the count of [statedb.JournalChange] entries | ||
| // that were added to the current [statedb.StateDB] | ||
| func (bk *NibiruBankKeeper) BalanceChangesForStateDB() uint64 { return bk.balanceChangesForStateDB } | ||
|
|
||
| func (bk NibiruBankKeeper) MintCoins( | ||
| ctx sdk.Context, | ||
| moduleName string, | ||
| coins sdk.Coins, | ||
| ) error { | ||
| // Use the embedded function from [bankkeeper.Keeper] | ||
| if err := bk.BaseKeeper.MintCoins(ctx, moduleName, coins); err != nil { | ||
| return err | ||
| } | ||
| if findEtherBalanceChangeFromCoins(coins) { | ||
| moduleBech32Addr := auth.NewModuleAddress(evm.ModuleName) | ||
| bk.SyncStateDBWithAccount(ctx, moduleBech32Addr) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (bk NibiruBankKeeper) BurnCoins( | ||
| ctx sdk.Context, | ||
| moduleName string, | ||
| coins sdk.Coins, | ||
| ) error { | ||
| // Use the embedded function from [bankkeeper.Keeper] | ||
| if err := bk.BaseKeeper.BurnCoins(ctx, moduleName, coins); err != nil { | ||
| return err | ||
| } | ||
| if findEtherBalanceChangeFromCoins(coins) { | ||
| moduleBech32Addr := auth.NewModuleAddress(evm.ModuleName) | ||
| bk.SyncStateDBWithAccount(ctx, moduleBech32Addr) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (bk NibiruBankKeeper) SendCoins( | ||
| ctx sdk.Context, | ||
| fromAddr sdk.AccAddress, | ||
| toAddr sdk.AccAddress, | ||
| coins sdk.Coins, | ||
| ) error { | ||
| // Use the embedded function from [bankkeeper.Keeper] | ||
| if err := bk.BaseKeeper.SendCoins(ctx, fromAddr, toAddr, coins); err != nil { | ||
| return err | ||
| } | ||
| if findEtherBalanceChangeFromCoins(coins) { | ||
| bk.SyncStateDBWithAccount(ctx, fromAddr) | ||
| bk.SyncStateDBWithAccount(ctx, toAddr) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (bk *NibiruBankKeeper) SyncStateDBWithAccount( | ||
| ctx sdk.Context, acc sdk.AccAddress, | ||
| ) { | ||
| // If there's no StateDB set, it means we're not in an EthereumTx. | ||
| if bk.StateDB == nil { | ||
| return | ||
| } | ||
| balanceWei := evm.NativeToWei( | ||
| bk.GetBalance(ctx, acc, evm.EVMBankDenom).Amount.BigInt(), | ||
| ) | ||
| bk.StateDB.SetBalanceWei(eth.NibiruAddrToEthAddr(acc), balanceWei) | ||
| bk.balanceChangesForStateDB += 1 | ||
| } | ||
|
|
||
| func findEtherBalanceChangeFromCoins(coins sdk.Coins) (found bool) { | ||
| for _, c := range coins { | ||
| if c.Denom == evm.EVMBankDenom { | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| func (bk NibiruBankKeeper) SendCoinsFromAccountToModule( | ||
| ctx sdk.Context, | ||
| senderAddr sdk.AccAddress, | ||
| recipientModule string, | ||
| coins sdk.Coins, | ||
| ) error { | ||
| // Use the embedded function from [bankkeeper.Keeper] | ||
| if err := bk.BaseKeeper.SendCoinsFromAccountToModule(ctx, senderAddr, recipientModule, coins); err != nil { | ||
| return err | ||
| } | ||
| if findEtherBalanceChangeFromCoins(coins) { | ||
| bk.SyncStateDBWithAccount(ctx, senderAddr) | ||
| moduleBech32Addr := auth.NewModuleAddress(recipientModule) | ||
| bk.SyncStateDBWithAccount(ctx, moduleBech32Addr) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (bk NibiruBankKeeper) SendCoinsFromModuleToAccount( | ||
| ctx sdk.Context, | ||
| senderModule string, | ||
| recipientAddr sdk.AccAddress, | ||
| coins sdk.Coins, | ||
| ) error { | ||
| // Use the embedded function from [bankkeeper.Keeper] | ||
| if err := bk.BaseKeeper.SendCoinsFromModuleToAccount(ctx, senderModule, recipientAddr, coins); err != nil { | ||
| return err | ||
| } | ||
| if findEtherBalanceChangeFromCoins(coins) { | ||
| moduleBech32Addr := auth.NewModuleAddress(senderModule) | ||
| bk.SyncStateDBWithAccount(ctx, moduleBech32Addr) | ||
| bk.SyncStateDBWithAccount(ctx, recipientAddr) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (bk NibiruBankKeeper) SendCoinsFromModuleToModule( | ||
| ctx sdk.Context, | ||
| senderModule string, | ||
| recipientModule string, | ||
| coins sdk.Coins, | ||
| ) error { | ||
| // Use the embedded function from [bankkeeper.Keeper] | ||
| if err := bk.BaseKeeper.SendCoinsFromModuleToModule(ctx, senderModule, recipientModule, coins); err != nil { | ||
| return err | ||
| } | ||
| if findEtherBalanceChangeFromCoins(coins) { | ||
| senderBech32Addr := auth.NewModuleAddress(senderModule) | ||
| recipientBech32Addr := auth.NewModuleAddress(recipientModule) | ||
| bk.SyncStateDBWithAccount(ctx, senderBech32Addr) | ||
| bk.SyncStateDBWithAccount(ctx, recipientBech32Addr) | ||
| } | ||
| return nil | ||
| } | ||
|
There was a problem hiding this comment. This was here because of the repeated calls during gas estimation, not for EVM reversions |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,3 +21,7 @@ | |
| } | ||
| } | ||
| } | ||
|
|
||
| func (k *Keeper) IsPrecompile(addr gethcommon.Address) bool { | ||
| return k.precompiles.Has(addr) | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line's required to appease the module manager when it does a type assertion on an object of type
bankkeeper.Keeper(an interface), asserting that it's actually abankkeeper.BaseKeeperstruct. I didn't see a simple way to force x/bank to use theNibiruBankKeeperstruct without editing the Bank module directly, so I opted for what's written here, which is quite simple.Edit: Moved the
NibiruBankKeeperto #2095. The rationale behind these lines are in that PR