Skip to main content

IObjectId

Namespace: IotaSdk

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
public interface IObjectId : System.IEquatable`1[[IotaSdk.ObjectId, IotaSdk, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Implements IEquatable<ObjectId>
Attributes NullableContextAttribute

Methods

DeriveDynamicChildId(TypeTag, Byte[])

Derive an ObjectId for a Dynamic Child Object.

hash(parent || len(key) || key || key_type_tag)

ObjectId DeriveDynamicChildId(TypeTag keyTypeTag, Byte[] keyBytes)

Parameters

keyTypeTag TypeTag

keyBytes Byte[]

Returns

ObjectId

DeriveObjectId(TypeTag, Byte[])

Derive the ObjectId of a derived object (0x2::derived_object).

hash(parent || len(key) || key || DerivedObjectKey(key_type_tag))

ObjectId DeriveObjectId(TypeTag keyTypeTag, Byte[] keyBytes)

Parameters

keyTypeTag TypeTag

keyBytes Byte[]

Returns

ObjectId

NextLexicographical()

Returns the next digest in byte-increasing order.

ObjectId NextLexicographical()

Returns

ObjectId

NextLexicographicalOpt()

Returns the next digest in byte-increasing order, or None if the result would overflow.

ObjectId? NextLexicographicalOpt()

Returns

ObjectId?

ToAddress()

Address ToAddress()

Returns

Address

ToBytes()

Byte[] ToBytes()

Returns

Byte[]

ToCanonicalString(Boolean)

Returns the string representation of this object ID using the canonical display, with or without a 0x prefix.

string ToCanonicalString(bool withPrefix)

Parameters

withPrefix Boolean

Returns

String

ToHex()

Returns the string representation of this object id in hex format with 0x prefix.

string ToHex()

Returns

String

ToRawHex()

Returns the string representation of this object id in hex format without 0x prefix.

string ToRawHex()

Returns

String

ToRawShortHex()

Returns the shortest possible string representation of the object id (i.e. with leading zeroes trimmed), without 0x prefix.

string ToRawShortHex()

Returns

String

ToShortHex()

Returns the shortest possible string representation of the object ID (i.e. with leading zeroes trimmed).

string ToShortHex()

Returns

String