spl_transfer_hook_interface::instruction

Enum TransferHookInstruction

Source
#[repr(C)]
pub enum TransferHookInstruction { Execute { amount: u64, }, InitializeExtraAccountMetaList { extra_account_metas: Vec<ExtraAccountMeta>, }, UpdateExtraAccountMetaList { extra_account_metas: Vec<ExtraAccountMeta>, }, }
Expand description

Instructions supported by the transfer hook interface.

Variants§

§

Execute

Runs additional transfer logic.

Accounts expected by this instruction:

  1. [] Source account
  2. [] Token mint
  3. [] Destination account
  4. [] Source account’s owner/delegate
  5. [] (Optional) Validation account
  6. ..5+M [] M optional additional accounts, written in validation account data

Fields

§amount: u64

Amount of tokens to transfer

§

InitializeExtraAccountMetaList

Initializes the extra account metas on an account, writing into the first open TLV space.

Accounts expected by this instruction:

  1. [w] Account with extra account metas
  2. [] Mint
  3. [s] Mint authority
  4. [] System program

Fields

§extra_account_metas: Vec<ExtraAccountMeta>

List of ExtraAccountMetas to write into the account

§

UpdateExtraAccountMetaList

Updates the extra account metas on an account by overwriting the existing list.

Accounts expected by this instruction:

  1. [w] Account with extra account metas
  2. [] Mint
  3. [s] Mint authority

Fields

§extra_account_metas: Vec<ExtraAccountMeta>

The new list of ExtraAccountMetas to overwrite the existing entry in the account.

Implementations§

Source§

impl TransferHookInstruction

Source

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

Unpacks a byte buffer into a TransferHookInstruction.

Source

pub fn pack(&self) -> Vec<u8>

Packs a TokenInstruction into a byte buffer.

Trait Implementations§

Source§

impl Clone for TransferHookInstruction

Source§

fn clone(&self) -> TransferHookInstruction

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 TransferHookInstruction

Source§

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

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

impl PartialEq for TransferHookInstruction

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for TransferHookInstruction

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