Skip to main content

Migrate

@iota/audit-trails API documentation

Class: Migrate

Transaction wrapper for trail migration.

Remarks​

Succeeds only when the on-chain trail's package version is strictly less than the package version this binding targets.

Requires the Permission.Migrate permission.

Emits an AuditTrailMigrated 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<Empty>

Applies transaction effects and events.

Parameters​

wasm_effects​

TransactionEffects

wasm_events​

IotaEvent[]

client​

CoreClientReadOnly

Read-only core client used during application.

Returns​

Promise<Empty>

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.