Skip to main content

Record

@iota/audit-trails API documentation

Class: Record

Single audit-trail record.

Remarks​

Records form a tamper-evident, sequential chain: each record has a monotonically increasing sequence number that is never reused, even after the record is deleted.

Properties​

addedAt​

addedAt: bigint

Millisecond timestamp at which the record was added.

addedBy​

addedBy: string

Address that added the record.

correction​

correction: RecordCorrection

Correction relationships for this record.

data​

data: Data

Record payload stored on-chain.

sequenceNumber​

sequenceNumber: bigint

Monotonic record sequence number inside the trail.

Accessors​

metadata​

Get Signature​

get metadata(): string | undefined

Optional application-defined metadata.

Returns​

string | undefined

Set Signature​

set metadata(value): void

Optional application-defined metadata.

Parameters​
value​

string | null | undefined

Returns​

void

tag​

Get Signature​

get tag(): string | undefined

Optional trail-owned tag attached to the record.

Returns​

string | undefined

Set Signature​

set tag(value): void

Optional trail-owned tag attached to the record.

Parameters​
value​

string | null | undefined

Returns​

void

Methods​

toJSON()​

toJSON(): Object

  • Return copy of self without private attributes.

Returns​

Object

toString()​

toString(): string

Return stringified version of self.

Returns​

string