Enum AllowlistInstruction 

pub enum AllowlistInstruction {
    InitializeAdminAuthority,
    UpdateAdminAuthority,
    AdminAddPrivateAllowlist,
    AdminRemovePrivateAllowlist,
    Thaw {
        user_system_account: Pubkey,
    },
    AdminAddPublicAllowedAccount,
    AdminAddPrivateAllowedAccount,
    AdminRemovePublicAllowedAccount,
    AdminRemovePrivateAllowedAccount,
    AdminFreeze,
    AdminBurn {
        amount: u64,
        decimals: u8,
    },
}

Variants

InitializeAdminAuthority

Initializes the allowlist admin account.

It creates a new system account.

This can only be called once.

The InitializeAdminAuthority instruction MUST be in the same Transaction as the program deployment Otherwise another party can acquire ownership of the uninitialized admin account.

Accounts expected by this instruction:

0. [signer] The Admin Authority account
1. [writable] The Admin’s Program Derived Account
2. [] System Program

UpdateAdminAuthority

Updates the allowlist admin account.

This can only be called by the existing admin authority.

Accounts expected by this instruction:

0. [signer] The current Admin Authority account
1. [signer] The new Admin Authority account
2. [writable] The Admin’s Program Derived Account

AdminAddPrivateAllowlist

Associates a Token Mint as a Private Instrument.

This can only be called by the existing admin authority.

Accounts expected by this instruction:

0. [signer] The Admin Authority account
1. [] The Admin’s Program Derived Account
2. [] The token mint for the private instrument
3. [writable] The Private Allowlist’s Program Derived Account
4. [] System Program

AdminRemovePrivateAllowlist

Changes Token Mint from a Public Instrument to a Private Instrument.

This can only be called by the existing admin authority.

Accounts expected by this instruction:

0. [signer] The Admin Authority account
1. [] The Admin’s Program Derived Account
2. [] The token mint for the private instrument
3. [writable] The Private Allowlist’s Program Derived Account
4. [] System Program

Thaw

Thaws the underlying Token Account of the provided system wallet account if the wallet is on the allow list.

Accounts expected by this instruction:

0. [] The token mint
1. [] The wallet system account Program Derived Address for the Public Instrument Allowlist
2. [] The wallet system account Program Derived Address for the Private Instrument Allowlist
3. [writable] The wallet’s Token Account for the Mint
4. [] The token program
5. [] The Allowlist PDA for the Freeze Authority

Fields

user_system_account: Pubkey

The wallet system account that is being thawed (e.g. the Token Account owner)

AdminAddPublicAllowedAccount

Adds a new account to the Public Instrument Allowlist, and can only be called by the Admin Authority.

Accounts expected by this instruction:

0. [signer] The Admin Authority account
1. [] The Admin’s Program Derived Account
2. [signer] The wallet system account to add to the allow list. Note: this can optionally be a signer.
3. [] The wallet system account Program Derived Address for the Private Instrument Allowlist
4. [] System Program

AdminAddPrivateAllowedAccount

Adds a new account to the Private Instrument Allowlist, and can only be called by the Admin Authority.

Accounts expected by this instruction:

0. [signer] The Admin Authority account
1. [] The Admin’s Program Derived Account
2. [signer] The wallet system account to add to the allow list. Note: this can optionally be a signer.
3. [] The wallet system account Program Derived Address for the Private Instrument Allowlist
4. [] The token mint for the private instrument
5. [] System Program

AdminRemovePublicAllowedAccount

Removes an existing account from the allowlist, and can only be called by the Admin Authority.

This instruction WILL NOT freeze existing Token Accounts, which is instead done via AdminFreeze.

Accounts expected by this instruction:

0. [signer] The Admin Authority account
1. [] The Admin’s Program Derived Account
2. [] The wallet system account to remove from the allow list.
3. [] The wallet system account Program Derived Address for the allow list

AdminRemovePrivateAllowedAccount

Removes an existing account from the allowlist, and can only be called by the Admin Authority.

This instruction WILL NOT freeze existing Token Accounts, which is instead done via AdminFreeze.

Accounts expected by this instruction:

0. [signer] The Admin Authority account
1. [] The Admin’s Program Derived Account
2. [] The wallet system account to remove from the allow list.
3. [] The wallet system account Program Derived Address for the allow list
4. [] The token mint for the private instrument

AdminFreeze

Freezes an Token Account, and can only be called by the Admin Authority.

Accounts expected by this instruction:

0. [signer] The Admin Authority account
1. [] The Admin’s Program Derived Account
2. [] The wallet system account
3. [writable] The wallet’s Token Account for the Mint
4. [] The token mint
5. [] The token program
6. [] The Allowlist PDA for the Freeze Authority

AdminBurn

Burns tokens by removing them from an account. If they account is frozen, it will unfreeze it first, and then refreeze it.

This instruction can only be called by the Admin Authority

The wallet address does NOT need to be on the allowlist to be burned.

Accounts expected by this instruction:

0. [signer] The Admin Authority account
1. [] The Admin’s Program Derived Account
2. [] The wallet system account
3. [writable] The wallet’s Token Account for the Mint
4. [] The token mint
5. [] The token program
6. [] The Allowlist PDA for the Freeze Authority

Fields

amount: u64

The amount of tokens to burn.

decimals: u8

Expected number of base 10 digits to the right of the decimal place.

Trait Implementations

impl BorshDeserialize for AllowlistInstruction

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for AllowlistInstruction

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

impl Clone for AllowlistInstruction

fn clone(&self) -> AllowlistInstruction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AllowlistInstruction

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

Formats the value using the given formatter.

impl EnumExt for AllowlistInstruction

fn deserialize_variant<__R: Read>( reader: &mut __R, variant_tag: u8, ) -> Result<Self, Error>

Deserialises given variant of an enum from the reader.

impl PartialEq for AllowlistInstruction

fn eq(&self, other: &AllowlistInstruction) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AllowlistInstruction