Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/developer-dao/token-airdrop-whitelist
Power an airdrop to a predefined set of addresses
https://github.com/developer-dao/token-airdrop-whitelist
erc20 solidity
Last synced: 2 months ago
JSON representation
Power an airdrop to a predefined set of addresses
- Host: GitHub
- URL: https://github.com/developer-dao/token-airdrop-whitelist
- Owner: Developer-DAO
- Created: 2021-11-13T18:01:13.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2021-12-03T20:21:18.000Z (about 3 years ago)
- Last Synced: 2024-04-14T02:01:10.387Z (9 months ago)
- Topics: erc20, solidity
- Language: TypeScript
- Homepage:
- Size: 1020 KB
- Stars: 32
- Watchers: 2
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DevCoin
## What is this?
This is a project to power an airdrop of tokens according to some predefined criteria. There is an ERC20 smart contract with a capped number of tokens.
When the contract is deployed, some portion of the tokens reserved for the airdrop are made available to a whitelisted set of addresses, and the remaining tokens go to a treasury wallet. After some time any tokens unclaimed in the airdrop can be swept up into the treasury.
The use case is for the [Developer DAO](https://www.developerdao.com/), allowing holders of the first (free) Developer DAO NFTs to claim a number of tokens for themselves. This project can be easily modified to support any desired criteria for whitelisting airdrop recipients.
## Quickstart:
Create `.env` (optional, just for testing):
```
ETHERSCAN_API_KEY=$APIKEY
ROPSTEN_URL=https://eth-kovan.alchemyapi.io/v2/$APIKEY
PRIVATE_KEY=0xabcdef1234...
INFURA_KEY=https://mainnet.infura.io/v3/$APIKEY
```
- Modify (contracts/DevCoin.sol)[contracts/DevCoin.sol] to your liking.
- `npm run snapshot:nft` -- gets a list of addresses who hold a given NFT.
- `npm run generate:proofs` -- generates a mapping of address => proof.
- `npm run build` -- compiles contract.
- `npm test` -- tests contract. It is highly recommended to read to understand how the contract works.
- `npm run deploy:local` -- deploy to local hardhat network.
- `npm run deploy:ropsten` -- deploy to ropsten hardhat network.
An included sample web3 script to get a proof for your wallet address is in [web/](web).
## Technical details
The challenge that this project solves is defining a whitelist of approved addresses which may claim tokens in the airdrop. It is inefficient to deploy or maintain a large list of whitelisted addresses in a contract, so instead a merkle tree is used. The contract is supplied with the merkle root of a tree whose leaves consist of addresses of whitelisted recipients. For a whitelisted recipient to claim their token they must present a merkle proof that corresponds to their address (can be done via web UI).
When a whitelisted holder presents their merkle proof to the `claim()` function, if their address matches the proof and belongs in the merkle tree, they are approved to claim their airdrop tokens, once.
### Uses:
- **OpenZeppelin** for contract foundation
- **HardHat** for contract testing
- **Ethers.js** for sample web3 app
- **merkletree.js** for merkle proof generation
## Diagram
# Performance optimizations
For faster runs of your tests and scripts, consider skipping ts-node's type checking by setting the environment variable `TS_NODE_TRANSPILE_ONLY` to `1` in hardhat's environment. For more details see [hardhat documentation](https://hardhat.org/guides/typescript.html#performance-optimizations).
## Credits
- [Mischa Spiegelmock](https://twitter.com/spiegelmock) @DeveloperDAO @JetBridge
If you make money with this feel free to send me some at `mish.eth`