CW20 Exchange

Introduction

The CW20 Exchange ADO is used to sell CW20 tokens for other assets. The token to be sold is specified at instantiation, and then sales can be started on the token by the contract owner by sending them to this ADO. Each sale has an "asset" to purchase the tokens with. This asset can be:

• CW20

• Native

Users can then purchase the CW20 token being sold by sending the required asset to the contract.

Multiple sales can take place at the same time but no two sales can have the same purchasing asset.

ado_type: cw20-exchange

Version: 2.1.0

InstantiateMsg

Rust

pub struct InstantiateMsg {
    pub token_address: AndrAddr,
    pub kernel_address: String,
    pub owner: Option<String>,
}

JSON

{
"token_address":"andr1...",
"kernel_address":"andr1...",
"owner":"andr1..."
}

Name	Type	Description
token_address	AndrAddr	Address of the CW20 token to be sold.
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 sent from the token_address contract by performing a Send. These tokens can be set for sale or used to purchase other CW20 tokens. This depends on the attached hook message.

Rust

pub enum ExecuteMsg {
    Receive(Cw20ReceiveMsg),
   }

Cw20ReceiveMsg

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

The msg in the Cw20ReceiveMsgshould be a base64 encoded Cw20HookMsg.

Cw20HookMsg

The CW20 tokens sent with StartSale should come from the contract address specified at instantiation.

The CW20 tokens sent with Purchase should be the same as the defined Asset from StartSale message.

pub enum Cw20HookMsg {
    StartSale {
        asset: AssetInfo,
        exchange_rate: Uint128,
        recipient: Option<String>,
        start_time: Option<Expiry>,
        duration: Option<MillisecondsDuration>,
    },
    Purchase {
        recipient: Option<String>,
    },
}

StartSale

Only available to the contract owner.

The asset to be traded cannot be the same as the asset being bought specified at instantiation.

Starts a sale on the CW20 tokens sent. This is attached as a msg when sending the CW20 tokens to the Exchange ADO.

Rust

pub enum Cw20HookMsg {
    StartSale {
        asset: AssetInfo,
        exchange_rate: Uint128,
        recipient: Option<String>,
        start_time: Option<Expiry>,
        duration: Option<MillisecondsDuration>,
    }
}

JSON

{
"start_sale":{
    "asset":{
        "native":"uandr"
        },
    "exchange_rate":"5",
    "start_time":{
        "from_now":3200000
        },
    "duration":900000
    }
}

Name	Type	Description
asset	AssetInfo	The asset that may be used to purchase the token.
exchange_rate	Uint128	The amount of the above asset required to purchase a single token.
recipient	Option<String>	The recipient of the sale proceeds. Defaults to the sender if not specified.
start_time	Expiry	Optional start time in milliseconds. If not specified, then the sale will start immediately.
duration	MillisecondsDuration	Optional duration for the sale in milliseconds from the start_time. If not specified then the sale never expires.

AssetInfo

/// Represents an **asset info** instance containing only verified data;
///to be saved in contract storage
pub type AssetInfo = AssetInfoBase<Addr>;

pub enum AssetInfoBase<T> {
    Native(String),
    Cw20(T),
}

• Native SDK coins: To create an asset info instance of this type, provide the denomination

• CW20 tokens: To create an asset info instance of this type, provide the contract address

Purchase

Purchase tokens using the CW20 tokens sent. This is attached as a msg when sending the CW20 tokens to the Exchange ADO.

You need to send an amount wich will get you a whole number in exchange. For example if the exchange rate is 5, then you need to send a multiple of 5 and nothing in between.

Rust

pub enum Cw20HookMsg {
     Purchase {
       recipient: Option<String>,
    }
}

JSON

{
"purchase":{
    "recipient":"andr1..."
    }
} 

Name	Type	Description
recipient	Option<String>	Optional recipient of the purchased CW20 tokens. If not set, defaults to the sender.

---

CancelSale

Only available for the contract owner.

Cancels an ongoing sale.

Rust

pub enum ExecuteMsg {
     CancelSale {
           asset: AssetInfo 
           }
     }

JSON

{
"cancel_sale":{
    "asset":{ 
        "cw20":"andr1..."
        }
    }
}

Name	Type	Description
asset	AssetInfo	The purchasing asset of the sale to cancel.

Purchase

Purchase tokens with native funds.

Dont be confused by the previous Purchase message. Although they share the same name, the first message is attached to a CW20 Send and is used to buy using CW20 tokens while this message is called directly on the CW20 Exchange ADO and is used to buy using native funds.

You need to attach the native funds to the message when calling this Purchase.

Rust

pub enum ExecuteMsg {
    Purchase {
         recipient: Option<String> 
         }
    }

JSON

{
"purchase":{
    "recipient":"andr1..."
    }
}

Name	Type	Description
recipient	Option<String>	Optional recipient to receive the purchased tokens. Defaults to the sender if not specified.

Base Executes

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

QueryMsg

Sale

Queries the sale info for the specified asset.

Rust

pub enum QueryMsg {
    #[returns(SaleResponse)]
    Sale { asset: AssetInfo }
    }

JSON

{
"sale":{
    "asset":{ 
        "cw20":"andr1..."    
        }
    }
}

Name	Type	Description
asset	AssetInfo	The asset of the sale to get info for.

SaleResponse

Rust

pub struct SaleResponse {
    pub sale: Option<Sale>,
}

Name	Type	Description
sale	Option<Sale>	The sale data if it exists.

Sale

pub struct Sale {
    pub exchange_rate: Uint128,
    pub amount: Uint128,
    pub recipient: String,
    pub start_time: Expiration,
    pub end_time: Expiration,
    pub start_amount: Uint128,
}

Name	Type	Description
exchange_rate	Uint128	The amount of exchange asset needed to purchase one token.
amount	Uint128	The amount of tokens for sale at the specified exchange_rate.
recipient	String	The recipient of the sale proceeds.
start_time	Expiration	The time when the sale starts.
end_time	Expiration	The time when the sale ends.
start_amount	Uint128	The amount of CW20 tokens for sale at the given rate at the start of the sale

TokenAddress

Queries the contract address of the token being purchased.

Rust

pub enum QueryMsg {
    #[returns(TokenAddressResponse)]
    TokenAddress {}
    }

JSON

{
"token_address":{}
}

TokenAddressResponse

The address of the token being sold.

pub struct TokenAddressResponse {
    pub address: String,
 }

SaleAssets

Queries the different assets of the sale.

Rust

pub enum QueryMsg {    
    #[returns(SaleAssetsResponse)]
    SaleAssets {
        start_after: Option<String>,
        limit: Option<u32>,
    }
}

JSON

{
"sale_assets":{
    "start_after":"token8",
    "limit": 67
    }
}

Name	Type	Description
start_after	Option<String>	An optional address for which to start after, used for pagination.
limit	Option<u32>	Optional limit to the number of assets that are returned. Default limit is 50 and the max limit is 100.

SaleAssetsResponse

A vec of string containing each of the assets.

pub struct SaleAssetsResponse {
    pub assets: Vec<String>,
}

Base Queries

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