Class AuctionHouseClient

You may use the builders() client to access the underlying Transaction Builders of this module.

const buildersClient = metaplex.auctions().builders();

You may use the pdas() client to build PDAs related to this module.

const pdasClient = metaplex.auctionHouse().pdas();

Creates a bid on a given asset.

You can post a public bid on a non-listed NFT by skipping seller and tokenAccount properties. Public bids are specific to the token itself and not to any specific auction. This means that a bid can stay active beyond the end of an auction and be resolved if it meets the criteria for subsequent auctions of that token.

await metaplex
  .auctionHouse()
  .bid({ auctionHouse, mintAccount, seller };

Creates a bid on a given asset and then executes a sale on the created bid and listing.

await metaplex
  .auctionHouse()
  .buy({ auctionHouse, listing, buyer };

Cancels the user's bid in the given auction house.

await metaplex
  .auctionHouse()
  .cancelBid({ auctionHouse, bid };

Cancels the user's listing in the given auction house.

await metaplex
  .auctionHouse()
  .cancelListing({ auctionHouse, listing };

Creates an Auction House.

await metaplex
  .auctionHouse()
  .create({ sellerFeeBasisPoints: 500 }); // 5% fee

Provide auctioneerAuthority in case you want to enable Auctioneer.

await metaplex
  .auctionHouse()
  .create({ sellerFeeBasisPoints: 500, auctioneerAuthority: mx.identity().publicKey };

Adds funds to the user's buyer escrow account for the given auction house.

await metaplex
  .auctionHouse()
  .depositToBuyerAccount({ auctionHouse, buyer, amount };

Executes a sale on a given bid and listing.

await metaplex
  .auctionHouse()
  .executeSale({ auctionHouse, bid, listing };

Finds an Auction House by its address.

const nft = await metaplex
  .auctionHouse()
  .findByAddress({ address };

Finds an Auction House by its creator and treasury mint.

const nft = await metaplex
  .auctionHouse()
  .findByCreatorAndMint({ creator, treasuryMint };

Finds a Bid by its receipt address.

const nft = await metaplex
  .auctionHouse()
  .findBidByReceipt({ receiptAddress, auctionHouse };

Finds a Bid by its trade state address.

const nft = await metaplex
  .auctionHouse()
  .findBidByTradeState({ tradeStateAddress, auctionHouse };

Finds Bids by multiple criteria. You can use any combination of keys.

// Find all bids in an Auction House.
const bids = await metaplex
  .auctionHouse()
  .findBids({ auctionHouse });

// Find bids by buyer and mint.
const bids = await metaplex
  .auctionHouse()
  .findBids({ auctionHouse, buyer, mint });

// Find bids by metadata.
const bids = await metaplex
  .auctionHouse()
  .findBids({ auctionHouse, metadata });

Finds a Listing by its trade state address.

const nft = await metaplex
  .auctionHouse()
  .findListingByTradeState({ tradeStateAddress, auctionHouse };

Finds a Listing by its receipt address.

const nft = await metaplex
  .auctionHouse()
  .findListingByReceipt({ receiptAddress, auctionHouse };

Finds Listings by multiple criteria. You can use any combination of keys.

// Find all listings in an Auction House.
const listings = await metaplex
  .auctionHouse()
  .findListings({ auctionHouse });

// Find listings by seller and mint.
const listings = await metaplex
  .auctionHouse()
  .findListings({ auctionHouse, seller, mint });

Finds a Purchase by its trade state address.

const nft = await metaplex
  .auctionHouse()
  .findPurchaseByTradeState({ sellerTradeState, buyerTradeState, auctionHouse };

Finds a Purchase by its receipt address.

const nft = await metaplex
  .auctionHouse()
  .findPurchaseByReceipt({ receiptAddress, auctionHouse };

Finds Purchases by multiple criteria. You can use any combination of keys. Supports only 3 criteria at the same time including the required auctionHouse attribute.

// Find all purchases in an Auction House.
const purchases = await metaplex
  .auctionHouse()
  .findPurchases({ auctionHouse });

// Find purchases by buyer and mint.
const purchases = await metaplex
  .auctionHouse()
  .findPurchases({ auctionHouse, buyer, mint });

// Find purchases by metadata.
const purchases = await metaplex
  .auctionHouse()
  .findPurchases({ auctionHouse, metadata });

// Find purchases by seller and buyer.
const purchases = await metaplex
  .auctionHouse()
  .findPurchases({ auctionHouse, seller, buyer });

Gets the balance of a buyer's escrow account for a given Auction House.

await metaplex
  .auctionHouse()
  .getBuyerBalance({ auctionHouse, buyerAddress };

Creates a listing on a given asset.

await metaplex
  .auctionHouse()
  .list({ auctionHouse, mintAccount };

Transforms a LazyBid model into a Bid model.

const bid = await metaplex
  .auctionHouse()
  .loadBid({ lazyBid };

Transforms a LazyListing model into a Listing model.

const listing = await metaplex
  .auctionHouse()
  .loadListing({ lazyListing };

Transforms a LazyPurchase model into a Purchase model.

const purchase = await metaplex
  .auctionHouse()
  .loadPurchase({ lazyPurchase };

Creates a listing on a given asset and then executes a sell on the created bid and listing.

await metaplex
  .auctionHouse()
  .sell({ auctionHouse, bid };

Updates an existing Auction House.

await metaplex
  .autionHouse()
  .update({
    auctionHouse,
    canChangeSalePrice: true, // Updates the canChangeSalePrice only.
  };

Withdraws funds from the user's buyer escrow account for the given auction house.

await metaplex
  .auctionHouse()
  .withdrawFromBuyerAccount({ auctionHouse, buyer, amount };

Transfers funds from Auction House Fee Wallet to the Fee Withdrawal Destination Wallet. By default Fee Withdrawal Destination Wallet is set to metaplex.identity().

await metaplex
  .auctionHouse()
  .withdrawFromFeeAccount({ auctionHouse, amount };

Transfers funds from Auction House Treasury Wallet to the Treasury Withdrawal Destination Wallet set on an Auction House creation. By default Treasury Withdrawal Destination Wallet is set to metaplex.identity().

await metaplex
  .auctionHouse()
  .withdrawFromTreasuryAccount({ auctionHouse, amount };