Add Merkle Tree

.eslintignore

@@ -0,0 +1,11 @@
+docs/
+lisk/
+templates/
+types/
+examples/
+**/*.d.ts
+jest.config.js
+coverage
+benchmark
+.eslintrc.js
+ecosystem.config.js

.eslintrc.js

@@ -0,0 +1,12 @@
+module.exports = {
+ root: true,
+ parserOptions: {
+ project: './tsconfig.json',
+ tsconfigRootDir: __dirname,
+ },
+ extends: ['lisk-base/ts'],
+ rules: {
+ '@typescript-eslint/member-ordering': 'off',
+ '@typescript-eslint/no-unsafe-argument': ['warn'],
+ },
+};

.gitignore

@@ -0,0 +1 @@
+node_modules

.prettierrc.json

@@ -0,0 +1,7 @@
+{
+ "printWidth": 100,
+ "singleQuote": true,
+ "trailingComma": "all",
+ "useTabs": true,
+ "arrowParens": "avoid"
+}

README.md

@@ -1 +1,114 @@
-# lisk-token-claim
+# Lisk Token Claim
+
+This library builds Merkle Tree from a snapshot and computes Merkle Root.
+
+## Installation
+
+```
+$ yarn
+```
+
+## Run
+
+```
+$ yarn generate-merkle-tree # Using ./data/mainnet
+$ 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` |
+
+## Merkle Leaf
+
+Each leaf will be encoded as ABI-format, in the following order:
+```
+LSK_ADDRESS_IN_HEX: bytes20
+BALANCE_IN_BEDDOWS: uint64
+NUMBER_OF_SIGNATURES: uint32
+MANDATORY_KEYS: bytes32[]
+OPTIONAL_KEYS: bytes32[]
+
+P.S. If the address is not a multisig address, NUMBER_OF_SIGNATURES would be 0, MANDATORY_KEYS and OPTIONAL_KEYS be []
+```
+
+## Params
+
+```
+balance.json:
+{
+ lskAddress: string;
+ balance: number;
+ balanceBeddows: number;
+ numberOfSignatures?: number;
+ mandatoryKeys?: string[];
+ optionalKeys?: string[];
+}
+
+merkle-tree-result.json:
+{
+ merkleRoot: string;
+ leaves: {
+ lskAddress: string;
+ address: string;
+ balance: number;
+ balanceBeddows: number;
+ numberOfSignatures: number;
+ mandatoryKeys: string[];
+ optionalKeys: string[];
+ hash: string;
+ proof: string[];
+ }[];
+}
+
+merkle-tree-result-simple.json:
+{
+ merkleRoot: string;
+ leaves: {
+ b32Address: string;
+ balanceBeddows: number;
+ mandatoryKeys: string[];
+ numberOfSignatures: number;
+ optionalKeys: string[];
+ proof: string[];
+ }[];
+}
+# `address` is a reserved in solidity, hence `b32Address` here
+```
+
+### `merkle-tree-simple`
+
+Due to the constraint of vm.parseJson in Foundry, fields in `merkle-tree-result` such as decimal field will trigger error.
+
+`merkle-tree-simple.json` is a lightweight version of `merkle-tree-result.json`, which also has sufficient params for claiming.
+
+## _Testing Only_
+
+### Generate balance.json from `dev-validators.json`
+
+```
+$ yarn create-balances:example
+```
+
+### (After running `generate-merkle-tree:example`) Sign all accounts and generates `signatures.json`
+
+```
+$ yarn sign:example
+```
+
+### Params (For testing purposes only)
+```
+signatures.json:
+{
+ message: string;
+ sigs: {
+ pubKey: string
+ r: string
+ s: string
+ }[];
+}[];
+```