refactor: general code style cleanups on precompile and statedb journal #2100
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,7 +24,7 @@ func (p precompileOracle) Address() gethcommon.Address { | |
| } | ||
|
|
||
| func (p precompileOracle) RequiredGas(input []byte) (gasPrice uint64) { | ||
| return requiredGas(input, embeds.SmartContract_Oracle.ABI) | ||
| } | ||
|
|
||
| const ( | ||
|
|
@@ -38,21 +38,19 @@ func (p precompileOracle) Run( | |
| defer func() { | ||
| err = ErrPrecompileRun(err, p) | ||
| }() | ||
| startResult, err := OnRunStart(evm, contract.Input, embeds.SmartContract_Oracle.ABI) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| method, args, ctx := startResult.Method, startResult.Args, startResult.CacheCtx | ||
|
|
||
| switch PrecompileMethod(method.Name) { | ||
| case OracleMethod_queryExchangeRate: | ||
| return p.queryExchangeRate(ctx, method, args) | ||
| default: | ||
| err = fmt.Errorf("invalid method called with name \"%s\"", method.Name) | ||
| return | ||
| } | ||
| } | ||
|
|
||
| func PrecompileOracle(keepers keepers.PublicKeepers) vm.PrecompiledContract { | ||
|
|
@@ -69,9 +67,8 @@ func (p precompileOracle) queryExchangeRate( | |
| ctx sdk.Context, | ||
| method *gethabi.Method, | ||
| args []interface{}, | ||
| ) (bz []byte, err error) { | ||
| pair, err := p.parseQueryExchangeRateArgs(args) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
@@ -88,7 +85,7 @@ func (p precompileOracle) queryExchangeRate( | |
| return method.Outputs.Pack(price.String()) | ||
| } | ||
|
|
||
| func (p precompileOracle) parseQueryExchangeRateArgs(args []interface{}) ( | ||
| pair string, | ||
| err error, | ||
| ) { | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -85,15 +85,15 @@ | |
| return nil, fmt.Errorf("no method with id: %#x", sigdata[:4]) | ||
| } | ||
|
|
||
| func decomposeInput( | ||
| abi *gethabi.ABI, input []byte, | ||
| ) (method *gethabi.Method, args []interface{}, err error) { | ||
| // ABI method IDs are exactly 4 bytes according to "gethabi.ABI.MethodByID". | ||
| if len(input) < 4 { | ||
| err = fmt.Errorf("input \"%s\" too short to extract method ID (less than 4 bytes)", collections.HumanizeBytes(input)) | ||
| return | ||
| } | ||
|
|
||
| method, err = methodById(abi, input[:4]) | ||
| if err != nil { | ||
| err = fmt.Errorf("unable to parse ABI method by its 4-byte ID: %w", err) | ||
|
|
@@ -109,8 +109,8 @@ | |
| return method, args, nil | ||
| } | ||
|
|
||
| func requiredGas(input []byte, abi *gethabi.ABI) uint64 { | ||
| method, err := methodById(abi, input[:4]) | ||
| if err != nil { | ||
| // It's appropriate to return a reasonable default here | ||
| // because the error from DecomposeInput will be handled automatically by | ||
|
|
@@ -122,26 +122,27 @@ | |
|
|
||
| // Map access could panic. We know that it won't panic because all methods | ||
| // are in the map, which is verified by unit tests. | ||
| var costPerByte, costFlat uint64 | ||
| if isMutation[PrecompileMethod(method.Name)] { | ||
| costPerByte, costFlat = gasCfg.WriteCostPerByte, gasCfg.WriteCostFlat | ||
| } else { | ||
| costPerByte, costFlat = gasCfg.ReadCostPerByte, gasCfg.ReadCostFlat | ||
| } | ||
|
|
||
| // Calculate the total gas required based on the input size and flat cost | ||
| return (costPerByte * uint64(len(input[4:]))) + costFlat | ||
| } | ||
|
|
||
| type PrecompileMethod string | ||
|
|
||
| type OnRunStartResult struct { | ||
| // Args contains the decoded (ABI unpacked) arguments passed to the contract | ||
| // as input. | ||
| Args []interface{} | ||
|
|
||
| // CacheCtx is a cached SDK context that allows isolated state | ||
| // operations to occur that can be reverted by the EVM's [statedb.StateDB]. | ||
| CacheCtx sdk.Context | ||
|
|
||
| // Method is the ABI method for the precompiled contract call. | ||
| Method *gethabi.Method | ||
|
|
@@ -178,9 +179,9 @@ | |
| // } | ||
| // ``` | ||
| func OnRunStart( | ||
| evm *vm.EVM, contractInput []byte, abi *gethabi.ABI, | ||
| ) (res OnRunStartResult, err error) { | ||
| method, args, err := decomposeInput(abi, contractInput) | ||
| if err != nil { | ||
| return res, err | ||
| } | ||
|
|
@@ -194,23 +195,23 @@ | |
| // journalEntry captures the state before precompile execution to enable | ||
| // proper state reversal if the call fails or if [statedb.JournalChange] | ||
| // is reverted in general. | ||
| cacheCtx, journalEntry := stateDB.CacheCtxForPrecompile() | ||
| if err = stateDB.SavePrecompileCalledJournalChange(journalEntry); err != nil { | ||
| return res, err | ||
| } | ||
| if err = stateDB.CommitCacheCtx(); err != nil { | ||
| return res, fmt.Errorf("error committing dirty journal entries: %w", err) | ||
| } | ||
|
|
||
| return OnRunStartResult{ | ||
| Args: args, | ||
| CacheCtx: cacheCtx, | ||
| Method: method, | ||
| StateDB: stateDB, | ||
| }, nil | ||
| } | ||
|
|
||
| var isMutation map[PrecompileMethod]bool = map[PrecompileMethod]bool{ | ||
| WasmMethod_execute: true, | ||
| WasmMethod_instantiate: true, | ||
| WasmMethod_executeMulti: true, | ||
|
|
||
Oops, something went wrong.
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.
You can add the method name as an argument to keep the error messages consistent across each tx method using the same function
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.
I originally got rid of
assertNotReadonlyTxbecause whenever it was invoked, theisTxargument was alwaystrue, which made that parameter redundant becauseassertNotReadonlyTxin a mutating precompile. I've replaced it and added thegethabi.Methodas a parameter to extract the method name into the error string.