@eth-optimism/tokenlist 10.0.278 → 10.0.280

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +8 -3
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -20,7 +20,9 @@ Please note that by adding a token to the list we aren’t making any claims abo
20
20
  - [Tokens that modify balances without emitting a Transfer event](https://github.com/d-xo/weird-erc20#balance-modifications-outside-of-transfers-rebasingairdrops)
21
21
 
22
22
  ### Specifying chains
23
+
23
24
  For right now, each OP Chain has their own review process. So, if you are adding tokens across multiple chains, please separate your pull request so that you have one PR for each chain, in order to streamline the review process.
25
+
24
26
  - If you're adding a token to `Base` (e.g. `base` [mainnet] or `base-sepolia` [testnet]), instead of using the predeploy token factory on Base, we recommend you use the token factory [listed here](https://docs.base.org/base-contracts/#l2-contract-addresses) to avoid having a token address that may conflict with a different token on Optimism.
25
27
  - If you are adding a token to `Zora`: please use the [`zora` label](https://github.com/ethereum-optimism/ethereum-optimism.github.io/labels/zora) and add [@tbtstl](https://github.com/tbtstl) as a reviewer.
26
28
  - If you are adding a token to `Mode`: please use the [`mode` label](https://github.com/ethereum-optimism/ethereum-optimism.github.io/labels/mode).
@@ -46,6 +48,7 @@ These issues are marked below as "requires manual review".
46
48
  - *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).*
47
49
 
48
50
  #### Debugging Automated checks failures
51
+
49
52
  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:
50
53
 
51
54
  1. Click on the `Details` link for `Validate PR` check in your PR
@@ -54,9 +57,11 @@ If your automated checks failed, you can see the reason for the failure by downl
54
57
  4. After download of `validation-artifacts.zip`, unzip it and open `validation_results.txt`
55
58
 
56
59
  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:
57
- ```
60
+
61
+ ```sh
58
62
  npx tsx ./bin/cli.ts validate --datadir ./data --tokens <data folder name (e.g. ETH)>
59
63
  ```
64
+
60
65
  ### Final approval
61
66
 
62
67
  All PRs are subject to a light-weight final approval, even if not marked as `requires manual review`.
@@ -190,11 +195,12 @@ If you require overrides for specific tokens, you can include the `overrides` fi
190
195
  ```
191
196
 
192
197
  ##### Bridge overrides
198
+
193
199
  To override an L1 bridge address, specify the L2 chain it bridges to along with the address of the L1 bridge. For an L2 bridge address override, just specify the address of the L2 bridge.
194
200
 
195
201
  Here is an example:
196
202
 
197
- ```
203
+ ```json
198
204
  {
199
205
  "name": "Synthetix",
200
206
  "symbol": "SNX",
@@ -232,7 +238,6 @@ Here is an example:
232
238
  }
233
239
  ```
234
240
 
235
-
236
241
  ### Create a pull request
237
242
 
238
243
  Open a [pull request](https://github.com/ethereum-optimism/ethereum-optimism.github.io/pulls) 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.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@eth-optimism/tokenlist",
3
3
  "description": "[Optimism] token list",
4
- "version": "10.0.278",
4
+ "version": "10.0.280",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
7
7
  "exports": {