The Superchain token list is used as the source of truth for the Optimism bridge UI and Base bridge UI which are the main interfaces for moving assets between Layer 1 and Layer 2.
It is worth noting that the Superchain Token List makes a distinction between token deployment / bridging and list curation. Tokens can be deployed / bridged in a permissionless manner, anyone can deploy / bridge a token on the Superchain. The Superchain Token List is a curated list of tokens and is managed by the maintainers of this repo.
Note: The standard bridge does not support certain ERC-20 configurations:
Our CI performs a series of automated checks on every PR.
These automated checks take place as part of the Validate PR check.
Some issues raised by CI will trigger an error and must be resolved before your PR will be approved.
These issues are marked below as “auto-reject” issues.
Other issues will surface a warning, and will require a manual review from a reviewer.
These issues are marked below as “requires manual review”.
name, symbol, and decimals matches on-chain data (auto-reject)
overrides are used (requires manual review)0x4200000000000000000000000000000000000010) (requires manual review)If your automated checks failed, you can see the reason for the failure by downloading validation-artifacts.zip, unzipping it and opening the validation_results.txt file. To locate the validation-artifacts follow these steps:
Details link for Validate PR check in your PRSummary in the left panelArtifacts and click on validation-artifactsvalidation-artifacts.zip, unzip it and open validation_results.txtIf you make changes and need to run the validation check again, you will need to wait for a reviewer to approve the checks to run again. However, if you do not want to wait for a reviewer to approve the checks to run again to see if the failures have been resolved, you can run the validation checks locally by running:
npx tsx ./bin/cli.ts validate --datadir ./data --tokens <data folder name (e.g. ETH)>
All PRs are subject to a light-weight final approval, even if not marked as requires manual review. If you are adding a token to a Base chain (e.g. base-goerli) please add a comment to your PR and tag @roberto-bayardo as they are the point of contact for Base tokens.
Create a folder inside of the data folder with the same name as the symbol of the token you are trying to add. For example, if you are adding a token with the symbol “ETH” you must create a folder called ETH.
Add a logo to the data folder you just created. Your logo MUST be an SVG called logo.svg. Your logo should be at least 200x200 pt minimum and 256x256 pt preferred.
Add a file to your folder called data.json with the following format:
{
"name": "Token Name",
"symbol": "SYMBOL",
"decimals": 18,
"description": "A multi-chain token",
"website": "https://token.com",
"twitter": "@token",
"tokens": {
"ethereum": {
"address": "0x1234123412341234123412341234123412341234"
},
"optimism": {
"address": "0x2345234523452345234523452345234523452345"
},
"goerli": {
"address": "0x5678567856785678567856785678567856785678"
},
"optimism-goerli": {
"address": "0x6789678967896789678967896789678967896789"
},
"base-goerli": {
"address": "0x7890789078907890789078907890789078907890"
}
}
}
Please include the token addresses for all of the below chains where the token you are submitting has been deployed. We currently accept tokens on the following chains:
ethereumoptimismgoerlibase-goerlioptimism-goerliIf you would like to add your token to this token list but you do not want your token to be included on the Optimism Bridge app, please include the nobridge option.
{
"name": "Token Name",
"symbol": "SYMBOL",
"decimals": 18,
"description": "A multi-chain token",
"website": "https://token.com",
"twitter": "@token",
"nobridge": true,
"tokens": {
...
}
}
If your token is not a standard ERC20 (e.g., DSToken), please include the nonstandard option.
{
"name": "Token Name",
"symbol": "SYMBOL",
"decimals": 18,
"description": "A multi-chain token",
"website": "https://token.com",
"twitter": "@token",
"nonstandard": true,
"tokens": {
...
}
}
If you require overrides for specific tokens, you can include the overrides field. You are able to override the name, symbol, decimals, or bridge for any token. You do not need to override every token at the same time.
{
"name": "Token Name",
"symbol": "SYMBOL",
"decimals": 18,
"description": "A multi-chain token",
"website": "https://token.com",
"twitter": "@token",
"tokens": {
"ethereum": {
"address": "0x1234123412341234123412341234123412341234",
"overrides": {
"name": "My Ethereum Token"
}
},
"optimism": {
"address": "0x2345234523452345234523452345234523452345",
"overrides": {
"bridge": "0x1111111111111111111111111111111111111111"
}
}
}
}
Open a pull request with the changes that you’ve made. Please only add one token per pull request to simplify the review process. This means two new files inside of one new folder. If you want to add multiple tokens, please open different PRs for each token.
Your pull request will be validated by a series of automated checks. If one of these checks fails, please resolve these issues and make sure that validation succeeds. We will review your pull request for final approval once automated validation succeeds.
Once your PR is merged, the token list will update automatically to include your token. Please do NOT update the token list (optimism.tokenlist.json) directly. All token list updates will be handled automatically when PRs are merged into the master branch.
Note that the bridge UI is updated approximately once every work day, so it might take a day (or three in the case of an update on Friday) until your token is available there.