Class SystemInstruction

System Instruction class

Index

Methods

decodeAllocate decodeAllocateWithSeed decodeAssign decodeAssignWithSeed decodeCreateAccount decodeCreateWithSeed decodeInstructionType decodeNonceAdvance decodeNonceAuthorize decodeNonceInitialize decodeNonceWithdraw decodeTransfer decodeTransferWithSeed

Methods

`Static`decodeAllocate

decodeAllocate(instruction: TransactionInstruction): AllocateFields
Decode an allocate system instruction and retrieve the instruction params.
Parameters
- instruction: TransactionInstruction
Returns AllocateFields
- Defined in packages/web3.js/src/programs/system.ts:391

`Static`decodeAllocateWithSeed

decodeAllocateWithSeed(
instruction: TransactionInstruction,
): AllocateWithSeedFields
Decode an allocate with seed system instruction and retrieve the instruction params.
Parameters
- instruction: TransactionInstruction
Returns AllocateWithSeedFields
- Defined in packages/web3.js/src/programs/system.ts:411

`Static`decodeAssign

decodeAssign(instruction: TransactionInstruction): AssignParams
Decode an assign system instruction and retrieve the instruction params.
Parameters
- instruction: TransactionInstruction
Returns AssignParams
- Defined in packages/web3.js/src/programs/system.ts:434

`Static`decodeAssignWithSeed

decodeAssignWithSeed(instruction: TransactionInstruction): AssignWithSeedParams
Decode an assign with seed system instruction and retrieve the instruction params.
Parameters
- instruction: TransactionInstruction
Returns AssignWithSeedParams
- Defined in packages/web3.js/src/programs/system.ts:450

`Static`decodeCreateAccount

decodeCreateAccount(instruction: TransactionInstruction): CreateAccountFields
Decode a create account system instruction and retrieve the instruction params.
Parameters
- instruction: TransactionInstruction
Returns CreateAccountFields
- Defined in packages/web3.js/src/programs/system.ts:327

`Static`decodeCreateWithSeed

decodeCreateWithSeed(
instruction: TransactionInstruction,
): CreateAccountWithSeedFields
Decode a create account with seed system instruction and retrieve the instruction params.
Parameters
- instruction: TransactionInstruction
Returns CreateAccountWithSeedFields
- Defined in packages/web3.js/src/programs/system.ts:470

`Static`decodeInstructionType

decodeInstructionType(
    instruction: TransactionInstruction,
):
    | "AdvanceNonceAccount"
    | "Allocate"
    | "AllocateWithSeed"
    | "Assign"
    | "AssignWithSeed"
    | "AuthorizeNonceAccount"
    | "Create"
    | "CreateAllowPrefund"
    | "CreateWithSeed"
    | "InitializeNonceAccount"
    | "Transfer"
    | "TransferWithSeed"
    | "UpgradeNonceAccount"
    | "WithdrawNonceAccount"
Decode a system instruction and retrieve the instruction type.
Parameters
- instruction: TransactionInstruction
Returns
    | "AdvanceNonceAccount"
    | "Allocate"
    | "AllocateWithSeed"
    | "Assign"
    | "AssignWithSeed"
    | "AuthorizeNonceAccount"
    | "Create"
    | "CreateAllowPrefund"
    | "CreateWithSeed"
    | "InitializeNonceAccount"
    | "Transfer"
    | "TransferWithSeed"
    | "UpgradeNonceAccount"
    | "WithdrawNonceAccount"
- Defined in packages/web3.js/src/programs/system.ts:314

`Static`decodeNonceAdvance

decodeNonceAdvance(instruction: TransactionInstruction): AdvanceNonceParams
Decode a nonce advance system instruction and retrieve the instruction params.
Parameters
- instruction: TransactionInstruction
Returns AdvanceNonceParams
- Defined in packages/web3.js/src/programs/system.ts:515

`Static`decodeNonceAuthorize

decodeNonceAuthorize(instruction: TransactionInstruction): AuthorizeNonceParams
Decode a nonce authorize system instruction and retrieve the instruction params.
Parameters
- instruction: TransactionInstruction
Returns AuthorizeNonceParams
- Defined in packages/web3.js/src/programs/system.ts:563

`Static`decodeNonceInitialize

decodeNonceInitialize(
instruction: TransactionInstruction,
): InitializeNonceParams
Decode a nonce initialize system instruction and retrieve the instruction params.
Parameters
- instruction: TransactionInstruction
Returns InitializeNonceParams
- Defined in packages/web3.js/src/programs/system.ts:495

`Static`decodeNonceWithdraw

decodeNonceWithdraw(instruction: TransactionInstruction): WithdrawNonceFields
Decode a nonce withdraw system instruction and retrieve the instruction params.
Parameters
- instruction: TransactionInstruction
Returns WithdrawNonceFields
- Defined in packages/web3.js/src/programs/system.ts:537

`Static`decodeTransfer

decodeTransfer(instruction: TransactionInstruction): TransferFields
Decode a transfer system instruction and retrieve the instruction params.
Parameters
- instruction: TransactionInstruction
Returns TransferFields
- Defined in packages/web3.js/src/programs/system.ts:350

`Static`decodeTransferWithSeed

decodeTransferWithSeed(
instruction: TransactionInstruction,
): TransferWithSeedFields
Decode a transfer with seed system instruction and retrieve the instruction params.
Parameters
- instruction: TransactionInstruction
Returns TransferWithSeedFields
- Defined in packages/web3.js/src/programs/system.ts:369

Class SystemInstruction

Index

Methods

Methods

StaticdecodeAllocate

Parameters

Returns AllocateFields

StaticdecodeAllocateWithSeed

Parameters

Returns AllocateWithSeedFields

StaticdecodeAssign

Parameters

Returns AssignParams

StaticdecodeAssignWithSeed

Parameters

Returns AssignWithSeedParams

StaticdecodeCreateAccount

Parameters

Returns CreateAccountFields

StaticdecodeCreateWithSeed

Parameters

Returns CreateAccountWithSeedFields

StaticdecodeInstructionType

Parameters

Returns | "AdvanceNonceAccount" | "Allocate" | "AllocateWithSeed" | "Assign" | "AssignWithSeed" | "AuthorizeNonceAccount" | "Create" | "CreateAllowPrefund" | "CreateWithSeed" | "InitializeNonceAccount" | "Transfer" | "TransferWithSeed" | "UpgradeNonceAccount" | "WithdrawNonceAccount"

StaticdecodeNonceAdvance

Parameters

Returns AdvanceNonceParams

StaticdecodeNonceAuthorize

Parameters

Returns AuthorizeNonceParams

StaticdecodeNonceInitialize

Parameters

Returns InitializeNonceParams

StaticdecodeNonceWithdraw

Parameters

Returns WithdrawNonceFields

StaticdecodeTransfer

Parameters

Returns TransferFields

StaticdecodeTransferWithSeed

Parameters

Returns TransferWithSeedFields

Settings

On This Page

`Static`decodeAllocate

`Static`decodeAllocateWithSeed

`Static`decodeAssign

`Static`decodeAssignWithSeed

`Static`decodeCreateAccount

`Static`decodeCreateWithSeed

`Static`decodeInstructionType

Returns
| "AdvanceNonceAccount"
| "Allocate"
| "AllocateWithSeed"
| "Assign"
| "AssignWithSeed"
| "AuthorizeNonceAccount"
| "Create"
| "CreateAllowPrefund"
| "CreateWithSeed"
| "InitializeNonceAccount"
| "Transfer"
| "TransferWithSeed"
| "UpgradeNonceAccount"
| "WithdrawNonceAccount"

`Static`decodeNonceAdvance

`Static`decodeNonceAuthorize

`Static`decodeNonceInitialize

`Static`decodeNonceWithdraw

`Static`decodeTransfer

`Static`decodeTransferWithSeed