Struct spl_token_2022::extension::confidential_transfer::ConfidentialTransferAccount

#[repr(C)]
pub struct ConfidentialTransferAccount {
    pub approved: PodBool,
    pub elgamal_pubkey: ElGamalPubkey,
    pub pending_balance_lo: EncryptedBalance,
    pub pending_balance_hi: EncryptedBalance,
    pub available_balance: EncryptedBalance,
    pub decryptable_available_balance: DecryptableBalance,
    pub allow_confidential_credits: PodBool,
    pub allow_non_confidential_credits: PodBool,
    pub pending_balance_credit_counter: PodU64,
    pub maximum_pending_balance_credit_counter: PodU64,
    pub expected_pending_balance_credit_counter: PodU64,
    pub actual_pending_balance_credit_counter: PodU64,
}

Confidential account state

Fields

approved: PodBool

true if this account has been approved for use. All confidential transfer operations for the account will fail until approval is granted.

elgamal_pubkey: ElGamalPubkey

The public key associated with ElGamal encryption

pending_balance_lo: EncryptedBalance

The low 16 bits of the pending balance (encrypted by elgamal_pubkey)

pending_balance_hi: EncryptedBalance

The high 48 bits of the pending balance (encrypted by elgamal_pubkey)

available_balance: EncryptedBalance

The available balance (encrypted by encrypiton_pubkey)

decryptable_available_balance: DecryptableBalance

The decryptable available balance

allow_confidential_credits: PodBool

If false, the extended account rejects any incoming confidential transfers

allow_non_confidential_credits: PodBool

If false, the base account rejects any incoming transfers

pending_balance_credit_counter: PodU64

The total number of Deposit and Transfer instructions that have credited pending_balance

maximum_pending_balance_credit_counter: PodU64

The maximum number of Deposit and Transfer instructions that can credit pending_balance before the ApplyPendingBalance instruction is executed

expected_pending_balance_credit_counter: PodU64

The expected_pending_balance_credit_counter value that was included in the last ApplyPendingBalance instruction

actual_pending_balance_credit_counter: PodU64

The actual pending_balance_credit_counter when the last ApplyPendingBalance instruction was executed

Implementations

impl ConfidentialTransferAccount

pub fn approved(&self) -> ProgramResult

Check if a ConfidentialTransferAccount has been approved for use.

pub fn closable(&self) -> ProgramResult

Check if a ConfidentialTransferAccount is in a closable state.

pub fn non_confidential_transfer_allowed(&self) -> ProgramResult

Check if a base account of a ConfidentialTransferAccount accepts non-confidential transfers.

pub fn valid_as_source(&self) -> ProgramResult

Checks if a ConfidentialTransferAccount is configured to send funds.

pub fn valid_as_destination(&self) -> ProgramResult

Checks if a confidential extension is configured to receive funds.

A destination account can receive funds if the following conditions are satisfied:

1. The account is approved by the confidential transfer mint authority
2. The account is not disabled by the account owner
3. The number of credits into the account has not reached the maximum credit counter

pub fn increment_pending_balance_credit_counter(&mut self) -> ProgramResult

Increments a confidential extension pending balance credit counter.

Trait Implementations

impl Clone for ConfidentialTransferAccount

fn clone(&self) -> ConfidentialTransferAccount

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfidentialTransferAccount

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

Formats the value using the given formatter.

impl Default for ConfidentialTransferAccount

fn default() -> ConfidentialTransferAccount

Returns the “default value” for a type.

impl Extension for ConfidentialTransferAccount

const TYPE: ExtensionType = ExtensionType::ConfidentialTransferAccount

Associated extension type enum, checked at the start of TLV entries

impl PartialEq for ConfidentialTransferAccount

fn eq(&self, other: &ConfidentialTransferAccount) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Zeroable for ConfidentialTransferAccount

fn zeroed() -> Self

Calls zeroed.

impl Copy for ConfidentialTransferAccount

impl Pod for ConfidentialTransferAccount

impl StructuralPartialEq for ConfidentialTransferAccount