Enum solana_zk_token_sdk::zk_token_proof_instruction::ProofInstruction

#[repr(u8)]
pub enum ProofInstruction {
    CloseContextState = 0,
    VerifyZeroBalance = 1,
    VerifyWithdraw = 2,
    VerifyCiphertextCiphertextEquality = 3,
    VerifyTransfer = 4,
    VerifyTransferWithFee = 5,
    VerifyPubkeyValidity = 6,
    VerifyRangeProofU64 = 7,
    VerifyBatchedRangeProofU64 = 8,
    VerifyBatchedRangeProofU128 = 9,
    VerifyBatchedRangeProofU256 = 10,
    VerifyCiphertextCommitmentEquality = 11,
    VerifyGroupedCiphertext2HandlesValidity = 12,
    VerifyBatchedGroupedCiphertext2HandlesValidity = 13,
    VerifyFeeSigma = 14,
}

Variants

CloseContextState = 0

Close a zero-knowledge proof context state.

Accounts expected by this instruction: 0. [writable] The proof context account to close

1. [writable] The destination account for lamports
2. [signer] The context account’s owner

Data expected by this instruction: None

VerifyZeroBalance = 1

Verify a zero-balance proof.

A zero-balance proof certifies that an ElGamal ciphertext encrypts the value zero.

Accounts expected by this instruction:

0. [] (Optional) Account to read the proof from
1. [writable] (Optional) The proof context account
2. [] (Optional) The proof context account owner

The instruction expects either: i. ZeroBalanceProofData if proof is provided as instruction data ii. u32 byte offset if proof is provided as an account

VerifyWithdraw = 2

Verify a withdraw zero-knowledge proof.

This proof is a collection of smaller proofs that are required by the SPL Token 2022 confidential extension Withdraw instruction.

Accounts expected by this instruction:

0. [] (Optional) Account to read the proof from
1. [writable] (Optional) The proof context account
2. [] (Optional) The proof context account owner

The instruction expects either: i. WithdrawData if proof is provided as instruction data ii. u32 byte offset if proof is provided as an account

VerifyCiphertextCiphertextEquality = 3

Verify a ciphertext-ciphertext equality proof.

A ciphertext-ciphertext equality proof certifies that two ElGamal ciphertexts encrypt the same message.

Accounts expected by this instruction:

0. [] (Optional) Account to read the proof from
1. [writable] (Optional) The proof context account
2. [] (Optional) The proof context account owner

The instruction expects either: i. CiphertextCiphertextEqualityProofData if proof is provided as instruction data ii. u32 byte offset if proof is provided as an account

VerifyTransfer = 4

Verify a transfer zero-knowledge proof.

This proof is a collection of smaller proofs that are required by the SPL Token 2022 confidential extension Transfer instruction with transfer fees.

Accounts expected by this instruction:

0. [] (Optional) Account to read the proof from
1. [writable] (Optional) The proof context account
2. [] (Optional) The proof context account owner

The instruction expects either: i. TransferData if proof is provided as instruction data ii. u32 byte offset if proof is provided as an account

VerifyTransferWithFee = 5

Verify a transfer with fee zero-knowledge proof.

This proof is a collection of smaller proofs that are required by the SPL Token 2022 confidential extension Transfer instruction without transfer fees.

Accounts expected by this instruction:

0. [] (Optional) Account to read the proof from
1. [writable] (Optional) The proof context account
2. [] (Optional) The proof context account owner

The instruction expects either: i. TransferWithFeeData if proof is provided as instruction data ii. u32 byte offset if proof is provided as an account

VerifyPubkeyValidity = 6

Verify a public key validity zero-knowledge proof.

A public key validity proof certifies that an ElGamal public key is well-formed and the prover knows the corresponding secret key.

Accounts expected by this instruction:

0. [] (Optional) Account to read the proof from
1. [writable] (Optional) The proof context account
2. [] (Optional) The proof context account owner

The instruction expects either: i. PubkeyValidityData if proof is provided as instruction data ii. u32 byte offset if proof is provided as an account

VerifyRangeProofU64 = 7

Verify a 64-bit range proof.

A range proof is defined with respect to a Pedersen commitment. The 64-bit range proof certifies that a Pedersen commitment holds an unsigned 64-bit number.

Accounts expected by this instruction:

0. [] (Optional) Account to read the proof from
1. [writable] (Optional) The proof context account
2. [] (Optional) The proof context account owner

The instruction expects either: i. RangeProofU64Data if proof is provided as instruction data ii. u32 byte offset if proof is provided as an account

VerifyBatchedRangeProofU64 = 8

Verify a 64-bit batched range proof.

A batched range proof is defined with respect to a sequence of Pedersen commitments [C_1, ..., C_N] and bit-lengths [n_1, ..., n_N]. It certifies that each commitment C_i is a commitment to a positive number of bit-length n_i. Batch verifying range proofs is more efficient than verifying independent range proofs on commitments C_1, ..., C_N separately.

The bit-length of a batched range proof specifies the sum of the individual bit-lengths n_1, ..., n_N. For example, this instruction can be used to certify that two commitments C_1 and C_2 each hold positive 32-bit numbers.

Accounts expected by this instruction:

0. [] (Optional) Account to read the proof from
1. [writable] (Optional) The proof context account
2. [] (Optional) The proof context account owner

The instruction expects either: i. BatchedRangeProofU64Data if proof is provided as instruction data ii. u32 byte offset if proof is provided as an account

VerifyBatchedRangeProofU128 = 9

Verify 128-bit batched range proof.

The bit-length of a batched range proof specifies the sum of the individual bit-lengths n_1, ..., n_N. For example, this instruction can be used to certify that two commitments C_1 and C_2 each hold positive 64-bit numbers.

Accounts expected by this instruction:

0. [] (Optional) Account to read the proof from
1. [writable] (Optional) The proof context account
2. [] (Optional) The proof context account owner

The instruction expects either: i. BatchedRangeProofU128Data if proof is provided as instruction data ii. u32 byte offset if proof is provided as an account

VerifyBatchedRangeProofU256 = 10

Verify 256-bit batched range proof.

The bit-length of a batched range proof specifies the sum of the individual bit-lengths n_1, ..., n_N. For example, this instruction can be used to certify that four commitments [C_1, C_2, C_3, C_4] each hold positive 64-bit numbers.

Accounts expected by this instruction:

0. [] (Optional) Account to read the proof from
1. [writable] (Optional) The proof context account
2. [] (Optional) The proof context account owner

The instruction expects either: i. BatchedRangeProofU256Data if proof is provided as instruction data ii. u32 byte offset if proof is provided as an account

VerifyCiphertextCommitmentEquality = 11

Verify a ciphertext-commitment equality proof.

A ciphertext-commitment equality proof certifies that an ElGamal ciphertext and a Pedersen commitment encrypt/encode the same message.

Accounts expected by this instruction:

0. [] (Optional) Account to read the proof from
1. [writable] (Optional) The proof context account
2. [] (Optional) The proof context account owner

The instruction expects either: i. CiphertextCommitmentEqualityProofData if proof is provided as instruction data ii. u32 byte offset if proof is provided as an account

VerifyGroupedCiphertext2HandlesValidity = 12

Verify a grouped-ciphertext validity proof.

A grouped-ciphertext validity proof certifies that a grouped ElGamal ciphertext is well-defined, i.e. the ciphertext can be decrypted by private keys associated with its decryption handles.

Accounts expected by this instruction:

0. [] (Optional) Account to read the proof from
1. [writable] (Optional) The proof context account
2. [] (Optional) The proof context account owner

The instruction expects either: i. GroupedCiphertext2HandlesValidityProofData if proof is provided as instruction data ii. u32 byte offset if proof is provided as an account

VerifyBatchedGroupedCiphertext2HandlesValidity = 13

Verify a batched grouped-ciphertext validity proof.

A batched grouped-ciphertext validity proof certifies the validity of two grouped ElGamal ciphertext that are encrypted using the same set of ElGamal public keys. A batched grouped-ciphertext validity proof is shorter and more efficient than two individual grouped-ciphertext validity proofs.

Accounts expected by this instruction:

0. [] (Optional) Account to read the proof from
1. [writable] (Optional) The proof context account
2. [] (Optional) The proof context account owner

The instruction expects either: i. BatchedGroupedCiphertext2HandlesValidityProofData if proof is provided as instruction data ii. u32 byte offset if proof is provided as an account

VerifyFeeSigma = 14

Verify a fee sigma proof.

A fee sigma proof certifies that a Pedersen commitment that encodes a transfer fee for SPL Token 2022 is well-formed.

Accounts expected by this instruction:

0. [] (Optional) Account to read the proof from
1. [writable] (Optional) The proof context account
2. [] (Optional) The proof context account owner

The instruction expects either: i. FeeSigmaProofData if proof is provided as instruction data ii. u32 byte offset if proof is provided as an account

Implementations

impl ProofInstruction

pub fn encode_verify_proof<T, U>( &self, context_state_info: Option<ContextStateInfo<'_>>, proof_data: &T ) -> Instruction

where T: Pod + ZkProofData<U>, U: Pod,

pub fn encode_verify_proof_from_account( &self, context_state_info: Option<ContextStateInfo<'_>>, proof_account: &Pubkey, offset: u32 ) -> Instruction

pub fn instruction_type(input: &[u8]) -> Option<Self>

pub fn proof_data<T, U>(input: &[u8]) -> Option<&T>

where T: Pod + ZkProofData<U>, U: Pod,

Trait Implementations

impl Clone for ProofInstruction

fn clone(&self) -> ProofInstruction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProofInstruction

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

Formats the value using the given formatter.

impl FromPrimitive for ProofInstruction

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl PartialEq for ProofInstruction

fn eq(&self, other: &ProofInstruction) -> 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 ToPrimitive for ProofInstruction

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

impl Copy for ProofInstruction

impl Eq for ProofInstruction

impl StructuralPartialEq for ProofInstruction