Add Merkle Tree

README.md

@@ -2,30 +2,33 @@
 
 This library builds Merkle Tree from a snapshot and computes Merkle Root.
 
-## Installation
+## Setup and Installation
 
 ```
+$ git clone [email protected]:LiskHQ/lisk-token-claim.git && cd lisk-token-claim
 $ yarn
 ```
 
 ## Run
 
 ```
-$ yarn generate-merkle-tree # Using ./data/mainnet
+$ yarn generate-merkle-tree:mainnet # Using ./data/mainnet
+$ yarn generate-merkle-tree:testnet # Using ./data/testnet
 $ yarn generate-merkle-tree:example # Using ./data/example
 ```
 
 ## Files
 
-| Name | Description | Generated By |
-|--------------------------------------------------|---------------------------------------------------------------------------------------------------| ----------------------------- |
-| `/data/<network>/balance.json`  | Stores balance by address after a snapshot is taken, addresses must be sorted in ascending order. | Snapshot |
-| `/data/<network>/merkle-tree-result.json` | Stores MerkleRoot, and leaves for each account. | `$ yarn generate-merkle-tree` |
-| `/data/<network>/merkle-tree-result-simple.json` | Stores MerkleRoot, and leaves for each account. | `$ yarn generate-merkle-tree` |
+| Name | Description  | Generated By  |
+| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |-----------------------------------------|
+| `/data/<network>/accounts.json` | Stores addresses, balances, and multisig details(If any) by address after a snapshot is taken, addresses must be sorted in ascending order. | Snapshot  |
+| `/data/<network>/merkle-tree-result.json` | Stores MerkleRoot, and leaves for each account.  | `$ yarn generate-merkle-tree:<network>` |
+| `/data/<network>/merkle-tree-result-simple.json` | Stores MerkleRoot, and leaves for each account.  | `$ yarn generate-merkle-tree:<network>` |
 
 ## Merkle Leaf
 
 Each leaf will be encoded as ABI-format, in the following order:
+
 ```
 LSK_ADDRESS_IN_HEX: bytes20
 BALANCE_IN_BEDDOWS: uint64
@@ -39,7 +42,7 @@ P.S. If the address is not a multisig address, NUMBER_OF_SIGNATURES would be 0,
 ## Params
 
 ```
-balance.json:
+accounts.json:
 {
  lskAddress: string;
  balance: number;
@@ -88,10 +91,10 @@ Due to the constraint of vm.parseJson in Foundry, fields in `merkle-tree-result`
 
 ## _Testing Only_
 
-### Generate balance.json from `dev-validators.json`
+### Generate accounts.json from `dev-validators.json`
 
 ```
-$ yarn create-balances:example
+$ yarn create-accounts:example
 ```
 
 ### (After running `generate-merkle-tree:example`) Sign all accounts and generates `signatures.json`
@@ -101,6 +104,7 @@ $ yarn sign:example
 ```
 
 ### Params (For testing purposes only)
+
 ```
 signatures.json:
 {
@@ -111,4 +115,4 @@ signatures.json:
  s: string
  }[];
 }[];
-```
+```