From 5b8dba05005cd554c081f717e9ef208f40aa7078 Mon Sep 17 00:00:00 2001 From: Bradley Camacho <42678939+bradleycamacho@users.noreply.github.com> Date: Mon, 18 Nov 2024 13:59:23 -0800 Subject: [PATCH 1/4] Basic nav work Adds a top-level category to left nav and new registry page under it --- pages/_meta.json | 13 +++++++++++++ pages/superchain/_meta.json | 3 +++ pages/superchain/superchain-registry.mdx | 9 +++++++++ 3 files changed, 25 insertions(+) create mode 100644 pages/superchain/_meta.json create mode 100644 pages/superchain/superchain-registry.mdx diff --git a/pages/_meta.json b/pages/_meta.json index fe5e5242..26f362e3 100644 --- a/pages/_meta.json +++ b/pages/_meta.json @@ -65,6 +65,19 @@ "display": "children" }, + "+++ THE SUPERCHAIN": { + "title": "", + "type": "separator" + }, + "--- THE SUPERCHAIN": { + "title": "THE SUPERCHAIN", + "type": "separator" + }, + "superchain": { + "title": "The Superchain", + "display": "children" + }, + "+++ OP STACK": { "title": "", "type": "separator" diff --git a/pages/superchain/_meta.json b/pages/superchain/_meta.json new file mode 100644 index 00000000..5108fb98 --- /dev/null +++ b/pages/superchain/_meta.json @@ -0,0 +1,3 @@ +{ + "superchain-registry": "The Superchain Registry" +} diff --git a/pages/superchain/superchain-registry.mdx b/pages/superchain/superchain-registry.mdx new file mode 100644 index 00000000..7749e6f7 --- /dev/null +++ b/pages/superchain/superchain-registry.mdx @@ -0,0 +1,9 @@ +--- +title: The Superchain Registry +lang: en-US +description: Learn about Optimism Superchain components, features, and roadmap. +--- + +import { Callout } from 'nextra/components' + +# The Superchain Registry From 1142844390df4f38f5a24b2be79b0663dbc32086 Mon Sep 17 00:00:00 2001 From: Bradley Camacho <42678939+bradleycamacho@users.noreply.github.com> Date: Mon, 18 Nov 2024 14:53:25 -0800 Subject: [PATCH 2/4] Add standard config and intro --- pages/superchain/superchain-registry.mdx | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/pages/superchain/superchain-registry.mdx b/pages/superchain/superchain-registry.mdx index 7749e6f7..ed34b833 100644 --- a/pages/superchain/superchain-registry.mdx +++ b/pages/superchain/superchain-registry.mdx @@ -7,3 +7,23 @@ description: Learn about Optimism Superchain components, features, and roadmap. import { Callout } from 'nextra/components' # The Superchain Registry + +The Superchain Registry is an index of chains which serves as the source of truth for who’s in the Superchain and what modifications they’ve made. The Superchain Registry introduces: + +- Clear definition of what constitutes a Standard Chain and config +- A step-by-step process new chains can follow to join the registry +- Validation checks to ensure chains follow the standard config before joining the Superchain Registry +- A Superchain Registry repository that shows who’s in the registry and what changes they have made to the standard config + +## The Standard Config + +The Standard Config is the set of requirements for an OP Stack chain to be considered a Standard Chain within the Superchain. These requirements are currently a draft, pending governance approval. + +All chains must meet this config to meet the inclusion requirements for The Superchain. This config isn't meant to exclude chains, but instead make it easier to understand *how* to configure your chain to make it compatatible with the Superchain. + +You can find the current draft version of The Standard Config in the [specs repo](https://specs.optimism.io/protocol/configurability.html#op-stack-configurability). + + + We recommend using the [OP Contract Manager](/stack/opcm) to deploy L1 contracts that meet the Standard Config. + + From 1cb4e99fb215b862b85318d3705eeb7ded115774 Mon Sep 17 00:00:00 2001 From: Bradley Camacho <42678939+bradleycamacho@users.noreply.github.com> Date: Mon, 18 Nov 2024 15:20:28 -0800 Subject: [PATCH 3/4] "Joining the registry" section --- pages/superchain/superchain-registry.mdx | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/pages/superchain/superchain-registry.mdx b/pages/superchain/superchain-registry.mdx index ed34b833..5b459962 100644 --- a/pages/superchain/superchain-registry.mdx +++ b/pages/superchain/superchain-registry.mdx @@ -8,13 +8,15 @@ import { Callout } from 'nextra/components' # The Superchain Registry -The Superchain Registry is an index of chains which serves as the source of truth for who’s in the Superchain and what modifications they’ve made. The Superchain Registry introduces: +The Superchain Registry is a human-readable index of chains which serves as the source of truth for who’s in the Superchain and what modifications they’ve made. The Superchain Registry introduces: - Clear definition of what constitutes a Standard Chain and config - A step-by-step process new chains can follow to join the registry - Validation checks to ensure chains follow the standard config before joining the Superchain Registry - A Superchain Registry repository that shows who’s in the registry and what changes they have made to the standard config +You can find the [Superchain Registry here](https://github.com/ethereum-optimism/superchain-registry) + ## The Standard Config The Standard Config is the set of requirements for an OP Stack chain to be considered a Standard Chain within the Superchain. These requirements are currently a draft, pending governance approval. @@ -27,3 +29,8 @@ You can find the current draft version of The Standard Config in the [specs repo We recommend using the [OP Contract Manager](/stack/opcm) to deploy L1 contracts that meet the Standard Config. +## Joining the registry + +The Superchain Registry is designed to outline and clarify the process for making your chain Superchain-compatible and joining the registry. + +If your chain meets the Standard Config requirements, [follow the steps in this guide](https://github.com/ethereum-optimism/superchain-registry/blob/main/docs/add-chain.md) to submit a pull request and join the Superchain. \ No newline at end of file From 0d0905c887982a00008578eb6837f60937fe2359 Mon Sep 17 00:00:00 2001 From: Bradley Camacho <42678939+bradleycamacho@users.noreply.github.com> Date: Mon, 18 Nov 2024 16:13:14 -0800 Subject: [PATCH 4/4] Various fixes and clarifications --- pages/superchain/superchain-registry.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/pages/superchain/superchain-registry.mdx b/pages/superchain/superchain-registry.mdx index 5b459962..41916745 100644 --- a/pages/superchain/superchain-registry.mdx +++ b/pages/superchain/superchain-registry.mdx @@ -8,12 +8,12 @@ import { Callout } from 'nextra/components' # The Superchain Registry -The Superchain Registry is a human-readable index of chains which serves as the source of truth for who’s in the Superchain and what modifications they’ve made. The Superchain Registry introduces: +The Superchain Registry is a human-readable index of chains which serves as the source of truth for who's in the Superchain and what modifications they've made. The Superchain Registry introduces: -- Clear definition of what constitutes a Standard Chain and config -- A step-by-step process new chains can follow to join the registry -- Validation checks to ensure chains follow the standard config before joining the Superchain Registry -- A Superchain Registry repository that shows who’s in the registry and what changes they have made to the standard config +* A clear definition of what constitutes a Standard Chain and config +* A step-by-step process new chains can follow to join the registry +* Validation checks to ensure chains follow the standard config before joining the Superchain Registry +* A Superchain Registry repository that shows who's in the registry and what changes they have made to the standard config You can find the [Superchain Registry here](https://github.com/ethereum-optimism/superchain-registry) @@ -33,4 +33,4 @@ You can find the current draft version of The Standard Config in the [specs repo The Superchain Registry is designed to outline and clarify the process for making your chain Superchain-compatible and joining the registry. -If your chain meets the Standard Config requirements, [follow the steps in this guide](https://github.com/ethereum-optimism/superchain-registry/blob/main/docs/add-chain.md) to submit a pull request and join the Superchain. \ No newline at end of file +If your chain meets the Standard Config requirements, [follow the steps in this guide](https://github.com/ethereum-optimism/superchain-registry/blob/main/docs/add-chain.md) to submit a pull request and join the Superchain. This guide will help you set up your chain, create your environment, and run all the validation checks needed to ensure your chain is ready to join the registry.