Type alias WithdrawFromBuyerAccountBuilderParams

WithdrawFromBuyerAccountBuilderParams: {
    amount: SolAmount | SplTokenAmount;
    auctionHouse: Pick<AuctionHouse, "address" | "authorityAddress" | "treasuryMint" | "feeAccountAddress" | "hasAuctioneer">;
    authority?: undefined | Signer;
    auctioneerAuthority?: undefined | Signer;
    buyer?: undefined | PublicKey | Signer;
    instructionKey?: undefined | string;
}

Type declaration

  • amount: SolAmount | SplTokenAmount

    Amount of funds to withdraw. This can either be in SOL or in the SPL token used by the Auction House as a currency.

  • auctionHouse: Pick<AuctionHouse, "address" | "authorityAddress" | "treasuryMint" | "feeAccountAddress" | "hasAuctioneer">

    The Auction House from which escrow buyer withdraws funds.

  • Optional authority?: undefined | Signer

    The Authority key. It is required when the buyer is not a signer. There must be one and only one signer; Authority or Buyer must sign.

    Default Value

    Defaults to not being used.

  • Optional auctioneerAuthority?: undefined | Signer

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

    Default Value

    No default value.

  • Optional buyer?: undefined | PublicKey | Signer

    The buyer who withdraws funds.

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

    Default Value

    metaplex.identity()

  • Optional instructionKey?: undefined | string

Settings

Member Visibility

Theme

Generated using TypeDoc