Skip to content

fix superchainerc20 language #1045

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 2 commits into from
Oct 30, 2024
Merged

fix superchainerc20 language #1045

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fcf3450
fix superchainerc20 language
cpengilly Oct 29, 2024
b91ced0
Apply suggestions from code review
cpengilly Oct 29, 2024
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
15 changes: 14 additions & 1 deletion nouns.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,17 @@ Optimism
OP Mainnet
Ethereum
OP Stack
MetaMask
MetaMask
SuperchainERC20
ZK
Security Council
Sequencer PBS
Superchain Registry
Retro Funding
Alt-DA
Teleportr
Dev Console
Granite
Holocene
Monitorism
Kubernetes
2 changes: 1 addition & 1 deletion pages/builders/app-developers/contracts/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
"compatibility": "Solidity compatibility",
"system-contracts": "System contracts",
"optimization": "Cost optimization",
"superchain-erc20": "SuperchainERC20 token standard"
"superchain-erc20": "SuperchainERC20"
}
2 changes: 1 addition & 1 deletion pages/stack/interop/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
28 changes: 14 additions & 14 deletions pages/stack/interop/superchain-erc20.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
---
title: SuperchainERC20 Token Standard
title: SuperchainERC20
lang: en-US
description: Learn basic details about the SuperchainERC20 token standard.
description: Learn about the basic details of the SuperchainERC20 implementation.
---

import { Callout } from 'nextra/components'

# SuperchainERC20 Token Standard
# SuperchainERC20

<Callout>
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.
</Callout>

`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.
Expand Down Expand Up @@ -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 token implementations

`SuperchainERC20` differs from other token standards in its focus and implementation:
`SuperchainERC20` differs from other token implementations 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.

<Callout type="info">
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.
</Callout>

## Implementation details
Expand All @@ -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.

<Callout type="warning">
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.
</Callout>

## Next steps
Expand Down
Loading