Yieldnest Airdrop Contracts

This repository contains the smart contracts and scripts for deploying the Yieldnest Airdrop. It leverages the Foundry development toolkit for testing, building, and deploying contracts. The project includes Solidity contracts for the airdrop, deployment scripts, and utilities for managing input data.

Project Overview

This repository includes:

• Smart Contracts: Contracts that manage the airdrop mechanism for Yieldnest tokens.
• Deployment Scripts: Scripts for deploying and configuring the airdrop contracts, including data processing utilities.
• Testing Framework: Tests using Foundry's Forge tool for the contracts and utilities.

Key Contracts and Scripts

• Main Contracts:

  • Airdrop.sol: The core contract for managing the airdrop.
  • IAirdrop.sol: Interface for the Airdrop contract.

• Deployment Scripts:

  • DeployAirdrop.s.sol: Script to deploy the Airdrop contract.

Prerequisites

• Foundry: A fast, portable, and modular toolkit for Ethereum development.
• Solidity: For developing smart contracts.
• Bash: Required for running shell scripts, including the CSV to JSON converter.

Installation

1. Clone the Repository

git clone https://github.com/yieldnest/yieldnest-airdrop.git
cd airdrop-contracts

2. Install Dependencies

This project uses foundry to manage dependencies:

forge install

Environment Variables

Before running the scripts, ensure you have set up your environment variables. Copy the .env.example file and provide the required values.

cp .env.example .env

Required Environment Variables

• ETHERSCAN_API_KEY: Your Etherscan API key for contract verification.
• MAINNET_RPC_URL: Full archival node URL for Mainnet.
• DEPLOYER_ACCOUNT_NAME: The deployer's account name, stored in your local cast wallet.
• DEPLOYER_ADDRESS: The deployer's public address.

Usage

Build

To compile the Solidity contracts, use:

forge build

Compile

You can compile the contracts with the following command:

forge compile

Test

Run the tests using Forge’s testing framework:

forge test -vvv

Gas Snapshots

To generate gas usage reports for the contracts, run:

forge snapshot

Lint

To check for linting issues in Solidity files, run:

forge fmt --check && solhint "{script,src,test}/**/*.sol"

Format

To format the Solidity code using Foundry:

forge fmt

Deployment

To deploy the Airdrop contract, use the provided Makefile. This project supports deploying with input data files in both CSV and JSON formats.

Deploying the Airdrop Contract

1. Simulate the Deployment: Simulate a deployment to check for errors using the following command:

   make simulate json=script/inputs/ynETH.json network=mainnet

2. Deploy the Contracts: To deploy the Airdrop contract to Mainnet, run:

   make deploy json=script/inputs/ynETH.json network=mainnet

   Note: Before running the deployment command, ensure the following environment variables are properly set:

   • MAINNET_RPC_URL (full archival node for Mainnet)
   • ETHERSCAN_API_KEY (for verifying contracts)
   • DEPLOYER_ACCOUNT_NAME (name of the deployer's account in the cast wallet)
   • DEPLOYER_ADDRESS (the deployer's public address)

The Makefile automates many aspects of the deployment, allowing you to easily convert input data and deploy the contract.

Deployment verification

Run for Holesky:

forge script script/VerifyDeployment.s.sol  --rpc-url https://rpc.ankr.com/eth_holesky --sig "run(string memory)" script/inputs/season-one-holesky.json

Run equivalent for Mainnet:

forge script script/VerifyDeployment.s.sol  --rpc-url [your own rpc]  --sig "run(string memory)" script/inputs/season-one.json

Example JSON Input File

Below is an example structure for the JSON input file used for the airdrop:

{
  "token": "0x0000000000000000000000000000000000000000",
  "rewardsSafe": "0x0000000000000000000000000000000000000000",
  "userAmounts": [
    {
      "user": "0x00000000051CBcE3fD04148CcE2c0adc7c651829",
      "amount": 38593
    },
    {
      "user": "0x000da9776cb42F19a7566385D0191E66F2Cb007a",
      "amount": 901128
    }
  ]
}

This file specifies the addresses and corresponding airdrop points for each recipient. These points will be used to calculate the distribution amounts during the airdrop.

Makefile Commands

The Makefile provides a set of useful commands to manage the project:

• make install: Install project dependencies.
• make clean: Remove cache and output directories.
• make build: Build the project.
• make test: Run the test suite.
• make simulate: Simulate the deployment without broadcasting.
• make deploy: Deploy the contract to the network specified.

Project Structure

• src/: Contains the core smart contracts for the airdrop system.
• script/: Contains deployment scripts and input data utilities.
• test/: Contains unit tests for the airdrop contracts.
• deployments/: Stores deployment artifacts and related configurations.
• .solhint.json: Configuration file for Solidity linting.
• foundry.toml: Foundry configuration file.
• remappings.txt: Foundry remappings for import resolution.
• .env.example: Example environment variable configuration file.

License

This project is licensed under the MIT License.