Skip to main content

IssueCapability

@iota/audit-trails API documentation

Class: IssueCapability

Transaction wrapper for issuing a capability.

Remarks​

Mints a new Capability for the role and transfers it to the configured recipient (or the caller when none was set). The validity window configured via CapabilityIssueOptions is enforced when the capability is later presented for authorization.

Requires the Permission.AddCapabilities permission.

Emits a CapabilityIssued 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<CapabilityIssued>

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

Decoded CapabilityIssued 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.