Skip to main content

Interface: TimelockedIotaBalanceLike

A typed view of an on-chain 0x2::timelock::TimeLock<Balance<IOTA>> object — a time-locked IOTA balance, e.g. Stardust vested rewards.

Methods

expirationTimestampMs()

expirationTimestampMs(): bigint;

Epoch timestamp (ms) of when the lock expires.

Returns

bigint


id()

id(): ObjectIdLike;

The object's ID.

Returns

ObjectIdLike


label()

label(): string | undefined;

Returns

string | undefined


locked()

locked(): bigint;

The locked IOTA amount in nanos.

Returns

bigint