Enum spl_tlv_account_resolution::seeds::Seed

pub enum Seed {
    Uninitialized,
    Literal {
        bytes: Vec<u8>,
    },
    InstructionData {
        index: u8,
        length: u8,
    },
    AccountKey {
        index: u8,
    },
    AccountData {
        account_index: u8,
        data_index: u8,
        length: u8,
    },
}

Enum to describe a required seed for a Program-Derived Address

Variants

Uninitialized

Uninitialized configuration byte space

Literal

A literal hard-coded argument Packed as: * 1 - Discriminator * 1 - Length of literal * N - Literal bytes themselves

Fields

bytes: Vec<u8>

The literal value represented as a vector of bytes.

For example, if a literal value is a string literal, such as “my-seed”, this value would be "my-seed".as_bytes().to_vec().

InstructionData

An instruction-provided argument, to be resolved from the instruction data Packed as: * 1 - Discriminator * 1 - Start index of instruction data * 1 - Length of instruction data starting at index

Fields

index: u8

The index where the bytes of an instruction argument begin

length: u8

The length of the instruction argument (number of bytes)

Note: Max seed length is 32 bytes, so u8 is appropriate here

AccountKey

The public key of an account from the entire accounts list. Note: This includes an extra accounts required.

Packed as: * 1 - Discriminator * 1 - Index of account in accounts list

Fields

index: u8

The index of the account in the entire accounts list

AccountData

An argument to be resolved from the inner data of some account Packed as: * 1 - Discriminator * 1 - Index of account in accounts list * 1 - Start index of account data * 1 - Length of account data starting at index

Fields

account_index: u8

The index of the account in the entire accounts list

data_index: u8

The index where the bytes of an account data argument begin

length: u8

The length of the argument (number of bytes)

Note: Max seed length is 32 bytes, so u8 is appropriate here

Implementations

impl Seed

pub fn tlv_size(&self) -> u8

Get the size of a seed configuration

pub fn pack(&self, dst: &mut [u8]) -> Result<(), ProgramError>

Packs a seed configuration into a slice

pub fn pack_into_address_config( seeds: &[Self], ) -> Result<[u8; 32], ProgramError>

Packs a vector of seed configurations into a 32-byte array, filling the rest with 0s. Errors if it overflows.

pub fn unpack(bytes: &[u8]) -> Result<Self, ProgramError>

Unpacks a seed configuration from a slice

pub fn unpack_address_config( address_config: &[u8; 32], ) -> Result<Vec<Self>, ProgramError>

Unpacks all seed configurations from a 32-byte array. Stops when it hits uninitialized data (0s).

Trait Implementations

impl Clone for Seed

fn clone(&self) -> Seed

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Seed

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

Formats the value using the given formatter.

impl PartialEq for Seed

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