-
Notifications
You must be signed in to change notification settings - Fork 473
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Automate Superchain Registry chain support #8105
Draft
emlautarom1
wants to merge
16
commits into
master
Choose a base branch
from
feat/superchain-registry
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
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
- Converter - Downloader - Lister
- Add compression - Add arg parsing
- We don't want to recurse
- Genesis and configs
emlautarom1
requested review from
flcl42,
deffrian,
stdevMac,
kamilchodola and
jmederosalvarado
January 24, 2025 17:41
@stdevMac Can you take care of checking this and making sure it works accordingly with Sedge? Also add to our CI BUT limit those side chains to trigger once per week. |
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.
Solves #8065
Changes
superchain.py
script to fetch, process and generate Nethermind compatible files for all OP Sperchain chains (see https://github.com/ethereum-optimism/superchain-registry)Types of changes
What types of changes does your code introduce?
Testing
Requires testing
If yes, did you write tests?
Notes on testing
Added tests to verify that we're properly decompressing generated
ChainSpec
files. Some tests were updated to use a newChainSpecFileLoader
that is format-aware of ChainSpec files, thus is able to decompress them if needed.Documentation
Requires documentation update
Requires explanation in Release Notes
Once this feature is properly working we need to document that Nethermind now supports all OP Superchain chains, not only a small subset (currently: OP, Base and Worldchain).
Remarks
The generated
ChainSpec
files are stored in a compressed format due to their excessive size when in.json
format. Just like in the Superchain Registry repository (https://github.com/ethereum-optimism/superchain-registry/blob/cb9a0ca8eda1608bf9958137a736fd2c18884fbd/superchain/README.md) we use zstandard as the compression algorithm. This is due to the OP team already figuring out that this is one of the best algorithms for this use case, and also to reduce the required amount of code (our scripts already deal with decompression so might as well compress the resulting artifacts using the same algorithm).Currently, 45 configs are generated: 28 in Mainnet and 17 in Sepolia.
We're still missing a GitHub action that automatically runs this script either periodically or when the Superchain Registry repository gets updated (the latter being preferable)