@eth-optimism/tokenlist 6.3.25 → 6.3.27

package/README.md

@@ -1,15 +1,14 @@
 # Superchain Token List
 
-The Superchain token list is used as the source of truth for the [Optimism bridge UI](https://app.optimism.io/bridge) and [Base bridge UI)(https://bridge.base.org/deposit) which are the main portals for moving assets between Layer 1 and Layer 2.
+The Superchain token list is used as the source of truth for the [Optimism bridge UI](https://app.optimism.io/bridge) and [Base bridge UI](https://bridge.base.org/deposit) which are the main portals for moving assets between Layer 1 and Layer 2.
 
 ## Review process and merge criteria
 
 ### Process overview
 
 1. Follow the instructions below to create a PR that would [add your token to the list](#adding-a-token-to-the-list).
-2. Respond to any issues raised in comments on your PR generated by [automated checks](#automated-checks).
-3. If your PR requires in-depth manual review, wait for a reviewer (**we review PRs once per week**).
-4. Wait for final approval.
+2. Wait for a reviewer to kick off the [automated checks](#automated-checks).
+3. After the automated checks pass and a reviewer approves the PR, then it will automatically be merged.
 
 **Note:** The standard bridge does *not* support certain ERC-20 configurations:
 
@@ -18,27 +17,37 @@ The Superchain token list is used as the source of truth for the [Optimism bridg
 
 ### Automated checks
 
-Note that if your token was grandfathered in before the validation was added, your token may fail validation when you edit it.  If this is the case you need to add additional fields that were since added such as website field.
-
 Our CI performs a series of automated checks on every PR.
-Some issues raised by CI will trigger an error and must be resolved before your PR will be reviewed.
+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 not immediately cause an error, but will require that a reviewer manually review your PR before it can be merged.
+Other issues will surface a warning, and will require a manual review from a reviewer.
 These issues are marked below as "requires manual review".
 
 - Given tokens actually exist on all specified chains (auto-reject)
 - L1 tokens are verified on Etherscan (auto-reject)
-- Description exists and is under 150 characters (auto-reject)
-- Website exists and loads properly (auto-reject)
+- Description is under 1000 characters (auto-reject)
 - Token `name`, `symbol`, and `decimals` matches on-chain data (auto-reject)
   - If `overrides` are used (requires manual review)
-- L2 token was deployed by the StandardTokenFactory (requires manual review)
-- Ethereum token listed on the [CoinGecko Token List](https://tokenlists.org/token-list?url=https://tokens.coingecko.com/uniswap/all.json)
+- L2 token was deployed by the [StandardTokenFactory](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts/contracts/L2/messaging/L2StandardTokenFactory.sol) or is an [L2StandardERC20](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts/contracts/standards/L2StandardERC20.sol) token that uses the standard L2 bridge address (`0x4200000000000000000000000000000000000010`) (requires manual review)
+- Ethereum token listed on the [CoinGecko Token List](https://tokenlists.org/token-list?url=https://tokens.coingecko.com/uniswap/all.json)(requires manual review)
   - *Why CoinGecko? CoinGecko's token list updates every hour which means we get token list updates very quickly. CoinGecko also uses an in-depth [listing criteria](https://www.coingecko.com/en/methodology).*
 
+#### Debugging Automated checks failures
+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:
+
+1. Click on the `Details` link for `Validate PR` check in your PR
+2. Click `Summary` in the left panel
+3. Find the section on the page labeled `Artifacts` and click on `validation-artifacts`
+4. After download of `validation-artifacts.zip`, unzip it and open `validation_results.txt`
+
+If 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)>
+```
 ### Final approval
 
-All PRs are subject to a light-weight final approval, even if not marked as `requires manual review`.
+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 [@roberto-bayardo](https://github.com/roberto-bayardo) as a reviewer.
 
 ## Adding a token to the list
 
@@ -168,4 +177,4 @@ Your pull request will be validated by a series of automated checks. If one of t
 
 ### Wait for the token list to update automatically
 
-Once your PR is merged, the token list will update automatically to include your token. Please do NOT update the token list directly. All token list updates will be handled automatically when PRs are merged into the `master` branch.
+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.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { l as list } from './optimism.tokenlist-59b26487.js';
+import { l as list } from './optimism.tokenlist-81d47c4f.js';
 
 
 

package/dist/index.js

@@ -41,7 +41,7 @@ var keywords = [
   "layer2",
   "infrastructure"
 ];
-var timestamp = "2023-04-11T23:17:34.235Z";
+var timestamp = "2023-04-12T19:10:57.968Z";
 var tokens = [
   {
     chainId: 1,
@@ -2606,7 +2606,7 @@ var tokens = [
 var version = {
   major: 6,
   minor: 3,
-  patch: 25
+  patch: 27
 };
 var optimism_tokenlist_default = {
   name,