Solana Rewards Distributor

Program Overview

The Rewards Distributor program is designed to efficiently manage and distribute airdrops on Solana using a Merkle tree structure. Each leaf in the tree represents a pair of (user-public-key, airdrop-amount).

By utilizing the Merkle tree root, this approach avoids the high costs of uploading thousands of individual entries to the blockchain, even with Solana's low transaction fees. The program also supports authorized updates to the Merkle root while keeping track of already claimed rewards. This allows reward amounts to be adjusted over time and calculated off-chain, offering flexibility and scalability.

Inspired by Uniswap merkle distributor

Development Guide

Requirements

1. Anchor
2. Yarn

Install Dependencies

To install the required dependencies, run:

yarn

Build program

To build the distributor program, run:

anchor build

Run tests

To execute the test suites, run:

anchor test

Test scenarios are located in the tests/*.spec.ts files

License

This project is distributed under the GPL v3.0 license.

CLI

To run localnet:

yarn localnet

Initialize

yarn cli admin initialize \
  --private-key-file <filename> \
  --cluster <localnet, devnet, testnet or mainnet-beta> \
  --updater <updater_address> \
  --token-mint <token_mint_address>

Example:

yarn cli admin initialize \
  --private-key-file ~/.config/solana/id.json \
  --cluster 'localnet' \
  --updater '88u6FPoAKo9L4V6PzfL1Brz5JGYAdCt2QvjbgTPXZReC' \
  --token-mint '9567hvuTyD6YCm5y3g8P1xCgfg8vh12nETfcfkWWANsy'

Set new admin

yarn cli admin set-admin \
  --private-key-file <filename> \
  --cluster <localnet, devnet, testnet or mainnet-beta> \
  --new-admin <admin_address>

Set new updater

yarn cli admin set-updater \
  --private-key-file <filename> \
  --cluster <localnet, devnet, testnet or mainnet-beta> \
  --new-updater <updater_address>

Update Merkle tree root

yarn cli admin update-root \
  --private-key-file <filename> \
  --cluster <localnet, devnet, testnet or mainnet-beta> \
  --new-root-file <filename>

yarn cli admin update-root \
  --private-key-file ~/.config/solana/id.json \
  --cluster localnet \
  --new-root-file 'root.json'

Shutdown

yarn cli admin shutdown \
  --private-key-file <filename> \
  --cluster <localnet, devnet, testnet or mainnet-beta> \
  --token-mint <token_mint_address>

yarn cli admin shutdown \
  --private-key-file ~/.config/solana/id.json \
  --cluster localnet \
  --token-mint '9567hvuTyD6YCm5y3g8P1xCgfg8vh12nETfcfkWWANsy'

Claim

yarn cli user claim \
  --private-key-file <filename> \
  --cluster <localnet, devnet, testnet or mainnet-beta> \
  --total-amount <amount> \
  --proof-file <filename>

Read states

Config

yarn cli read config \
  --private-key-file <filename> \
  --cluster <localnet, devnet, testnet or mainnet-beta>

Claimed rewards

yarn cli read claimed-rewards \
  --private-key-file <filename> \
  --cluster <localnet, devnet, testnet or mainnet-beta> \
  --claimant <claimant_address>