Type alias DirectSellBuilderParams

DirectSellBuilderParams: { auctionHouse: AuctionHouse; bid: Omit<never & Readonly<{ model: "bid"; lazy: false; auctionHouse: AuctionHouse; tradeStateAddress: Pda; buyerAddress: PublicKey; bookkeeperAddress: Option<PublicKey>; receiptAddress: Option<Pda>; purchaseReceiptAddress: Option<PublicKey>; price: SolAmount | SplTokenAmount; tokens: SplTokenAmount; createdAt: DateTime; canceledAt: Option<DateTime> } & { isPublic: true; asset: Sft | Nft }> & { isPublic: true; asset: Sft | Nft }, "bookkeeperAddress" | "purchaseReceiptAddress" | "createdAt"> | Omit<Readonly<{ model: "bid"; lazy: false; auctionHouse: AuctionHouse; tradeStateAddress: Pda; buyerAddress: PublicKey; bookkeeperAddress: Option<PublicKey>; receiptAddress: Option<Pda>; purchaseReceiptAddress: Option<PublicKey>; price: SolAmount | SplTokenAmount; tokens: SplTokenAmount; createdAt: DateTime; canceledAt: Option<DateTime> } & { isPublic: false; asset: SftWithToken | NftWithToken }> & { isPublic: false; asset: SftWithToken | NftWithToken } & never, "bookkeeperAddress" | "purchaseReceiptAddress" | "createdAt">; sellerToken: undefined | null | Token; authority?: undefined | PublicKey | Signer; auctioneerAuthority?: undefined | Signer; seller?: undefined | PublicKey | Signer; printReceipt?: undefined | boolean; bookkeeper?: undefined | Signer; createListingInstructionKey?: undefined | string; executeSaleInstructionKey?: undefined | string }

Type declaration

  • auctionHouse: AuctionHouse

    The Auction House in which to create a Listing and execute a Sale.

  • bid: Omit<never & Readonly<{ model: "bid"; lazy: false; auctionHouse: AuctionHouse; tradeStateAddress: Pda; buyerAddress: PublicKey; bookkeeperAddress: Option<PublicKey>; receiptAddress: Option<Pda>; purchaseReceiptAddress: Option<PublicKey>; price: SolAmount | SplTokenAmount; tokens: SplTokenAmount; createdAt: DateTime; canceledAt: Option<DateTime> } & { isPublic: true; asset: Sft | Nft }> & { isPublic: true; asset: Sft | Nft }, "bookkeeperAddress" | "purchaseReceiptAddress" | "createdAt"> | Omit<Readonly<{ model: "bid"; lazy: false; auctionHouse: AuctionHouse; tradeStateAddress: Pda; buyerAddress: PublicKey; bookkeeperAddress: Option<PublicKey>; receiptAddress: Option<Pda>; purchaseReceiptAddress: Option<PublicKey>; price: SolAmount | SplTokenAmount; tokens: SplTokenAmount; createdAt: DateTime; canceledAt: Option<DateTime> } & { isPublic: false; asset: SftWithToken | NftWithToken }> & { isPublic: false; asset: SftWithToken | NftWithToken } & never, "bookkeeperAddress" | "purchaseReceiptAddress" | "createdAt">

    The Public Bid that is used in the sale. We only need a subset of the Bid model but we need enough information regarding its settings to know how to execute the sale.

    This includes its auction house address, buyer, receipt address, etc.

  • sellerToken: undefined | null | Token

    The Token Account of an asset to sell. Public Bid doesn't contain a token, so it must be provided externally via this parameter.

  • Optional authority?: undefined | PublicKey | Signer

    The Auction House authority. If this is Signer the transaction fee will be paid from the Auction House Fee Account

    Default Value

    auctionHouse.authority

  • 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.

    There must be one and only one signer; Authority or Seller must sign.

    Default Value

    metaplex.identity()

  • Optional printReceipt?: undefined | boolean

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

    Default Value

    true

  • Optional bookkeeper?: undefined | Signer

    The address of the bookkeeper wallet responsible for the receipt.

    Default Value

    metaplex.identity()

  • Optional createListingInstructionKey?: undefined | string
  • Optional executeSaleInstructionKey?: undefined | string

Generated using TypeDoc