Skip to main content

TimelockedIotaBalance

TimelockedIotaBalance Objects

class TimelockedIotaBalance(TimelockedIotaBalanceProtocol)

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

try_from_bcs

@classmethod
def try_from_bcs(cls, bytes: bytes) -> TimelockedIotaBalance

Decode from BCS bytes, without validating the on-chain type tag.

try_from_object

@classmethod
def try_from_object(cls, object: Object) -> TimelockedIotaBalance

Decode from an on-chain object, validating its Move type tag.

expiration_timestamp_ms

def expiration_timestamp_ms() -> int

Epoch timestamp (ms) of when the lock expires.

id

def id() -> ObjectId

The object's ID.

locked

def locked() -> int

The locked IOTA amount in nanos.