Skip to main content

TimelockedIotaBalance

type TimelockedIotaBalance​

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

type TimelockedIotaBalance struct {
    // contains filtered or unexported fields
}

func LiftFromExternalTimelockedIotaBalance​

func LiftFromExternalTimelockedIotaBalance(handle uint64) *TimelockedIotaBalance

func TimelockedIotaBalanceTryFromBcs​

func TimelockedIotaBalanceTryFromBcs(bytes []byte) (*TimelockedIotaBalance, error)

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

func TimelockedIotaBalanceTryFromObject​

func TimelockedIotaBalanceTryFromObject(object *Object) (*TimelockedIotaBalance, error)

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

func (*TimelockedIotaBalance) DebugString​

func (_self *TimelockedIotaBalance) DebugString() string

func (*TimelockedIotaBalance) Destroy​

func (object *TimelockedIotaBalance) Destroy()

func (*TimelockedIotaBalance) ExpirationTimestampMs​

func (_self *TimelockedIotaBalance) ExpirationTimestampMs() uint64

Epoch timestamp (ms) of when the lock expires.

func (*TimelockedIotaBalance) Id​

func (_self *TimelockedIotaBalance) Id() *ObjectId

The object's ID.

func (*TimelockedIotaBalance) Label​

func (_self *TimelockedIotaBalance) Label() *string

func (*TimelockedIotaBalance) Locked​

func (_self *TimelockedIotaBalance) Locked() uint64

The locked IOTA amount in nanos.