Skip to main content

NotarizationBuilderDynamic

@iota/notarization API documentation

Class: NotarizationBuilderDynamic

Represents a builder for constructing dynamic notarization transactions.

Dynamic notarizations are updatable records that can evolve over time.

Methods​

withBytesState()​

withBytesState(data, metadata?): NotarizationBuilderDynamic

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​

NotarizationBuilderDynamic

withStringState()​

withStringState(data, metadata?): NotarizationBuilderDynamic

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​

NotarizationBuilderDynamic

withImmutableDescription()​

withImmutableDescription(description): NotarizationBuilderDynamic

Adds an immutable description to the notarization.

Arguments

  • description - A string describing the notarization.

Parameters​

description​

string

Returns​

NotarizationBuilderDynamic

withUpdatableMetadata()​

withUpdatableMetadata(metadata): NotarizationBuilderDynamic

Adds updatable metadata to the notarization.

Arguments

  • metadata - A string representing the metadata.

Parameters​

metadata​

string

Returns​

NotarizationBuilderDynamic

dynamic()​

static dynamic(): NotarizationBuilderDynamic

Creates a new dynamic notarization builder.

Returns​

NotarizationBuilderDynamic

withTransferLock()​

withTransferLock(lock): NotarizationBuilderDynamic

Adds a transfer lock to the notarization.

Arguments

  • lock - A TimeLock specifying the transfer lock.

Parameters​

lock​

TimeLock

Returns​

NotarizationBuilderDynamic

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