MetaplexAuctionHouseProgram class

Inheritance

• Object
• TransactionInstruction
• MetaplexAuctionHouseProgram

Constructors

MetaplexAuctionHouseProgram({required List<AccountMeta> keys, required SolAddress programId, required ProgramLayout layout})

MetaplexAuctionHouseProgram.auctioneerBuy({required MetaplexAuctionHouseAuctioneerBuyLayout layout, required SolAddress wallet, required SolAddress paymentAccount, required SolAddress transferAuthority, required SolAddress treasuryMint, required SolAddress tokenAccount, required SolAddress metadata, required SolAddress escrowPaymentAccount, required SolAddress authority, required SolAddress auctioneerAuthority, required SolAddress auctionHouse, required SolAddress auctionHouseFeeAccount, required SolAddress buyerTradeState, required SolAddress ahAuctioneerPda, SolAddress tokenProgram = SPLTokenProgramConst.tokenProgramId, SolAddress systemProgram = SystemProgramConst.programId, SolAddress rent = SystemProgramConst.sysvarRentPubkey})

factory

MetaplexAuctionHouseProgram.auctioneerCancel({required SolAddress wallet, required SolAddress tokenAccount, required SolAddress tokenMint, required SolAddress authority, required SolAddress auctioneerAuthority, required SolAddress auctionHouse, required SolAddress auctionHouseFeeAccount, required SolAddress tradeState, required SolAddress ahAuctioneerPda, required MetaplexAuctionHouseAuctioneerCancelLayout layout, SolAddress tokenProgram = SPLTokenProgramConst.tokenProgramId})

Cancel, but with an auctioneer

factory

MetaplexAuctionHouseProgram.auctioneerDeposit({required SolAddress wallet, required SolAddress paymentAccount, required SolAddress transferAuthority, required SolAddress escrowPaymentAccount, required SolAddress treasuryMint, required SolAddress authority, required SolAddress auctioneerAuthority, required SolAddress auctionHouse, required SolAddress auctionHouseFeeAccount, required SolAddress ahAuctioneerPda, required MetaplexAuctionHouseAuctioneerDepositLayout layout, SolAddress tokenProgram = SPLTokenProgramConst.tokenProgramId, SolAddress systemProgram = SystemProgramConst.programId, SolAddress rent = SystemProgramConst.sysvarRentPubkey})

Deposit amount into the escrow payment account for your specific wallet.

factory

MetaplexAuctionHouseProgram.auctioneerExecutePartialSale({required SolAddress buyer, required SolAddress seller, required SolAddress tokenAccount, required SolAddress tokenMint, required SolAddress metadata, required SolAddress treasuryMint, required SolAddress escrowPaymentAccount, required SolAddress sellerPaymentReceiptAccount, required SolAddress buyerReceiptTokenAccount, required SolAddress authority, required SolAddress auctioneerAuthority, required SolAddress auctionHouse, required SolAddress auctionHouseFeeAccount, required SolAddress auctionHouseTreasury, required SolAddress buyerTradeState, required SolAddress sellerTradeState, required SolAddress freeTradeState, required SolAddress ahAuctioneerPda, required SolAddress programAsSigner, required MetaplexAuctionHouseAuctioneerExecutePartialSaleLayout layout, SolAddress ataProgram = AssociatedTokenAccountProgramConst.associatedTokenProgramId, SolAddress tokenProgram = SPLTokenProgramConst.tokenProgramId, SolAddress systemProgram = SystemProgramConst.programId, SolAddress rent = SystemProgramConst.sysvarRentPubkey})

factory

MetaplexAuctionHouseProgram.auctioneerExecuteSale({required SolAddress buyer, required SolAddress seller, required SolAddress tokenAccount, required SolAddress tokenMint, required SolAddress metadata, required SolAddress treasuryMint, required SolAddress escrowPaymentAccount, required SolAddress sellerPaymentReceiptAccount, required SolAddress buyerReceiptTokenAccount, required SolAddress authority, required SolAddress auctioneerAuthority, required SolAddress auctionHouse, required SolAddress auctionHouseFeeAccount, required SolAddress auctionHouseTreasury, required SolAddress buyerTradeState, required SolAddress sellerTradeState, required SolAddress freeTradeState, required SolAddress ahAuctioneerPda, required SolAddress programAsSigner, required MetaplexAuctionHouseAuctioneerExecuteSaleLayout layout, SolAddress ataProgram = AssociatedTokenAccountProgramConst.associatedTokenProgramId, SolAddress tokenProgram = SPLTokenProgramConst.tokenProgramId, SolAddress systemProgram = SystemProgramConst.programId, SolAddress rent = SystemProgramConst.sysvarRentPubkey})

factory

MetaplexAuctionHouseProgram.auctioneerPublicBuy({required SolAddress wallet, required SolAddress paymentAccount, required SolAddress transferAuthority, required SolAddress treasuryMint, required SolAddress tokenAccount, required SolAddress metadata, required SolAddress escrowPaymentAccount, required SolAddress authority, required SolAddress auctioneerAuthority, required SolAddress auctionHouse, required SolAddress auctionHouseFeeAccount, required SolAddress buyerTradeState, required SolAddress ahAuctioneerPda, required MetaplexAuctionHouseAuctioneerPublicBuyLayout layout, SolAddress tokenProgram = SPLTokenProgramConst.tokenProgramId, SolAddress systemProgram = SystemProgramConst.programId, SolAddress rent = SystemProgramConst.sysvarRentPubkey})

Create a public buy bid by creating a public_buyer_trade_state account and an escrow_payment account and funding the escrow with the necessary SOL or SPL token amount.

factory

MetaplexAuctionHouseProgram.auctioneerSell({required SolAddress wallet, required SolAddress tokenAccount, required SolAddress metadata, required SolAddress authority, required SolAddress auctioneerAuthority, required SolAddress auctionHouse, required SolAddress auctionHouseFeeAccount, required SolAddress sellerTradeState, required SolAddress freeSellerTradeState, required SolAddress ahAuctioneerPda, required SolAddress programAsSigner, required MetaplexAuctionHouseAuctioneerSellLayout layout, SolAddress tokenProgram = SPLTokenProgramConst.tokenProgramId, SolAddress systemProgram = SystemProgramConst.programId, SolAddress rent = SystemProgramConst.sysvarRentPubkey})

factory

MetaplexAuctionHouseProgram.auctioneerWithdraw({required SolAddress wallet, required SolAddress receiptAccount, required SolAddress escrowPaymentAccount, required SolAddress treasuryMint, required SolAddress authority, required SolAddress auctioneerAuthority, required SolAddress auctionHouse, required SolAddress auctionHouseFeeAccount, required SolAddress ahAuctioneerPda, required MetaplexAuctionHouseAuctioneerWithdrawLayout layout, SolAddress tokenProgram = SPLTokenProgramConst.tokenProgramId, SolAddress systemProgram = SystemProgramConst.programId, SolAddress rent = SystemProgramConst.sysvarRentPubkey, SolAddress ataProgram = AssociatedTokenAccountProgramConst.associatedTokenProgramId})

Withdraw amount from the escrow payment account for your specific wallet.

factory

MetaplexAuctionHouseProgram.buy({required SolAddress wallet, required SolAddress paymentAccount, required SolAddress transferAuthority, required SolAddress treasuryMint, required SolAddress tokenAccount, required SolAddress metadata, required SolAddress escrowPaymentAccount, required SolAddress authority, required SolAddress auctionHouse, required SolAddress auctionHouseFeeAccount, required SolAddress buyerTradeState, required MetaplexAuctionHouseBuyLayout layout, SolAddress tokenProgram = SPLTokenProgramConst.tokenProgramId, SolAddress systemProgram = SystemProgramConst.programId, SolAddress rent = SystemProgramConst.sysvarRentPubkey})

Create a private buy bid by creating a buyer_trade_state account and an escrow_payment account and funding the escrow with the necessary SOL or SPL token amount.

factory

MetaplexAuctionHouseProgram.cancel({required SolAddress wallet, required SolAddress tokenAccount, required SolAddress tokenMint, required SolAddress authority, required SolAddress auctionHouse, required SolAddress auctionHouseFeeAccount, required SolAddress tradeState, required MetaplexAuctionHouseCancelLayout layout, SolAddress tokenProgram = SPLTokenProgramConst.tokenProgramId})

Cancel a bid or ask by revoking the token delegate, transferring all lamports from the trade state account to the fee payer, and setting the trade state account data to zero so it can be garbage collected.

factory

MetaplexAuctionHouseProgram.cancelBidReceipt({required SolAddress receipt, required SolAddress instruction, SolAddress systemProgram = SystemProgramConst.programId})

Cancel an active bid receipt by setting the canceled_at field to the current time.

factory

MetaplexAuctionHouseProgram.cancelListingReceipt({required SolAddress receipt, required SolAddress instruction, SolAddress systemProgram = SystemProgramConst.programId})

Cancel an active listing receipt by setting the canceled_at field to the current time.

factory

MetaplexAuctionHouseProgram.cancelRemainingAccounts({required SolAddress metadataProgram, required SolAddress delegateRecord, required SolAddress programAsSigner, required SolAddress metadata, required SolAddress edition, required SolAddress tokenRecord, required SolAddress tokenMint, required SolAddress authRulesProgram, required SolAddress authRules, required SolAddress sysvarInstructions, SolAddress systemProgram = SystemProgramConst.programId})

factory

MetaplexAuctionHouseProgram.closeEscrowAccount({required SolAddress wallet, required SolAddress escrowPaymentAccount, required SolAddress auctionHouse, required MetaplexAuctionHouseCloseEscrowAccountLayout layout, SolAddress systemProgram = SystemProgramConst.programId})

Close the escrow account of the user.

factory

MetaplexAuctionHouseProgram.createAuctionHouse({required MetaplexAuctionHouseCreateAuctionHouseLayout layout, required SolAddress treasuryMint, required SolAddress payer, required SolAddress authority, required SolAddress feeWithdrawalDestination, required SolAddress treasuryWithdrawalDestination, required SolAddress treasuryWithdrawalDestinationOwner, required SolAddress auctionHouse, required SolAddress auctionHouseFeeAccount, required SolAddress auctionHouseTreasury, SolAddress tokenProgram = SPLTokenProgramConst.tokenProgramId, SolAddress systemProgram = SystemProgramConst.programId, SolAddress associatedTokenProgramId = AssociatedTokenAccountProgramConst.associatedTokenProgramId, SolAddress rent = SystemProgramConst.sysvarRentPubkey})

Create a new Auction House instance.

factory

MetaplexAuctionHouseProgram.delegateAuctioneer({required SolAddress auctionHouse, required SolAddress authority, required SolAddress auctioneerAuthority, required SolAddress ahAuctioneerPda, required MetaplexAuctionHouseDelegateAuctioneerLayout layout, SolAddress systemProgram = SystemProgramConst.programId})

factory

MetaplexAuctionHouseProgram.deposit({required SolAddress wallet, required SolAddress paymentAccount, required SolAddress transferAuthority, required SolAddress escrowPaymentAccount, required SolAddress treasuryMint, required SolAddress authority, required SolAddress auctionHouse, required SolAddress auctionHouseFeeAccount, required MetaplexAuctionHouseDepositLayout layout, SolAddress tokenProgram = SPLTokenProgramConst.tokenProgramId, SolAddress systemProgram = SystemProgramConst.programId, SolAddress rent = SystemProgramConst.sysvarRentPubkey})

Deposit amount into the escrow payment account for your specific wallet.

factory

MetaplexAuctionHouseProgram.executePartialSale({required SolAddress buyer, required SolAddress seller, required SolAddress tokenAccount, required SolAddress tokenMint, required SolAddress metadata, required SolAddress treasuryMint, required SolAddress escrowPaymentAccount, required SolAddress sellerPaymentReceiptAccount, required SolAddress buyerReceiptTokenAccount, required SolAddress authority, required SolAddress auctionHouse, required SolAddress auctionHouseFeeAccount, required SolAddress auctionHouseTreasury, required SolAddress buyerTradeState, required SolAddress sellerTradeState, required SolAddress freeTradeState, SolAddress ataProgram = AssociatedTokenAccountProgramConst.associatedTokenProgramId, required SolAddress programAsSigner, required MetaplexAuctionHouseExecutePartialSaleLayout layout, SolAddress tokenProgram = SPLTokenProgramConst.tokenProgramId, SolAddress systemProgram = SystemProgramConst.programId, SolAddress rent = SystemProgramConst.sysvarRentPubkey})

factory

MetaplexAuctionHouseProgram.executeSale({required SolAddress buyer, required SolAddress seller, required SolAddress tokenAccount, required SolAddress tokenMint, required SolAddress metadata, required SolAddress treasuryMint, required SolAddress escrowPaymentAccount, required SolAddress sellerPaymentReceiptAccount, required SolAddress buyerReceiptTokenAccount, required SolAddress authority, required SolAddress auctionHouse, required SolAddress auctionHouseFeeAccount, required SolAddress auctionHouseTreasury, required SolAddress buyerTradeState, required SolAddress sellerTradeState, required SolAddress freeTradeState, required SolAddress programAsSigner, required MetaplexAuctionHouseExecuteSaleLayout layout, SolAddress tokenProgram = SPLTokenProgramConst.tokenProgramId, SolAddress systemProgram = SystemProgramConst.programId, SolAddress rent = SystemProgramConst.sysvarRentPubkey, SolAddress ataProgram = AssociatedTokenAccountProgramConst.associatedTokenProgramId})

factory

MetaplexAuctionHouseProgram.executeSaleRemainingAccounts({required SolAddress metadataProgram, required SolAddress edition, required SolAddress ownerTr, required SolAddress destinationTr, required SolAddress authRulesProgram, required SolAddress authRules, required SolAddress sysvarInstructions})

factory

MetaplexAuctionHouseProgram.printBidReceipt({required SolAddress receipt, required SolAddress bookkeeper, required SolAddress instruction, required MetaplexAuctionHousePrintBidReceiptLayout layout, SolAddress systemProgram = SystemProgramConst.programId, SolAddress rent = SystemProgramConst.sysvarRentPubkey})

Create a bid receipt by creating a bid_receipt account.

factory

MetaplexAuctionHouseProgram.printListingReceipt({required SolAddress receipt, required SolAddress bookkeeper, required SolAddress instruction, required MetaplexAuctionHousePrintListingReceiptLayout layout, SolAddress systemProgram = SystemProgramConst.programId, SolAddress rent = SystemProgramConst.sysvarRentPubkey})

Create a listing receipt by creating a listing_receipt account.

factory

MetaplexAuctionHouseProgram.printPurchaseReceipt({required SolAddress purchaseReceipt, required SolAddress listingReceipt, required SolAddress bidReceipt, required SolAddress bookkeeper, required SolAddress instruction, required MetaplexAuctionHousePrintPurchaseReceiptLayout layout, SolAddress systemProgram = SystemProgramConst.programId, SolAddress rent = SystemProgramConst.sysvarRentPubkey})

Create a purchase receipt by creating a purchase_receipt account.

factory

MetaplexAuctionHouseProgram.publicBuy({required SolAddress wallet, required SolAddress paymentAccount, required SolAddress transferAuthority, required SolAddress treasuryMint, required SolAddress tokenAccount, required SolAddress metadata, required SolAddress escrowPaymentAccount, required SolAddress authority, required SolAddress auctionHouse, required SolAddress auctionHouseFeeAccount, required SolAddress buyerTradeState, required MetaplexAuctionHousePublicBuyLayout layout, SolAddress tokenProgram = SPLTokenProgramConst.tokenProgramId, SolAddress systemProgram = SystemProgramConst.programId, SolAddress rent = SystemProgramConst.sysvarRentPubkey})

Create a public buy bid by creating a public_buyer_trade_state account and an escrow_payment account and funding the escrow with the necessary SOL or SPL token amount.

factory

MetaplexAuctionHouseProgram.sell({required SolAddress wallet, required SolAddress tokenAccount, required SolAddress metadata, required SolAddress authority, required SolAddress auctionHouse, required SolAddress auctionHouseFeeAccount, required SolAddress sellerTradeState, required SolAddress freeSellerTradeState, required SolAddress programAsSigner, required MetaplexAuctionHouseSellLayout layout, SolAddress tokenProgram = SPLTokenProgramConst.tokenProgramId, SolAddress systemProgram = SystemProgramConst.programId, SolAddress rent = SystemProgramConst.sysvarRentPubkey})

factory

MetaplexAuctionHouseProgram.sellRemainingAccounts({required SolAddress metadataProgram, required SolAddress delegateRecord, required SolAddress tokenRecord, required SolAddress tokenMint, required SolAddress edition, required SolAddress authRulesProgram, required SolAddress authRules, required SolAddress sysvarInstructions})

factory

MetaplexAuctionHouseProgram.updateAuctioneer({required SolAddress auctionHouse, required SolAddress authority, required SolAddress auctioneerAuthority, required SolAddress ahAuctioneerPda, required MetaplexAuctionHouseUpdateAuctioneerLayout layout, SolAddress systemProgram = SystemProgramConst.programId})

factory

MetaplexAuctionHouseProgram.updateAuctionHouse({required SolAddress treasuryMint, required SolAddress payer, required SolAddress authority, required SolAddress newAuthority, required SolAddress feeWithdrawalDestination, required SolAddress treasuryWithdrawalDestination, required SolAddress treasuryWithdrawalDestinationOwner, required SolAddress auctionHouse, required MetaplexAuctionHouseUpdateAuctionHouseLayout layout, SolAddress tokenProgram = SPLTokenProgramConst.tokenProgramId, SolAddress systemProgram = SystemProgramConst.programId, SolAddress rent = SystemProgramConst.sysvarRentPubkey, SolAddress ataProgram = AssociatedTokenAccountProgramConst.associatedTokenProgramId})

Update Auction House values such as seller fee basis points, update authority, treasury account, etc.

factory

MetaplexAuctionHouseProgram.withdraw({required SolAddress wallet, required SolAddress receiptAccount, required SolAddress escrowPaymentAccount, required SolAddress treasuryMint, required SolAddress authority, required SolAddress auctionHouse, required SolAddress auctionHouseFeeAccount, required MetaplexAuctionHouseWithdrawLayout layout, SolAddress tokenProgram = SPLTokenProgramConst.tokenProgramId, SolAddress systemProgram = SystemProgramConst.programId, SolAddress rent = SystemProgramConst.sysvarRentPubkey, SolAddress ataProgram = AssociatedTokenAccountProgramConst.associatedTokenProgramId})

Withdraw amount from the escrow payment account for your specific wallet.

factory

MetaplexAuctionHouseProgram.withdrawFromFee({required SolAddress authority, required SolAddress feeWithdrawalDestination, required SolAddress auctionHouseFeeAccount, required SolAddress auctionHouse, required MetaplexAuctionHouseWithdrawFromFeeLayout layout, SolAddress systemProgram = SystemProgramConst.programId})

Withdraw amount from the Auction House Fee Account to a provided destination account.

factory

MetaplexAuctionHouseProgram.withdrawFromTreasury({required SolAddress treasuryMint, required SolAddress authority, required SolAddress treasuryWithdrawalDestination, required SolAddress auctionHouseTreasury, required SolAddress auctionHouse, required MetaplexAuctionHouseWithdrawFromTreasuryLayout layout, SolAddress tokenProgram = SPLTokenProgramConst.tokenProgramId, SolAddress systemProgram = SystemProgramConst.programId})

Withdraw amount from the Auction House Treasury Account to a provided destination account.

factory

Properties

data ↔ List<int>

Program input.

getter/setter pair, inherited

hashCode → int

The hash code for this object.

no setter, inherited

keys → List<AccountMeta>

Public keys to include in this transaction Boolean represents whether this pubkey needs to sign the transaction

final, inherited

programId → SolAddress

Program Id to execute.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited