Struct spl_token_2022::extension::confidential_transfer::ConfidentialTransferAccount

#[repr(C)]
pub struct ConfidentialTransferAccount {
    pub approved: PodBool,
    pub pubkey_elgamal: EncryptionPubkey,
    pub pending_balance: EncryptedBalance,
    pub available_balance: EncryptedBalance,
    pub decryptable_available_balance: DecryptableBalance,
    pub allow_balance_credits: PodBool,
    pub pending_balance_credit_counter: PodU64,
    pub expected_pending_balance_credit_counter: PodU64,
    pub actual_pending_balance_credit_counter: PodU64,
    pub withheld_amount: EncryptedWithheldAmount,
}

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.

pubkey_elgamal: EncryptionPubkey

The public key associated with ElGamal encryption

pending_balance: EncryptedBalance

The pending balance (encrypted by pubkey_elgamal)

available_balance: EncryptedBalance

The available balance (encrypted by pubkey_elgamal)

decryptable_available_balance: DecryptableBalance

The decryptable available balance

allow_balance_credits: PodBool

pending_balance may only be credited by Deposit or Transfer instructions if true

pending_balance_credit_counter: PodU64

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

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

withheld_amount: EncryptedWithheldAmount

The withheld amount of fees. This will always be zero if fees are never enabled.

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

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

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

impl PartialEq<ConfidentialTransferAccount> 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: &ConfidentialTransferAccount) -> bool

This method tests for !=.

impl Zeroable for ConfidentialTransferAccount

fn zeroed() -> Self

Calls zeroed.

impl Copy for ConfidentialTransferAccount

impl Pod for ConfidentialTransferAccount

impl StructuralPartialEq for ConfidentialTransferAccount