Skip to content

Moved interop tutorials to their own directory #1253

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.

Sign up for GitHub

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 6 commits into from
Jan 17, 2025
Merged

Moved interop tutorials to their own directory #1253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c75690d
Moved tutorials to their own directory
qbzzt Jan 16, 2025
2ad3f7f
Fix JSONs
qbzzt Jan 16, 2025
8791d39
Moved best practices to where it belongs
qbzzt Jan 16, 2025
1b7cb11
Removed `assets.mdx`
qbzzt Jan 17, 2025
f0cea1a
Removed best practices
qbzzt Jan 17, 2025
6209934
Update pages/stack/interop/superchain-erc20.mdx
krofax Jan 17, 2025
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
6 changes: 4 additions & 2 deletions pages/stack/interop/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
"predeploy": "Interop predeploys",
"message-passing": "Interop message passing",
"op-supervisor": "OP Supervisor",
"assets": "Assets",
"superchain-weth": "SuperchainWETH (Interoperable ETH)",
"superchain-erc20": "SuperchainERC20",
"security": "Cross-chain security",
"tools": "Tools"
"tools": "Tools",
"tutorials": "Tutorials"
}
23 changes: 0 additions & 23 deletions pages/stack/interop/assets.mdx
View file
Open in desktop

This file was deleted.

7 changes: 0 additions & 7 deletions pages/stack/interop/assets/_meta.json
View file
Open in desktop

This file was deleted.

31 changes: 0 additions & 31 deletions pages/stack/interop/assets/superchainerc20-best-practices.mdx
View file
Open in desktop

This file was deleted.

6 changes: 6 additions & 0 deletions ...stack/interop/assets/superchain-erc20.mdx → pages/stack/interop/superchain-erc20.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,12 @@ This diagram illustrates the process where tokens are burned on the source chain
Projects moving from other token implementations may need to adapt to the `SuperchainERC20` specification.
</Callout>

## Consistent addresses across chains

It is best to use predefined addresses: Assign and verify the same address for each `SuperchainERC20` instance on every chain. Predefined addresses reduce deployment conflicts and ensure tokens are accurately recognized across chains. Otherwise, the `SuperchainERC20Bridge` would need a way to verify if the tokens they mint on destination, correspond to the tokens that were burned on source.

Consider using `Create2Deployer` or one of our [predeploys](https://specs.optimism.io/interop/predeploys.html) to ensure this.

## Implementation details

Application developers must do two things to make their tokens `SuperchainERC20` compatible. Doing this setup now ensures that tokens can benefit from Interop once the Interop upgrade happens.
Expand Down
0 .../stack/interop/assets/superchain-weth.mdx → pages/stack/interop/superchain-weth.mdx
View file
Open in desktop
File renamed without changes.
4 changes: 4 additions & 0 deletions pages/stack/interop/tutorials/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"transfer-superchainERC20": "How to transfer a SuperchainERC20",
"deploy-superchain-erc20": "Deploy assets using SuperchainERC20"
}
0 ...nterop/assets/deploy-superchain-erc20.mdx → ...rop/tutorials/deploy-superchain-erc20.mdx
View file
Open in desktop
File renamed without changes.
0 ...terop/assets/transfer-superchainERC20.mdx → ...op/tutorials/transfer-superchainERC20.mdx
View file
Open in desktop
File renamed without changes.
10 changes: 6 additions & 4 deletions public/_redirects
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,12 @@
/builders/cex-wallet-developers/cex-support /builders/app-developers/overview
/builders/cex-wallet-developers/wallet-support /builders/app-developers/overview
/builders/cex-wallet-developers /builders/app-developers/overview
/stack/interop/superchain-erc20 /stack/interop/assets/superchain-erc20
/stack/interop/superchain-weth /stack/interop/assets/superchain-weth
/stack/interop/transfer-superchainERC20 /stack/interop/assets/transfer-superchainERC20
/builders/app-developers/contracts/superchain-erc20 /stack/interop/assets/superchain-erc20
/stack/interop/assets/superchain-erc20 /stack/interop/superchain-erc20
/stack/interop/assets/superchain-weth /stack/interop/superchain-weth
/stack/interop/transfer-superchainERC20 /stack/interop/tutorials/transfer-superchainERC20
/stack/interop/assets/transfer-superchainERC20 /stack/interop/tutorials/transfer-superchainERC20
/stack/interop/assets/deploy-superchain-erc20 /stack/interop/tutorials/deploy-superchain-erc20
/builders/app-developers/contracts/superchain-erc20 /stack/interop/superchain-erc20
/builders/chain-operators/tutorials/sdk /builders/app-developers/overview
/stack/explainer /superchain/superchain-explainer
/stack/interop/architecture /stack/interop/explainer#interoperability-architecture
Expand Down