@pooltogether/merkle-distributor

1.0.2 • Public • Published

@pooltogether/merkle-distributor

Tests Lint

This project contains the distribution, code, and deployment scripts for the PoolTogether retroactive token claims. The BigQuery output was generated by the Retroactive Query

Setup

Install Dependencies

$ yarn

Compile Contracts

$ yarn compile

Run Tests

$ yarn test

Verify the output from the Retroactive Query

The file bq-results-20210202-094742-fvr9ifm390n3.json contains the full set of rows (ordered by address ascending) of the Retroactive Query. You can follow the steps in that project to generate this file.

In this repo the file merkle_tree.json is generated from the BigQuery output and fed into the contract deployment script. You can generate the merkle proof file yourself using the steps below.

Generate Merkle Proof

First pre-process the BigQuery results (the file is missing commas):

$ ts-node ./scripts/pre-process-json.ts -i bq-results-20210202-094742-fvr9ifm390n3.json > bq-results.processed.json

Now generate a merkle proof blob:

$ ts-node ./scripts/generate-merkle-root -i bq-results.processed.json > merkle-proof.generated.json

You can compare your proof to the committed proof:

$ diff merkle-proof.generated.json merkle_tree.json

You will not see any differences!

Deploy the Contract

The contract deployment script consumes the merkle_tree.json file as the distribution. Make sure this file exists before running the deploy script.

You can deploy to rinkeby:

$ yarn deploy rinkeby

Or you can deploy to mainnet:

$ yarn deploy mainnet

Dependencies (0)

    Dev Dependencies (24)

    Package Sidebar

    Install

    npm i @pooltogether/merkle-distributor

    Weekly Downloads

    0

    Version

    1.0.2

    License

    SEE LICENSE IN LICENSE

    Unpacked Size

    1.64 MB

    Total Files

    80

    Last publish

    Collaborators

    • asselstine