Struct Instruction

pub struct Instruction {
    pub program_id: Pubkey,
    pub accounts: Vec<AccountMeta>,
    pub data: Vec<u8>,
}

wasm-bindgen version of the Instruction struct. This duplication is required until https://github.com/rustwasm/wasm-bindgen/issues/3671 is fixed. This must not diverge from the regular non-wasm Instruction struct.

Fields

program_id: Pubkey

accounts: Vec<AccountMeta>

data: Vec<u8>

Implementations

impl Instruction

pub fn new_with_borsh<T>( program_id: Pubkey, data: &T, accounts: Vec<AccountMeta>, ) -> Instruction

where T: BorshSerialize,

Create a new instruction from a value, encoded with borsh.

program_id is the address of the program that will execute the instruction. accounts contains a description of all accounts that may be accessed by the program.

Borsh serialization is often preferred over bincode as it has a stable specification and an implementation in JavaScript, neither of which are true of bincode.

Examples

#[derive(BorshSerialize, BorshDeserialize)]
pub struct MyInstruction {
    pub lamports: u64,
}

pub fn create_instruction(
    program_id: &Pubkey,
    from: &Pubkey,
    to: &Pubkey,
    lamports: u64,
) -> Instruction {
    let instr = MyInstruction { lamports };

    Instruction::new_with_borsh(
        *program_id,
        &instr,
        vec![
            AccountMeta::new(*from, true),
            AccountMeta::new(*to, false),
        ],
   )
}

pub fn new_with_bincode<T>( program_id: Pubkey, data: &T, accounts: Vec<AccountMeta>, ) -> Instruction

where T: Serialize,

Create a new instruction from a value, encoded with bincode.

program_id is the address of the program that will execute the instruction. accounts contains a description of all accounts that may be accessed by the program.

Examples

#[derive(Serialize, Deserialize)]
pub struct MyInstruction {
    pub lamports: u64,
}

pub fn create_instruction(
    program_id: &Pubkey,
    from: &Pubkey,
    to: &Pubkey,
    lamports: u64,
) -> Instruction {
    let instr = MyInstruction { lamports };

    Instruction::new_with_bincode(
        *program_id,
        &instr,
        vec![
            AccountMeta::new(*from, true),
            AccountMeta::new(*to, false),
        ],
   )
}

pub fn new_with_bytes( program_id: Pubkey, data: &[u8], accounts: Vec<AccountMeta>, ) -> Instruction

Create a new instruction from a byte slice.

program_id is the address of the program that will execute the instruction. accounts contains a description of all accounts that may be accessed by the program.

The caller is responsible for ensuring the correct encoding of data as expected by the callee program.

Examples

#[derive(BorshSerialize, BorshDeserialize)]
pub struct MyInstruction {
    pub lamports: u64,
}

pub fn create_instruction(
    program_id: &Pubkey,
    from: &Pubkey,
    to: &Pubkey,
    lamports: u64,
) -> Result<Instruction, Error> {
    let instr = MyInstruction { lamports };

    let mut instr_in_bytes: Vec<u8> = Vec::new();
    instr.serialize(&mut instr_in_bytes)?;

    Ok(Instruction::new_with_bytes(
        *program_id,
        &instr_in_bytes,
        vec![
            AccountMeta::new(*from, true),
            AccountMeta::new(*to, false),
        ],
   ))
}

Trait Implementations

impl Clone for Instruction

fn clone(&self) -> Instruction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instruction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Instruction

fn deserialize<__D>( __deserializer: __D, ) -> Result<Instruction, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Instruction> for JsValue

fn from(value: Instruction) -> JsValue

Converts to this type from the input type.

impl FromWasmAbi for Instruction

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Instruction

Recover a Self from Self::Abi.

impl IntoWasmAbi for Instruction

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for Instruction

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<Instruction>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <Instruction as LongRefFromWasmAbi>::Abi, ) -> <Instruction as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Instruction

fn is_none(abi: &<Instruction as FromWasmAbi>::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Instruction

fn none() -> <Instruction as IntoWasmAbi>::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl PartialEq for Instruction

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

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<Instruction>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi( js: <Instruction as RefFromWasmAbi>::Abi, ) -> <Instruction as RefFromWasmAbi>::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for Instruction

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<Instruction>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi( js: <Instruction as RefMutFromWasmAbi>::Abi, ) -> <Instruction as RefMutFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl Serialize for Instruction

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFromJsValue for Instruction

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value( value: JsValue, ) -> Result<Instruction, <Instruction as TryFromJsValue>::Error>

Performs the conversion.

impl VectorFromWasmAbi for Instruction

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi( js: <Instruction as VectorFromWasmAbi>::Abi, ) -> Box<[Instruction]>

impl VectorIntoWasmAbi for Instruction

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi( vector: Box<[Instruction]>, ) -> <Instruction as VectorIntoWasmAbi>::Abi

impl Eq for Instruction

impl StructuralPartialEq for Instruction