Class: TimelockedIotaBalance
A typed view of an on-chain 0x2::timelock::TimeLock<Balance<IOTA>>
object — a time-locked IOTA balance, e.g. Stardust vested rewards.
Extends
UniffiAbstractObject
Implements
Properties
[destructorGuardSymbol]
readonly [destructorGuardSymbol]: UniffiGcObject;
[pointerLiteralSymbol]
readonly [pointerLiteralSymbol]: bigint;
[uniffiTypeNameSymbol]
readonly [uniffiTypeNameSymbol]: "TimelockedIotaBalance" = "TimelockedIotaBalance";
Methods
expirationTimestampMs()
expirationTimestampMs(): bigint;
Epoch timestamp (ms) of when the lock expires.
Returns
bigint
Implementation of
TimelockedIotaBalanceLike.expirationTimestampMs
id()
id(): ObjectIdLike;
The object's ID.
Returns
Implementation of
label()
label(): string | undefined;
Returns
string | undefined
Implementation of
TimelockedIotaBalanceLike.label
locked()
locked(): bigint;
The locked IOTA amount in nanos.
Returns
bigint
Implementation of
TimelockedIotaBalanceLike.locked
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 TimelockedIotaBalance;
Parameters
obj_
any
Returns
obj_ is TimelockedIotaBalance
tryFromBcs()
static tryFromBcs(bytes): TimelockedIotaBalanceLike;
Decode from BCS bytes, without validating the on-chain type tag.
Parameters
bytes
ArrayBuffer
Returns
tryFromObject()
static tryFromObject(object): TimelockedIotaBalanceLike;
Decode from an on-chain object, validating its Move type tag.