Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[token-2022] Update docs to use zk_elgamal_proof program #7162

Merged
merged 1 commit into from
Aug 19, 2024
Merged

[token-2022] Update docs to use zk_elgamal_proof program #7162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 38 additions & 34 deletions token/program-2022/src/extension/confidential_transfer/instruction.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ use {
instruction::{encode_instruction, TokenInstruction},
proof::{ProofData, ProofLocation},
},
bytemuck::Zeroable, // `Pod` comes from zk_token_proof_instruction
bytemuck::Zeroable,
num_enum::{IntoPrimitive, TryFromPrimitive},
solana_program::{
instruction::{AccountMeta, Instruction},
Expand Down Expand Up @@ -75,18 +75,18 @@ pub enum ConfidentialTransferInstruction {
/// `DisableNonConfidentialCredits` instructions to disable.
///
/// In order for this instruction to be successfully processed, it must be
/// accompanied by the `VerifyPubkeyValidityProof` instruction of the
/// `zk_token_proof` program in the same transaction or the address of a
/// accompanied by the `VerifyPubkeyValidity` instruction of the
/// `zk_elgamal_proof` program in the same transaction or the address of a
/// context state account for the proof must be provided.
///
/// Accounts expected by this instruction:
///
/// * Single owner/delegate
/// 0. `[writeable]` The SPL Token account.
/// 1. `[]` The corresponding SPL Token mint.
/// 2. `[]` Instructions sysvar if `VerifyPubkeyValidityProof` is included
/// in the same transaction or context state account if
/// `VerifyPubkeyValidityProof` is pre-verified into a context state
/// 2. `[]` Instructions sysvar if `VerifyPubkeyValidity` is included in
/// the same transaction or context state account if
/// `VerifyPubkeyValidity` is pre-verified into a context state
/// account.
/// 3. `[]` (Optional) Record account if the accompanying proof is to be
/// read from a record account.
Expand All @@ -95,9 +95,9 @@ pub enum ConfidentialTransferInstruction {
/// * Multisignature owner/delegate
/// 0. `[writeable]` The SPL Token account.
/// 1. `[]` The corresponding SPL Token mint.
/// 2. `[]` Instructions sysvar if `VerifyPubkeyValidityProof` is included
/// in the same transaction or context state account if
/// `VerifyPubkeyValidityProof` is pre-verified into a context state
/// 2. `[]` Instructions sysvar if `VerifyPubkeyValidity` is included in
/// the same transaction or context state account if
/// `VerifyPubkeyValidity` is pre-verified into a context state
/// account.
/// 3. `[]` (Optional) Record account if the accompanying proof is to be
/// read from a record account.
Expand Down Expand Up @@ -143,25 +143,25 @@ pub enum ConfidentialTransferInstruction {
/// token account.
///
/// In order for this instruction to be successfully processed, it must be
/// accompanied by the `VerifyZeroBalanceProof` instruction of the
/// `zk_token_proof` program in the same transaction or the address of a
/// accompanied by the `VerifyZeroCiphertext` instruction of the
/// `zk_elgamal_proof` program in the same transaction or the address of a
/// context state account for the proof must be provided.
///
/// * Single owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[]` Instructions sysvar if `VerifyZeroBalanceProof` is included in
/// 1. `[]` Instructions sysvar if `VerifyZeroCiphertext` is included in
/// the same transaction or context state account if
/// `VerifyZeroBalanceProof` is pre-verified into a context state
/// `VerifyZeroCiphertext` is pre-verified into a context state
/// account.
/// 2. `[]` (Optional) Record account if the accompanying proof is to be
/// read from a record account.
/// 3. `[signer]` The single account owner.
///
/// * Multisignature owner/delegate
/// 0. `[writable]` The SPL Token account.
/// 1. `[]` Instructions sysvar if `VerifyZeroBalanceProof` is included in
/// 1. `[]` Instructions sysvar if `VerifyZeroCiphertext` is included in
/// the same transaction or context state account if
/// `VerifyZeroBalanceProof` is pre-verified into a context state
/// `VerifyZeroCiphertext` is pre-verified into a context state
/// account.
/// 2. `[]` (Optional) Record account if the accompanying proof is to be
/// read from a record account.
Expand Down Expand Up @@ -251,10 +251,10 @@ pub enum ConfidentialTransferInstruction {
/// Transfer tokens confidentially.
///
/// In order for this instruction to be successfully processed, it must be
/// accompanied by the following list of `zk_token_proof` program
/// accompanied by the following list of `zk_elgamal_proof` program
/// instructions:
/// - `VerifyCiphertextCommitmentEqualityProof`
/// - `VerifyBatchedGroupedCiphertext3HandlesValidityProof`
/// - `VerifyCiphertextCommitmentEquality`
/// - `VerifyBatchedGroupedCiphertext3HandlesValidity`
/// - `VerifyBatchedRangeProofU128`
/// These instructions can be accompanied in the same transaction or can be
/// pre-verified into a context state account, in which case, only their
Expand All @@ -267,7 +267,8 @@ pub enum ConfidentialTransferInstruction {
/// 2. `[]` The token mint.
/// 3. `[writable]` The destination SPL Token account.
/// 4. `[]` (Optional) Instructions sysvar if at least one of the
/// `zk_token_proof` instructions are included in the same transaction.
/// `zk_elgamal_proof` instructions are included in the same
/// transaction.
/// 5. `[]` (Optional) Equality proof record account or context state
/// account.
/// 6. `[]` (Optional) Ciphertext validity proof record account or context
Expand All @@ -281,7 +282,8 @@ pub enum ConfidentialTransferInstruction {
/// 2. `[]` The token mint.
/// 3. `[writable]` The destination SPL Token account.
/// 4. `[]` (Optional) Instructions sysvar if at least one of the
/// `zk_token_proof` instructions are included in the same transaction.
/// `zk_elgamal_proof` instructions are included in the same
/// transaction.
/// 5. `[]` (Optional) Equality proof record account or context state
/// account.
/// 6. `[]` (Optional) Ciphertext validity proof record account or context
Expand Down Expand Up @@ -412,13 +414,13 @@ pub enum ConfidentialTransferInstruction {
/// Transfer tokens confidentially with fee.
///
/// In order for this instruction to be successfully processed, it must be
/// accompanied by the following list of `zk_token_proof` program
/// accompanied by the following list of `zk_elgamal_proof` program
/// instructions:
/// - `VerifyCiphertextCommitmentEqualityProof`
/// - `VerifyBatchedGroupedCiphertext3HandlesValidityProof` (transfer amount
/// - `VerifyCiphertextCommitmentEquality`
/// - `VerifyBatchedGroupedCiphertext3HandlesValidity` (transfer amount
/// ciphertext)
/// - `FeeSigmaProof`
/// - `VerifyBatchedGroupedCiphertext2HandlesValidityProof` (fee ciphertext)
/// - `VerifyPercentageWithFee`
/// - `VerifyBatchedGroupedCiphertext2HandlesValidity` (fee ciphertext)
/// - `VerifyBatchedRangeProofU256`
/// These instructions can be accompanied in the same transaction or can be
/// pre-verified into a context state account, in which case, only their
Expand All @@ -433,7 +435,8 @@ pub enum ConfidentialTransferInstruction {
/// 2. `[]` The token mint.
/// 3. `[writable]` The destination SPL Token account.
/// 4. `[]` (Optional) Instructions sysvar if at least one of the
/// `zk_token_proof` instructions are included in the same transaction.
/// `zk_elgamal_proof` instructions are included in the same
/// transaction.
/// 5. `[]` (Optional) Equality proof record account or context state
/// account.
/// 6. `[]` (Optional) Transfer amount ciphertext validity proof record
Expand All @@ -451,7 +454,8 @@ pub enum ConfidentialTransferInstruction {
/// 2. `[]` The token mint.
/// 3. `[writable]` The destination SPL Token account.
/// 4. `[]` (Optional) Instructions sysvar if at least one of the
/// `zk_token_proof` instructions are included in the same transaction.
/// `zk_elgamal_proof` instructions are included in the same
/// transaction.
/// 5. `[]` (Optional) Equality proof record account or context state
/// account.
/// 6. `[]` (Optional) Transfer amount ciphertext validity proof record
Expand Down Expand Up @@ -511,7 +515,7 @@ pub struct ConfigureAccountInstructionData {
/// The maximum number of despots and transfers that an account can receiver
/// before the `ApplyPendingBalance` is executed
pub maximum_pending_balance_credit_counter: PodU64,
/// Relative location of the `ProofInstruction::ZeroBalanceProof`
/// Relative location of the `ProofInstruction::ZeroCiphertextProof`
/// instruction to the `ConfigureAccount` instruction in the
/// transaction. If the offset is `0`, then use a context state account
/// for the proof.
Expand Down Expand Up @@ -576,12 +580,12 @@ pub struct TransferInstructionData {
#[cfg_attr(feature = "serde-traits", serde(with = "aeciphertext_fromstr"))]
pub new_source_decryptable_available_balance: DecryptableBalance,
/// Relative location of the
/// `ProofInstruction::VerifyCiphertextCommitmentEqualityProof` instruction
/// `ProofInstruction::VerifyCiphertextCommitmentEquality` instruction
/// to the `Transfer` instruction in the transaction. If the offset is
/// `0`, then use a context state account for the proof.
pub equality_proof_instruction_offset: i8,
/// Relative location of the
/// `ProofInstruction::VerifyBatchedGroupedCiphertext3HandlesValidityProof`
/// `ProofInstruction::VerifyBatchedGroupedCiphertext3HandlesValidity`
/// instruction to the `Transfer` instruction in the transaction. If the
/// offset is `0`, then use a context state account for the proof.
pub ciphertext_validity_proof_instruction_offset: i8,
Expand Down Expand Up @@ -615,23 +619,23 @@ pub struct TransferWithFeeInstructionData {
#[cfg_attr(feature = "serde-traits", serde(with = "aeciphertext_fromstr"))]
pub new_source_decryptable_available_balance: DecryptableBalance,
/// Relative location of the
/// `ProofInstruction::VerifyCiphertextCommitmentEqualityProof` instruction
/// `ProofInstruction::VerifyCiphertextCommitmentEquality` instruction
/// to the `TransferWithFee` instruction in the transaction. If the offset
/// is `0`, then use a context state account for the proof.
pub equality_proof_instruction_offset: i8,
/// Relative location of the
/// `ProofInstruction::VerifyBatchedGroupedCiphertext3HandlesValidityProof`
/// `ProofInstruction::VerifyBatchedGroupedCiphertext3HandlesValidity`
/// instruction to the `TransferWithFee` instruction in the transaction.
/// If the offset is `0`, then use a context state account for the
/// proof.
pub transfer_amount_ciphertext_validity_proof_instruction_offset: i8,
/// Relative location of the `ProofInstruction::VerifyFeeSigmaProof`
/// Relative location of the `ProofInstruction::VerifyPercentageWithFee`
/// instruction to the `TransferWithFee` instruction in the transaction.
/// If the offset is `0`, then use a context state account for the
/// proof.
pub fee_sigma_proof_instruction_offset: i8,
/// Relative location of the
/// `ProofInstruction::VerifyBatchedGroupedCiphertext2HandlesValidityProof`
/// `ProofInstruction::VerifyBatchedGroupedCiphertext2HandlesValidity`
/// instruction to the `TransferWithFee` instruction in the transaction.
/// If the offset is `0`, then use a context state account for the
/// proof.
Expand Down
4 changes: 2 additions & 2 deletions token/program-2022/src/extension/confidential_transfer_fee/instruction.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ pub enum ConfidentialTransferFeeInstruction {
///
/// In order for this instruction to be successfully processed, it must be
/// accompanied by the `VerifyCiphertextCiphertextEquality` instruction
/// of the `zk_token_proof` program in the same transaction or the
/// of the `zk_elgamal_proof` program in the same transaction or the
/// address of a context state account for the proof must be provided.
///
/// Accounts expected by this instruction:
Expand Down Expand Up @@ -126,7 +126,7 @@ pub enum ConfidentialTransferFeeInstruction {
///
/// In order for this instruction to be successfully processed, it must be
/// accompanied by the `VerifyWithdrawWithheldTokens` instruction of the
/// `zk_token_proof` program in the same transaction or the address of a
/// `zk_elgamal_proof` program in the same transaction or the address of a
/// context state account for the proof must be provided.
///
/// Accounts expected by this instruction:
Expand Down
2 changes: 1 addition & 1 deletion token/program-2022/src/proof.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! Helper for processing instruction data from ZK Token proof program
//! Helper for processing instruction data from ZK ElGamal proof program

use {
crate::check_zk_token_proof_program_account,
Expand Down
Loading