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.
How it works
Here’s a breakdown of what’s under the hood:- Cross-Chain Interoperability: SuperchainERC20 tokens can move across multiple chains. This is possible by using the IERC-7802 interface, which lets tokens be minted on one chain and burned on another to maintain a consistent supply.
- Superchain Network: The Superchain is a network of connected blockchains, allowing smooth data and asset flow. By using Optimism’s scaling solutions, the Superchain reduces gas fees and speeds up transactions.
- Deployment: The kit helps deploy SuperchainERC20 tokens on Ethereum-compatible chains, including setting up contracts, minting, burning, and cross-chain communication.
- Testing: Test scripts simulate real token transfers across chains to ensure everything works properly before going live.
Setup
1
Install foundry
supersim requires anvil to be installed.Follow the Foundry toolchain guide for detailed instructions.2
Clone the repo
Next, you need to clone and navigate to the repo:
3
Install dependencies
Install project dependencies using
pnpm:4
Initialize .env files
5
Start the development environment
This command will:
- Start the
supersimlocal development environment - Deploy the smart contracts to the test networks
- Launch the example frontend application
Deploy SuperchainERC20s
1
Configure RPC urls
This repository includes a script to automatically fetch the public RPC URLs for each chain listed in the Superchain Registry and add them to the
[rpc_endpoints] configuration section of foundry.toml.The script ensures that only new RPC URLs are appended, preserving any URLs already present in foundry.toml. To execute this script, run:2
Modify deploy config parameters
The deployment configuration for token deployments is managed through the
This section defines parameters for deploying token contracts.
Deployment configuration for the token that will be deployed.
deploy-config.toml file. Below is a detailed breakdown of each configuration section:[deploy-config]
This section defines parameters for deploying token contracts.| Parameter | Description | Example |
|---|---|---|
salt | A unique identifier used for deploying token contracts via [Create2]. This value along with the contract bytecode ensures that contract deployments are deterministic. | salt = "ethers phoenix" |
chains | Lists the chains where the token will be deployed. Each chain must correspond to an entry in the [rpc_endpoints] section of foundry.toml. | chains = ["op_chain_a","op_chain_b"] |
[token]
Deployment configuration for the token that will be deployed.| Parameter | Description | Example |
|---|---|---|
owner_address | The address designated as the owner of the token. The L2NativeSuperchainERC20.sol contract included in this repo extends the Ownable contract. | owner_address = "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266" |
name | The token’s name. | name = "TestSuperchainERC20" |
symbol | The token’s symbol. | symbol = "TSU" |
decimals | The number of decimal places the token supports. | decimals = 18 |
3
Deploy a token
- Before proceeding, ensure that your
deploy-config.tomlfile is fully configured (see the Modify Deploy Config Parameters section setup details). - Also, confirm that the
[rpc_endpoints]section infoundry.tomlis properly set up by following the instructions in Configure RPC urls.
Deployments are executed through the
SuperchainERC20Deployer.s.sol script. This script deploys tokens across each specified chain in the deployment configuration using Create2, ensuring deterministic contract addresses for each deployment. The script targets the L2NativeSuperchainERC20.sol contract by default. If you need to modify the token being deployed, either update this file directly or point the script to a custom token contract of your choice.- To execute a token deployment run:
Best practices for deploying SuperchainERC20
Use Create2 to deploy SuperchainERC20
Create2 ensures that the address is deterministically determined by the bytecode of the contract and the provided salt. This is crucial because in order for cross-chain transfers of SuperchainERC20s to work with interop, the tokens must be deployed at the same address across all chains.
Set safe crosschainMint and crosschainBurn permissions
For best security practices SuperchainERC20Bridge should be the only contract with permission to call crosschainMint and crosschainBurn. These permissions are set up by default when using the SuperchainERC20 contract.
Next Steps
- Test your token deployment on multiple chains using Supersim and run simple end-to-end integration tests.
- For specific use cases, check out our guides for bridging a SuperchainERC20 token to another chain or modifying an existing ERC20 contract to be interoperable.
- Questions about Interop? Check out our collection of interop guides or check out this Superchain interop design video walk-thru.