1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
use {
crate::{
error::TokenError,
extension::{Extension, ExtensionType},
pod::*,
},
bytemuck::{Pod, Zeroable},
solana_program::entrypoint::ProgramResult,
safe_zk_token_sdk::zk_token_elgamal::pod,
};
/// Maximum bit length of any deposit or transfer amount
///
/// Any deposit or transfer amount must be less than 2^48
pub const MAXIMUM_DEPOSIT_TRANSFER_AMOUNT_BIT_LENGTH: usize = 48;
/// Bit length of the low bits of pending balance plaintext
pub const PENDING_BALANCE_LO_BIT_LENGTH: usize = 16;
/// Bit length of the high bits of pending balance plaintext
pub const PENDING_BALANCE_HI_BIT_LENGTH: usize = 48;
/// Confidential Transfer Extension instructions
pub mod instruction;
/// Confidential Transfer Extension processor
pub mod processor;
/// ElGamal ciphertext containing an account balance
pub type EncryptedBalance = pod::ElGamalCiphertext;
/// Authenticated encryption containing an account balance
pub type DecryptableBalance = pod::AeCiphertext;
/// (aggregated) ElGamal ciphertext containing a transfer fee
pub type EncryptedFee = pod::FeeEncryption;
/// ElGamal ciphertext containing a withheld amount
pub type EncryptedWithheldAmount = pod::ElGamalCiphertext;
/// Confidential transfer mint configuration
#[repr(C)]
#[derive(Clone, Copy, Debug, Default, PartialEq, Pod, Zeroable)]
pub struct ConfidentialTransferMint {
/// Authority to modify the `ConfidentialTransferMint` configuration and to approve new
/// accounts (if `auto_approve_new_accounts` is true)
///
/// The legacy Token Multisig account is not supported as the authority
pub authority: OptionalNonZeroPubkey,
/// Indicate if newly configured accounts must be approved by the `authority` before they may be
/// used by the user.
///
/// * If `true`, no approval is required and new accounts may be used immediately
/// * If `false`, the authority must approve newly configured accounts (see
/// `ConfidentialTransferInstruction::ConfigureAccount`)
pub auto_approve_new_accounts: PodBool,
/// Authority to decode any transfer amount in a confidential transafer.
pub auditor_encryption_pubkey: OptionalNonZeroEncryptionPubkey,
/// Authority to withraw withheld fees that are associated with accounts. It must be set to
/// `None` if the mint is not extended for fees.
///
/// Note that the withdraw withheld authority has the ability to decode any withheld fee
/// amount that are associated with accounts. When combined with the fee parameters, the
/// withheld fee amounts can reveal information about transfer amounts.
///
/// * If not `None`, transfers must include ElGamal cyphertext of the transfer fee with this
/// public key. If this is the case, but the base mint is not extended for fees, then any
/// transfer will fail.
/// * If `None`, transfer fee is disabled. If this is the case, but the base mint is extended
/// for fees, then any transfer will fail.
pub withdraw_withheld_authority_encryption_pubkey: OptionalNonZeroEncryptionPubkey,
/// Withheld transfer fee confidential tokens that have been moved to the mint for withdrawal.
/// This will always be zero if fees are never enabled.
pub withheld_amount: EncryptedWithheldAmount,
}
impl Extension for ConfidentialTransferMint {
const TYPE: ExtensionType = ExtensionType::ConfidentialTransferMint;
}
/// Confidential account state
#[repr(C)]
#[derive(Clone, Copy, Debug, Default, PartialEq, Pod, Zeroable)]
pub struct ConfidentialTransferAccount {
/// `true` if this account has been approved for use. All confidential transfer operations for
/// the account will fail until approval is granted.
pub approved: PodBool,
/// The public key associated with ElGamal encryption
pub encryption_pubkey: EncryptionPubkey,
/// The low 16 bits of the pending balance (encrypted by `encryption_pubkey`)
pub pending_balance_lo: EncryptedBalance,
/// The high 48 bits of the pending balance (encrypted by `encryption_pubkey`)
pub pending_balance_hi: EncryptedBalance,
/// The available balance (encrypted by `encrypiton_pubkey`)
pub available_balance: EncryptedBalance,
/// The decryptable available balance
pub decryptable_available_balance: DecryptableBalance,
/// If `false`, the extended account rejects any incoming confidential transfers
pub allow_confidential_credits: PodBool,
/// If `false`, the base account rejects any incoming transfers
pub allow_non_confidential_credits: PodBool,
/// The total number of `Deposit` and `Transfer` instructions that have credited
/// `pending_balance`
pub pending_balance_credit_counter: PodU64,
/// The maximum number of `Deposit` and `Transfer` instructions that can credit
/// `pending_balance` before the `ApplyPendingBalance` instruction is executed
pub maximum_pending_balance_credit_counter: PodU64,
/// The `expected_pending_balance_credit_counter` value that was included in the last
/// `ApplyPendingBalance` instruction
pub expected_pending_balance_credit_counter: PodU64,
/// The actual `pending_balance_credit_counter` when the last `ApplyPendingBalance` instruction
/// was executed
pub actual_pending_balance_credit_counter: PodU64,
/// The withheld amount of fees. This will always be zero if fees are never enabled.
pub withheld_amount: EncryptedWithheldAmount,
}
impl Extension for ConfidentialTransferAccount {
const TYPE: ExtensionType = ExtensionType::ConfidentialTransferAccount;
}
impl ConfidentialTransferAccount {
/// Check if a `ConfidentialTransferAccount` has been approved for use.
pub fn approved(&self) -> ProgramResult {
if bool::from(&self.approved) {
Ok(())
} else {
Err(TokenError::ConfidentialTransferAccountNotApproved.into())
}
}
/// Check if a `ConfidentialTransferAccount` is in a closable state.
pub fn closable(&self) -> ProgramResult {
if self.pending_balance_lo == EncryptedBalance::zeroed()
&& self.pending_balance_hi == EncryptedBalance::zeroed()
&& self.available_balance == EncryptedBalance::zeroed()
&& self.withheld_amount == EncryptedWithheldAmount::zeroed()
{
Ok(())
} else {
Err(TokenError::ConfidentialTransferAccountHasBalance.into())
}
}
/// Check if a base account of a `ConfidentialTransferAccount` accepts non-confidential
/// transfers.
pub fn non_confidential_transfer_allowed(&self) -> ProgramResult {
if bool::from(&self.allow_non_confidential_credits) {
Ok(())
} else {
Err(TokenError::NonConfidentialTransfersDisabled.into())
}
}
/// Checks if a `ConfidentialTransferAccount` is configured to send funds.
pub fn valid_as_source(&self) -> ProgramResult {
self.approved()
}
/// 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 reached the maximum credit counter
pub fn valid_as_destination(&self) -> ProgramResult {
self.approved()?;
if !bool::from(self.allow_confidential_credits) {
return Err(TokenError::ConfidentialTransferDepositsAndTransfersDisabled.into());
}
let new_destination_pending_balance_credit_counter =
u64::from(self.pending_balance_credit_counter)
.checked_add(1)
.ok_or(TokenError::Overflow)?;
if new_destination_pending_balance_credit_counter
> u64::from(self.maximum_pending_balance_credit_counter)
{
return Err(TokenError::MaximumPendingBalanceCreditCounterExceeded.into());
}
Ok(())
}
/// Increments a confidential extension pending balance credit counter.
pub fn increment_pending_balance_credit_counter(&mut self) -> ProgramResult {
self.pending_balance_credit_counter = (u64::from(self.pending_balance_credit_counter)
.checked_add(1)
.ok_or(TokenError::Overflow)?)
.into();
Ok(())
}
}