Skip to main content

Class: MergeCoins

Command to merge multiple coins of the same type into a single coin

BCS

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

merge-coins = argument (vector argument)

Extends​

  • UniffiAbstractObject

Implements​

Constructors​

Constructor​

new MergeCoins(coin, coinsToMerge): MergeCoins;

Parameters​

coin​

ArgumentLike

coinsToMerge​

ArgumentLike[]

Returns​

MergeCoins

Overrides​

UniffiAbstractObject.constructor

Properties​

[destructorGuardSymbol]​

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]​

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]​

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

Methods​

coin()​

coin(): ArgumentLike;

Coin to merge coins into

Returns​

ArgumentLike

Implementation of​

MergeCoinsLike.coin

coinsToMerge()​

coinsToMerge(): ArgumentLike[];

Set of coins to merge into coin

All listed coins must be of the same type and be the same type as coin

Returns​

ArgumentLike[]

Implementation of​

MergeCoinsLike.coinsToMerge

equals()​

equals(other): boolean;

Parameters​

other​

MergeCoins

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 MergeCoins;

Parameters​

obj_​

any

Returns​

obj_ is MergeCoins