README.md
1# Ethereum-lists
2
3[](https://travis-ci.org/MyEtherWallet/ethereum-lists)
4[](https://github.com/MyEtherWallet/ethereum-lists/)
5[](https://github.com/MyEtherWallet/ethereum-lists)
6
7A repository for maintaining lists of things like malicious URLs, fake token addresses, and so forth. We love lists.
8
9## Found a Phishing URL? See a fake ICO address?
10
11Everyone is encouraged to make a PR or issue to add an address or URL to the list. This process is far easier than you might imagine!
12
131. If you do not already have a Github account, sign up. (it's free and easy!)
14
152. Navigate to the `src` folder and pick which one you'd like to add:
16
17 - `addresses` folder is for the darklisting or whitelisting ethereum addresses
18 - `contracts` folder is for the different network contracts
19 - `tokens` folder is for the different network tokens
20 - `urls` folder is for the darklisting or whitelisting ethereum urls
21
22 1. For urls or addresses:
23
24 - Click on the file you wish to update:
25 - If you would like to make an addition:
26 **a.** Copy the top most item starting with the first `{` and ending with the `},`
27 **b.** Paste it right above the first item
28 **c.** Replace that information with the new information
29 **d.** Some add'l notes on specific files are below. Please skim if you don't know what the fields are.
30 - If you would like to make a correction or remove an item:
31
32 **a.** Scroll to the item in question
33 **b.** Edit the item or remove the item by selecting the top `{` and ending with the `},` and deleting that chunk.
34 **c.** Some add'l notes on specific files are below. Please skim if you don't know what the fields are.
35
36 - Scroll to the bottom. under "Commit changes" enter a reason you are making this change.
37 - Example: _"Adding myetherscam.com to darklist. See [link to tweet / reddit post / screenshot]."_
38 - You can also provide more details in the box below. Please provide as much detail / evidence as reasonable so reviewers can verify quickly.
39
40
41 - Click the green "Propose File change" button.
42
43 - This next page is a review of what you did. Proofread and stuff.
44
45 - Click the "Create Pull Request" button.....twice.
46
47 - That's it. You successfully made a new pull request!
48
49 2. For tokens or contracts:
50 - Click on the network where you would like to implement a change.
51 - If you would like to make an addition:
52
53 **a.** Click create new file on the upper right side of the screen.
54
55 **b.** Name your file with the ethereum address with a `.json` extension. e.g: `0xDECAF9CD2367cdbb726E904cD6397eDFcAe6068D.json`
56
57 **c.** Some add'l notes on specific files are below. Please skim if you don't know what the fields are.
58 - If you would like to make a correction or remove an item:
59
60 **a.** Navigate to the file.
61 **b.** Click the pencil to edit or the trash can to delete.
62 - When editing, update the relevant information.
63 - Scroll to the bottom. under "Commit changes" enter a reason you are making this change.
64 - Example: _"Adding myetherscam.com to darklist. See [link to tweet / reddit post / screenshot]."_
65 - You can also provide more details in the box below. Please provide as much detail / evidence as reasonable so reviewers can verify quickly.
66
67
68 - Click the green "Propose File change" button.
69
70 - This next page is a review of what you did. Proofread and stuff.
71
72 - Click the "Create Pull Request" button.....twice.
73
74 - That's it. You successfully made a new pull request!
75
76## Address Darklist
77
78`src/addresses/addresses-darklist.json`
79
80- **Purpose**: A list of addresses that deserve to be accompanied by a warning.
81- **Example**:
82 - Fake twitter handle ShiftShape is DMing telling people to send ETH to `0x1234...` for discount.
83 - VitalikBooty DMs you a link telling you to enter your private key in order to 2FA your wallet.
84- **Not for:**
85 - Tracking addresses of phishers or scammers.
86 - Reporting where stolen funds were sent to.
87
88## Address Lightlist
89
90`src/addresses/addresses-lightlist.json`
91
92- **Purpose**:
93
94 - A list of addresses that are the "legitimate" addresses.
95 - Optionally accompanied by a recommended gas price for sending to (for token contributions mostly)
96
97- **Example**:
98 - Upcoming token sale wants to ensure people sending to their address know to use a gas price of 200000.
99
100_Best if you use github account that is part of token team or tweet or email us or something to verify. We should all get in the habit of cross-referencing provided information._
101
102## URL Darklist
103
104`src/addresses/urls-darklist.json`
105
106- **Purpose**:
107 - A list of URLs known to be fake, malicious, phishing.
108- **Example**:
109 - `myetherphish[.]com`
110- **Not for:**
111 - Opinions on whether a project / token sale is a bad project.
112
113## URL Lightlist
114
115`src/addresses/urls-lightlist.json`
116
117- **Purpose**:
118 - A list URLs that are caught by the Levenshtein algorithm above or are known to be the "legitimate" URLs.
119 - Usually are added if a URL is added to the above.
120- **Example**:
121 - `myetherwallet.com`
122- **Not for:**
123 - Promoting your social media shit.
124
125## Contract ABIs
126
127ABIs associated with contract addresses.
128
129##### Information (all optional except for name, symbol, address, decimals):
130
131- `name`: Contract name
132- `address`: Ethereum (or other chain) address of a contract.
133- `comment`: Any notes or comment about the contract
134- `abi`: The contract abi
135
136Please make sure that you name the files by its address. You can see examples [here](https://github.com/MyEtherWallet/ethereum-lists/tree/master/src/contracts): https://github.com/MyEtherWallet/ethereum-lists/tree/master/src/tokens
137
138## Tokens
139
140Information related to tokens. ERC-20 compliant only (For now).
141
142##### Information (all optional except for name, symbol, address, decimals):
143
144- `symbol`: Short ticker style symbol of token.
145- `name`: Token name.
146- `address`: Ethereum (or other chain) address of ERC-20 token.
147- `decimal`: The decimals of the token.
148- `logo`: An optional logo of your token. Must be a **square** (recommended: 128x128) PNG w/ transparent background. Please compress using https://tinypng.com/
149- `support`: A support email, support URL, or other way people can get assistance regarding the token.
150- `social`: Where details about the token is
151
152Please make sure that you name the files by its address. You can see examples [here](https://github.com/MyEtherWallet/ethereum-lists/tree/master/src/tokens): https://github.com/MyEtherWallet/ethereum-lists/tree/master/src/tokens
153
154#### Development
155
156on terminal, run: `git clone git@github.com:MyEtherWallet/ethereum-lists.git; cd ethereum-lists`
157and then run: `npm run compile; npm run test:checkToken; npm run test:checkContract; npm run lint` to compile
158
159#### A last note
160
161This list is maintained by volunteers in the cryptocurrency community & people like you around the internet. It may not always be up to date, and it may occasionally get it wrong. If you find an error or omission, please open an issue or make a PR with any corrections.
162
){kind=link}
){kind=link}
){kind=link}