Merkle-Airdrop

Introduction

The Merkle-Airdrop ADO is a smart contract that allows projects to launch airdrops using the Merkle-tree (hashing). Uses the same logic of the base cw20-merkel-airdrop contract. If you do not know what is a Merkle-airdrop and how it is different from a normal airdrop, please refer to the following article.

The merkle airdorp can be used to either airdrop CW20 tokens or native tokens.

In case of CW20 tokens, the airdrop ADO should be the owner of the CW20 tokens to distribute.

Ado_type: merkle-airdrop

Version: 2.1.0

InstantiateMsg

Rust

pub struct InstantiateMsg {
    pub asset_info: Asset,
    pub kernel_address: String,
    pub owner: Option<String>
}

JSON

{
"asset_info":{
    "cw20_token":"andr1..."
     },
"kernel_address":"andr1...",
"owner":"andr1..."
} 

Name	Type	Description
asset_info	Asset	The assets to airdrop. Can be either a native token or a CW20.
kernel_address	String	Contract address of the kernel contract to be used for AMP messaging. Kernel contract address can be found in our deployed contracts.
owner	Option<String>	Optional address to specify as the owner of the ADO being created. Defaults to the sender if not specified.

ExecuteMsg

RegisterMerkleRoot

Sets the provided Merkle-root that contains the whitelisted addresses that can claim tokens from the airdrop.

Only the owner can execute RegisterMerkleRoot.

Rust

 pub enum ExecuteMsg {
 RegisterMerkleRoot {
        merkle_root: String,
        expiration: Option<Expiry>,
        total_amount: Option<Uint128>,
  }
 }

JSON

{
"register_merkle_root":{
"merkle_root":"876dd0a3ef4a2816ffd1c12ab649825a958b0f...",
"total_amount":"1000000"
  }
}

Name	Type	Description
merkle_root	String	A hex-encoded Merkle root.
expiration	Option<Expiry>	An optional expiration for the root. Defaults to never if not specified.
total_amount	Option<Uint128>	An optional amount to specify the maximum number of tokens that can be claimed from the airdrop.

Claim

Claims the funds assigned to the address executing the claim.

Only addresses found in the Merkle-Root can claim tokens.

Rust

 pub enum ExecuteMsg{  
   Claim {
        stage: u8,
        amount: Uint128,
        proof: Vec<String>,
    }
 }

JSON

{
"claim":{
 "stage": 3,
 "amount":"10000",
 "proof":["876dd0a3ef4a28","..."]
}

Name	Type	Description
stage	u8	Stage is used to index which airdrop to claim from. There can be more than one airdrop and each is referenced by it's designated stage.
amount	Uint128	The amount of tokens to claim.
proof	Vec<String>	Hex-encoded Merkle proof that proves that the address claiming the tokens from the airdrop is found in the Merkle-Root. Needs to be calculated similar to this.

Burn

Burn the remaining tokens (unclaimed) after expire time for the specified stage.

Only the owner can execute Burn.

Rust

 pub enum ExecuteMsg{
   Burn {
        stage: u8,
    }
}

JSON

{
"burn":{
 "stage": 2
   }
 }

Name	Type	Description
stage	u8	The stage of the airdrop used to specify which airdrop to execute burn on.

Base Executes

The rest of the execute messages can be found in the ADO Base section.

Query

Config

Rust

pub enum QueryMsg {
 #[returns(ConfigResponse)]
 Config {}
 }

JSON

{
"config":{}
}

ConfigResponse

Rust

pub struct ConfigResponse {
    pub asset_info: Asset,
}

JSON

{
"asset_info":{
 "cw20_token":"andr1..."
   }
 }

Name	Type	Description
asset_info	Asset	The type of Asset.

MerkleRoot

Queries the Merkle-Root for the specified stage.

Rust

pub enum QueryMsg {
 #[returns(MerkleRootResponse)]
 MerkleRoot {
  stage: u8
  }
}

JSON

{
"merkle_root":{
   "stage": 2
   }
}

stage	u8	The stage which we want to get the Merkle root for.

MerkleRootResponse

Rust

pub struct MerkleRootResponse {
    pub stage: u8,
    pub merkle_root: String,
    pub expiration: Expiration,
    pub total_amount: Uint128,
}

JSON

{
"stage":2,
"merkle_root":"876dd0a3ef4a2816ffd1c12ab649825a958b0f",
"expiration": {
"at_height": 500
 },
 "total_amount":"1000000"
 }

Name	Type	Description
stage	u8	The stage that belongs to this root.
merkle_root	String	The Merkle-Root of this stage.
expiration	Expiration	The expiration for the airdrop of this stage.
total_amount	Uint128	The total amount of funds to be airdropped belonging to this stage.

LatestStage

Queries the last stage.

Rust

pub enum QueryMsg {
  #[returns(LatestStageResponse)]
  LatestStage {}
  }

JSON

{
"latest_stage":{}
}

LastStageResponse

Rust

pub struct LatestStageResponse {
    pub latest_stage: u8,
}

JSON

{
"latest_stage": 4 
}

IsClaimed

Checks if the specified address has claimed the airdrop tokens.

Rust

pub enum QueryMsg {
    #[returns(IsClaimedResponse)]
    IsClaimed {
     stage: u8,
     address: String
      }
    }

JSON

{
"is_claimed": 2,
"address":"andr1..."
}

Name	Type	Description
stage	u8	The stage to check.
address	String	The address to check.

IsClaimedResponse

Rust

pub struct IsClaimedResponse {
    pub is_claimed: bool,
}

JSON

{
"is_claimed": false
}

Name	Type	Description
is_claimed	bool	Returns true if the funds have claimed and false otherwise.

TotalClaimed

Rust

pub enum QueryMsg {
  #[returns(TotalClaimedResponse)]
  TotalClaimed {
    stage: u8
    }
  }

JSON

{
"total_claimed":{
"stage": 2
  }
}

Name	Type	Description
stage	u8	The stage to check the amount claimed.

TotalClaimedResponse

Rust

pub struct TotalClaimedResponse {
    pub total_claimed: Uint128,
}

JSON

{
"total_claimed":"10000"
}

Name	Type	Description
total_claimed	Uint128	The stage to check the amount claimed.

Base Queries

The rest of the query messages can be found in the ADO Base section.