Type alias CreateListingBuilderParams

CreateListingBuilderParams: {
    auctionHouse: AuctionHouse;
    mintAccount: PublicKey;
    tokenAccount?: undefined | PublicKey;
    authority?: undefined | PublicKey | Signer;
    price?: undefined | SolAmount | SplTokenAmount;
    tokens?: undefined | SplTokenAmount;
    auctioneerAuthority?: undefined | Signer;
    seller?: undefined | PublicKey | Signer;
    printReceipt?: undefined | boolean;
    bookkeeper?: undefined | Signer;
    instructionKey?: undefined | string;
}

Creates a listing on a given asset.

const transactionBuilder = metaplex
  .auctionHouse()
  .builders()
  .createListing({ auctionHouse, mintAccount });

Type declaration

  • auctionHouse: AuctionHouse

    A model of the Auction House related to this listing.

  • mintAccount: PublicKey

    The mint account to create a listing for. This is used to find the metadata.

  • Optional tokenAccount?: undefined | PublicKey

    The token account address that's associated to the asset a listing created is for.

    Default Value

    Seller's Associated Token Account.

  • Optional authority?: undefined | PublicKey | Signer

    The Auction House authority.

    There must be one and only one signer; Authority or Seller must sign. Auction house should be the signer for changing the price instead of user wallet for cases when seller lists at 0.

    Default Value

    auctionHouse.authority

  • Optional price?: undefined | SolAmount | SplTokenAmount

    The listing price.

    Default Value

    0 SOLs or tokens.

  • Optional tokens?: undefined | SplTokenAmount

    The number of tokens to list. For an NFT listing it must be 1 token.

    When a Fungible Asset is put on sale. The buyer can then create a buy order of said assets that is less than the token_size of the sell order.

    Default Value

    1 token.

  • Optional auctioneerAuthority?: undefined | Signer

    The Auctioneer authority key. It is required when Auction House has Auctioneer enabled.

    Default Value

    No default value.

  • Optional seller?: undefined | PublicKey | Signer

    Creator of a listing.

    The wallet being a signer is the only condition in which an NFT can sell at a price of 0. If the user does list at 0 then auction house can change the sale price if the 'can_change_sale_price' option is true. If the trade is not priced at 0, the wallet holder has to be a signer since auction house cannot sign if listing over 0. There must be one and only one signer; Authority or Seller must sign.

    Default Value

    metaplex.identity()

  • Optional printReceipt?: undefined | boolean

    Prints the listing receipt. The receipt holds information about the listing, So it's important to print it if you want to use the Listing model

    The receipt printing is skipped for the Auctioneer Auction House Since it currently doesn't support it.

    Default Value

    true

  • Optional bookkeeper?: undefined | Signer

    The address of the bookkeeper wallet responsible for the receipt.

    Default Value

    metaplex.identity()

  • Optional instructionKey?: undefined | string

Settings

Member Visibility

Theme

Generated using TypeDoc