Skip to main content

LockMetadata

@iota/notarization API documentation

Class: LockMetadata

Time-based access restrictions attached to a notarization at creation.

Remarks​

deleteLock cannot be TimeLockType.UntilDestroyed, and its unlock time must be no earlier than the unlock times of updateLock and transferLock — on-chain creation aborts otherwise.

Permitted lock configurations depend on the NotarizationMethod:

  • Dynamic: updateLock is fixed to TimeLockType.None; transferLock may carry any TimeLock variant.
  • Locked: both updateLock and transferLock are fixed to TimeLockType.UntilDestroyed — Locked-Notarizations are non-transferable and their state is immutable.

Properties​

deleteLock​

deleteLock: TimeLock

Lock gating destruction. Cannot be TimeLockType.UntilDestroyed; its unlock time must be ≥ both other locks' unlock times.

transferLock​

transferLock: TimeLock

Lock gating ownership transfer.

Value depends on the Notarization Method:

  • Dynamic: any TimeLock variant — controls when ownership transfer is permitted.
  • Locked: fixed to TimeLockType.UntilDestroyed — Locked-Notarizations are non-transferable.

updateLock​

updateLock: TimeLock

Lock gating state and metadata updates.

Value depends on the Notarization Method:

Methods​

toJSON()​

toJSON(): Object

  • Return copy of self without private attributes.

Returns​

Object

toString()​

toString(): string

Return stringified version of self.

Returns​

string