feat: precompilegen
Solidity interface -> stateful precompile
#72
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.
Why this should be merged
Note that this is not a full replacement for
ava-labs/subnet-evm/cmd/precompilegen
. The original conflates the general concept of stateful precompiles with Ava-specific functionality (e.g. implementation configuration, module registration, etc.) while this is purely a mechanism for creating precompiles that conform to Solidity interfaces. In addition to the benefits I outline below, there is a case for separation of concerns.The primary benefit of this approach is that the implementation is separate from the wrapper that converts it into a
vm.PrecompiledContract
. Thesubnet-evm
generator leaves place for custom code to be inserted, making it impossible to update the boilerplate without overwriting customisation.How this works
Code generation is analogous to gRPC server stubs:
precompilegen
solc
ABI outputtype FooServer interface
type Contract interface
func RegisterFooServer(..., FooServer)
func New(Contract) vm.PrecompiledContract
becomes
which is used for the return values of
params.RulesHooks.PrecompileOverride
.Tip
See
libevm/precompilegen/testprecompile/generated.go
for output andlibevm/precompilegen/gen_test.go
for usage.To-do
contract.UseGas() bool
equivalent onvm.PrecompileEnvironment
(refactor:PrecompileEnvironment.{,Use,Refund}Gas()
in lieu of args #73).payable
andview
/pure
implications.How this was tested
Integration test exercising Solidity-based test via a
simulated.Backend
.