Skip to main content

Token

spl_token_client::token

Struct Token 

Source 
pub struct Token<T> { /* private fields */ }

Implementations§

Source§

impl<T> Token<T>
where T: SendTransaction + SimulateTransaction,

Source

pub fn new( client: Arc<dyn ProgramClient<T>>, program_id: &Address, address: &Address, decimals: Option<u8>, payer: Arc<dyn Signer>, ) -> Self

Source

pub fn new_native( client: Arc<dyn ProgramClient<T>>, program_id: &Address, payer: Arc<dyn Signer>, ) -> Self

Source

pub fn is_native(&self) -> bool

Source

pub fn get_address(&self) -> &Address

Get token address.

Source

pub fn with_payer(self, payer: Arc<dyn Signer>) -> Self

Source

pub fn with_nonce( self, nonce_account: &Address, nonce_authority: Arc<dyn Signer>, nonce_blockhash: &Hash, ) -> Self

Source

pub fn with_transfer_hook_accounts( self, transfer_hook_accounts: Vec<AccountMeta>, ) -> Self

Source

pub fn with_compute_unit_price(self, compute_unit_price: u64) -> Self

Source

pub fn with_compute_unit_limit( self, compute_unit_limit: ComputeUnitLimit, ) -> Self

Source

pub fn with_memo<M: AsRef<str>>(&self, memo: M, signers: Vec<Address>) -> &Self

Source

pub async fn get_new_latest_blockhash(&self) -> TokenResult<Hash>

Source

pub async fn simulate_ixs<S: Signers>( &self, token_instructions: &[Instruction], signing_keypairs: &S, ) -> TokenResult<T::SimulationOutput>

Source

pub async fn process_ixs<S: Signers>( &self, token_instructions: &[Instruction], signing_keypairs: &S, ) -> TokenResult<T::Output>

Source

pub async fn create_mint<'a, S: Signers>( &self, mint_authority: &'a Address, freeze_authority: Option<&'a Address>, extension_initialization_params: Vec<ExtensionInitializationParams>, signing_keypairs: &S, ) -> TokenResult<T::Output>

Source

pub async fn create_native_mint( client: Arc<dyn ProgramClient<T>>, program_id: &Address, payer: Arc<dyn Signer>, ) -> TokenResult<Self>

Create native mint

Source

pub async fn create_multisig( &self, account: &dyn Signer, multisig_members: &[&Address], minimum_signers: u8, ) -> TokenResult<T::Output>

Create multisig

Source

pub fn get_associated_token_address(&self, owner: &Address) -> Address

Get the address for the associated token account.

Source

pub async fn create_associated_token_account( &self, owner: &Address, ) -> TokenResult<T::Output>

Create and initialize the associated account.

Source

pub async fn create_auxiliary_token_account( &self, account: &dyn Signer, owner: &Address, ) -> TokenResult<T::Output>

Create and initialize a new token account.

Source

pub async fn create_auxiliary_token_account_with_extension_space( &self, account: &dyn Signer, owner: &Address, extensions: Vec<ExtensionType>, ) -> TokenResult<T::Output>

Create and initialize a new token account.

Source

pub async fn get_account(&self, account: Address) -> TokenResult<BaseAccount>

Retrieve a raw account

Source

pub async fn get_mint_info(&self) -> TokenResult<StateWithExtensionsOwned<Mint>>

Retrieve mint information.

Source

pub async fn get_account_info( &self, account: &Address, ) -> TokenResult<StateWithExtensionsOwned<Account>>

Retrieve account information.

Source

pub async fn get_or_create_associated_account_info( &self, owner: &Address, ) -> TokenResult<StateWithExtensionsOwned<Account>>

Retrieve the associated account or create one if not found.

Source

pub async fn set_authority<S: Signers>( &self, account: &Address, authority: &Address, new_authority: Option<&Address>, authority_type: AuthorityType, signing_keypairs: &S, ) -> TokenResult<T::Output>

Assign a new authority to the account.

Source

pub async fn mint_to<S: Signers>( &self, destination: &Address, authority: &Address, amount: u64, signing_keypairs: &S, ) -> TokenResult<T::Output>

Mint new tokens

Source

pub async fn transfer<S: Signers>( &self, source: &Address, destination: &Address, authority: &Address, amount: u64, signing_keypairs: &S, ) -> TokenResult<T::Output>

Transfer tokens to another account

Source

pub async fn create_recipient_associated_account_and_transfer<S: Signers>( &self, source: &Address, destination: &Address, destination_owner: &Address, authority: &Address, amount: u64, fee: Option<u64>, signing_keypairs: &S, ) -> TokenResult<T::Output>

Transfer tokens to an associated account, creating it if it does not exist

Source

pub async fn transfer_with_fee<S: Signers>( &self, source: &Address, destination: &Address, authority: &Address, amount: u64, fee: u64, signing_keypairs: &S, ) -> TokenResult<T::Output>

Transfer tokens to another account, given an expected fee

Source

pub async fn burn<S: Signers>( &self, source: &Address, authority: &Address, amount: u64, signing_keypairs: &S, ) -> TokenResult<T::Output>

Burn tokens from account

Source

pub async fn approve<S: Signers>( &self, source: &Address, delegate: &Address, authority: &Address, amount: u64, signing_keypairs: &S, ) -> TokenResult<T::Output>

Approve a delegate to spend tokens

Source

pub async fn revoke<S: Signers>( &self, source: &Address, authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Revoke a delegate

Source

pub async fn close_account<S: Signers>( &self, account: &Address, lamports_destination: &Address, authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Close an empty account and reclaim its lamports

Source

pub async fn empty_and_close_account<S: Signers>( &self, account_to_close: &Address, lamports_destination: &Address, tokens_destination: &Address, authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Close an account, reclaiming its lamports and tokens

Source

pub async fn freeze<S: Signers>( &self, account: &Address, authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Freeze a token account

Source

pub async fn thaw<S: Signers>( &self, account: &Address, authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Thaw / unfreeze a token account

Source

pub async fn wrap<S: Signers>( &self, account: &Address, owner: &Address, lamports: u64, signing_keypairs: &S, ) -> TokenResult<T::Output>

Wrap lamports into native account

Source

pub async fn wrap_with_mutable_ownership<S: Signers>( &self, account: &Address, owner: &Address, lamports: u64, signing_keypairs: &S, ) -> TokenResult<T::Output>

Wrap lamports into a native account that can always have its ownership changed

Source

pub async fn unwrap_lamports<S: Signers>( &self, source: &Address, destination: &Address, authority: &Address, amount: Option<u64>, signing_keypairs: &S, ) -> TokenResult<T::Output>

Unwrap lamports from native account

Source

pub async fn sync_native(&self, account: &Address) -> TokenResult<T::Output>

Sync native account lamports

Source

pub async fn set_transfer_fee<S: Signers>( &self, authority: &Address, transfer_fee_basis_points: u16, maximum_fee: u64, signing_keypairs: &S, ) -> TokenResult<T::Output>

Set transfer fee

Source

pub async fn set_default_account_state<S: Signers>( &self, authority: &Address, state: &AccountState, signing_keypairs: &S, ) -> TokenResult<T::Output>

Set default account state on mint

Source

pub async fn harvest_withheld_tokens_to_mint( &self, sources: &[&Address], ) -> TokenResult<T::Output>

Harvest withheld tokens to mint

Source

pub async fn withdraw_withheld_tokens_from_mint<S: Signers>( &self, destination: &Address, authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Withdraw withheld tokens from mint

Source

pub async fn withdraw_withheld_tokens_from_accounts<S: Signers>( &self, destination: &Address, authority: &Address, sources: &[&Address], signing_keypairs: &S, ) -> TokenResult<T::Output>

Withdraw withheld tokens from accounts

Source

pub async fn reallocate<S: Signers>( &self, account: &Address, authority: &Address, extension_types: &[ExtensionType], signing_keypairs: &S, ) -> TokenResult<T::Output>

Reallocate a token account to be large enough for a set of ExtensionTypes

Source

pub async fn enable_required_transfer_memos<S: Signers>( &self, account: &Address, authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Require memos on transfers into this account

Source

pub async fn disable_required_transfer_memos<S: Signers>( &self, account: &Address, authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Stop requiring memos on transfers into this account

Source

pub async fn pause<S: Signers>( &self, authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Pause transferring, minting, and burning on the mint

Source

pub async fn resume<S: Signers>( &self, authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Resume transferring, minting, and burning on the mint

Source

pub async fn enable_cpi_guard<S: Signers>( &self, account: &Address, authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Prevent unsafe usage of token account through CPI

Source

pub async fn disable_cpi_guard<S: Signers>( &self, account: &Address, authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Stop preventing unsafe usage of token account through CPI

Source

pub async fn update_interest_rate<S: Signers>( &self, authority: &Address, new_rate: i16, signing_keypairs: &S, ) -> TokenResult<T::Output>

Update interest rate

Source

pub async fn update_multiplier<S: Signers>( &self, authority: &Address, new_multiplier: f64, new_multiplier_effective_timestamp: i64, signing_keypairs: &S, ) -> TokenResult<T::Output>

Update multiplier

Source

pub async fn update_transfer_hook_program_id<S: Signers>( &self, authority: &Address, new_program_id: Option<Address>, signing_keypairs: &S, ) -> TokenResult<T::Output>

Update transfer hook program id

Source

pub async fn update_metadata_address<S: Signers>( &self, authority: &Address, new_metadata_address: Option<Address>, signing_keypairs: &S, ) -> TokenResult<T::Output>

Update metadata pointer address

Source

pub async fn update_group_address<S: Signers>( &self, authority: &Address, new_group_address: Option<Address>, signing_keypairs: &S, ) -> TokenResult<T::Output>

Update group pointer address

Source

pub async fn update_group_member_address<S: Signers>( &self, authority: &Address, new_member_address: Option<Address>, signing_keypairs: &S, ) -> TokenResult<T::Output>

Update group member pointer address

Source

pub async fn confidential_transfer_update_mint<S: Signers>( &self, authority: &Address, auto_approve_new_account: bool, auditor_elgamal_pubkey: Option<PodElGamalPubkey>, signing_keypairs: &S, ) -> TokenResult<T::Output>

Update confidential transfer mint

Source

pub async fn confidential_transfer_configure_token_account<S: Signers>( &self, account: &Address, authority: &Address, context_state_account: Option<&Address>, maximum_pending_balance_credit_counter: Option<u64>, elgamal_keypair: &ElGamalKeypair, aes_key: &AeKey, signing_keypairs: &S, ) -> TokenResult<T::Output>

Configures confidential transfers for a token account. If the maximum pending balance credit counter for the extension is not provided, then it is set to be a default value of 2^16.

Source

pub async fn confidential_transfer_configure_token_account_with_registry( &self, account: &Address, elgamal_registry_account: &Address, payer: Option<&Address>, ) -> TokenResult<T::Output>

Configures confidential transfers for a token account using an ElGamal registry account

Source

pub async fn confidential_transfer_approve_account<S: Signers>( &self, account: &Address, authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Approves a token account for confidential transfers

Source

pub async fn confidential_transfer_empty_account<S: Signers>( &self, account: &Address, authority: &Address, context_state_account: Option<&Address>, account_info: Option<EmptyAccountAccountInfo>, elgamal_keypair: &ElGamalKeypair, signing_keypairs: &S, ) -> TokenResult<T::Output>

Prepare a token account with the confidential transfer extension for closing

Source

pub async fn confidential_transfer_deposit<S: Signers>( &self, account: &Address, authority: &Address, amount: u64, decimals: u8, signing_keypairs: &S, ) -> TokenResult<T::Output>

Deposit SPL Tokens into the pending balance of a confidential token account

Source

pub async fn confidential_transfer_withdraw<S: Signers>( &self, account: &Address, authority: &Address, equality_proof_account: Option<&Address>, range_proof_account: Option<&Address>, withdraw_amount: u64, decimals: u8, account_info: Option<WithdrawAccountInfo>, elgamal_keypair: &ElGamalKeypair, aes_key: &AeKey, signing_keypairs: &S, ) -> TokenResult<T::Output>

Withdraw SPL Tokens from the available balance of a confidential token account

Source

pub async fn confidential_transfer_transfer<S: Signers>( &self, source_account: &Address, destination_account: &Address, source_authority: &Address, equality_proof_account: Option<&Address>, ciphertext_validity_proof_account_with_ciphertext: Option<&ProofAccountWithCiphertext>, range_proof_account: Option<&Address>, transfer_amount: u64, account_info: Option<TransferAccountInfo>, source_elgamal_keypair: &ElGamalKeypair, source_aes_key: &AeKey, destination_elgamal_pubkey: &ElGamalPubkey, auditor_elgamal_pubkey: Option<&ElGamalPubkey>, signing_keypairs: &S, ) -> TokenResult<T::Output>

Transfer tokens confidentially

Source

pub async fn confidential_transfer_create_record_account<S1: Signer, S2: Signer, ZK: Pod + ZkProofData<U>, U: Pod>( &self, record_account: &Address, record_authority: &Address, proof_data: &ZK, record_account_signer: &S1, record_authority_signer: &S2, ) -> TokenResult<Vec<T::Output>>

Create a record account containing zero-knowledge proof needed for a confidential transfer.

Source

pub async fn confidential_transfer_close_record_account<S: Signers>( &self, record_account: &Address, lamport_destination_account: &Address, record_account_authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Close a record account.

Source

pub async fn confidential_transfer_create_context_state_account<S: Signers, ZK: Pod + ZkProofData<U>, U: Pod>( &self, context_state_account: &Address, context_state_authority: &Address, proof_data: &ZK, split_account_creation_and_proof_verification: bool, signing_keypairs: &S, ) -> TokenResult<T::Output>

Create a context state account containing zero-knowledge proof needed for a confidential transfer instruction.

Source

pub async fn confidential_transfer_create_context_state_account_from_record<S: Signers, ZK: Pod + ZkProofData<U>, U: Pod>( &self, context_state_account: &Address, context_state_authority: &Address, record_account: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Create a context state account from another account containing zero-knowledge proof needed for a confidential transfer instruction.

Source

pub async fn confidential_transfer_close_context_state_account<S: Signers>( &self, context_state_account: &Address, lamport_destination_account: &Address, context_state_authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Close a ZK Token proof program context state

Source

pub async fn confidential_transfer_transfer_with_fee<S: Signers>( &self, source_account: &Address, destination_account: &Address, source_authority: &Address, equality_proof_account: Option<&Address>, transfer_amount_ciphertext_validity_proof_account_with_ciphertext: Option<&ProofAccountWithCiphertext>, percentage_with_cap_proof_account: Option<&Address>, fee_ciphertext_validity_proof_account: Option<&Address>, range_proof_account: Option<&Address>, transfer_amount: u64, account_info: Option<TransferAccountInfo>, source_elgamal_keypair: &ElGamalKeypair, source_aes_key: &AeKey, destination_elgamal_pubkey: &ElGamalPubkey, auditor_elgamal_pubkey: Option<&ElGamalPubkey>, withdraw_withheld_authority_elgamal_pubkey: &ElGamalPubkey, fee_rate_basis_points: u16, maximum_fee: u64, signing_keypairs: &S, ) -> TokenResult<T::Output>

Transfer tokens confidentially with fee

Source

pub async fn confidential_transfer_apply_pending_balance<S: Signers>( &self, account: &Address, authority: &Address, account_info: Option<ApplyPendingBalanceAccountInfo>, elgamal_secret_key: &ElGamalSecretKey, aes_key: &AeKey, signing_keypairs: &S, ) -> TokenResult<T::Output>

Applies the confidential transfer pending balance to the available balance

Source

pub async fn confidential_transfer_enable_confidential_credits<S: Signers>( &self, account: &Address, authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Enable confidential transfer Deposit and Transfer instructions for a token account

Source

pub async fn confidential_transfer_disable_confidential_credits<S: Signers>( &self, account: &Address, authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Disable confidential transfer Deposit and Transfer instructions for a token account

Source

pub async fn confidential_transfer_enable_non_confidential_credits<S: Signers>( &self, account: &Address, authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Enable a confidential extension token account to receive non-confidential payments

Source

pub async fn confidential_transfer_disable_non_confidential_credits<S: Signers>( &self, account: &Address, authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Disable non-confidential payments for a confidential extension token account

Source

pub async fn confidential_transfer_withdraw_withheld_tokens_from_mint<S: Signers>( &self, destination_account: &Address, withdraw_withheld_authority: &Address, context_state_account: Option<&Address>, withheld_tokens_info: Option<WithheldTokensInfo>, withdraw_withheld_authority_elgamal_keypair: &ElGamalKeypair, destination_elgamal_pubkey: &ElGamalPubkey, new_decryptable_available_balance: &DecryptableBalance, signing_keypairs: &S, ) -> TokenResult<T::Output>

Withdraw withheld confidential tokens from mint

Source

pub async fn confidential_transfer_withdraw_withheld_tokens_from_accounts<S: Signers>( &self, destination_account: &Address, withdraw_withheld_authority: &Address, context_state_account: Option<&Address>, withheld_tokens_info: Option<WithheldTokensInfo>, withdraw_withheld_authority_elgamal_keypair: &ElGamalKeypair, destination_elgamal_pubkey: &ElGamalPubkey, new_decryptable_available_balance: &DecryptableBalance, sources: &[&Address], signing_keypairs: &S, ) -> TokenResult<T::Output>

Withdraw withheld confidential tokens from accounts

Source

pub async fn confidential_transfer_harvest_withheld_tokens_to_mint( &self, sources: &[&Address], ) -> TokenResult<T::Output>

Harvest withheld confidential tokens to mint

Source

pub async fn confidential_transfer_enable_harvest_to_mint<S: Signers>( &self, withdraw_withheld_authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Enable harvest of confidential fees to mint

Source

pub async fn confidential_transfer_disable_harvest_to_mint<S: Signers>( &self, withdraw_withheld_authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Disable harvest of confidential fees to mint

Source

pub async fn confidential_transfer_rotate_supply_elgamal_pubkey<S: Signers>( &self, authority: &Address, current_supply_elgamal_keypair: &ElGamalKeypair, new_supply_elgamal_pubkey: &ElGamalPubkey, aes_key: &AeKey, context_state_account: Option<&Address>, account_info: Option<SupplyAccountInfo>, signing_keypairs: &S, ) -> TokenResult<T::Output>

Rotate supply ElGamal public key in a confidential mint

Source

pub async fn confidential_transfer_update_decrypt_supply<S: Signers>( &self, authority: &Address, new_decryptable_supply: &DecryptableBalance, signing_keypairs: &S, ) -> TokenResult<T::Output>

Update decryptable supply in a confidential mint

Source

pub async fn confidential_transfer_mint<S: Signers>( &self, authority: &Address, destination_account: &Address, equality_proof_account: Option<&Address>, ciphertext_validity_proof_account_with_ciphertext: Option<&ProofAccountWithCiphertext>, range_proof_account: Option<&Address>, mint_amount: u64, supply_elgamal_keypair: &ElGamalKeypair, destination_elgamal_pubkey: &ElGamalPubkey, auditor_elgamal_pubkey: Option<&ElGamalPubkey>, aes_key: &AeKey, account_info: Option<SupplyAccountInfo>, signing_keypairs: &S, ) -> TokenResult<T::Output>

Confidentially mint tokens

Source

pub async fn confidential_transfer_permissioned_burn<S: Signers>( &self, authority: &Address, source_account: &Address, permissioned_burn_authority: &Address, equality_proof_account: Option<&Address>, ciphertext_validity_proof_account_with_ciphertext: Option<&ProofAccountWithCiphertext>, range_proof_account: Option<&Address>, burn_amount: u64, source_elgamal_keypair: &ElGamalKeypair, supply_elgamal_pubkey: &ElGamalPubkey, auditor_elgamal_pubkey: Option<&ElGamalPubkey>, aes_key: &AeKey, account_info: Option<BurnAccountInfo>, signing_keypairs: &S, ) -> TokenResult<T::Output>

Confidentially burn tokens with permissioned burn authority

Source

pub async fn confidential_transfer_burn<S: Signers>( &self, authority: &Address, source_account: &Address, equality_proof_account: Option<&Address>, ciphertext_validity_proof_account_with_ciphertext: Option<&ProofAccountWithCiphertext>, range_proof_account: Option<&Address>, burn_amount: u64, source_elgamal_keypair: &ElGamalKeypair, supply_elgamal_pubkey: &ElGamalPubkey, auditor_elgamal_pubkey: Option<&ElGamalPubkey>, aes_key: &AeKey, account_info: Option<BurnAccountInfo>, signing_keypairs: &S, ) -> TokenResult<T::Output>

Confidentially burn tokens

Source

pub async fn confidential_transfer_apply_pending_burn<S: Signers>( &self, authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Apply pending burn amount to the confidential supply amount

Source

pub async fn withdraw_excess_lamports<S: Signers>( &self, source: &Address, destination: &Address, authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Source

pub async fn token_metadata_initialize<S: Signers>( &self, update_authority: &Address, mint_authority: &Address, name: String, symbol: String, uri: String, signing_keypairs: &S, ) -> TokenResult<T::Output>

Initialize token-metadata on a mint

Source

pub async fn token_metadata_initialize_with_rent_transfer<S: Signers>( &self, payer: &Address, update_authority: &Address, mint_authority: &Address, name: String, symbol: String, uri: String, signing_keypairs: &S, ) -> TokenResult<T::Output>

Initialize token-metadata on a mint

Source

pub async fn token_metadata_update_field<S: Signers>( &self, update_authority: &Address, field: Field, value: String, signing_keypairs: &S, ) -> TokenResult<T::Output>

Update a token-metadata field on a mint

Source

pub async fn token_metadata_update_field_with_rent_transfer<S: Signers>( &self, payer: &Address, update_authority: &Address, field: Field, value: String, transfer_lamports: Option<u64>, signing_keypairs: &S, ) -> TokenResult<T::Output>

Update a token-metadata field on a mint. Includes a transfer for any additional rent-exempt SOL required.

Source

pub async fn token_metadata_update_authority<S: Signers>( &self, current_authority: &Address, new_authority: Option<Address>, signing_keypairs: &S, ) -> TokenResult<T::Output>

Update the token-metadata authority in a mint

Source

pub async fn token_metadata_remove_key<S: Signers>( &self, update_authority: &Address, key: String, idempotent: bool, signing_keypairs: &S, ) -> TokenResult<T::Output>

Remove a token-metadata field on a mint

Source

pub async fn token_group_initialize<S: Signers>( &self, mint_authority: &Address, update_authority: &Address, max_size: u64, signing_keypairs: &S, ) -> TokenResult<T::Output>

Initialize token-group on a mint

Source

pub async fn token_group_initialize_with_rent_transfer<S: Signers>( &self, payer: &Address, mint_authority: &Address, update_authority: &Address, max_size: u64, signing_keypairs: &S, ) -> TokenResult<T::Output>

Initialize token-group on a mint

Source

pub async fn token_group_update_max_size<S: Signers>( &self, update_authority: &Address, new_max_size: u64, signing_keypairs: &S, ) -> TokenResult<T::Output>

Update a token-group max size on a mint

Source

pub async fn token_group_update_authority<S: Signers>( &self, current_authority: &Address, new_authority: Option<Address>, signing_keypairs: &S, ) -> TokenResult<T::Output>

Update the token-group authority in a mint

Source

pub async fn token_group_initialize_member<S: Signers>( &self, mint_authority: &Address, group_mint: &Address, group_update_authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Initialize a token-group member on a mint

Source

pub async fn token_group_initialize_member_with_rent_transfer<S: Signers>( &self, payer: &Address, mint_authority: &Address, group_mint: &Address, group_update_authority: &Address, signing_keypairs: &S, ) -> TokenResult<T::Output>

Initialize a token-group member on a mint

Source

pub async fn confidential_transfer_get_pending_balance( &self, account: &Address, elgamal_secret_key: &ElGamalSecretKey, ) -> TokenResult<u64>

Get the pending balance for a confidential transfer account.

This decrypts and combines the low 16 bits and high 48 bits of the pending balance into a single u64 value.

Source

pub async fn confidential_transfer_get_available_balance( &self, account: &Address, aes_key: &AeKey, ) -> TokenResult<u64>

Get the available balance for a confidential transfer account.

This decrypts the decryptable available balance using the provided AES key.

Source

pub async fn confidential_transfer_get_total_balance( &self, account: &Address, elgamal_secret_key: &ElGamalSecretKey, aes_key: &AeKey, ) -> TokenResult<u64>

Get the total balance (pending and available) for a confidential transfer account.

This combines both pending and available balances with overflow protection.

Source

pub async fn confidential_transfer_has_pending_balance( &self, account: &Address, ) -> TokenResult<bool>

Check if a confidential transfer account has any pending balance.

This checks whether the pending_balance_credit_counter is greater than zero.

Trait Implementations§

Source§

impl<T> Debug for Token<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for Token<T>

§

impl<T> !Send for Token<T>

§

impl<T> !Sync for Token<T>

§

impl<T> !UnwindSafe for Token<T>

§

impl<T> Freeze for Token<T>

§

impl<T> Unpin for Token<T>

§

impl<T> UnsafeUnpin for Token<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> MaybeSendSync for T

Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more