Skip to content

Commit 2293a72

Browse files
authored
Use blockspace charter terminology (#376)
* add readme for standard rollup blockspace charter definition files * fix incorrect comment * use blockspace charter terminology in the top level readme * improve sentence
1 parent 2b78905 commit 2293a72

File tree

3 files changed

+13
-3
lines changed

3 files changed

+13
-3
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,12 @@ just validate 11155420
9090
```
9191

9292
> [!NOTE]
93-
> If you set `SCR_STANDARD_CHAIN_CANDIDATE`, your chain will be checked against the majority of the standard configuration requirements. These are defined in the [specs](https://specs.optimism.io/protocol/configurability.html). However, these requirements are currently a draft, pending governance approval.
93+
> If you set `SCR_STANDARD_CHAIN_CANDIDATE`, your chain will be checked against the majority of the standard rollup requirements as outlined by the [Standard Rollup Blockspace Charter](https://gov.optimism.io/t/season-6-draft-standard-rollup-charter/8135) (currently a draft pending Governance approval).
9494
>
9595
> The final requirement to qualify as a standard chain concerns the `ProxyAdminOwner` role. The validation check for this role will not be run until the chain is [promoted](#promote-a-chain-to-standard) to standard.
9696
97+
The [`validation_test.go`](./validation/validation_test.go) test declaration file defines which checks run on each class of chain. The parameters referenced in each check are recorded in [TOML files in the `standard` directory](./validation/standard).
98+
9799
### 6. Run codegen and check output
98100
This is a tool which will rewrite certain summary files of all the chains in the registry, including the one you are adding. The output will be checked in a continuous integration checks (it is required to pass):
99101

validation/standard/readme.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Standard Rollup Blockspace Charter definition files
2+
This directory contains a number of TOML files which declare various parameters, addresses, contract versions and other data which define a **standard chain** in the sense of the [Standard Rollup Charter](https://gov.optimism.io/t/season-6-draft-standard-rollup-charter/8135).
3+
4+
Distinct, named declaration files have been added (where necessary) to allow testnets and devnets to have greater flexibility in their configurations.
5+
6+
Parameters may be declared to be equal to a pair of values, meaning that the parameter must be within the bounds defined by those values.
7+
8+
The TOML files are embedded into Go bindings, which are in turn references by the validation checks in the parent directory. The entrypoint for those checks is [`validation_test.go`](../validation_test.go).
9+

validation/validation_test.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,7 @@ func testUniversal(t *testing.T, chain *ChainConfig) {
5858
})
5959
}
6060

61-
// testStandardCandidate should be applied only to a fully Standard Chain,
62-
// i.e. not to a Standard Candidate Chain.
61+
// testStandardCandidate applies to Standard and Standard Candidate Chains.
6362
func testStandardCandidate(t *testing.T, chain *ChainConfig) {
6463
t.Run("Standard Config Params", func(t *testing.T) {
6564
t.Run("Data Availability", func(t *testing.T) { testDataAvailability(t, chain) })

0 commit comments

Comments
 (0)