Type alias DepositToBuyerAccountBuilderParams

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

Type declaration

  • amount: SolAmount | SplTokenAmount

    Amount of funds to deposit. 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" | "isNative" | "hasAuctioneer">

    The Auction House in which escrow buyer deposits funds. We only need a subset of the AuctionHouse model but we need enough information regarding its settings to know how to deposit funds.

    This includes, its address, authority address, treasury mint, etc.

  • Optional auctioneerAuthority?: undefined | Signer

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

    Default Value

    Defaults to not being used.

  • Optional buyer?: undefined | Signer

    The buyer who deposits funds. This expects a Signer.

    Default Value

    metaplex.identity()

  • Optional instructionKey?: undefined | string

Settings

Member Visibility

Theme

Generated using TypeDoc