Skip to main content

RevokeCapability

@iota/audit-trails API documentation

Class: RevokeCapability

Transaction wrapper for revoking a capability.

Remarks​

Adds the capability ID to the trail's denylist. Pass capabilityValidUntil so CleanupRevokedCapabilities can later prune the entry once that timestamp elapses; pass null to keep the denylist entry permanently.

Requires the Permission.RevokeCapabilities permission.

Emits a CapabilityRevoked event on success.

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<CapabilityRevoked>

Applies transaction effects and events and decodes the matching event payload.

Parameters​

wasm_effects​

TransactionEffects

wasm_events​

IotaEvent[]

client​

CoreClientReadOnly

Read-only core client used during application.

Returns​

Promise<CapabilityRevoked>

Decoded CapabilityRevoked event payload.

Throws​

When the expected event is missing or 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.