Merkle Payout

This is an implementation of Uniswap's merkle payout contract and is built using hardhat. The original implementation can be found here

This is a sample contract which has been deployed on rinkeby

Features offered

This merkle contract supports

• deploying on mainnet/rinkeby
• on deploy
  • funder
  • token
  • merkleRoot

Read functions

• funder : the address who deposts and can reclaim funds
• token : ERC20 token in which the payouts should happen
• merkleRoot : generated merkle root of the distribution
• hasClaimed : check if an address has a pending claim

Write functions

• claim : allows address to make a claim against the contract
• batchClaim : invoked by funder to trigger all pending claims
• reclaimFunds : invoked by funder and allowed token to be sent back to funder

Events Emitted

• ReclaimFunds : emitted when funder invokes reclaimFunds
• FundsClaimed : emitted when address succesfully invokes claim
• BatchClaimTriggered : emitted when funder succesfully invokes batchClaim

Deploying merkle contract

• Create an .env file and fill out

  • INFURA_ID : Infura ID for deploying contract
  • DEPLOYER_PRIVATE_KEY : address which deploys the contract
  • ETHERSCAN_API_KEY : API key for etherscan verification
  • TOKEN : Access token for the ingest_merkle_claim_to_clr_match API
  • GRANT_PAYOUT_PK : Grant payout primary key
  • API_BASE_URL : Base backend API URL (http://localhost:8000 or https://gitcoin.co)

• Update input.ts parameters

  • PayoutConfig
  • PayoutDistribution[]

• Update verify.ts parameter

  • token
  • merkleRoot
  • funder

• Deploy contract

  yarn deploy:rinkeby #  deploy on rinkeby
  yarn deploy:mainnet #  deploy on mainnet

• Verify contract on etherscan

  # rinkeby
  yarn hardhat verify --constructor-args verify.js --network rinkeby <CONTRACT_ADDRESS>
  # mainnet
  yarn hardhat verify --constructor-args verify.js --network mainnet <CONTRACT_ADDRESS>

• The claims object would be generated and stored in scripts/output.json. This would be required for an address to make a claim Note: To make a claim against via etherscan, the claim object would be of the following format

  [2,'0x5cdb35fADB8262A3f88863254c870c2e6A848CcA','0x4563918244f40000',['0x025ddd38f5815f027203629fc384e2a7beb453a112c2de03feb75dca73aef3bf','0xc1d74d73190dcdd156b817d78d3459ecd5efac2345c34fa48ad52d2ae11dc526','0x2bb06b1200f1a5d9c3d252ec853852c5042118c7fa74781e510ed334add6a1f2','0x2107e84fe9e2588768a806612070bc0c2095c08e70af311cad5ae5c2c0fa27a4']]

• Ingest merkle claims in the backend:

  yarn ingest_merkle_claims

Contract Changes

Any time you make changes to the contract/ deploy scripts. Ensure these steps are run before raising a PR to make changes

hardhat clean   # clean artifacts
hardhat compile # compile contract

yarn lint       # eslint
yarn prettier   # prettier

yarn test       # test

yarn coverage   # coverage report

Coverage Report

Coverage report is built using solidity-coverage plugin.

alias chrome="open -a 'Google Chrome'"

yarn coverage
chrome coverage/index.html

Deploys

Round	Token	Contract Address
GR13	DAI	https://etherscan.io/address/0xF63FD0739cB68651eFbD06BCcb23F1A1623D5520
GR13	UNI	https://etherscan.io/address/0x0019863771b57FBA997cF6602CB2dD572A43e977
GR13	gOHM	https://etherscan.io/address/0x868CBca73915f842A70cD9584D80a57DB5E690C1
GR14	DAI	https://etherscan.io/address/0x2878883dD4345C7b35c13FefC5096dd400814D91
GR14	UDT	https://etherscan.io/address/0x22fDA1F97F2fD078F4609AaF74914ddf436de8e8
GR14	MASK	https://etherscan.io/address/0x62a5A2E85619c0922B32243165B9BAAB27Bc7E63
GR14	AURORA	https://etherscan.io/address/0xeFc138E4e0Fdcd7C9E616cC3E5c356C3ce23B1f2
GR14	GRT	https://etherscan.io/address/0xa640830aFAa6455E198eDa49E085C4C377789ddd