Skip to main content

TimelockedIotaBalance

TimelockedIotaBalance​

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.

debugDescription​

var debugDescription: String { get }

A textual representation of this instance, suitable for debugging.

Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the String(reflecting:) initializer. This initializer works with any type, and uses the custom debugDescription property for types that conform to CustomDebugStringConvertible:

struct Point: CustomDebugStringConvertible {
    let x: Int, y: Int

    var debugDescription: String {
        return "(\(x), \(y))"
    }
}

let p = Point(x: 21, y: 30)
let s = String(reflecting: p)
print(s)
// Prints "(21, 30)"

The conversion of p to a string in the assignment to s uses the Point type's debugDescription property.

expirationTimestampMs()​

func expirationTimestampMs() -> UInt64

Epoch timestamp (ms) of when the lock expires.

id()​

func id() -> ObjectId

The object's ID.

label()​

func label() -> String?

locked()​

func locked() -> UInt64

The locked IOTA amount in nanos.

tryFromBcs(bytes:)​

static func tryFromBcs(bytes: Data) throws -> TimelockedIotaBalance

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

tryFromObject(object:)​

static func tryFromObject(object: Object) throws -> TimelockedIotaBalance

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