Skip to main content

Class: Command

A single command in a programmable transaction.

BCS

The BCS serialized form for this type is defined by the following ABNF:

command =  command-move-call
=/ command-transfer-objects
=/ command-split-coins
=/ command-merge-coins
=/ command-publish
=/ command-make-move-vector
=/ command-upgrade

command-move-call           = %d00 move-call
command-transfer-objects    = %d01 transfer-objects
command-split-coins         = %d02 split-coins
command-merge-coins         = %d03 merge-coins
command-publish             = %d04 publish
command-make-move-vector    = %d05 make-move-vector
command-upgrade             = %d06 upgrade

Extends​

  • UniffiAbstractObject

Implements​

Properties​

[destructorGuardSymbol]​

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]​

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]​

readonly [uniffiTypeNameSymbol]: "Command" = "Command";

Methods​

equals()​

equals(other): boolean;

Parameters​

other​

Command

Returns​

boolean

toDebugString()​

toDebugString(): string;

Returns​

string

toString()​

toString(): string;

Returns a string representation of an object.

Returns​

string

uniffiDestroy()​

uniffiDestroy(): void;

Explicitly tell Rust to destroy the native peer that backs this object.

Once this method has been called, any following method calls will throw an error.

Can be called more than once.

Returns​

void

Overrides​

UniffiAbstractObject.uniffiDestroy

uniffiUse()​

uniffiUse<T>(block): T;

A convenience method to use this object, then destroy it after its use.

Type Parameters​

T​

T

Parameters​

block​

(obj) => T

Returns​

T

Inherited from​

UniffiAbstractObject.uniffiUse

instanceOf()​

static instanceOf(obj_): obj_ is Command;

Parameters​

obj_​

any

Returns​

obj_ is Command

newMakeMoveVector()​

static newMakeMoveVector(makeMoveVector): CommandLike;

Given n-values of the same type, it constructs a vector. For non objects or an empty vector, the type tag must be specified.

Parameters​

makeMoveVector​

MakeMoveVectorLike

Returns​

CommandLike

newMergeCoins()​

static newMergeCoins(mergeCoins): CommandLike;

It merges n-coins into the first coin

Parameters​

mergeCoins​

MergeCoinsLike

Returns​

CommandLike

newMoveCall()​

static newMoveCall(moveCall): CommandLike;

A call to either an entry or a public Move function

Parameters​

moveCall​

MoveCallLike

Returns​

CommandLike

newPublish()​

static newPublish(publish): CommandLike;

Publishes a Move package. It takes the package bytes and a list of the package's transitive dependencies to link against on-chain.

Parameters​

publish​

PublishLike

Returns​

CommandLike

newSplitCoins()​

static newSplitCoins(splitCoins): CommandLike;

It splits off some amounts into a new coins with those amounts

Parameters​

splitCoins​

SplitCoinsLike

Returns​

CommandLike

newTransferObjects()​

static newTransferObjects(transferObjects): CommandLike;

It sends n-objects to the specified address. These objects must have store (public transfer) and either the previous owner must be an address or the object must be newly created.

Parameters​

transferObjects​

TransferObjectsLike

Returns​

CommandLike

newUpgrade()​

static newUpgrade(upgrade): CommandLike;

Upgrades a Move package Takes (in order):

  1. A vector of serialized modules for the package.
  2. A vector of object ids for the transitive dependencies of the new package.
  3. The object ID of the package being upgraded.
  4. An argument holding the UpgradeTicket that must have been produced from an earlier command in the same programmable transaction.

Parameters​

upgrade​

UpgradeLike

Returns​

CommandLike