# Marketplace ## Introduction The **Marketplace** ADO is a smart contract that allows you to sell your NFTs in a marketplace. The seller sends their NFT to the Marketplace ADO and attaches the sale options such as the price and funds used to purchase the NFT. Once the NFT is sent, the sale will start at the time specified by the seller. Purchasing the NFT can be customized to work with one of the following options: * **Native:** By specifying the denom of the chain in the [StartSale](#start-sale) message. * **CW20:** By specifying the contract address of the CW20 token to be used in the StartSale. The CW20 tokens allowed to be set as the purchasing token can be restricted by specifying `authorized_cw20_address` at instantiation. If this is not specified, then any CW20 token can be set. {% hint style="warning" %} Each sale is assigned an Id which starts at 1 and increments for each new sale. {% endhint %} **Ado\_type:** marketplace **Version: 2.3.0** ## InstantiateMsg {% tabs %} {% tab title="Rust" %} ```rust pub struct InstantiateMsg { pub authorized_cw20_address: Option, pub authorized_token_addresses: Option>, pub kernel_address: String, pub owner: Option } ``` {% endtab %} {% tab title="JSON" %} ```json { "authorized_cw20_address":"andr1...", "kernel_address":"andr1..." } ``` {% endtab %} {% endtabs %}
NameTypeDescription
authorized_cw20_addressOption<AndrAddr>Optional CW20 address to authorize to be used as the purchasing coin for the NFTs in the marketplace sale. If not specified, then any CW20 can be set as the purchasing coin.
authorized_token_addressesOption<Vec<AndrAddr>Optional set of CW721 contract addresses to be allowed to send NFTs to the Marketplace ADO. If not specified, then any CW721 can send NFTs to the marketplace to be sold.
kernel_addressStringContract address of the kernel contract to be used for AMP messaging. Kernel contract address can be found in our deployed contracts.
ownerOption<String>Optional address to specify as the owner of the ADO being created. Defaults to the sender if not specified.
## ExecuteMsg ### ReceiveNft Receives a token from a [`SendNft`](https://docs.andromedaprotocol.io/andromeda/cw721#sendnft) and starts an auction based on the given parameters in the **StartSale** struct. {% hint style="warning" %} This message is not called by the user on this ADO, but is the case that handles receiving NFTs from a CW721 ADO. {% endhint %} {% tabs %} {% tab title="Rust" %} ```rust pub enum ExecuteMsg { ReceiveNft(Cw721ReceiveMsg) } ``` {% endtab %} {% endtabs %} #### Cw721ReceiveMsg ```rust pub struct Cw721ReceiveMsg { pub sender: String, pub token_id: String, pub msg: Binary, } ``` The `msg` in the `Cw721ReceiveMsg` should be a base64 encoded binary of a `Cw721HookMsg`. ### Start Sale A CW721 hook message that starts a new sale with the given parameters. {% tabs %} {% tab title="Rust" %} ```rust pub enum Cw721HookMsg { StartSale { price: Uint128, coin_denom: Asset, start_time: Option, duration: Option, recipient: Option, } } ``` {% endtab %} {% tab title="JSON" %} ```json { "start_sale": { "price":"500000", "coin_denom":{ "native_token":"uandr" }, "start_time":{ "from_now":7200000 }, "duration": 60000000, "recipient":{ "address":"andr1..." } } } ``` {% endtab %} {% endtabs %}
NameTypeDescription
priceUint128The price of the NFT, which is the amount of coin_denom needed to buy the NFT.
coin_denomAssetThe denom to be used to buy the NFT. Can be either a CW20 or native funds. For CW20, provide the contract address e.g. "andr1...". For native provide the denom e.g. "uandr".
start_timeOption<Expiry>Optional start time in milliseconds. If not specified, then the sale will start immediately.
durationOption<MillisecondsDuration>Optional duration for the sale in milliseconds from the start_time. If not specified then the sale never expires.
uses_cw20boolWhether a CW20 token is used to purchase the NFT or not.
recipientOption<Recipient>Optional address to receive the funds from the NFT sale. If not specified, then the funds will go to the sender of the NFT.
*** ### Receive Receives tokens from a CW20 [Send](https://docs.andromedaprotocol.io/andromeda/cw20#send) message to be used to buy an NFT. {% hint style="warning" %} This message is not called by the user on this ADO, but is the case that handles receiving CW20 tokens from a CW20 ADO. {% endhint %} {% tabs %} {% tab title="Rust" %} ```rust pub struct Cw20ReceiveMsg { pub sender: String, pub amount: Uint128, pub msg: Binary, } pub enum ExecuteMsg { Receive(Cw20ReceiveMsg), } ``` {% endtab %} {% endtabs %} {% hint style="warning" %} In order to buy and NFT using a CW20, you need to define the message of the `Cw20ReceiveMsg` as a `Cw721HookMsg`. {% endhint %} ### Buy (CW20) Buys an NFT using the sent CW20 tokens. {% hint style="warning" %} You need to get the base64 encoded representation of the JSON message and attach it as the `msg` field for the CW20 **Send** message. The Owner of the NFT is not allowed to buy it. {% endhint %} {% tabs %} {% tab title="Rust" %} ```rust pub enum Cw20HookMsg { Buy { token_id: String, token_address: String, }, } ``` {% endtab %} {% tab title="JSON" %} ```json { "buy":{ "token_id":"1", "token_address":"andr1..." } } ``` {% endtab %} {% endtabs %} | Name | Type | Description | | --------------- | ------ | --------------------------------------------------- | | `token_id` | String | The token id of the NFT you want to buy. | | `token_address` | String | The address of the NFT contract the NFT belongs to. | *** ### UpdateSale Update the price and denom for the sale of the token. {% hint style="warning" %} Only available to the NFT owner. {% endhint %} {% tabs %} {% tab title="Rust" %} 
pub enum ExecuteMsg {
    UpdateSale {
        token_id: String,
        token_address: String,
        price: Uint128,
        coin_denom: Asset,
        recipient:Option<Recipient>
    }
}
{% endtab %} {% tab title="JSON" %} ```json { "update_sale":{ "token_id":"1", "token_address":"andr1...", "price":"100", "coin_denom":{ "native_token":"native" }, "recipient":{ "address":"andr1..." } } } ``` {% endtab %} {% endtabs %} | Name | Type | Description | | --------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `token_id` | String | The Id of the token to update the sale for. | | `token_address` | String | The address of the cw721 contract that minted the token. | | `price` | Uint128 | The price of the NFT, which is the amount of `coin_denom` needed to buy the NFT. | | `coin_denom` | [Asset](https://docs.andromedaprotocol.io/andromeda/platform-and-framework/common-types#asset) | The denom to be used to buy the NFT. Can be either a CW20 or native funds. For CW20, provide the contract address e.g. "**andr1...**". For native provide the denom e.g. "**uandr**". | | `recipient` | Option<[Recipient](https://docs.andromedaprotocol.io/andromeda/platform-and-framework/common-types#recipient)> | Optional address to receive the funds from the NFT sale. If not specified, then the funds will go to the sender of the NFT. | ### Buy Buys the NFT that is for sale. {% hint style="warning" %} Dont forget to attach the required funds. The Owner of the NFT is not allowed to buy it. {% endhint %} {% tabs %} {% tab title="Rust" %} 
pub enum ExecuteMsg { 
 Buy {
        token_id: String,
        token_address: String,
     }
  }
{% endtab %} {% tab title="JSON" %} ```json { "buy":{ "token_id":"1", "token_address":"andr1..." } } ``` {% endtab %} {% endtabs %} | Name | Type | Description | | --------------- | ------ | ---------------------------------------------------- | | `token_id` | String | The Id of the NFT to buy. | | `token_address` | String | The address of the cw721 that minted the NFT to buy. | ### AuthorizeContract Authorize a CW721 or CW20 contract to send tokens to this ADO. {% hint style="warning" %} Only available to the contract owner. CW721 is used to send NFTs to be sold, and CW20 is used to send tokens to be used in sales. For CW721, the action should be specified as "send\_nft". For CW20, the action should be specified as "send\_cw20". {% endhint %} {% tabs %} {% tab title="Rust" %} ```rust pub enum ExecuteMsg { AuthorizeContract { action: PermissionAction, addr: AndrAddr, expiration: Option, }, } ``` {% endtab %} {% tab title="JSON" %} ```json { "authorize_contract":{ "action":"send_cw20", "addr":"andr1..." } } ``` {% endtab %} {% endtabs %} | Name | Type | Description | | ------------ | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | | `action` | [PermissionAction](#permissionaction) | The action to authorize the specified address to do. | | `addr` | [AndrAddr](https://docs.andromedaprotocol.io/andromeda/platform-and-framework/common-types#andraddr) | The contract address of the CW721 (NFT) contract to authorize. | | `expiration` | Option<[Expiry](https://docs.andromedaprotocol.io/andromeda/platform-and-framework/common-types#expiry)> | An optional expiration for the permission. | #### PermissionAction ```rust #[cw_serde] pub enum PermissionAction { SendCw20, SendNft, } ``` **SendCw20:** Used in case the ADO to authorize/deauthorize is a CW20 ADO. **SendNFT:** Used in case the ADO to authorize/deauthorize is a CW721 ADO. ### DeauthorizeContract Removes authorization from a CW721 or CW20 contract to send tokens to this ADO. {% hint style="warning" %} Only available to the contract owner. For CW721, the action should be specified as "send\_nft". For CW20, the action should be specified as "send\_cw20". {% endhint %} {% tabs %} {% tab title="Rust" %} ```rust pub enum ExecuteMsg { DeauthorizeContract { action: PermissionAction, addr: AndrAddr, }, } ``` {% endtab %} {% tab title="JSON" %} ```json { "deauthorize_contract":{ "action":"send_nft", "addr":"andr1..." } } ``` {% endtab %} {% endtabs %} | Name | Type | Description | | -------- | ---------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | | `action` | [PermissionAction](#permissionaction) | The action to deauthorize the specified address to do. | | `addr` | [AndrAddr](https://docs.andromedaprotocol.io/andromeda/platform-and-framework/common-types#andraddr) | The contract address of the CW721 (NFT) contract to remove authorization for. | ### CancelSale Cancels the sale for the specified NFT. {% hint style="warning" %} Only the NFT owner can cancel the sale. {% endhint %} {% tabs %} {% tab title="Rust" %} ```rust pub enum ExecuteMsg { CancelSale { token_id: String, token_address: String, } } ``` {% endtab %} {% tab title="JSON" %} ```json { "cancel_sale":{ "token_id":"1", "token_address":"andr1..." } } ``` {% endtab %} {% endtabs %} | Name | Type | Description | | --------------- | ------ | -------------------------------------------------------------------- | | `token_id` | String | The Id of the NFT to cancel the sale for. | | `token_address` | String | The address of the cw721 that minted the NFT to cancel the sale for. | ### Base Executes The rest of the execute messages can be found in the[ ADO Base](https://docs.andromedaprotocol.io/andromeda/platform-and-framework/ado-base) section. ## QueryMsg ### LatestSaleState Gets the latest sale state for the given token. This will either be the current sale if there is one in progress or the last completed one. {% tabs %} {% tab title="Rust" %} ```rust pub enum QueryMsg { #[returns(SaleStateResponse)] LatestSaleState { token_id: String, token_address: String, } } ``` {% endtab %} {% tab title="JSON" %} ```json { "latest_sale_state":{ "token_id":"1", "token_address":"andr1..." } } ``` {% endtab %} {% endtabs %} | Name | Type | Description | | --------------- | ------ | ------------------------------------------------------ | | `token_id` | String | The Id of the token to check. | | `token_address` | String | The address of the cw721 that minted the NFT to check. | #### SaleStateResponse {% tabs %} {% tab title="Rust" %} ```rust pub struct SaleStateResponse { pub sale_id: Uint128, pub coin_denom: String, pub price: Uint128, pub status: Status, pub start_time: Expiration, pub end_time: Expiration, pub recipient: Option, } ``` {% endtab %} {% tab title="JSON" %} ```json { "sale_id":"3", "coin_denom":"uandr", "price":"100", "status":"open", "start_time":{ "expiration":{ "at_time":"1146593483949835832" } }, "end_time":{ "expiration":{ "at_time":"1246593483949835832" } } } ``` {% endtab %} {% endtabs %} | Name | Type | Description | | ------------ | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `sale_id` | Uint128 | The Id of the sale. The first sale has an Id of 1 and each sale after it increments the Id by 1. | | `coin_denom` | String | The denom used in the sale. | | `price` | Uint128 | The price of the NFT. | | `status` | Status |

The status of the sale which can be one of the following options:

-Open

-Expired

-Executed

-Cancelled

| | `start_time` | [Expiration](https://docs.andromedaprotocol.io/andromeda/platform-and-framework/common-types#expiration) | The time the sale on the NFT will start. | | `end_time` | [Expiration](https://docs.andromedaprotocol.io/andromeda/platform-and-framework/common-types#expiration) | The time the the sale on the NFT will end. | | `recipient` | Option<[Recipient](https://docs.andromedaprotocol.io/andromeda/platform-and-framework/common-types#recipient)> | The address that will receive the funds from the sale of the NFT. | ### SaleState Gets the sale state for the given sale Id. {% tabs %} {% tab title="Rust" %} ```rust pub enum QueryMsg #[returns(SaleStateResponse)] SaleState { sale_id: Uint128, } } ``` {% endtab %} {% tab title="JSON" %} ```json { "sale_state":{ "sale_id":"1" } } ``` {% endtab %} {% endtabs %} | Name | Type | Description | | --------- | ------- | ---------------------------- | | `sale_id` | Uint128 | The Id of the sale to check. | Returns a [SaleStateResponse](#salestateresponse). ### SaleIds Queries the sale Ids of the specified token. {% tabs %} {% tab title="Rust" %} ```rust pub enum QueryMsg { #[returns(SaleIdsResponse)] SaleIds { token_id: String, token_address: String, } } ``` {% endtab %} {% tab title="JSON" %} ```json { "sale_ids":{ "token_id":"1", "token_address":"andr1..." } } ``` {% endtab %} {% endtabs %} | Name | Type | Description | | --------------- | ------ | --------------------------------------------- | | `token_id` | String | The Id of the token to check the sale for. | | `token_address` | String | The address of the cw721 that minted the NFT. | Returns the Ids of the sales that have been conducted on the NFT. ### SaleInfosForAddress Get sale information on the provided CW721 token address. {% tabs %} {% tab title="Rust" %} ```rust pub enum QueryMsg { #[returns(Vec)] SaleInfosForAddress { token_address: String, start_after: Option, limit: Option, } } ``` {% endtab %} {% tab title="JSON" %} ```json { "sale_infos_for_address":{ "token_address":"andr1..." } } ``` {% endtab %} {% endtabs %} | Name | Type | Description | | --------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | `token_address` | String | The cw721 contract address to check the sales for. | | `start_after` | Option\ | Optional parameter to specify which `SaleInfo` to start from. If none specified index `0` will be used. | | `limit` | Option\ | Optional parameter to specify how many `SaleInfo` to query. If none specified a default limit of 10 is used. The maximum limit is 30. | #### SaleInfo A `Vec` is returned. {% tabs %} {% tab title="Rust" %} ```rust pub struct SaleInfo { pub sale_ids: Vec, pub token_address: String, pub token_id: String, } ``` {% endtab %} {% endtabs %} | Name | Type | Description | | --------------- | ------------- | ------------------------------------------ | | `sale_ids` | Vec\ | The Ids of the sales conducted on the NFT. | | `token_address` | String | The cw721 contract address. | | `token_id` | String | The Id of the token. | ### AuthorizedAddresses Gets all of the authorized ADO addresses for the specified action. {% hint style="warning" %} For CW721, the action should be specified as "send\_nft". For CW20, the action should be specified as "send\_cw20". {% endhint %} {% tabs %} {% tab title="Rust" %} ```rust pub enum QueryMsg { #[returns(::andromeda_std::common::denom::AuthorizedAddressesResponse)] AuthorizedAddresses { action: PermissionAction, start_after: Option, limit: Option, order_by: Option, }, } ``` {% endtab %} {% tab title="JSON" %} ```json { "authorized_addresses":{ "action":"send_nft", "start_after":"andr1...", "limit":40, } } ``` {% endtab %} {% endtabs %} | Name | Type | Description | | ------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | `action` | [PermissionAction](#permissionaction) | The type of authorized addresses to fetch. | | `start_after` | Option\ | Optional parameter to specify which `address` to start from. | | `limit` | Option\ | Optional parameter to specify how many addresses to return. If none specified a default limit of 25 is used. The maximum limit is 50. | | `order_by` | Option<[OrderBy](#orderby)> | Whether to return the addresses in ascending or descending order. Defaults to ascending if not specified. | #### OrderBy How the returned addresses are ordered. ```rust pub enum OrderBy { Asc, Desc, } ``` #### AuthorizedAddressesResponse ```rust #[cw_serde] pub struct AuthorizedAddressesResponse { pub addresses: Vec, } ``` | Name | Type | Description | | ----------- | ------------ | ------------------------------------------------------------------------------------------ | | `addresses` | Vec\ | A vector containing the contract addresses of the authorized ADO for the specified action. | ### Base Queries The rest of the query messages can be found in the[ ADO Base](https://docs.andromedaprotocol.io/andromeda/platform-and-framework/ado-base) section.