feat: precompile Solidity testing in pure Go #1234
Open
Conversation
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
montana77783
approved these changes
Jul 16, 2024
montana77783
approved these changes
Jul 16, 2024
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
scripts/abigen/abigen.go
Outdated
| return fmt.Errorf("abigen: %w", err) | ||
| } | ||
|
|
||
| re := regexp.MustCompile(`github.com/ethereum/go-ethereum/(accounts|core)/`) |
Check failure
Code scanning / CodeQL
Missing regular expression anchor High
scripts/abigen/abigen.go
Outdated
| return fmt.Errorf("abigen: %w", err) | ||
| } | ||
|
|
||
| re := regexp.MustCompile(`github.com/ethereum/go-ethereum/(accounts|core)/`) |
Check failure
Code scanning / CodeQL
Incomplete regular expression for hostnames High
…le `contract Empty` Repeated runs of `go generate ./contracts/...` could result in different outputs. I suspect that it's because of a Solidity bug (they call it a feature though) that appends a hash of the complete source file from which a contract was compiled. In this case it would have been from the different context in which the otherwise same `Example` contracts were defined; in the worst case a single-character change in a comment results in different addresses (i.e. a bug) `</rant>`.
…n` as assumed to be available
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Prerequisite for #1228. Also paves the way for pure-Solidity (similar to Forge) testing of contracts intended to be deployed with custom precompiles.
How this works
The new
evmsimpackage wraps geth'sSimulatedBackendto provide a real EVM with an interface allowing use with contract bindings generated withabigen. It provides some additional convenience functions that make using the simulator easier. Most importantly, enabling individual precompiles is trivial.The new
dstestparses transaction receipts to find events emitted by Solidity-based tests inheriting fromDSTest; the existing precompile tests use this, as do Forge tests. All failingDSTestassertions emit such events.The existing Solidity contracts for testing the allowlist precompile are run through
solc | abigento produce Go bindings that are used withevmsimto mirror the behaviour of the equivalent Hardhat test. Failures are detected (and reported) with thedstestpackage. Unlike the Hardhat tests, these are run in the same process and on thesubnet-evmVM implementation.Tip
Review the code in the order described above:
testing/evmsim, thentesting/dstest, thencontracts/*_test.go. Apologies for adding so much functionality in one PR! It started as (3) but that necessitated (2) and then (1).How this was tested
Unit testing of
dstestagainst anevmsimbackend running a Solidity contract that emitsDSTestevents. The allowlist tests were also deliberately broken (and then reverted) to confirm that the Go tests fail.How is this documented
Full godoc commentary.
TODO Before review
//go:generate solc | abigeninto scriptevmsim.New()