Skip to main content

ObjectIdInterface

interface ObjectIdInterface

An ObjectId is a 32-byte identifier used to uniquely identify an object on the IOTA blockchain.

Relationship to Address

Addresses and ObjectIds share the same 32-byte addressable space but are derived leveraging different domain-separator values to ensure, cryptographically, that there won't be any overlap, e.g. there can't be a valid Object whose ObjectId is equal to that of the Address of a user account.

BCS

An ObjectId's BCS serialized form is defined by the following:

object-id = address

Inheritors

ObjectId

Functions

NameSummary
deriveDynamicChildIdabstract fun deriveDynamicChildId(keyTypeTag: TypeTag, keyBytes: ByteArray): ObjectId
Derive an ObjectId for a Dynamic Child Object.
deriveObjectIdabstract fun deriveObjectId(keyTypeTag: TypeTag, keyBytes: ByteArray): ObjectId
Derive the ObjectId of a derived object (0x2::derived_object).
nextLexicographicalabstract fun nextLexicographical(): ObjectId
Returns the next digest in byte-increasing order.
nextLexicographicalOptabstract fun nextLexicographicalOpt(): ObjectId?
Returns the next digest in byte-increasing order, or None if the result would overflow.
toAddressabstract fun toAddress(): Address
toBytesabstract fun toBytes(): ByteArray
toCanonicalStringabstract fun toCanonicalString(withPrefix: Boolean): String
Returns the string representation of this object ID using the canonical display, with or without a 0x prefix.
toHexabstract fun toHex(): String
Returns the string representation of this object id in hex format with 0x prefix.
toRawHexabstract fun toRawHex(): String
Returns the string representation of this object id in hex format without 0x prefix.
toRawShortHexabstract fun toRawShortHex(): String
Returns the shortest possible string representation of the object id (i.e. with leading zeroes trimmed), without 0x prefix.
toShortHexabstract fun toShortHex(): String
Returns the shortest possible string representation of the object ID (i.e. with leading zeroes trimmed).