docs: add SuperchainDefinition type to superchain-config spec #867
Conversation
This file contains hidden or 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
Himess
force-pushed
the
add-superchain-config-type
branch
4 times, most recently
from
0693114 to
c7127f3
Compare
Author
|
Ready :D |
Himess
force-pushed
the
add-superchain-config-type
branch
from
c7127f3 to
023c15a
Compare
Himess
force-pushed
the
add-superchain-config-type
branch
from
023c15a to
15e69ea
Compare
Author
|
@emhane Done! |
emhane
requested changes
Dec 5, 2025
specs/protocol/superchain-config.md
Outdated
| ```javascript | ||
| SuperchainDefinition { | ||
| Name string | ||
| ProtocolVersionsAddr checksummedAddress |
Member
There was a problem hiding this comment.
does checksummed address mean 32 byte array ? not sure what the rest of the spec uses for that, could you please check?
specs/protocol/superchain-config.md
Outdated
|
|
||
| **Fields:** | ||
|
|
||
| - `ChainID`: The chain ID of the L1 network (e.g., 1 for Ethereum mainnet, 11155111 for Sepolia) |
Member
There was a problem hiding this comment.
Suggested change
| - `ChainID`: The chain ID of the L1 network (e.g., 1 for Ethereum mainnet, 11155111 for Sepolia) | |
| - `ChainID`: The chain ID of the L1 network (e.g. 1 for Ethereum mainnet, 11155111 for Sepolia) |
nitpick
- Change `checksummedAddress` to `address` for consistency with rest of spec - Remove comma in e.g. abbreviation per style nitpick
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Adds
SuperchainDefinitiontype documentation to superchain-config spec with field descriptions for L1 contract addresses and network parameters.Fixes #741
Tests
Additional context
Metadata