Rate Limiting Withdrawals

Introduction

The Rate Limiting Withdrawals ADO acts as a bank account that limits the frequency and size of an account holder's withdrawals. Only one type of coin can be used.

Ado_type: rate-limiting-withdrawals

Version: 2.1.0-beta.1

InstantiateMsg

Rust

pub struct InstantiateMsg {
    pub allowed_coin: CoinAndLimit,
    pub minimal_withdrawal_frequency: MinimumFrequency,
    pub kernel_address: String,
    pub owner: Option<String>,
}

JSON

{
"allowed_coin":{
    "coin":"uandr",
    "limit":"500"
    },
"minimal_withdrawal_frequency":{
    "time":{
        "time":3600000
        }
    },
"kernel_address":"andr1...",
"owner":"andr1..."
}

Name	Type	Description
allowed_coin	CoinAndLimit	Set the allowed coin denom and the maximum amount allowed to withdraw.
minimal_withdrawal_frequency	MinimumFrequency	The time required between withdrawals. Specified in milliseconds. Cannot be 0.
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.

CoinAndLimit

pub struct CoinAndLimit {
    pub coin: String,
    pub limit: Uint128,
}

Name	Type	Description
coin	String	Sets the accepted coin denom.
limit	Uint128	Sets the withdrawal limit in terms of amount.

MinimumFrequency

pub enum MinimumFrequency {
     Time { time: MillisecondsDuration },
     }

• Time: A time in milliseconds. For example 3600 would specify that each the user needs to wait 3600 milliseconds between withdrawals.

ExecuteMsg

Deposits

Deposit funds for the specified recipient.

Only the allowed coin in instantiation can be deposited.

Rust

pub enum ExecuteMsg {
    Deposits {
        recipient: Option<String>,
    }
}

JSON

{
"deposits":{
    "recipient":"andr1..."
    }
}

Name	Type	Description
recipient	Option<String>	The owner of the deposited funds. If not set, defaults to the sender.

WithdrawFunds

Withdraw funds from the available balance.

Enough time should pass since the last withdrawal.

Rust

pub enum ExecuteMsg{
     WithdrawFunds {
        amount: Uint128,
    }
}

JSON

{
"withdraw_funds":{
    "amount":"100"
    }
}

Name	Type	Description
amount	Uint128	The amount of coins to withdraw.

Base Executes

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

QueryMsg

CoinAllowanceDetails

Provides the allowed coin and limits for withdrawal size and frequency.

Rust

pub enum QueryMsg{
    #[returns(CoinAllowance)]
    CoinAllowanceDetails {}
    }

JSON

{
"coin_allowance_details":{}
}

CoinAllowance

Returns a CoinAllowance struct.

Rust

pub struct CoinAllowance {
    pub coin: String,
    pub limit: Uint128,
    pub minimal_withdrawal_frequency: MillisecondsDuration,
}

JSON

{
"coin":"uandr",
"limit":"50000",
"minimal_withdrawal_frequency": 3600000
}

Name	Type	Description
coin	string	The coin denom.
limit	Uint128	The amount allowed to withdraw per withdrawal.
minimal_withdrawal_frequency	MillisecondsDuration	The time required between withdrawals. Specified in milliseconds.

AccountDetails

Shows the balance and latest withdrawal time.

Rust

pub enum QueryMsg{
     #[returns(AccountDetails)]
     AccountDetails {
        account: String,
    }
}

JSON

{
"account_details":{
    "account":"andr1..."
    }
}

Name	Type	Description
account	String	The address to check the account for.

AccountDetails

Returns an AccountDetails struct.

Rust

pub struct AccountDetails {
    pub balance: Uint128,
    pub latest_withdrawal: Option<Timestamp>,
}

JSON

{
"balance":"100000",
"latest_withdrawal":"1658744585559151746"
}

Name	Type	Description
balance	Uint128	The balance of the specified address.
latest_withdrawal	Option<Timestamp>	The time of the last withdrawal of the specified address.

Base Queries

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