Enum ConfidentialMintBurnInstruction

#[repr(u8)]
pub enum ConfidentialMintBurnInstruction {
    InitializeMint = 0,
    RotateSupplyElGamalPubkey = 1,
    UpdateDecryptableSupply = 2,
    Mint = 3,
    Burn = 4,
    ApplyPendingBurn = 5,
}

Confidential Transfer extension instructions

Variants

InitializeMint = 0

Initializes confidential mints and burns for a mint.

The ConfidentialMintBurnInstruction::InitializeMint instruction requires no signers and MUST be included within the same Transaction as TokenInstruction::InitializeMint. Otherwise another party can initialize the configuration.

The instruction fails if the TokenInstruction::InitializeMint instruction has already executed for the mint.

Accounts expected by this instruction:

0. [writable] The SPL Token mint.

Data expected by this instruction: InitializeMintData

RotateSupplyElGamalPubkey = 1

Rotates the ElGamal pubkey used to encrypt confidential supply

The pending burn amount must be zero in order for this instruction to be processed successfully.

Accounts expected by this instruction:

• Single authority

0. [writable] The SPL Token mint.
1. [] Instructions sysvar if CiphertextCiphertextEquality is included in the same transaction or context state account if CiphertextCiphertextEquality is pre-verified into a context state account.
2. [signer] Confidential mint authority.

• Multisignature authority

0. [writable] The SPL Token mint.
1. [] Instructions sysvar if CiphertextCiphertextEquality is included in the same transaction or context state account if CiphertextCiphertextEquality is pre-verified into a context state account.
2. [] The multisig authority account owner.
3. ..[signer] Required M signer accounts for the SPL Token Multisig

Data expected by this instruction: RotateSupplyElGamalPubkeyData

UpdateDecryptableSupply = 2

Updates the decryptable supply of the mint

Accounts expected by this instruction:

• Single authority

0. [writable] The SPL Token mint.
1. [signer] Confidential mint authority.

• Multisignature authority

0. [writable] The SPL Token mint.
1. [] The multisig authority account owner.
2. ..[signer] Required M signer accounts for the SPL Token Multisig

Data expected by this instruction: UpdateDecryptableSupplyData

Mint = 3

Mints tokens to confidential balance

Fails if the destination account is frozen.

Accounts expected by this instruction:

• Single authority

0. [writable] The SPL Token account.
1. [writable] The SPL Token mint.
2. [] (Optional) Instructions sysvar if at least one of the zk_elgamal_proof instructions are included in the same transaction.
3. [] (Optional) The context state account containing the pre-verified VerifyCiphertextCommitmentEquality proof
4. [] (Optional) The context state account containing the pre-verified VerifyBatchedGroupedCiphertext3HandlesValidity proof
5. [] (Optional) The context state account containing the pre-verified VerifyBatchedRangeProofU128
6. [signer] The single account owner.

• Multisignature authority

0. [writable] The SPL Token mint.
1. [] The SPL Token mint. [writable] if the mint has a non-zero supply elgamal-pubkey
2. [] (Optional) Instructions sysvar if at least one of the zk_elgamal_proof instructions are included in the same transaction.
3. [] (Optional) The context state account containing the pre-verified VerifyCiphertextCommitmentEquality proof
4. [] (Optional) The context state account containing the pre-verified VerifyBatchedGroupedCiphertext3HandlesValidity proof
5. [] (Optional) The context state account containing the pre-verified VerifyBatchedRangeProofU128
6. [] The multisig account owner.
7. ..[signer] Required M signer accounts for the SPL Token Multisig

Data expected by this instruction: MintInstructionData

Burn = 4

Burn tokens from confidential balance

Fails if the destination account is frozen.

Accounts expected by this instruction:

• Single authority

0. [writable] The SPL Token account.
1. [writable] The SPL Token mint.
2. [] (Optional) Instructions sysvar if at least one of the zk_elgamal_proof instructions are included in the same transaction.
3. [] (Optional) The context state account containing the pre-verified VerifyCiphertextCommitmentEquality proof
4. [] (Optional) The context state account containing the pre-verified VerifyBatchedGroupedCiphertext3HandlesValidity proof
5. [] (Optional) The context state account containing the pre-verified VerifyBatchedRangeProofU128
6. [signer] The single account owner.

• Multisignature authority

0. [writable] The SPL Token mint.
1. [] The SPL Token mint. [writable] if the mint has a non-zero supply elgamal-pubkey
2. [] (Optional) Instructions sysvar if at least one of the zk_elgamal_proof instructions are included in the same transaction.
3. [] (Optional) The context state account containing the pre-verified VerifyCiphertextCommitmentEquality proof
4. [] (Optional) The context state account containing the pre-verified VerifyBatchedGroupedCiphertext3HandlesValidity proof
5. [] (Optional) The context state account containing the pre-verified VerifyBatchedRangeProofU128
6. [] The multisig account owner.
7. ..[signer] Required M signer accounts for the SPL Token Multisig

Data expected by this instruction: BurnInstructionData

ApplyPendingBurn = 5

Applies the pending burn amount to the confidential supply

• Single authority

0. [writable] The SPL token mint.
1. [signer] The single mint authority.

• Multisignature authority

0. [writable] The SPL token mint.
1. [] The multisig account owner.
2. .. [signer] Required M signer accounts for the SPL Token Multisig account.

Trait Implementations

impl Clone for ConfidentialMintBurnInstruction

fn clone(&self) -> ConfidentialMintBurnInstruction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfidentialMintBurnInstruction

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

Formats the value using the given formatter.

impl From<ConfidentialMintBurnInstruction> for u8

fn from(enum_value: ConfidentialMintBurnInstruction) -> Self

Converts to this type from the input type.

impl TryFrom<u8> for ConfidentialMintBurnInstruction

type Error = TryFromPrimitiveError<ConfidentialMintBurnInstruction>

The type returned in the event of a conversion error.

fn try_from(number: u8) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.

impl TryFromPrimitive for ConfidentialMintBurnInstruction

const NAME: &'static str = "ConfidentialMintBurnInstruction"

type Primitive = u8

type Error = TryFromPrimitiveError<ConfidentialMintBurnInstruction>

fn try_from_primitive( number: Self::Primitive, ) -> Result<Self, TryFromPrimitiveError<Self>>

impl Copy for ConfidentialMintBurnInstruction