Protected
Readonly
metaplexCreates 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.
const transactionBuilder = metaplex
.auctionHouse()
.builders()
.createBid({ auctionHouse, mintAccount, seller })
Optional
options: TransactionBuilderOptionsCreates a bid on a given asset and executes a sale on the created bid and given listing.
const transactionBuilder = metaplex
.auctionHouse()
.builders()
.buy({ auctionHouse, listing, buyer })
Optional
options: TransactionBuilderOptionsCancels the user's bid in the given auction house.
const transactionBuilder = metaplex
.auctionHouse()
.builders()
.cancelBid({ auctionHouse, bid });
Optional
options: TransactionBuilderOptionsCancels the user's listing in the given auction house.
const transactionBuilder = metaplex
.auctionHouse()
.builders()
.cancelListing({ auctionHouse, listing });
Optional
options: TransactionBuilderOptionsCreates an Auction House.
const transactionBuilder = metaplex
.auctionHouse()
.builders()
.createAuctionHouse({ sellerFeeBasisPoints: 500 }) // 5% fee
Optional
options: TransactionBuilderOptionsAdds funds to the user's buyer escrow account for the given auction house.
const transactionBuilder = metaplex
.auctionHouse()
.builders()
.depositToBuyerAccount({ auctionHouse, buyer, amount });
Optional
options: TransactionBuilderOptionsOptional
options: TransactionBuilderOptionsOptional
options: TransactionBuilderOptionsCreates a listing on a given asset and executes a sale on the created listing and given bid.
const transactionBuilder = metaplex
.auctionHouse()
.builders()
.sell({ auctionHouse, bid, seller })
Optional
options: TransactionBuilderOptionsUpdates an existing Auction House.
const transactionBuilder = metaplex
.auctionHouse()
.builders()
.updateAuctionHouse({ auctionHouse, canChangeSalePrice: true })
Optional
options: TransactionBuilderOptionsWithdraws funds from the user's buyer escrow account to the given auction house.
const transactionBuilder = metaplex
.auctionHouse()
.builders()
.withdrawFromBuyerAccountBuilder({ auctionHouse, buyer, amount });
Optional
options: TransactionBuilderOptionsGenerated using TypeDoc
This client allows you to access the underlying Transaction Builders for the write operations of the Auction House module.
See
AuctionsClient