Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Superchain Registry docs #1125

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
3 changes: 3 additions & 0 deletions pages/superchain/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"superchain-registry": "The Superchain Registry"
}
36 changes: 36 additions & 0 deletions pages/superchain/superchain-registry.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: The Superchain Registry
lang: en-US
description: Learn about Optimism Superchain components, features, and roadmap.
---

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:

* 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)

## 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).

<Callout type="info">
We recommend using the [OP Contract Manager](/stack/opcm) to deploy L1 contracts that meet the Standard Config.
</Callout>

## 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. 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.
Loading