Type alias ExecuteSaleBuilderParams

ExecuteSaleBuilderParams: {
    auctionHouse: AuctionHouse;
    bid: Pick<Bid, "auctionHouse" | "asset" | "tradeStateAddress" | "buyerAddress" | "receiptAddress" | "price" | "tokens" | "canceledAt">;
    listing: Pick<Readonly<{
        model: "listing";
        lazy: false;
        auctionHouse: AuctionHouse;
        asset: SftWithToken | NftWithToken;
        tradeStateAddress: Pda;
        sellerAddress: PublicKey;
        bookkeeperAddress: Option<PublicKey>;
        receiptAddress: Option<Pda>;
        purchaseReceiptAddress: Option<PublicKey>;
        price: SolAmount | SplTokenAmount;
        tokens: SplTokenAmount;
        createdAt: DateTime;
        canceledAt: Option<DateTime>;
    }>, "auctionHouse" | "asset" | "tradeStateAddress" | "receiptAddress" | "price" | "tokens" | "canceledAt" | "sellerAddress">;
    auctioneerAuthority?: undefined | Signer;
    printReceipt?: undefined | boolean;
    bookkeeper?: undefined | Signer;
    instructionKey?: undefined | string;
}

Type declaration

  • auctionHouse: AuctionHouse

    The Auction House in which to execute a sale.

  • bid: Pick<Bid, "auctionHouse" | "asset" | "tradeStateAddress" | "buyerAddress" | "receiptAddress" | "price" | "tokens" | "canceledAt">

    The 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 asset, auction house address, buyer, receipt address etc.

  • listing: Pick<Readonly<{
        model: "listing";
        lazy: false;
        auctionHouse: AuctionHouse;
        asset: SftWithToken | NftWithToken;
        tradeStateAddress: Pda;
        sellerAddress: PublicKey;
        bookkeeperAddress: Option<PublicKey>;
        receiptAddress: Option<Pda>;
        purchaseReceiptAddress: Option<PublicKey>;
        price: SolAmount | SplTokenAmount;
        tokens: SplTokenAmount;
        createdAt: DateTime;
        canceledAt: Option<DateTime>;
    }>, "auctionHouse" | "asset" | "tradeStateAddress" | "receiptAddress" | "price" | "tokens" | "canceledAt" | "sellerAddress">

    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 auctioneerAuthority?: undefined | Signer

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

    Default Value

    No default value.

  • 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 instructionKey?: undefined | string

Generated using TypeDoc