CreateNotarizationLocked
@iota/notarization API documentation
Class: CreateNotarizationLocked
Transaction that creates a Locked-Notarization.
Remarks
A Locked-Notarization is immutable after creation: its state and updatable metadata are fixed for the lifetime of the object. On success the new notarization object is transferred to the transaction sender.
Emits a LockedNotarizationCreated event on success.
Constructors
Constructor
new CreateNotarizationLocked(
builder):CreateNotarizationLocked
Constructs the transaction from a configured Locked-Notarization builder.
Parameters
builder
A finalized NotarizationBuilderLocked.
Returns
CreateNotarizationLocked
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<OnChainNotarization>
Reads the on-chain effects and events of the submitted transaction and returns the resulting OnChainNotarization.
Parameters
wasm_effects
TransactionEffects
wasm_events
IotaEvent[]
client
CoreClientReadOnly
A read-only client connected to the target network.
Returns
Promise<OnChainNotarization>
The created OnChainNotarization.
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 or the result cannot be reconstructed.
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 — e.g. when the configured state, metadata, or lock combination is rejected.