Type alias Bid

Bid: {
    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: boolean;
    asset: Sft | SftWithToken | Nft | NftWithToken;
}

Type declaration

  • model: "bid"

    A model identifier to distinguish models in the SDK.

  • lazy: false

    Whether or not the asset was loaded. When this is false, it means the Bid includes asset model.

  • auctionHouse: AuctionHouse

    A model of the Auction House related to this bid.

  • tradeStateAddress: Pda

    The address of the buyer's trade state account.

  • buyerAddress: PublicKey

    The address of the buyer's wallet.

  • bookkeeperAddress: Option<PublicKey>

    The address of the bookkeeper account. It is responsible for signing a Bid Receipt Print.

  • receiptAddress: Option<Pda>

    The address of the bid receipt account. This is the account that stores information about this bid. The Bid model is built on top of this account.

  • purchaseReceiptAddress: Option<PublicKey>

    The address of the purchase receipt account. This is the account that stores information about the purchase related to this bid.

    const transactionBuilder = metaplex
    .auctionHouse()
    .builders()
    .findPurchaseByReceipt({ auctionHouse, receiptAddress: purchaseReceiptAddress });
  • price: SolAmount | SplTokenAmount

    The buyer's price.

  • tokens: SplTokenAmount

    The number of tokens bid is for.

  • createdAt: DateTime

    The date of creation.

  • canceledAt: Option<DateTime>

    The date of cancellation.

  • isPublic: boolean

    The bid is not public, which means that it was created according to the listing.

  • asset: Sft | SftWithToken | Nft | NftWithToken

    The Nft or Sft with the associated token account.

Generated using TypeDoc