Skip to content

Fixed interop next steps pages and updated SuperchainERC20 callout #1426

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

Merged
merged 7 commits into from
Feb 28, 2025
Merged
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
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "Optimism Docs",
"type": "module",
"scripts": {
"lint": "eslint . --ext mdx --max-warnings 0 && pnpm spellcheck:lint && pnpm check-breadcrumbs && pnpm check-redirects && pnpm validate-metadata",
"lint": "eslint . --ext mdx --max-warnings 0 && pnpm spellcheck:lint && pnpm check-breadcrumbs && pnpm check-redirects && pnpm validate-metadata && pnpm link-checker",
"fix": "eslint . --ext mdx --fix && pnpm spellcheck:fix && pnpm breadcrumbs && pnpm fix-redirects && pnpm metadata-batch-cli",
"spellcheck:lint": "cspell lint \"**/*.mdx\"",
"spellcheck:fix": "cspell --words-only --unique \"**/*.mdx\" | sort --ignore-case | uniq > words.txt",
Expand Down
5 changes: 1 addition & 4 deletions pages/app-developers/tools/supersim.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,4 @@ This diagram illustrates how developers interact with Supersim through the CLI,

* Build a [revolutionary app](/app-developers/get-started) that uses multiple blockchains within the Superchain
* Deploy a [SuperchainERC20](/stack/interop/tutorials/deploy-superchain-erc20) to the Superchain
* View more [interop tutorials](/stack/interop/tutorials)
* Check out the collection of [Supersim docs](/app-developers/tutorials/supersim) for tutorials and specific use cases.
* Questions about Interop? Check out our collection of [interop guides](/stack/interop) or check out this [Superchain interop design video walk-thru](https://www.youtube.com/watch?v=FKc5RgjtGes).
* For more info about how Superchain interoperability works under the hood, [check out the specs](https://specs.optimism.io/interop/overview.html).
* View more [supersim tutorials](/app-developers/tutorials/supersim)
2 changes: 1 addition & 1 deletion pages/app-developers/tutorials.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ If you're a bit more familiar with the OP Stack and Ethereum, you can try walkin

## Interop
<Cards>
<Card title="Issuing new assets with SuperchainERC20" href="/app-developers/tutorials/interop/deploy-superchain-erc20" icon={<img src="/img/icons/shapes.svg" />} />
<Card title="Deploying a SuperchainERC20" href="/app-developers/tutorials/interop/deploy-superchain-erc20" icon={<img src="/img/icons/shapes.svg" />} />
<Card title="Transferring a SuperchainERC20" href="/app-developers/tutorials/interop/transfer-superchainERC20" icon={<img src="/img/icons/shapes.svg" />} />
<Card title="Bridging native cross-chain ETH transfers" href="/app-developers/tutorials/interop/bridge-crosschain-eth" icon={<img src="/img/icons/shapes.svg" />} />
<Card title="Relaying interop messages using `cast`" href="/app-developers/tutorials/interop/relay-messages-cast" icon={<img src="/img/icons/shapes.svg" />} />
Expand Down
2 changes: 1 addition & 1 deletion pages/app-developers/tutorials/interop.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { Card, Cards } from 'nextra/components'
This is a collection of app developer tutorials focused on interop.

<Cards>
<Card title="Issuing new assets with SuperchainERC20" href="/app-developers/tutorials/interop/deploy-superchain-erc20" icon={<img src="/img/icons/shapes.svg" />} />
<Card title="Deploying a SuperchainERC20" href="/app-developers/tutorials/interop/deploy-superchain-erc20" icon={<img src="/img/icons/shapes.svg" />} />
<Card title="Transferring a SuperchainERC20" href="/app-developers/tutorials/interop/transfer-superchainERC20" icon={<img src="/img/icons/shapes.svg" />} />
<Card title="Bridging native cross-chain ETH transfers" href="/app-developers/tutorials/interop/bridge-crosschain-eth" icon={<img src="/img/icons/shapes.svg" />} />
<Card title="Relaying interop messages using `cast`" href="/app-developers/tutorials/interop/relay-messages-cast" icon={<img src="/img/icons/shapes.svg" />} />
Expand Down
2 changes: 1 addition & 1 deletion pages/app-developers/tutorials/interop/_meta.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"transfer-superchainERC20": "Transferring a SuperchainERC20",
"deploy-superchain-erc20": "Issuing new assets with SuperchainERC20",
"deploy-superchain-erc20": "Deploying a SuperchainERC20",
"bridge-crosschain-eth": "Bridging native cross-chain ETH transfers",
"relay-messages-cast": "Relaying interop messages using `cast`",
"relay-messages-viem": "Relaying interop messages using `viem`",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Issuing new assets with SuperchainERC20
title: Deploying a SuperchainERC20
lang: en-US
description: >-
Learn how to issue assets on SuperchainERC20.
Expand Down
2 changes: 1 addition & 1 deletion pages/stack/interop.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Documentation covering explainers and tutorials for using Superchain interop.

<Card title="Superchain interop message passing" href="/stack/interop/message-passing" icon={<img src="/img/icons/shapes.svg" />} />

<Card title="Superchain interop compatible tokens" href="/stack/interop/token-compatible" icon={<img src="/img/icons/shapes.svg" />} />
<Card title="Superchain interop compatible tokens" href="/stack/interop/compatible-tokens" icon={<img src="/img/icons/shapes.svg" />} />

<Card title="OP Supervisor" href="/stack/interop/op-supervisor" icon={<img src="/img/icons/shapes.svg" />} />

Expand Down
2 changes: 1 addition & 1 deletion pages/stack/interop/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"op-supervisor": "OP Supervisor",
"superchain-weth": "Superchain ETH",
"superchain-erc20": "SuperchainERC20",
"token-compatible": "Superchain interop compatible tokens",
"compatible-tokens": "Superchain interop compatible tokens",
"reorg": "Superchain interop reorg awareness",
"interop-security": "Superchain interop transaction safety",
"tools": "Tools",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ content_type: guide
import { Callout } from 'nextra/components'
import { InteropCallout } from '@/components/WipCallout'

<InteropCallout />
<Callout>
The SuperchainERC20 standard is ready for production use with active Mainnet deployments.
Please note that the OP Stack interoperability upgrade, required for crosschain messaging, is currently still in active development.
</Callout>

# Superchain interop compatible tokens

Expand Down
4 changes: 1 addition & 3 deletions pages/stack/interop/explainer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This goal requires low-latency, seamless message passing and asset bridging.
*Superchain interoperability* is a set of protocols and services that lets OP Stack blockchains read each other's state.
Superchain interoperability provides the following benefits:

* ETH and ERC-20 tokens to move securely between chains via native minting and burning. Asset interoperability solves the issues of liquidity fragmentation and poor user experiences caused by asset wrapping or liquidity pools.
* ETH and ERC-20 tokens to move securely between chains via native minting and burning. Asset interoperability solves the issues of liquidity fragmentation and poor user experiences caused by asset wrapping or liquidity pools.
* Apps to compose with data that exist on other chains.
* Horizontal scalability for applications that need it.

Expand Down Expand Up @@ -229,5 +229,3 @@ This means ETH and ERC-20s can seamlessly and securely move across L2s, and inte
* Deploy a [SuperchainERC20](/stack/interop/tutorials/deploy-superchain-erc20) to the Superchain
* Learn [how messages get from one chain to another chain](/stack/interop/message-passing)
* Watch [this video](https://www.youtube.com/watch?v=FKc5RgjtGes), which gives an overview of Superchain interoperability.
* Learn more about the [superchain predeploys](/stack/interop/predeploy) added to the OP Stack to enable interoperability.
* Use [Supersim](/stack/interop/tools/supersim), a multichain dev environment that simulates interop for testing applications against a local version of the Superchain.
8 changes: 2 additions & 6 deletions pages/stack/interop/message-passing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,5 @@ sequenceDiagram
## Next steps

* Build a [revolutionary app](/app-developers/get-started) that uses multiple blockchains within the Superchain
* Actually [pass messages between blockchains](/stack/interop/tutorials/message-passing).
* Deploy a [SuperchainERC20](/stack/interop/tutorials/deploy-superchain-erc20) to the Superchain
* Practice how to use [Superchain interop message passing](/stack/interop/message-passing)
* Read how [messages get from one blockchain to another (`CrossL2Inbox`)](explainer#how-messages-get-from-one-chain-to-the-other).
* Try [Supersim](tools/supersim) for testing cross-chain messages locally.
* Learn about [manually relaying messages](/stack/interop/tutorials/relay-messages-viem)
* Learn how to [pass messages between blockchains](/stack/interop/tutorials/message-passing).
* Deploy a [SuperchainERC20](/stack/interop/tutorials/deploy-superchain-erc20) to the Superchain.
4 changes: 1 addition & 3 deletions pages/stack/interop/op-supervisor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,5 @@ For a full listing of API names, see the [source code](https://github.com/ethere

* Build a [revolutionary app](/app-developers/get-started) that uses multiple blockchains within the Superchain
* Deploy a [SuperchainERC20](/stack/interop/tutorials/deploy-superchain-erc20) to the Superchain
* Practice how to use [Superchain interop message passing](/stack/interop/message-passing)
* Learn about [manually relaying messages](/stack/interop/tutorials/relay-messages-viem)
* Learn [how ETH can move across chains](https://docs.optimism.io/stack/interop/superchain-weth)
* Want to learn more? Read our guide on the anatomy of a [cross-chain message](./explainer#how-messages-get-from-one-chain-to-the-other) or check out this [interop design video walk-thru](https://www.youtube.com/watch?v=FKc5RgjtGes)
* For more info about how Superchain interoperability works under the hood, [check out the specs](https://specs.optimism.io/interop/overview.html).
8 changes: 3 additions & 5 deletions pages/stack/interop/superchain-weth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,6 @@ Here is an example of how this works.

## Next steps

* Build a [revolutionary app](/app-developers/get-started) that uses multiple blockchains within the Superchain
* Explore [the `SuperchainWETH` specs](https://specs.optimism.io/interop/superchain-weth.html) for in-depth implementation details.
* Read the [interop message passing](/stack/interop/message-passing) page for more information about how `L2ToL2CrossDomainMessenger` passes messages.
* Learn about [SuperchainERC20](/stack/interop/superchain-erc20)
* Practice [transferring ETH across chains using Superchain interop](/stack/interop/tutorials/bridge-crosschain-eth)
* Build a [revolutionary app](/app-developers/get-started) that uses multiple blockchains within the Superchain.
* Learn about [SuperchainERC20](/stack/interop/superchain-erc20).
* Practice [transferring ETH across chains using Superchain interop](/stack/interop/tutorials/bridge-crosschain-eth).
2 changes: 0 additions & 2 deletions pages/stack/interop/tools/devnet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,6 @@ To simplify user experience, the Superchain interop devnet has a relayer running

## Next steps

* Review the [Superchain Interop Explainer](/stack/interop/explainer) for answers to common questions about interoperability.
* Read the [Message Passing Explainer](/stack/interop/message-passing) to understand what happens "under the hood".
* Build a [revolutionary app](/app-developers/get-started) that uses multiple blockchains within the Superchain
* Deploy a [SuperchainERC20](/stack/interop/tutorials/deploy-superchain-erc20) to the Superchain
* View more [interop tutorials](/stack/interop/tutorials)
2 changes: 1 addition & 1 deletion pages/stack/interop/tutorials.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Documentation covering Interop related tutorials.
<Cards>
<Card title="Interop message passing tutorial" href="/stack/interop/tutorials/message-passing" icon={<img src="/img/icons/shapes.svg" />} />

<Card title="Issuing new assets with SuperchainERC20" href="/stack/interop/tutorials/deploy-superchain-erc20" icon={<img src="/img/icons/shapes.svg" />} />
<Card title="Deploying a SuperchainERC20" href="/stack/interop/tutorials/deploy-superchain-erc20" icon={<img src="/img/icons/shapes.svg" />} />

<Card title="Transferring a SuperchainERC20" href="/stack/interop/tutorials/transfer-superchainERC20" icon={<img src="/img/icons/shapes.svg" />} />

Expand Down
3 changes: 1 addition & 2 deletions pages/stack/interop/tutorials/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
{
"message-passing": "Interop message passing",
"deploy-superchain-erc20": "Issuing new assets with SuperchainERC20",
"deploy-superchain-erc20": "Deploying a SuperchainERC20",
"transfer-superchainERC20": "Transferring a SuperchainERC20",
"deploy-superchain-erc20": "Issuing new assets with SuperchainERC20",
"custom-superchain-erc20": "Custom SuperchainERC20 tokens",
"bridge-crosschain-eth": "Bridging native cross-chain ETH transfers",
"relay-messages-cast": "Relaying interop messages using `cast`",
Expand Down
4 changes: 2 additions & 2 deletions pages/stack/interop/tutorials/deploy-superchain-erc20.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Issuing new assets with SuperchainERC20
title: Deploying a SuperchainERC20
lang: en-US
description: Learn about the basic details of deploying assets on SuperchainERC20
---
Expand All @@ -12,7 +12,7 @@ import { Steps } from 'nextra/components'
However, the OP Stack interoperability upgrade, required for crosschain messaging, is currently still in active development.
</Callout>

# Issuing new assets with SuperchainERC20
# Deploying a SuperchainERC20

## Overview

Expand Down