spl_token_2022::extension::confidential_mint_burn::instruction

Enum ConfidentialMintBurnInstruction

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

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:

  1. [writable] The SPL Token mint.

Data expected by this instruction: InitializeMintData

§

RotateSupplyElGamalPubkey = 1

Rotates the ElGamal pubkey used to encrypt confidential supply

Accounts expected by this instruction:

  • Single authority
  1. [writable] The SPL Token mint.
  2. [] Instructions sysvar if CiphertextCiphertextEquality is included in the same transaction or context state account if CiphertextCiphertextEquality is pre-verified into a context state account.
  3. [signer] Confidential mint authority.
  • Multisignature authority
  1. [writable] The SPL Token mint.
  2. [] Instructions sysvar if CiphertextCiphertextEquality is included in the same transaction or context state account if CiphertextCiphertextEquality is pre-verified into a context state account.
  3. [] The multisig authority account owner.
  4. ..[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
  1. [writable] The SPL Token mint.
  2. [signer] Confidential mint authority.
  • Multisignature authority
  1. [writable] The SPL Token mint.
  2. [] The multisig authority account owner.
  3. ..[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
  1. [writable] The SPL Token account.
  2. [] The SPL Token mint. [writable] if the mint has a non-zero supply elgamal-pubkey
  3. [] (Optional) Instructions sysvar if at least one of the zk_elgamal_proof instructions are included in the same transaction.
  4. [] (Optional) The context state account containing the pre-verified VerifyCiphertextCommitmentEquality proof
  5. [] (Optional) The context state account containing the pre-verified VerifyBatchedGroupedCiphertext3HandlesValidity proof
  6. [] (Optional) The context state account containing the pre-verified VerifyBatchedRangeProofU128
  7. [signer] The single account owner.
  • Multisignature authority
  1. [writable] The SPL Token mint.
  2. [] The SPL Token mint. [writable] if the mint has a non-zero supply elgamal-pubkey
  3. [] (Optional) Instructions sysvar if at least one of the zk_elgamal_proof instructions are included in the same transaction.
  4. [] (Optional) The context state account containing the pre-verified VerifyCiphertextCommitmentEquality proof
  5. [] (Optional) The context state account containing the pre-verified VerifyBatchedGroupedCiphertext3HandlesValidity proof
  6. [] (Optional) The context state account containing the pre-verified VerifyBatchedRangeProofU128
  7. [] The multisig account owner.
  8. ..[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
  1. [writable] The SPL Token account.
  2. [] The SPL Token mint. [writable] if the mint has a non-zero supply elgamal-pubkey
  3. [] (Optional) Instructions sysvar if at least one of the zk_elgamal_proof instructions are included in the same transaction.
  4. [] (Optional) The context state account containing the pre-verified VerifyCiphertextCommitmentEquality proof
  5. [] (Optional) The context state account containing the pre-verified VerifyBatchedGroupedCiphertext3HandlesValidity proof
  6. [] (Optional) The context state account containing the pre-verified VerifyBatchedRangeProofU128
  7. [signer] The single account owner.
  • Multisignature authority
  1. [writable] The SPL Token mint.
  2. [] The SPL Token mint. [writable] if the mint has a non-zero supply elgamal-pubkey
  3. [] (Optional) Instructions sysvar if at least one of the zk_elgamal_proof instructions are included in the same transaction.
  4. [] (Optional) The context state account containing the pre-verified VerifyCiphertextCommitmentEquality proof
  5. [] (Optional) The context state account containing the pre-verified VerifyBatchedGroupedCiphertext3HandlesValidity proof
  6. [] (Optional) The context state account containing the pre-verified VerifyBatchedRangeProofU128
  7. [] The multisig account owner.
  8. ..[signer] Required M signer accounts for the SPL Token Multisig

Data expected by this instruction: BurnInstructionData

Trait Implementations§

Source§

impl Clone for ConfidentialMintBurnInstruction

Source§

fn clone(&self) -> ConfidentialMintBurnInstruction

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConfidentialMintBurnInstruction

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<ConfidentialMintBurnInstruction> for u8

Source§

fn from(enum_value: ConfidentialMintBurnInstruction) -> Self

Converts to this type from the input type.
Source§

impl TryFrom<u8> for ConfidentialMintBurnInstruction

Source§

type Error = TryFromPrimitiveError<ConfidentialMintBurnInstruction>

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFromPrimitive for ConfidentialMintBurnInstruction

Source§

const NAME: &'static str = "ConfidentialMintBurnInstruction"

Source§

type Primitive = u8

Source§

type Error = TryFromPrimitiveError<ConfidentialMintBurnInstruction>

Source§

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

Source§

impl Copy for ConfidentialMintBurnInstruction

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V