|
5 | 5 | **Table of Contents** |
6 | 6 |
|
7 | 7 | - [Overview](#overview) |
| 8 | +- [Configuration Data Structure](#configuration-data-structure) |
| 9 | + - [SuperchainDefinition](#superchaindefinition) |
8 | 10 | - [Invariants](#invariants) |
9 | 11 | - [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) |
10 | 12 | - [Impact](#impact) |
|
29 | 31 | The SuperchainConfig contract is used to manage global configuration values for multiple OP Chains |
30 | 32 | within a single Superchain network. |
31 | 33 |
|
| 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 | + |
32 | 62 | ## Invariants |
33 | 63 |
|
34 | 64 | ### iSUPC-001: The Guardian and Pause Deputy must be able to trigger the Pause Mechanism |
|
0 commit comments