Skip to main content

OnChainNotarization

@iota/notarization API documentation

Class: OnChainNotarization

Represents an on-chain notarization object.

Provides access to various properties of the notarization, such as its ID, state, metadata and method.

Properties​

id​

readonly id: string

Retrieves the ID of the notarization.

Returns

A hexadecimal string representing the notarization ID.

state​

readonly state: State

Retrieves the current state of the notarization.

Returns

A State object representing the notarization state.

immutableMetadata​

readonly immutableMetadata: ImmutableMetadata

Retrieves the immutable metadata of the notarization.

Returns

A ImmutableMetadata object containing the metadata.

updatableMetadata​

readonly updatableMetadata: undefined | string

Retrieves the updatable metadata of the notarization.

Returns

An optional string containing the metadata.

lastStateChangeAt​

readonly lastStateChangeAt: bigint

Retrieves the timestamp of the last state change.

Returns

A number value representing the timestamp, the time in seconds since the Unix epoch.

stateVersionCount​

readonly stateVersionCount: bigint

Retrieves the count of state versions.

Returns

A number value representing the number of state versions.

method​

readonly method: NotarizationMethod

Retrieves the notarization method.

Returns

A NotarizationMethod object representing the method.

Methods​

toJSON()​

toJSON(): Object

  • Return copy of self without private attributes.

Returns​

Object

toString()​

toString(): string

Return stringified version of self.

Returns​

string