Type alias WithdrawFromBuyerAccountBuilderParams

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

Type declaration

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

    The Auction House from which escrow buyer withdraws funds.

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

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

Generated using TypeDoc