prependTransactionMessageInstruction

function prependTransactionMessageInstruction<
    TTransactionMessage,
    TInstruction,
>(
    instruction,
    transactionMessage,
): PrependTransactionMessageInstructions<
    TTransactionMessage,
    [TInstruction]
>;

Given an instruction, this method will return a new transaction message with that instruction having been added to the beginning of the list of existing instructions.

Type Parameters

Type Parameter
TTransactionMessage extends Readonly<{ instructions: readonly Instruction<string, readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[]>[]; version: TransactionVersion; }>
TInstruction extends Instruction<string, readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[]>

Parameters

ParameterType
instructionTInstruction
transactionMessageTTransactionMessage

Returns

PrependTransactionMessageInstructions<TTransactionMessage, [TInstruction]>

See

prependTransactionInstructions if you need to prepend multiple instructions to a transaction message.

Example

import { address } from '@solana/addresses';
import { prependTransactionMessageInstruction } from '@solana/transaction-messages';
 
const memoTransaction = prependTransactionMessageInstruction(
    {
        data: new TextEncoder().encode('Hello world!'),
        programAddress: address('MemoSq4gqABAXKb96qnH8TysNcWxMyWCqXgDLGmfcHr'),
    },
    tx,
);

On this page