Struct BuyNftBuilder

pub struct BuyNftBuilder { /* private fields */ }

Instruction builder for BuyNft.

Accounts:

0. [writable] owner
1. [writable, signer] taker
2. [writable] rent_payer
3. [writable] fee_vault
4. [writable] pool
5. [optional] whitelist
6. [optional] mint_proof
7. [writable, optional] shared_escrow
8. [writable, optional] maker_broker
9. [writable, optional] taker_broker
10. [signer, optional] cosigner
11. [optional] amm_program (default to TAMM6ub33ij1mbetoMyVBLeKY5iP41i4UPUJQGkhfsg)
12. [optional] escrow_program
13. [optional] native_program (default to 11111111111111111111111111111111)
14. [] mint
15. [writable] metadata
16. [] edition
17. [writable, optional] user_token_record
18. [writable, optional] pool_token_record
19. [optional] token_metadata_program
20. [optional] sysvar_instructions
21. [optional] authorization_rules
22. [optional] authorization_rules_program
23. [writable] nft_receipt
24. [writable] taker_ta
25. [writable] pool_ta
26. [optional] token_program (default to TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA)
27. [optional] associated_token_program (default to ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL)
28. [optional] system_program (default to 11111111111111111111111111111111)

Implementations

impl BuyNftBuilder

pub fn new() -> Self

pub fn owner(&mut self, owner: Pubkey) -> &mut Self

The owner of the pool and the buyer/recipient of the NFT.

pub fn taker(&mut self, taker: Pubkey) -> &mut Self

The taker is the user buying or selling the NFT.

pub fn rent_payer(&mut self, rent_payer: Pubkey) -> &mut Self

The original rent payer of the pool–stored on the pool. Used to refund rent in case the pool is auto-closed.

pub fn fee_vault(&mut self, fee_vault: Pubkey) -> &mut Self

Fee vault account owned by the TFEE program.

pub fn pool(&mut self, pool: Pubkey) -> &mut Self

The Pool state account that the NFT is being sold into. Stores pool state and config, but is also the owner of any NFTs in the pool, and also escrows any SOL. Any active pool can be specified provided it is a Token type and the NFT passes at least one whitelist condition.

pub fn whitelist(&mut self, whitelist: Option<Pubkey>) -> &mut Self

[optional account] The whitelist account that the pool uses to verify the NFTs being sold into it.

pub fn mint_proof(&mut self, mint_proof: Option<Pubkey>) -> &mut Self

[optional account] Optional account which must be passed in if the NFT must be verified against a merkle proof condition in the whitelist.

pub fn shared_escrow(&mut self, shared_escrow: Option<Pubkey>) -> &mut Self

[optional account] The shared escrow account for pools that have liquidity in a shared account.

pub fn maker_broker(&mut self, maker_broker: Option<Pubkey>) -> &mut Self

[optional account] The account that receives the maker broker fee.

pub fn taker_broker(&mut self, taker_broker: Option<Pubkey>) -> &mut Self

[optional account] The account that receives the taker broker fee.

pub fn cosigner(&mut self, cosigner: Option<Pubkey>) -> &mut Self

[optional account] The optional cosigner account that must be passed in if the pool has a cosigner.

pub fn amm_program(&mut self, amm_program: Pubkey) -> &mut Self

[optional account, default to 'TAMM6ub33ij1mbetoMyVBLeKY5iP41i4UPUJQGkhfsg'] The AMM program account, used for self-cpi logging.

pub fn escrow_program(&mut self, escrow_program: Option<Pubkey>) -> &mut Self

[optional account] The escrow program account for shared liquidity pools.

pub fn native_program(&mut self, native_program: Pubkey) -> &mut Self

[optional account, default to '11111111111111111111111111111111']

pub fn mint(&mut self, mint: Pubkey) -> &mut Self

The mint account of the NFT.

pub fn metadata(&mut self, metadata: Pubkey) -> &mut Self

The Token Metadata metadata account of the NFT.

pub fn edition(&mut self, edition: Pubkey) -> &mut Self

The Token Metadata edition account of the NFT.

pub fn user_token_record( &mut self, user_token_record: Option<Pubkey>, ) -> &mut Self

[optional account] The Token Metadata source token record account of the NFT.

pub fn pool_token_record( &mut self, pool_token_record: Option<Pubkey>, ) -> &mut Self

[optional account] The Token Metadata token record for the destination.

pub fn token_metadata_program( &mut self, token_metadata_program: Option<Pubkey>, ) -> &mut Self

[optional account] The Token Metadata program account.

pub fn sysvar_instructions( &mut self, sysvar_instructions: Option<Pubkey>, ) -> &mut Self

[optional account] The sysvar instructions account.

pub fn authorization_rules( &mut self, authorization_rules: Option<Pubkey>, ) -> &mut Self

[optional account] The Metaplex Token Authority Rules account that stores royalty enforcement rules.

pub fn authorization_rules_program( &mut self, authorization_rules_program: Option<Pubkey>, ) -> &mut Self

[optional account] The Metaplex Token Authority Rules program account.

pub fn nft_receipt(&mut self, nft_receipt: Pubkey) -> &mut Self

The NFT deposit receipt, which ties an NFT to the pool it was deposited to.

pub fn taker_ta(&mut self, taker_ta: Pubkey) -> &mut Self

The TA of the buyer, where the NFT will be transferred.

pub fn pool_ta(&mut self, pool_ta: Pubkey) -> &mut Self

The TA of the pool, where the NFT is held.

pub fn token_program(&mut self, token_program: Pubkey) -> &mut Self

[optional account, default to 'TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA'] Either the legacy token program or token-2022.

pub fn associated_token_program( &mut self, associated_token_program: Pubkey, ) -> &mut Self

[optional account, default to 'ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL'] The SPL associated token program.

pub fn system_program(&mut self, system_program: Pubkey) -> &mut Self

[optional account, default to '11111111111111111111111111111111'] The Solana system program.

pub fn max_amount(&mut self, max_amount: u64) -> &mut Self

pub fn authorization_data( &mut self, authorization_data: AuthorizationDataLocal, ) -> &mut Self

[optional argument]

pub fn optional_royalty_pct(&mut self, optional_royalty_pct: u16) -> &mut Self

[optional argument]

pub fn add_remaining_account(&mut self, account: AccountMeta) -> &mut Self

Add an additional account to the instruction.

pub fn add_remaining_accounts(&mut self, accounts: &[AccountMeta]) -> &mut Self

Add additional accounts to the instruction.

pub fn instruction(&self) -> Instruction

Trait Implementations

impl Clone for BuyNftBuilder

fn clone(&self) -> BuyNftBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BuyNftBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BuyNftBuilder

fn default() -> BuyNftBuilder

Returns the “default value” for a type.