Skip to content

Commit

Permalink
removed unused package
Browse files Browse the repository at this point in the history
  • Loading branch information
GSaphal committed Dec 24, 2021
1 parent c13a9fb commit 6e33b01
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 7 deletions.
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,37 @@
#
# Merkle Tree Generator for Zilliqa

A Simple Javascript library to generate Merkle Tree and get its root and proof for any type of Merkle Tree Distribution

## Installation

The recommend way to use MetaMask React with a React app is to install it as a dependency:

```shell
# If you use npm:
npm i merkle-tree-zilliqa-js

# Or if you use Yarn:
yarn add merkle-tree-zilliqa-js
```

## Example

1. The first step is to import the function generateTree from the package.

```javascript
import { generateTree } from 'merkle-tree-zilliqa-js';
```

2. The next step is to send a array of data to the generate tree function. Make sure that the data has the following format:

[
{
wallet:"zil..............",
amount:"10000000000",
}
]
Note: Make sure that the wallet passed is in the base32 format i.e zil.............

3. And boom, you are done! It returns you with the merkle root and proof for all the passed wallets, which can be passed on Smart Contracts for claiming the rewards.

This is just the initial version of the package, feel free to contribute more to it.
5 changes: 0 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@
"dependencies": {
"@zilliqa-js/crypto": "^3.3.3",
"@zilliqa-js/util": "^3.3.3",
"bn.js": "^5.2.0",
"js-sha256": "^0.9.0",
"merkletreejs": "^0.2.27"
}
Expand Down

0 comments on commit 6e33b01

Please sign in to comment.