ObjectIdInterface

type ObjectIdInterface

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

## Relationship to Address

`Address`es and `ObjectId`s 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:

```text object-id = address ```

type ObjectIdInterface interface {
    // Derive an ObjectId for a Dynamic Child Object.
    //
    // hash(parent || len(key) || key || key_type_tag)
    DeriveDynamicChildId(keyTypeTag *TypeTag, keyBytes []byte) *ObjectId
    // Derive the ObjectId of a derived object (`0x2::derived_object`).
    //
    // hash(parent || len(key) || key || DerivedObjectKey(key_type_tag))
    DeriveObjectId(keyTypeTag *TypeTag, keyBytes []byte) *ObjectId
    // Returns the next digest in byte-increasing order.
    NextLexicographical() *ObjectId
    // Returns the next digest in byte-increasing order, or `None` if the
    // result would overflow.
    NextLexicographicalOpt() **ObjectId
    ToAddress() *Address
    ToBytes() []byte
    // Returns the string representation of this object ID using the
    // canonical display, with or without a `0x` prefix.
    ToCanonicalString(withPrefix bool) string
    // Returns the string representation of this object id in hex format with
    // `0x` prefix.
    ToHex() string
    // Returns the string representation of this object id in hex format
    // without `0x` prefix.
    ToRawHex() string
    // Returns the shortest possible string representation of the object id
    // (i.e. with leading zeroes trimmed), without `0x` prefix.
    ToRawShortHex() string
    // Returns the shortest possible string representation of the object ID
    // (i.e. with leading zeroes trimmed).
    ToShortHex() string
}