Type alias DirectBuyInput

DirectBuyInput: {
    auctionHouse: AuctionHouse;
    listing: Pick<Listing, "asset" | "auctionHouse" | "canceledAt" | "price" | "sellerAddress" | "tokens" | "tradeStateAddress" | "receiptAddress">;
    authority?: PublicKey | Signer;
    buyer?: Signer;
    price?: SolAmount | SplTokenAmount;
    auctioneerAuthority?: Signer;
    bookkeeper?: Signer;
    printReceipt?: boolean;
}

Type declaration

  • auctionHouse: AuctionHouse

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

  • listing: Pick<Listing, "asset" | "auctionHouse" | "canceledAt" | "price" | "sellerAddress" | "tokens" | "tradeStateAddress" | "receiptAddress">

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

    This includes, its asset, auction house address, seller, receipt address etc.

  • Optional authority?: 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 buyer?: Signer

    Creator of a bid. Should not be the same as seller who creates a Listing

    Default Value

    metaplex.identity()

  • Optional price?: SolAmount | SplTokenAmount

    The buyer's price.

    Default Value

    listing.price.

  • Optional auctioneerAuthority?: Signer

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

    Default Value

    No default value.

  • Optional bookkeeper?: Signer

    The address of the bookkeeper wallet responsible for the receipt.

    Default Value

    metaplex.identity()

  • Optional printReceipt?: 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

Settings

Member Visibility

Theme

Generated using TypeDoc