From fcf34502ddf515f95747537ff4e813d8c0805ffd Mon Sep 17 00:00:00 2001 From: cpengilly <29023967+cpengilly@users.noreply.github.com> Date: Tue, 29 Oct 2024 10:53:40 -0700 Subject: [PATCH 1/2] fix superchainerc20 language - update language - update _meta.json files - update nouns.txt --- nouns.txt | 15 +++++++++- .../app-developers/contracts/_meta.json | 2 +- pages/stack/interop/_meta.json | 2 +- pages/stack/interop/superchain-erc20.mdx | 28 +++++++++---------- 4 files changed, 30 insertions(+), 17 deletions(-) diff --git a/nouns.txt b/nouns.txt index 49bee1513..6fd4a3cab 100644 --- a/nouns.txt +++ b/nouns.txt @@ -2,4 +2,17 @@ Optimism OP Mainnet Ethereum OP Stack -MetaMask \ No newline at end of file +MetaMask +SuperchainERC20 +ZK +Security Council +Sequencer PBS +Superchain Registry +Retro Funding +Alt-DA +Teleportr +Dev Console +Granite +Holocene +Monitorism +Kubernetes diff --git a/pages/builders/app-developers/contracts/_meta.json b/pages/builders/app-developers/contracts/_meta.json index 535326a4c..c4b36699f 100644 --- a/pages/builders/app-developers/contracts/_meta.json +++ b/pages/builders/app-developers/contracts/_meta.json @@ -2,5 +2,5 @@ "compatibility": "Solidity compatibility", "system-contracts": "System contracts", "optimization": "Cost optimization", - "superchain-erc20": "SuperchainERC20 token standard" + "superchain-erc20": "SuperchainERC20" } diff --git a/pages/stack/interop/_meta.json b/pages/stack/interop/_meta.json index 0fad31024..304ddf4a7 100644 --- a/pages/stack/interop/_meta.json +++ b/pages/stack/interop/_meta.json @@ -2,5 +2,5 @@ "explainer": "Interop explainer", "cross-chain-message": "Anatomy of cross-chain message", "supersim": "Supersim Multichain Development Environment", - "superchain-erc20": "SuperchainERC20 token standard" + "superchain-erc20": "SuperchainERC20" } \ No newline at end of file diff --git a/pages/stack/interop/superchain-erc20.mdx b/pages/stack/interop/superchain-erc20.mdx index 092af2cb4..77d7daf41 100644 --- a/pages/stack/interop/superchain-erc20.mdx +++ b/pages/stack/interop/superchain-erc20.mdx @@ -1,29 +1,29 @@ --- -title: SuperchainERC20 Token Standard +title: SuperchainERC20 lang: en-US -description: Learn basic details about the SuperchainERC20 token standard. +description: Learn basic details about SuperchainERC20 implementation. --- import { Callout } from 'nextra/components' -# SuperchainERC20 Token Standard +# SuperchainERC20 Interop is currently in active development and not yet ready for production use. The information provided here may change. Check back regularly for the most up-to-date information. -`SuperchainERC20` is a token standard designed to enable asset interoperability in the Superchain. +`SuperchainERC20` is designed to enable asset interoperability in the Superchain. Asset interoperability allows for tokens to securely move across chains without asset wrapping or liquidity pools for maximal capital efficiency, thus unifying liquidity and simplifying the user experience. Additional features: -* **Simplified deployments**: Provides a consistent, unified standard for tokens across all Superchain-compatible networks and a common crosschain interface for the EVM ecosystem at large. +* **Simplified deployments**: Provides a consistent, unified implementation for tokens across all Superchain-compatible networks and a common crosschain interface for the EVM ecosystem at large. * **Permissionless propagation**: Easily clone an existing token contract to a new OP Stack chain using `create2` without requiring the original owner, which enables movement of assets to the new chain once Interop goes live. Importantly, permissionless propagation retains the integrity of the original owner on the contract and preserves security but proliferates the contract's availability to new chains. -* **Ethereum-aligned**: Intentionally designed to be generic and supported as an Ethereum-wide standard (RIP coming soon). +* **Ethereum-aligned**: Intentionally designed to be generic and supported as an Ethereum-wide implementation (RIP coming soon). ## How it works -`SuperchainERC20` token standard facilitates secure token transfers between chains in the Superchain networks via native burning and minting. +`SuperchainERC20` facilitates secure token transfers between chains in the Superchain networks via native burning and minting. * **Token Burning**: Initiating message where token is **burned** on the source chain. A user initiates a transfer of token from one blockchain to another and specifies the recipient wallet address on the destination chain. A specified amount of token is burned on the source chain. * **Token Minting**: Executing message where token is **minted** on the destination chain. The specified amount of token is minted on the destination chain directly to the recipient wallet address. @@ -55,19 +55,19 @@ This diagram illustrates the process where tokens are burned on the source chain ## Major components -* **Token Contract**: implements the `SuperchainERC20` standard with bridging functionality. +* **Token Contract**: implements `SuperchainERC20` with bridging functionality. * **Factory Predeploy**: uses a `create2`-based factory for deploying `SuperchainERC20` tokens consistently across chains. * **Bridging Functions**: using methods like `sendERC20` and `relayERC20` for cross-chain transfers. -## Comparison to other standards +## Comparison to other tokens -`SuperchainERC20` differs from other token standards in its focus and implementation: +`SuperchainERC20` differs from other tokens in its focus and implementation: -* `SuperchainERC20` has minimal differentiation from a standard ERC20 deployment, only requiring a minimal crosschain mint/burn interface, which aims to be a common pattern for the EVM ecosystem (RIP coming soon). +* `SuperchainERC20` has minimal differentiation from an ERC20 deployment, only requiring a minimal crosschain mint/burn interface, which aims to be a common pattern for the EVM ecosystem (RIP coming soon). * `SuperchainERC20` shares trust assumptions across all chains in the Superchain, such that custom assumptions around security and latency are not required to account for when executing transfers. - Projects moving from other token standards may need to adapt to the `SuperchainERC20` specification. + Projects moving from other token implementations may need to adapt to the `SuperchainERC20` specification. ## Implementation details @@ -77,10 +77,10 @@ Application developers must do two things to make their tokens `SuperchainERC20` 1. Permission only `SuperchainERC20Bridge` to call `crosschainMint` and `crosschainBurn`. 2. Deployment at same address on every chain in the Superchain using `create2` function. -For now, application developers should view `SuperchainERC20`as standard ERC20 tokens with additional built-in functions that allow cross-chain asset movement that will be enabled once Interop goes live. +For now, application developers should view `SuperchainERC20`as ERC20 tokens with additional built-in functions that allow cross-chain asset movement that will be enabled once Interop goes live. - To enable asset interoperability, `SuperchainERC20` token must give access to the address where the future `SuperchainERC20Bridge` will live. + To enable asset interoperability, `SuperchainERC20` must give access to the address where the future `SuperchainERC20Bridge` will live. ## Next steps From b91ced02c4509182f4cbae21d162f2c161f34fd9 Mon Sep 17 00:00:00 2001 From: cpengilly <29023967+cpengilly@users.noreply.github.com> Date: Tue, 29 Oct 2024 12:45:46 -0700 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: soyboy <85043086+sbvegan@users.noreply.github.com> --- pages/stack/interop/superchain-erc20.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pages/stack/interop/superchain-erc20.mdx b/pages/stack/interop/superchain-erc20.mdx index 77d7daf41..6542f6ae5 100644 --- a/pages/stack/interop/superchain-erc20.mdx +++ b/pages/stack/interop/superchain-erc20.mdx @@ -1,7 +1,7 @@ --- title: SuperchainERC20 lang: en-US -description: Learn basic details about SuperchainERC20 implementation. +description: Learn about the basic details of the SuperchainERC20 implementation. --- import { Callout } from 'nextra/components' @@ -59,9 +59,9 @@ This diagram illustrates the process where tokens are burned on the source chain * **Factory Predeploy**: uses a `create2`-based factory for deploying `SuperchainERC20` tokens consistently across chains. * **Bridging Functions**: using methods like `sendERC20` and `relayERC20` for cross-chain transfers. -## Comparison to other tokens +## Comparison to other token implementations -`SuperchainERC20` differs from other tokens in its focus and implementation: +`SuperchainERC20` differs from other token implementations in its focus and implementation: * `SuperchainERC20` has minimal differentiation from an ERC20 deployment, only requiring a minimal crosschain mint/burn interface, which aims to be a common pattern for the EVM ecosystem (RIP coming soon). * `SuperchainERC20` shares trust assumptions across all chains in the Superchain, such that custom assumptions around security and latency are not required to account for when executing transfers.