Skip to main content

TransferNotarization

@iota/notarization API documentation

Class: TransferNotarization

Transaction that transfers ownership of a Dynamic-Notarization.

Remarks​

Permitted only when the notarization has no LockMetadata or when its transferLock is not currently active. Submitting against a Locked-Notarization or while the transfer lock is engaged aborts on-chain.

Emits a DynamicNotarizationTransferred event on success.

Constructors​

Constructor​

new TransferNotarization(recipient, object_id): TransferNotarization

Constructs the transaction.

Parameters​

recipient​

string

The new owner's IOTA address.

object_id​

string

Returns​

TransferNotarization

Throws​

When the ID or address is malformed.

Methods​

toJSON()​

toJSON(): Object

  • Return copy of self without private attributes.

Returns​

Object

toString()​

toString(): string

Return stringified version of self.

Returns​

string

applyWithEvents()​

applyWithEvents(wasm_effects, wasm_events, client): Promise<Empty>

Reads the on-chain effects and events of the submitted transaction.

Parameters​

wasm_effects​

TransactionEffects

wasm_events​

IotaEvent[]

client​

CoreClientReadOnly

A read-only client connected to the target network.

Returns​

Promise<Empty>

Remarks​

Invoked automatically by the TransactionBuilder machinery after the transaction has been submitted; calling it directly is normally not necessary.

Throws​

When the effects/events are inconsistent with this transaction.

buildProgrammableTransaction()​

buildProgrammableTransaction(client): Promise<Uint8Array<ArrayBufferLike>>

Builds the programmable transaction bytes.

Parameters​

client​

CoreClientReadOnly

A read-only client connected to the target network.

Returns​

Promise<Uint8Array<ArrayBufferLike>>

The BCS-serialized programmable transaction, ready to be signed and submitted.

Throws​

When the transaction cannot be built.