Skip to main content

DeleteRecordsBatch

@iota/audit-trails API documentation

Class: DeleteRecordsBatch

Transaction wrapper for deleting records in batch form.

Remarks​

Walks the trail from the front and silently skips records still inside the delete-record window or whose tag the capability does not allow. The set of locked records is fixed at the start of the on-chain call: count-based windows protect the last count records present when the call begins, and time-based windows are evaluated against the clock timestamp captured at that point.

limit caps the number of records actually deleted, not the number of records inspected. Ineligible records at the front of the trail are silently walked past without counting toward limit, so more than limit records may be visited before limit deletions accumulate.

Requires the Permission.DeleteAllRecords permission.

Emits one RecordDeleted event per deletion.

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<BigUint64Array<ArrayBufferLike>>

Applies transaction effects and events and decodes the matching payload.

Parameters​

wasm_effects​

TransactionEffects

wasm_events​

IotaEvent[]

client​

CoreClientReadOnly

Read-only core client used during application.

Returns​

Promise<BigUint64Array<ArrayBufferLike>>

Sequence numbers of the records deleted in this batch, in deletion order — at most the requested limit, possibly fewer.

Throws​

When transaction application fails.

buildProgrammableTransaction()​

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

Builds the programmable transaction bytes for submission.

Parameters​

client​

CoreClientReadOnly

Read-only core client used to resolve packages and serialize the transaction.

Returns​

Promise<Uint8Array<ArrayBufferLike>>

BCS-encoded programmable transaction bytes ready for signing and submission.

Throws​

When transaction serialization fails.