Struct DepositNftBuilder

pub struct DepositNftBuilder { /* private fields */ }

Instruction builder for DepositNft.

Accounts:

0. [writable, signer] owner
1. [writable] pool
2. [] whitelist
3. [optional] mint_proof
4. [] mint
5. [writable] metadata
6. [] edition
7. [writable, optional] user_token_record
8. [writable, optional] pool_token_record
9. [optional] token_metadata_program
10. [optional] sysvar_instructions
11. [optional] authorization_rules
12. [optional] authorization_rules_program
13. [writable] nft_receipt
14. [writable] owner_ta
15. [writable] pool_ta
16. [optional] token_program (default to TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA)
17. [optional] associated_token_program (default to ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL)
18. [optional] system_program (default to 11111111111111111111111111111111)

Implementations

impl DepositNftBuilder

pub fn new() -> Self

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

The owner of the pool and the NFT.

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

The pool the NFT is being transferred to/from.

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

The whitelist that gatekeeps which NFTs can be deposited into the pool. Must match the whitelist stored in the pool state.

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 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 owner_ta(&mut self, owner_ta: Pubkey) -> &mut Self

The token account of the owner, where the NFT will be transferred from.

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

The token account of the pool, where the NFT will be escrowed.

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

[optional account, default to 'TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA'] The SPL Token program for the Mint and ATAs.

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 authorization_data( &mut self, authorization_data: AuthorizationDataLocal, ) -> &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 DepositNftBuilder

fn clone(&self) -> DepositNftBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DepositNftBuilder

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

Formats the value using the given formatter.

impl Default for DepositNftBuilder

fn default() -> DepositNftBuilder

Returns the “default value” for a type.