diff --git a/package.json b/package.json index e2012b05e..bee69656d 100644 --- a/package.json +++ b/package.json @@ -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", diff --git a/pages/app-developers/tools/supersim.mdx b/pages/app-developers/tools/supersim.mdx index 110f77004..ccedfcd86 100644 --- a/pages/app-developers/tools/supersim.mdx +++ b/pages/app-developers/tools/supersim.mdx @@ -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) diff --git a/pages/app-developers/tutorials.mdx b/pages/app-developers/tutorials.mdx index 68c54bae8..74928dc36 100644 --- a/pages/app-developers/tutorials.mdx +++ b/pages/app-developers/tutorials.mdx @@ -43,7 +43,7 @@ If you're a bit more familiar with the OP Stack and Ethereum, you can try walkin ## Interop - } /> + } /> } /> } /> } /> diff --git a/pages/app-developers/tutorials/interop.mdx b/pages/app-developers/tutorials/interop.mdx index f8a154017..d9a89fb30 100644 --- a/pages/app-developers/tutorials/interop.mdx +++ b/pages/app-developers/tutorials/interop.mdx @@ -11,7 +11,7 @@ import { Card, Cards } from 'nextra/components' This is a collection of app developer tutorials focused on interop. - } /> + } /> } /> } /> } /> diff --git a/pages/app-developers/tutorials/interop/_meta.json b/pages/app-developers/tutorials/interop/_meta.json index d1e285e62..f0ba512a4 100644 --- a/pages/app-developers/tutorials/interop/_meta.json +++ b/pages/app-developers/tutorials/interop/_meta.json @@ -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`", diff --git a/pages/app-developers/tutorials/interop/deploy-superchain-erc20.mdx b/pages/app-developers/tutorials/interop/deploy-superchain-erc20.mdx index 7916f5b28..7fa7c6b0e 100644 --- a/pages/app-developers/tutorials/interop/deploy-superchain-erc20.mdx +++ b/pages/app-developers/tutorials/interop/deploy-superchain-erc20.mdx @@ -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. diff --git a/pages/stack/interop.mdx b/pages/stack/interop.mdx index 113b254de..58220489f 100644 --- a/pages/stack/interop.mdx +++ b/pages/stack/interop.mdx @@ -17,7 +17,7 @@ Documentation covering explainers and tutorials for using Superchain interop. } /> - } /> + } /> } /> diff --git a/pages/stack/interop/_meta.json b/pages/stack/interop/_meta.json index 734346b9a..2f9e36cbb 100644 --- a/pages/stack/interop/_meta.json +++ b/pages/stack/interop/_meta.json @@ -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", diff --git a/pages/stack/interop/token-compatible.mdx b/pages/stack/interop/compatible-tokens.mdx similarity index 97% rename from pages/stack/interop/token-compatible.mdx rename to pages/stack/interop/compatible-tokens.mdx index ee7b3422b..9ded2d6fd 100644 --- a/pages/stack/interop/token-compatible.mdx +++ b/pages/stack/interop/compatible-tokens.mdx @@ -11,7 +11,10 @@ content_type: guide import { Callout } from 'nextra/components' import { InteropCallout } from '@/components/WipCallout' - + +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. + # Superchain interop compatible tokens diff --git a/pages/stack/interop/explainer.mdx b/pages/stack/interop/explainer.mdx index 96254e26f..386e7e983 100644 --- a/pages/stack/interop/explainer.mdx +++ b/pages/stack/interop/explainer.mdx @@ -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. @@ -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. diff --git a/pages/stack/interop/message-passing.mdx b/pages/stack/interop/message-passing.mdx index f6eab30bb..2332c69f5 100644 --- a/pages/stack/interop/message-passing.mdx +++ b/pages/stack/interop/message-passing.mdx @@ -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. diff --git a/pages/stack/interop/op-supervisor.mdx b/pages/stack/interop/op-supervisor.mdx index 19f23f198..3e0925192 100644 --- a/pages/stack/interop/op-supervisor.mdx +++ b/pages/stack/interop/op-supervisor.mdx @@ -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). diff --git a/pages/stack/interop/superchain-weth.mdx b/pages/stack/interop/superchain-weth.mdx index 1cc63b99c..d569db857 100644 --- a/pages/stack/interop/superchain-weth.mdx +++ b/pages/stack/interop/superchain-weth.mdx @@ -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). diff --git a/pages/stack/interop/tools/devnet.mdx b/pages/stack/interop/tools/devnet.mdx index 006bcbd9e..736b1770c 100644 --- a/pages/stack/interop/tools/devnet.mdx +++ b/pages/stack/interop/tools/devnet.mdx @@ -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) diff --git a/pages/stack/interop/tutorials.mdx b/pages/stack/interop/tutorials.mdx index 4e0305e1b..ebf3c52bf 100644 --- a/pages/stack/interop/tutorials.mdx +++ b/pages/stack/interop/tutorials.mdx @@ -13,7 +13,7 @@ Documentation covering Interop related tutorials. } /> - } /> + } /> } /> diff --git a/pages/stack/interop/tutorials/_meta.json b/pages/stack/interop/tutorials/_meta.json index e5ef429e1..67816f137 100644 --- a/pages/stack/interop/tutorials/_meta.json +++ b/pages/stack/interop/tutorials/_meta.json @@ -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`", diff --git a/pages/stack/interop/tutorials/deploy-superchain-erc20.mdx b/pages/stack/interop/tutorials/deploy-superchain-erc20.mdx index 26b3eb3c4..44865d216 100644 --- a/pages/stack/interop/tutorials/deploy-superchain-erc20.mdx +++ b/pages/stack/interop/tutorials/deploy-superchain-erc20.mdx @@ -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 --- @@ -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. -# Issuing new assets with SuperchainERC20 +# Deploying a SuperchainERC20 ## Overview