Skip to main content

LockingConfig

@iota/audit-trails API documentation


Class: LockingConfig

Full locking configuration.

Remarks

Combines three independent rules: a per-record delete window, a trail-delete time lock, and a write-time lock. The trail-delete lock must not be TimeLock.withUntilDestroyed, and a count-based delete-record window must use count > 0; trail creation and locking updates that violate either invariant are rejected (client-side where possible, on-chain otherwise).

Constructors

Constructor

new LockingConfig(delete_record_window, delete_trail_lock, write_lock): LockingConfig

Creates a locking configuration.

Parameters

delete_record_window

LockingWindow

delete_trail_lock

TimeLock

write_lock

TimeLock

Returns

LockingConfig

Properties

deleteRecordWindow

deleteRecordWindow: LockingWindow

Delete-window policy applied to individual records.

Records inside the window are locked against deletion.


deleteTrailLock

deleteTrailLock: TimeLock

Time lock that gates deletion of the entire trail.

Must not be TimeLock.withUntilDestroyed; trail creation and locking updates that violate this invariant abort on-chain.


writeLock

writeLock: TimeLock

Time lock that gates record writes (addRecord).

Methods

toJSON()

toJSON(): Object

  • Return copy of self without private attributes.

Returns

Object


toString()

toString(): string

Return stringified version of self.

Returns

string