Add Merkle Tree #1

Phanco · 2023-11-30T13:58:24Z

What was the problem?

This PR resolves #2

How was it solved?

Merkle Tree function implemented, and a script to read balances json

How was it tested?

Test cases passed at lisk-contract side using the merkle tree and root built by this script

README.md

data/example/balances.json

data/example/create-balances.ts

main.ts

src/merkle-tree.ts

main.ts

AndreasKendziorra · 2023-12-04T09:04:06Z

data/example/sign.ts

What's the purpose of this file?

It signs all claims and store as signatures.json. Of course it is for testing/demonstration purpose

Could this file be refactored in a way that we could use it as a library for generating signatures? And then create another example file to use this library?
I think it would be beneficial to have something like this.

Or do we have a plan to create another issue which will deal with it?

Good question, we can work closely with UI team to see how the sign module should be implemented

shuse2

Since in this repo, there will be multiple functionality

Library
CLI
Server?

it would be nice to prepare it as monorepo?

README.md

matjazv · 2023-12-08T14:24:31Z

README.md

+ mandatoryKeys: string[];
+ optionalKeys: string[];
+ payload: string;


Is payload used somewhere?
In merkle-tree-result.json file I can't find it.

payload is a field to manually compare with existing data, however OZ's lib does not have a function to generate abi-encoded message so now I have removed it

data/example/merkle-tree-result-simple.json

README.md

Phanco · 2023-12-08T15:17:13Z

So sorry the README was not updated accordingly, now it has been updated

matjazv · 2023-12-08T16:01:33Z

src/interface.ts

+ numberOfSignatures: number;
+ mandatoryKeys: Array<string>;
+ optionalKeys: Array<string>;
+ payload: string;


Probably here could payload also be removed?

matjazv · 2023-12-08T16:02:16Z

README.md

+
+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.


merkle-tree-simple.json -> merkle-tree-result-simple.json?

README.md

data/example/create-balances.ts

data/example/sign.ts

main.ts

src/interface.ts

test/main.spec.ts

README.md

data/example/sign.ts

README.md

src/buildTree.ts

test/buildTree.spec.ts

test/buildTreeJSON.spec.ts

… leaves in cli

tsconfig.json

shuse2 · 2024-01-09T21:07:24Z

packages/tree-builder/src/applications/buildTreeJSON.ts

@@ -0,0 +1,59 @@
+import * as fs from 'fs';


let's keep the file name in snake case (both for src and test)

Also, applications maybe doesn't fit with the contents

README.md

jest.config.js

packages/tree-builder/package.json

packages/tree-builder/src/applications/buildTree.ts

packages/tree-builder/src/applications/buildTreeJSON.ts

packages/tree-builder/src/commands/generate-merkle-tree/index.ts

packages/tree-builder/src/applications/example/sign-accounts.ts

packages/tree-builder/README.md

packages/tree-builder/test/applications/build_tree.ts

packages/tree-builder/src/applications/example/sign_accounts.ts

Phanco · 2024-01-17T13:19:01Z

UPDATE: This PR focuses on Merkle Tree building, the method of account reading will be changed in the another PR.

packages/tree-builder/src/applications/generate-merkle-tree/build_tree.ts

packages/tree-builder/package.json

packages/tree-builder/src/applications/generate-merkle-tree/build_tree.ts

Phanco added 2 commits November 30, 2023 14:57

Add Merkle Tree

d6875c1

Changed editing, update main.ts scripts

4719b19

Phanco self-assigned this Nov 30, 2023

Rename package to align with repo name

09c12e5

Phanco marked this pull request as ready for review November 30, 2023 14:29

Phanco requested review from AndreasKendziorra and matjazv November 30, 2023 14:29

Added more details at README

bba45fb

AndreasKendziorra requested changes Dec 4, 2023

View reviewed changes

shuse2 reviewed Dec 5, 2023

View reviewed changes

Phanco added 3 commits December 7, 2023 16:30

Addresses are now sorted, betting naming of leaf

0faa955

Update Beddows value to balances.json

54d60fe

Add unit test

90672e9

Phanco requested a review from AndreasKendziorra December 8, 2023 14:00

matjazv requested changes Dec 8, 2023

View reviewed changes

Update README

1c931af

Phanco requested a review from matjazv December 8, 2023 15:45

matjazv requested changes Dec 8, 2023

View reviewed changes

AndreasKendziorra requested changes Dec 13, 2023

View reviewed changes

Phanco added 3 commits January 2, 2024 20:01

Modulized merkleTree building process, updated test cases

97b5279

Updated README

c753d7c

Add set instruction to README

a9037d6

Phanco requested review from matjazv and AndreasKendziorra January 3, 2024 10:17

AndreasKendziorra reviewed Jan 4, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

data/example/sign.ts Outdated Show resolved Hide resolved

AndreasKendziorra requested changes Jan 4, 2024

View reviewed changes

Phanco added 3 commits January 4, 2024 17:24

Update test cases

3ff9267

Rename merkleTree files, added merkleRoot file

37e9bfe

Improve README

e95c789

keyPairs are calculated instead of stored, users can custom number of…

4add790

… leaves in cli

shuse2 requested changes Jan 10, 2024

View reviewed changes

Update comments

8f257da

Phanco force-pushed the 115-implement-merkle-tree-builder branch from 98f9349 to 8f257da Compare January 10, 2024 12:49

Added append0x function, update tsconfig

ade43be

Phanco force-pushed the 115-implement-merkle-tree-builder branch from 90805d3 to ade43be Compare January 10, 2024 13:26

Update files to snake case

28d64d5

Phanco force-pushed the 115-implement-merkle-tree-builder branch from 5cc70b1 to 28d64d5 Compare January 10, 2024 16:13

Phanco added 3 commits January 10, 2024 17:14

Undo irrelavant changes

d892067

Update format

d3795d9

Change example args to flags

bedb635

AndreasKendziorra requested changes Jan 11, 2024

View reviewed changes

packages/tree-builder/README.md Outdated Show resolved Hide resolved

packages/tree-builder/test/applications/build_tree.ts Outdated Show resolved Hide resolved

packages/tree-builder/src/applications/example/sign_accounts.ts Outdated Show resolved Hide resolved

Phanco added 3 commits January 11, 2024 15:30

Update code according to PR comments

523510c

Update test file names

044e9c7

Use oclif logging

2a0a7fa

Phanco force-pushed the 115-implement-merkle-tree-builder branch from 1cafbea to 2a0a7fa Compare January 17, 2024 12:22

Update formatting and tsconfig

646fc49

Phanco force-pushed the 115-implement-merkle-tree-builder branch from 8b9ce34 to 646fc49 Compare January 17, 2024 12:24

Phanco requested review from AndreasKendziorra and shuse2 January 17, 2024 13:18

AndreasKendziorra approved these changes Jan 17, 2024

View reviewed changes

matjazv approved these changes Jan 18, 2024

View reviewed changes

shuse2 reviewed Jan 19, 2024

View reviewed changes

packages/tree-builder/src/applications/generate-merkle-tree/build_tree.ts Outdated Show resolved Hide resolved

shuse2 reviewed Jan 19, 2024

View reviewed changes

packages/tree-builder/package.json Outdated Show resolved Hide resolved

shuse2 reviewed Jan 19, 2024

View reviewed changes

packages/tree-builder/src/applications/generate-merkle-tree/build_tree.ts Outdated Show resolved Hide resolved

Update log import, changed fn name build_tree -> buildTree

cd17364

shuse2 approved these changes Jan 19, 2024

View reviewed changes

shuse2 merged commit 83a4f23 into main Jan 19, 2024
1 check passed

shuse2 deleted the 115-implement-merkle-tree-builder branch January 19, 2024 14:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Merkle Tree #1

Add Merkle Tree #1

Phanco commented Nov 30, 2023 •

edited

Loading

AndreasKendziorra Dec 4, 2023

Phanco Dec 4, 2023

matjazv Dec 5, 2023

Phanco Dec 7, 2023

shuse2 left a comment •

edited

Loading

matjazv Dec 8, 2023

Phanco Dec 8, 2023

Phanco commented Dec 8, 2023

matjazv Dec 8, 2023

matjazv Dec 8, 2023

shuse2 Jan 9, 2024

shuse2 Jan 10, 2024

Phanco commented Jan 17, 2024


		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.

Add Merkle Tree #1

Add Merkle Tree #1

Conversation

Phanco commented Nov 30, 2023 • edited Loading

What was the problem?

How was it solved?

How was it tested?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shuse2 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Phanco commented Dec 8, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Phanco commented Jan 17, 2024

Phanco commented Nov 30, 2023 •

edited

Loading

shuse2 left a comment •

edited

Loading