Skip to content

README.md

Latest commit

 

History

History
348 lines (302 loc) · 12.9 KB

README.md

File metadata and controls

348 lines (302 loc) · 12.9 KB

Airdrop Contract

Introduction

Contract responsible to handle snip20 airdrop

Sections

Init

Request
Name Type Description optional
admin String New contract owner; SHOULD be a valid bech32 address yes
dump_address String Where the decay amount will be sent yes
airdrop_token Contract The token that will be airdropped no
airdrop_amount String Total airdrop amount to be claimed no
start_date u64 When the airdrop starts in UNIX time yes
end_date u64 When the airdrop ends in UNIX time yes
decay_start u64 When the airdrop decay starts in UNIX time yes
merkle_root String Base 64 encoded merkle root of the airdrop data tree no
total_accounts u32 Total accounts in airdrop (needed for merkle proof) no
max_amount String Used to limit the user permit amounts (lowers exploit possibility) no
default_claim String The default amount to be gifted regardless of tasks no
task_claim RequiredTasks The amounts per tasks to gift no
query_rounding string To prevent leaking information, total claimed is rounded off to this value no

##Admin

Messages

UpdateConfig

Updates the given values

Request
Name Type Description optional
admin string New contract admin; SHOULD be a valid bech32 address yes
dump_address string Sets the dump address if there isnt any yes
query_rounding String To prevent leaking information yes
start_date u64 When the airdrop starts in UNIX time yes
end_date u64 When the airdrop ends in UNIX time yes
decay_start u64 When the airdrop decay starts in UNIX time yes
padding string Allows for enforcing constant length messages yes

AddTasks

Adds another task that can unlock the users claim percentage, total task percentage cannot exceed 100%

Task
Name Type Description optional
address String The address that will grant the task to accounts no
percent string The percent to be unlocked when completed no
Request
Name Type Description optional
tasks Tasks The new tasks to be added no
padding string Allows for enforcing constant length messages yes
Response
{
  "add_tasks": {
    "status": "success"
  }
}

ClaimDecay

Drains the decayed amount of airdrop into the specified dump_address

Response
{
  "claim_decay": {
    "status": "success"
  }
}

##Task Admin

Messages

CompleteTask

Complete that address' tasks for a given user

Request
Name Type Description optional
address String The address that completed the task no
padding string Allows for enforcing constant length messages yes
Response
{
  "complete_task": {
    "status": "success"
  }
}

##User

Messages

Account

(Creates / Updates) an account from which the user will claim all of his given addresses' rewards

Request
Name Type Description optional
addresses Array of AddressProofPermit Proof that the user owns those addresses no
partial_tree Array of string An array of nodes that serve as a proof for the addresses no
padding string Allows for enforcing constant length messages yes
Response
{
  "account": {
    "status": "success",
    "total": "Total airdrop amount",
    "claimed": "Claimed amount",
    "finished_tasks": "All of the finished tasks",
    "addresses": ["claimed addresses"]
  }
}

DisablePermitKey

Disables that permit's key. Any permit that has that key for that address will be declined.

Request
Name Type Description optional
key string Permit key no
padding string Allows for enforcing constant length messages yes
Response
{
  "disable_permit_key": {
    "status": "success"
  }
}

SetViewingKey

Sets a viewing key for the account, useful for when the network is congested because of permits.

Request
Name Type Description optional
key string Viewing key no
padding string Allows for enforcing constant length messages yes
Response
{
  "set_viewing_key": {
    "status": "success"
  }
}

Claim

Claim the user's available claimable amount

Response
{
  "claim": {
    "status": "success",
    "total": "Total airdrop amount",
    "claimed": "Claimed amount",
    "finished_tasks": "All of the finished tasks",
    "addresses": ["claimed addresses"]
  }
}

Queries

GetConfig

Gets the contract's config

Response

{
  "config": {
    "config": "Contract's config"
  }
}

Dates

Get the contracts airdrop timeframe, can calculate the decay factor if a time is given

Request
Name Type Description optional
current_date u64 The current time in UNIX format yes 
{
  "dates": {
    "start": "Airdrop start",
    "end": "Airdrop end",
    "decay_start": "Airdrop start of decay",
    "decay_factor": "Decay percentage"
  }
}

TotalClaimed

Shows the total amount of the token that has been claimed. If airdrop hasn't ended then it'll just show an estimation.

Request
{
  "total_claimed": {
    "claimed": "Claimed amount"
  }
}

Account

Get the account's information

Request
Name Type Description optional
permit AccountProofPermit Address's permit no
current_date u64 Current time in UNIT format yes 
{
  "account": {
    "total": "Total airdrop amount",
    "claimed": "Claimed amount",
    "unclaimed": "Amount available to claim",
    "finished_tasks": "All of the finished tasks",
    "addresses": ["claimed addresses"]
  }
}

AccountWithKey

Get the account's information using a viewing key

Request
Name Type Description optional
account String Accounts address yes
key String Address's viewing key no
current_date u64 Current time in UNIT format yes 
{
  "account_with_key": {
    "total": "Total airdrop amount",
    "claimed": "Claimed amount",
    "unclaimed": "Amount available to claim",
    "finished_tasks": "All of the finished tasks",
    "addresses": ["claimed addresses"]
  }
}

AddressProofPermit

This is a structure used to prove that the user has permission to query that address's information (when querying account info). This is also used to prove that the user owns that address (when creating/updating accounts) and the given amount is in the airdrop. This permit is written differently from the rest since its made taking into consideration many of Terra's limitations compared to Keplr's flexibility.

NOTE: The parameters must be in order

How to sign

Structure

Name Type Description optional
params FillerMsg Filler params accounting for Terra Ledgers limitations no
memo String Base64Encoded AddressProofMsg no
chain_id String Chain ID of the network this proof will be used in no
signature PermitSignature Signature of the permit no

FillerMsg

{
  "coins": [],
  "contract": "",
  "execute_msg": "",
  "sender": ""
}

AddressProofMsg

The information inside permits that validate the airdrop eligibility and validate the account holder's key.

NOTE: The parameters must be in order

Structure

Name Type Description optional
address String Address of the signer (might be redundant) no
amount String Airdrop amount no
contract String Airdrop contract no
index Integer Index of airdrop data in reference to the original tree no
key String Some permit key no

AccountProofMsg

The information inside permits that validate account ownership

NOTE: The parameters must be in order

Structure

Name Type Description optional
contract String Airdrop contract no
key String Some permit key no

PermitSignature

The signature that proves the validity of the data

NOTE: The parameters must be in order

Structure

Name Type Description optional
pub_key pubkey Signer's public key no
signature String Base 64 encoded signature no

Pubkey

Public key

NOTE: The parameters must be in order

Structure

Name Type Description optional
type String Must be tendermint/PubKeySecp256k1 no
value String The base 64 key no