Type alias CreateBidBuilderParams

CreateBidBuilderParams: {
    auctionHouse: AuctionHouse;
    mintAccount: PublicKey;
    tokenAccount?: undefined | Option<PublicKey>;
    authority?: undefined | PublicKey | Signer;
    price?: undefined | SolAmount | SplTokenAmount;
    tokens?: undefined | SplTokenAmount;
    auctioneerAuthority?: undefined | Signer;
    buyer?: undefined | Signer;
    seller?: undefined | Option<PublicKey>;
    printReceipt?: undefined | boolean;
    bookkeeper?: undefined | Signer;
    instructionKey?: undefined | string;
}

Type declaration

  • auctionHouse: AuctionHouse

    The Auction House in which to create a Bid.

  • mintAccount: PublicKey

    The mint account to create a bid for. This is used to find the metadata.

  • Optional tokenAccount?: undefined | Option<PublicKey>

    The token account address that's associated to the asset a bid created is for. If this or seller isn't provided, then the bid will be public.

    Default Value

    No default value.

  • Optional authority?: undefined | 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 price?: undefined | SolAmount | SplTokenAmount

    The buyer's price.

    Default Value

    0 SOLs or tokens.

  • Optional tokens?: undefined | SplTokenAmount

    The number of tokens to bid for. For an NFT bid it must be 1 token.

    When a Fungible Asset is put on sale. The buyer can then create a buy order of said assets that is less than the token_size of the sell order.

    Default Value

    1 token.

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

    Creator of a bid.

    Default Value

    metaplex.identity()

  • Optional seller?: undefined | Option<PublicKey>

    The account address that holds the asset a bid created is for. If this or tokenAccount isn't provided, then the bid will be public.

    Default Value

    No default value.

  • Optional printReceipt?: undefined | boolean

    Prints the bid receipt. The receipt holds information about the bid, So it's important to print it if you want to use the Bid model

    The receipt printing is skipped for the Auctioneer Auction House Since it currently doesn't support it.

    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

Settings

Member Visibility

Theme

Generated using TypeDoc