Deploying a SuperchainERC20

The SuperchainERC20 standard is ready for production deployments. Please note that the OP Stack interoperability upgrade, required for crosschain messaging, is currently in active development.

Welcome to the SuperchainERC20 quickstart guide! In this guide, we'll cover how the token works and the deployment process using the SuperchainERC20 starter kit. Whether you're a seasoned developer or just starting out, this guide has got you covered.

What is SuperchainERC20?

SuperchainERC20 provides a standardized token implementation enabling seamless token transfers across the Superchain.

SuperchainERC20 extends the standard ERC-20 token with cross-chain mint and burn capabilities, enabling seamless interoperability across the Superchain interop cluster. This token standard implements the ERC-7802 interface to enable 1-block latency cross-chain mint/burn functionality.

How does SuperchainERC20 work?

SuperchainERC20 and SuperchainTokenBridge work together to allow ERC-20 tokens to be transferred from one chain to the other.

SuperchainERC20 cross-chain transfers require two transactions:

Initiate Transaction: On the source chain, tokens are burned and a cross-chain message is emitted
Execute Transaction: The message is relayed to the destination chain, triggering token minting

This flow ensures tokens maintain consistent total supply across the entire Superchain ecosystem and eliminates the need for liquidity pools or wrapped tokens.

Why SuperchainERC20 matters for users, token issuers, and apps on Ink

Superchain interop provides Ink with essential cross-chain capabilities that enhance the network's interoperability. When token issuers use SuperchainERC20 over a typical ER-C20 deployment it gives token issuers access to the broader Superchain network effects, ensuring your tokens can seamlessly be used by apps and users across the Superchain.

SuperchainERC20 deployment creates opportunities for:

Enhanced Liquidity: Unified token representation across chains improves capital efficiency
Simplified Developer Experience: Consistent API for projects building on Ink
Reduced Fragmentation: Improved capital efficiency for DeFi applications across the Superchain ecosystem - one chain to rule them all

🚀 Deploying SuperchainERC20 - Quickstart

Prerequisites

First, you'll need to install Foundry, as the project requires anvil. Follow the Foundry installation guide.

Setup Steps

Clone the repository

git clone [email protected]:ethereum-optimism/superchainerc20-starter.git
cd superchainerc20-starter

Install dependencies
```
pnpm i
```
Set up environment files
```
pnpm init:env
```
Start the development environment
```
pnpm dev
```
Update RPC URLs
```
pnpm contracts:update:rpcs
```

Configure deployment settings Create or update your deployment configuration file:

[deploy_config]
salt = "ethers phoenix"
chains = ["sepolia/ink"]
 
[token]
owner_address = "<YOUR ADDRESS>"    # Your wallet address
name = "<YOUR TOKEN NAME>"          # The name of your token
symbol = "<YOUR TOKEN SYMBOL>"      # Your token's symbol (e.g., "OPT")
decimals = 18                       # Number of decimal places (18 is standard)

Save this to packages/contracts/configs/deploy-config.toml

Set up your deployer private key
```
echo 'DEPLOYER_PRIVATE_KEY=<YOUR PRIVATE KEY>' > packages/contracts/.env
```
⚠️ Never share or commit your private key. Make sure your wallet has enough funds for deployment.
Deploy your token
```
pnpm contracts:deploy:token
```

Security considerations

To ensure security, you must either design the deployer to allow only a specific trusted ERC-20 contract, such as SuperchainERC20, to be deployed through it, or call CREATE2 to deploy the contract directly from an EOA you control.

This precaution is critical because if an unauthorized ERC-20 contract is deployed at the same address on any Superchain network, it could allow malicious actors to mint unlimited tokens and bridge them to the network where the original ERC-20 contract resides.

For production deployments, ensure that:

Grant permissions to the SuperchainTokenBridge(address 0x4200000000000000000000000000000000000028) to call crosschainMint and crosschainBurn.
Deploy the SuperchainERC20 at the same address on every chain in the Superchain where you want your token to be available. If you do not deploy the contract to a specific destination chain, users will be unable to successfully move their tokens to that chain.

What's Next?

SuperchainERC20 enables token issuers to seamlessly access Superchain network effects. By leveraging SuperchainERC20 and Superchain interop, developers can focus on building features rather than solving complex cross-chain challenges.

For troubleshooting or questions, join our Discord community
Use Supersim, a local development tool, to deploy a SuperchainERC20 or build an interop-enabled app
Learn more about the technical architecture of Superchain interop
Learn about how other token standards can benefit from Superchain interop

Shipping on the Superchain Account Abstraction