You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-29Lines changed: 27 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,39 +1,38 @@
1
-
Sequence Token Directory
2
-
========================
1
+
# Sequence Token Directory
3
2
4
3
Token directory that contains a comprehensive list of ERC-20, ERC-721, ERC-1155 and other contracts.
5
4
6
5
**NOTES:**
7
-
* The [./index/index.json](./index/index.json) is an auto-generated file that is a master index of all ./index/**/* contents
8
-
including chain names, chain ids, file names, and sha256 hashes of the file contents. This file
9
-
is perfect for using as the primary index of this repo, and when syncing contents you can traverse this
10
-
index file and also compare the sha256 hash if the file has changed.
11
-
* The [./index/deprecated.json](./index/deprecated.json) is a manually maintained file which lists all folders which are deprecated
12
-
and as a result the files will be labelled as deprecated in the master index.json.
13
-
* The [./index/external.json](./index/external.json) is a manually maintained file of external token list sources which are synced
14
-
and downloaded to the [./index/_external](./index/_external) folder. We store the contents here to ensure data integrity,
15
-
and we also compute and include these files in the master index.json.
6
+
7
+
- The [./index/index.json](./index/index.json) is an auto-generated file that is a master index of all ./index/\*_/_ contents
8
+
including chain names, chain ids, file names, and sha256 hashes of the file contents. This file
9
+
is perfect for using as the primary index of this repo, and when syncing contents you can traverse this
10
+
index file and also compare the sha256 hash if the file has changed.
11
+
- The [./index/deprecated.json](./index/deprecated.json) is a manually maintained file which lists all folders which are deprecated
12
+
and as a result the files will be labelled as deprecated in the master index.json.
13
+
- The [./index/external.json](./index/external.json) is a manually maintained file of external token list sources which are synced
14
+
and downloaded to the [./index/\_external](./index/_external) folder. We store the contents here to ensure data integrity,
15
+
and we also compute and include these files in the master index.json.
16
16
17
17
**REMINDERS:**
18
-
*`pnpm reindex` is automatically called as a pre-commit hook anytime an entry it changed. You may also
19
-
call it manually if you like.
20
-
*`pnpm sync-external` must be called manually periodically to ensure we have the latest contents, this
21
-
script is not run automatically.
22
18
19
+
-`pnpm reindex` is automatically called as a pre-commit hook anytime an entry it changed. You may also
20
+
call it manually if you like.
21
+
-`pnpm sync-external` must be called manually periodically to ensure we have the latest contents, this
22
+
script is not run automatically.
23
23
24
-
## Setup
24
+
## Setup
25
25
26
-
*`pnpm install` will setup your local tools
27
-
*`pnpm reindex` to reindex the token directory master index.json, but see notes above, as this
28
-
is also automatically called as a pre-commit hook.
29
-
*`pnpm sync-external` to sync ./index/external.json files to local ./index/_external/ folder.
26
+
-`pnpm install` will setup your local tools
27
+
-`pnpm reindex` to reindex the token directory master index.json, but see notes above, as this
28
+
is also automatically called as a pre-commit hook.
29
+
-`pnpm sync-external` to sync ./index/external.json files to local ./index/\_external/ folder.
30
30
31
31
## Token List Formats
32
32
33
33
The ERC-20 token lists present in this repository follow the [Uniswap Token List Schema](https://github.com/Uniswap/token-lists). The original list was populated using [Coingecko](https://www.coingecko.com/en)'s erc20 token list [CoinGecko](https://tokens.coingecko.com/uniswap/all.json). Token description and links are taken from Coingecko's API.
34
34
35
-
The ERC-721 and ERC-1155 token lists present in this repository follow the [Sequence Collectible List Schema](https://github.com/0xsequence/collectible-lists).
36
-
35
+
The ERC-721 and ERC-1155 token lists present in this repository follow the [Sequence Collectible List Schema](https://github.com/0xsequence/collectible-lists).
37
36
38
37
## How to Add or Update Your Token / Contract
39
38
@@ -45,7 +44,6 @@ If a token is missing entirely, or contains incorrect or missing information, pl
45
44
4.[Open a PR](https://github.com/0xsequence/token-directory/compare) comparing the master branch with your fork
46
45
5. In the PR, add an explanation if this PR is for an existing token that needs to be updated
47
46
48
-
49
47
## Formats
50
48
51
49
Depending on the standard, your token entries should respect the following format:
@@ -56,16 +54,16 @@ See [here](https://github.com/0xsequence/token-directory/blob/master/index/mainn
56
54
57
55
```typescript
58
56
{
59
-
chainId: number, // Chain ID
57
+
chainId: number, // Chain ID
60
58
address: string, // Contract address
61
59
name: string, // Name of token, 40 chars max
62
60
symbol: string, // Symbol of token, 20 chars max
63
61
decimals: number, // Number of decimals token uses
64
-
logoURI: string|null, // URI / URL for token logo
62
+
logoURI: string|null, // URI / URL for token logo
65
63
extensions: {
66
64
link: string|null, // URL of token's website
67
65
description: string|null, // Short description of token (1000 chars max)
68
-
ogImage: string|null// URL of Open Graph image of token website
66
+
ogImage: string|null// URL of Open Graph image of token website
69
67
}
70
68
```
71
69
@@ -75,16 +73,16 @@ See [here](https://github.com/0xsequence/token-directory/blob/master/index/mainn
75
73
76
74
```typescript
77
75
{
78
-
chainId: number, // Chain ID
76
+
chainId: number, // Chain ID
79
77
address: string, // Contract address
80
78
name: string, // Name of token, 40 chars max
81
-
standard: 'erc721'|'erc1155', // Name of token's standard
79
+
standard: 'erc721'|'erc1155', // Name of token's standard
82
80
symbol: string|null, // Symbol of token, 20 chars max
83
81
logoURI: string|null, // URI / URL for token logo
84
82
extensions: {
85
83
link: string|null, // URL of token's website
86
84
description: string|null, // Short description of token (1000 chars max)
87
-
ogImage: string|null// URL of Open Graph image of token website
85
+
ogImage: string|null// URL of Open Graph image of token website
0 commit comments