@@ -4,4 +4,36 @@ You can contribute to the tool by adding support for a ledger, updating the
44mapping process for an existing ledger, or adding a new metric. In all cases,
55the information should be submitted via a GitHub PR.
66
7- ...
7+ ## Add support for ledgers
8+
9+ You can add support for a ledger that is not already supported as follows.
10+
11+ ### Mapping information
12+
13+ In the directory ` mapping_information/ ` , there exist two folders: ` addresses `
14+ and ` special_addresses ` .
15+
16+ ` addresses ` contains information about the owner or manager of an address. This
17+ information should be publicly available and verifiable, for example it may come
18+ from a public explorer, social media or forum posts, articles, etc. Each file in
19+ this folder is named ` <project_name>.json ` (for the corresponding ledger) and
20+ contains a dictionary where the key is the address and the value is a dictionary
21+ with the following information:
22+ (i) the name of the entity (that controls the address);
23+ (ii) the source of the information (e.g., an explorer's URL);
24+ (iii) (optional) a boolean value ` is_contract ` (if omitted then it is assumed false);
25+ (iv) (optional) ` extra_info ` that might be relevant or interesting (not used for
26+ the analysis).
27+
28+ ` special_addresses ` contains information about addresses that should be treated
29+ specially, e.g., excluded from the analysis. This includes burn addresses,
30+ protocol-related addresses (e.g., Ethereum's staking contract), treasury
31+ addresses, etc. Here each file is named ` <project_name>.json ` and contains a
32+ list of dictionaries with the following information:
33+ (i) the address;
34+ (ii) the source of the information;
35+ (iii) ` extra_info ` which describes the reason why the address is special.
36+
37+ To contribute mapping information you can either update an existing file, by
38+ changing and/or adding some entries, or create a new file for a newly-supported
39+ ledger.
0 commit comments