Skip to main content

NotarizationBuilderLocked

@iota/notarization API documentation

Class: NotarizationBuilderLocked

Represents a builder for constructing locked notarization transactions.

Locked notarizations are immutable records (the notarization state) that cannot be modified after creation.

Methods​

toJSON()​

toJSON(): Object

  • Return copy of self without private attributes.

Returns​

Object

toString()​

toString(): string

Return stringified version of self.

Returns​

string

withBytesState()​

withBytesState(data, metadata?): NotarizationBuilderLocked

Adds a state to the notarization using binary data.

Arguments

  • data - Binary data representing the state.
  • metadata - Optional metadata associated with the state.

Parameters​

data​

Uint8Array

metadata?​

null | string

Returns​

NotarizationBuilderLocked

withStringState()​

withStringState(data, metadata?): NotarizationBuilderLocked

Adds a state to the notarization using a string.

Arguments

  • data - String data representing the state.
  • metadata - Optional metadata associated with the state.

Parameters​

data​

string

metadata?​

null | string

Returns​

NotarizationBuilderLocked

withImmutableDescription()​

withImmutableDescription(description): NotarizationBuilderLocked

Adds an immutable description to the notarization.

Arguments

  • description - A string describing the notarization.

Parameters​

description​

string

Returns​

NotarizationBuilderLocked

withUpdatableMetadata()​

withUpdatableMetadata(metadata): NotarizationBuilderLocked

Adds updatable metadata to the notarization.

Arguments

  • metadata - A string representing the metadata.

Parameters​

metadata​

string

Returns​

NotarizationBuilderLocked

locked()​

static locked(): NotarizationBuilderLocked

Creates a new locked notarization builder.

Returns​

NotarizationBuilderLocked

withDeleteLock()​

withDeleteLock(lock): NotarizationBuilderLocked

Adds a delete lock to the notarization.

Arguments

  • lock - A TimeLock specifying the delete lock.

Parameters​

lock​

TimeLock

Returns​

NotarizationBuilderLocked

finish()​

finish(): any

Finalizes the notarization builder and returns a transaction builder that can be used to build and execute the final transaction on the ledger.

Returns

A TransactionBuilder to build and execute the transaction.

Returns​

any