Skip to content

Commit 15e69ea

Browse files
committed
docs: add SuperchainDefinition type to superchain-config spec
1 parent c7e5d47 commit 15e69ea

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

specs/protocol/superchain-config.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
**Table of Contents**
66

77
- [Overview](#overview)
8+
- [Configuration Data Structure](#configuration-data-structure)
9+
- [SuperchainDefinition](#superchaindefinition)
810
- [Invariants](#invariants)
911
- [iSUPC-001: The Guardian and Pause Deputy must be able to trigger the Pause Mechanism](#isupc-001-the-guardian-and-pause-deputy-must-be-able-to-trigger-the-pause-mechanism)
1012
- [Impact](#impact)
@@ -29,6 +31,34 @@
2931
The SuperchainConfig contract is used to manage global configuration values for multiple OP Chains
3032
within a single Superchain network.
3133

34+
## Configuration Data Structure
35+
36+
The `SuperchainDefinition` type represents the configuration for a
37+
Superchain target, containing information about L1 contract addresses
38+
and network parameters.
39+
40+
### SuperchainDefinition
41+
42+
```javascript
43+
SuperchainDefinition {
44+
Name string // "mainnet", "sepolia"
45+
ProtocolVersionsAddr checksummedAddress // protocol_versions_addr
46+
SuperchainConfigAddr checksummedAddress // superchain_config_addr
47+
OPContractsManagerAddr checksummedAddress // op_contracts_manager_addr
48+
Hardforks Hardforks // hardforks
49+
L1 SuperchainL1 // L1 chain information
50+
}
51+
```
52+
53+
**Fields:**
54+
55+
- `Name`: The name of the superchain (e.g., "mainnet", "sepolia")
56+
- `ProtocolVersionsAddr`: Address of the ProtocolVersions contract on L1
57+
- `SuperchainConfigAddr`: Address of the SuperchainConfig contract on L1
58+
- `OPContractsManagerAddr`: Address of the OP Contracts Manager on L1
59+
- `Hardforks`: Hardfork activation configuration for the superchain
60+
- `L1`: L1 chain information including chain ID, RPC endpoint, and explorer URL
61+
3262
## Invariants
3363

3464
### iSUPC-001: The Guardian and Pause Deputy must be able to trigger the Pause Mechanism

words.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,7 @@ cellborder
124124
chainid
125125
Chainid
126126
checkpointed
127+
checksummedAddress
127128
clabby
128129
codehash
129130
configurables

0 commit comments

Comments
 (0)