Skip to main content

Commands

@iota/iota-sdk

@iota/iota-sdk / transactions / Commands

Variable: Commands

const Commands: object

Defined in: sdk/typescript/src/transactions/Commands.ts:34

Simple helpers used to construct transactions:

Type Declaration​

Intent()​

Intent(__namedParameters): TransactionShape<"$Intent">

Parameters​

__namedParameters​
data?​

Record<string, unknown> = {}

inputs?​

Record<string, { GasCoin: true; } | { Input: number; type?: "object" | "pure"; } | { Result: number; } | { NestedResult: [number, number]; } | ({ GasCoin: true; } | { Input: number; type?: "object" | "pure"; } | { Result: number; } | { NestedResult: [number, number]; })[]> = {}

name​

string

Returns​

TransactionShape<"$Intent">

MakeMoveVec()​

MakeMoveVec(__namedParameters): TransactionShape<"MakeMoveVec">

Parameters​

__namedParameters​
elements​

({ GasCoin: true; } | { Input: number; type?: "object" | "pure"; } | { Result: number; } | { NestedResult: [number, number]; })[]

type?​

string

Returns​

TransactionShape<"MakeMoveVec">

MergeCoins()​

MergeCoins(destination, sources): TransactionShape<"MergeCoins">

Parameters​

destination​

{ GasCoin: true; } | { Input: number; type?: "object" | "pure"; } | { Result: number; } | { NestedResult: [number, number]; }

sources​

({ GasCoin: true; } | { Input: number; type?: "object" | "pure"; } | { Result: number; } | { NestedResult: [number, number]; })[]

Returns​

TransactionShape<"MergeCoins">

MoveCall()​

MoveCall(input): TransactionShape<"MoveCall">

Parameters​

input​

{ arguments?: ({ $kind: "GasCoin"; GasCoin: true; } | { $kind: "Input"; Input: number; type?: "pure"; } | { $kind: "Input"; Input: number; type?: "object"; } | { $kind: "Result"; Result: number; } | { $kind: "NestedResult"; NestedResult: [number, number]; })[]; function: string; module: string; package: string; typeArguments?: string[]; } | { arguments?: ({ $kind: "GasCoin"; GasCoin: true; } | { $kind: "Input"; Input: number; type?: "pure"; } | { $kind: "Input"; Input: number; type?: "object"; } | { $kind: "Result"; Result: number; } | { $kind: "NestedResult"; NestedResult: [number, number]; })[]; target: string; typeArguments?: string[]; }

Returns​

TransactionShape<"MoveCall">

Publish()​

Publish(__namedParameters): TransactionShape<"Publish">

Parameters​

__namedParameters​
dependencies​

string[]

modules​

string[] | number[][]

Returns​

TransactionShape<"Publish">

SplitCoins()​

SplitCoins(coin, amounts): TransactionShape<"SplitCoins">

Parameters​

coin​

{ GasCoin: true; } | { Input: number; type?: "object" | "pure"; } | { Result: number; } | { NestedResult: [number, number]; }

amounts​

({ GasCoin: true; } | { Input: number; type?: "object" | "pure"; } | { Result: number; } | { NestedResult: [number, number]; })[]

Returns​

TransactionShape<"SplitCoins">

TransferObjects()​

TransferObjects(objects, address): TransactionShape<"TransferObjects">

Parameters​

objects​

({ GasCoin: true; } | { Input: number; type?: "object" | "pure"; } | { Result: number; } | { NestedResult: [number, number]; })[]

address​

{ GasCoin: true; } | { Input: number; type?: "object" | "pure"; } | { Result: number; } | { NestedResult: [number, number]; }

Returns​

TransactionShape<"TransferObjects">

Upgrade()​

Upgrade(__namedParameters): TransactionShape<"Upgrade">

Parameters​

__namedParameters​
dependencies​

string[]

modules​

string[] | number[][]

package​

string

ticket​

{ GasCoin: true; } | { Input: number; type?: "object" | "pure"; } | { Result: number; } | { NestedResult: [number, number]; }

Returns​

TransactionShape<"Upgrade">