Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/1inch/merkle-distribution

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/1inch/merkle-distribution
Owner: 1inch
License: mit
Created: 2021-08-06T18:49:45.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2024-07-01T00:13:11.000Z (3 months ago)
Last Synced: 2024-07-05T06:58:47.037Z (3 months ago)
Language: JavaScript
Size: 1.1 MB
Stars: 57
Watchers: 8
Forks: 29
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        


    

    



# Merkle Distribution

[![Build Status](https://github.com/1inch/merkle-distribution/actions/workflows/test.yml/badge.svg)](https://github.com/1inch/merkle-distribution/actions)

[![Coverage Status](https://codecov.io/gh/1inch/merkle-distribution/branch/master/graph/badge.svg?token=4AY5FRY8HN)](https://codecov.io/gh/1inch/merkle-distribution)

Set of smart contracts for gas efficient merkle tree drops. 

## Sequential cumulative Merkle Tree drops

Each next Merkle Tree root replaces previous one and should contain cumulative balances of all the participants. Cumulative claimed amount is used as invalidation for every participant.

## Signature-based drop

Each entry of the drop contains private key which is used to sign the address of the receiver. This is done to safely distribute the drop and prevent MEV stealing.

## How to create qr-codes and deploy the contract

### Generation

To generate QR-codes for the drop, use the following command:

```bash

yarn qr:create  -a  -n  

```

|Parameter|Description|

|---|---|

|version|Version of the drop. Used to identify the drop on the front-end side|

|token amounts|Comma-delimited list of amounts of tokens for each QR-code|

|qr-code numbers|Comma-delimited list of number of QR-codes to generate. The position corresponds to the position of amount|

Example:

To generate qr codes for the drop

|Amounts|Number of codes|

|---|---|

|5 INCH|100 qr-codes|

|10 INCH|50 qr-codes|

|20 INCH|20 qr-codes|

use the following command:

```bash

yarn qr:create 1 -a 5,10,20 -n 100,50,20

```

### Deployment

To deploy the contract, use the following command:

```bash

yarn qr:deploy hardhat --v  --r  --h 

```

|Parameter|Description|

|---|---|

|version|Version of the drop. Used to make deployment output JSON unique|

|merkle root|The root of the merkle tree. Should be taken from the previous step.|

|merkle tree height|The height of the merkle tree. Power of height |

Example:

For the drop generated in the previous example, use the following command:

```bash

yarn qr:deploy hardhat --v 36 --r 0x0ee0c05c1942ba534867e4676ddd0cc2 --h 8

```

where

|Parameter|Value|

|---|---|

|version|36|

|merkle root|0x0ee0c05c1942ba534867e4676ddd0cc2|

|merkle tree height|8|