Lockdrop

Introduction

This ADO is another part of the toolkit of allowing a user to setup their own CW20 token. The lockdrop ADO allows users to deposit a native token in exchange for a given CW20 token.

There are two phases:

• The first phase is the deposit phase in which users can deposit a native denom. They can also freely withdraw in this time.

• The second phase is the withdrawal phase, in which for the first half, users can withdraw up to half of their deposit, and in the second half, the amount they can withdraw decreases linearly from 50% to 0%. Users can only withdraw once during the withdrawal phase.

After the deposit phase is over, each user gets the token in proportion to how much of the native denom they put in (claims need to be enabled first.)

Ado_type: lockdrop

Version: 2.1.0

InstantiateMsg

Withdrawal window should be greater than 0.

Deposit window should be greater than 0.

Withdrawal window should be less than deposit window.

Rust

pub struct InstantiateMsg {
    pub init_timestamp: MillisecondsExpiration,
    pub deposit_window: MillisecondsDuration,
    pub withdrawal_window: MillisecondsDuration,
    pub incentive_token: AndrAddr,
    pub native_denom: String,
    pub kernel_address: String,
    pub owner: Option<String>
}

JSON

{
"init_timestamp":164987751339483294,
"deposit_window":600000,
"withdrawal_window":400000,
"incentive_token":"andr1...",
"native_denom":"uandr",
"kernel_address":"andr1..."
}

Name	Type	Description
init_timestamp	MillisecondsExpiration	Timestamp in milliseconds till when deposits can be made.
deposit_window	MillisecondsDuration	Number of milliseconds for which lockup deposits will be accepted.
withdrawal_window	MillisecondsDuration	Number of milliseconds for which lockup withdrawals will be allowed. Cannot exceed the deposit_window.
incentive_token	AndrAddr	The CW20 token being given as incentive.
native_denom	String	The native token being deposited.
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

Receive

Receives CW20 tokens that will be used as incentive for the lockdrop.

The sender needs to be the CW20 contract of the incentive token (Same as the one specified in instantiation).

Needs to be sent before the withdrawal period.

Rust

pub enum ExecuteMsg {
    Receive(Cw20ReceiveMsg)
    }

Cw20ReceiveMsg

pub struct Cw20ReceiveMsg {
    pub sender: String,
    pub amount: Uint128,
    pub msg: Binary,
}

The msg in Cw20ReceiveMsg should be a Cw20HookMsg of type IncreaseIncentives

IncreaseIstncentives

Rust

pub enum Cw20HookMsg {
    IncreaseIncentives {},
}

JSON

{
"increase_incentives":{}
}

---

DepositNative

Deposit native fund in the contract in exchange for receiving a proportion of the Cw-20 incentive tokens.

Deposit window should be open.

A single type of native coins should be attached with the same denom specified in the instantiation by native_denom.

Rust

pub enum ExecuteMsg {
    DepositNative {},
 }    

JSON

{
"deposit_native":{}
}

WithdrawNative

Withdraw native funds from the lockup position.

Withdrawal window needs to be open.

The amount should not exceed the maximum withdrawal allowed.

Rust

pub enum ExecuteMsg {
  WithdrawNative {
        amount: Option<Uint128>,
    }
}

JSON

{
"withdraw_native": {
    "amount":"1000"
    }
}

Name	Type	Description
amount	Option<Uint128>	The amount of native funds to withdraw.

EnableClaims

EnableClaims can be called by anyone after the deposit and withdrawing phases have ended.

Rust

pub enum ExecuteMsg {
    EnableClaims {},
    }

JSON

{
"enable_claims":{}
}

ClaimRewards

Claims the CW20 incentive tokens from the lockdrop.

Rust

pub enum ExecuteMsg {
    ClaimRewards {}
    }

JSON

{
"claim_rewards":{}
}

Base Executes

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

QueryMsg

Config

Queries the config of the contract.

Rust

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

JSON

{
"config":{}
}

ConfigResponse

Rust

pub struct ConfigResponse {
    pub init_timestamp: MillisecondsExpiration,
    pub deposit_window: MillisecondsDuration,
    pub withdrawal_window: MillisecondsDuration,
    pub lockdrop_incentives: Uint128,
    pub incentive_token: AndrAddr,
    pub native_denom: String,
}

• lockdrop_incentives is the total amount of lockdrop incentive tokens (Cw20 tokens) to be distributed among the users.

The rest of the field definitions are the same as the one in the InstantiateMsg.

State

Queries the current state of the contract.

Rust

pub enum QueryMsg {
    #[returns(StateResponse)]
    State {},
}

JSON

{
"state":{}
}

StateResponse

Rust

 pub struct StateResponse {
        pub total_native_locked: Uint128,
        pub are_claims_allowed: bool,
    }

JSON

{
"total_native_locked":"100000",
"are_claims_allowed": false
}

Name	Type	Description
total_native_locked	Uint128	Total native coins deposited at the end of Lockdrop window. This value remains unchanged post the lockdrop window.
are_claims_allowed	bool	Boolean value indicating if the user can withdraw their token rewards or not.

UserInfo

Gets information for the user with the address specified.

Rust

pub enum QueryMsg {
     #[returns(UserInfoResponse)]
     UserInfo {
        address: String,
    }
}

JSON

{
"user_info": {
    "address":"andr1..."
    }
}

Name	Type	Description
address	String	The user address to get the info for.

UserInfoResponse

Rust

pub struct UserInfoResponse {
    pub total_native_locked: Uint128,
    pub total_incentives: Uint128,
    pub is_lockdrop_claimed: bool,
    pub withdrawal_flag: bool,
}

JSON

{
"total_native_locked":"1000",
"total_incentives":"50000",
"is_lockdrop_claimed": true,
"withrawal_flag": true
}

Name	Type	Description
total_native_locked	Uint128	Total UST amount deposited by the user across all his lockup positions.
total_incentives	Uint128	The total amount of incentive tokens for the user.
is_lockdrop_claimed	bool	Whether the lockdrop tokens have been claimed by the user or not.
wtihdrawal_flag	bool	Whether or not the user has withdrawn during the withdrawal phase.

WithdrawalPercentAllowed

Returns the max withdrawable percent for a position.

The provided timestamp cannot be in the past.

Rust

pub enum QueryMsg {
      #[returns(Decimal)]
      WithdrawalPercentAllowed {
            timestamp: Option<Milliseconds>,
    }
}

JSON

{
"withdrawal_percent_allowed":{
    "timestamp": 1705341474
    }
}

Name	Type	Description
timestamp	Option<u64>	The timestamp in milliseconds to check the maximum withdrawal allowed for. If not specified, the current timestamp will be used.

Returns a number of type Decimal representing the percentage allowed to withdraw.

Base Queries

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