Documentation/canton-network-docs/SDKsdApp SDKAPI ReferenceView on canton-network-docs ↗
canton-network-docs/SDKsdApp SDKAPI Reference

Events

The dApp SDK emits events so your UI can stay in sync with the wallet’s state. Subscribe with the on* functions and unsubscribe with the matching off* function. For usage examples, see Handle Events.

​
onStatusChanged(handler) / offStatusChanged(handler)

Fires when the connection status or session state changes.
Payload fieldTypeDescription
connection.isConnectedbooleanWhether a session is currently active.

​
onAccountsChanged(handler) / offAccountsChanged(handler)

Fires when accounts are added or removed, or the primary account changes.
PayloadTypeDescription
accountsAccount[]The current set of parties.

​
onTxChanged(handler) / offTxChanged(handler)

Fires as a transaction submitted via prepareExecute moves through its lifecycle.
Payload fieldTypeDescription
status'pending' | 'signed' | 'executed' | 'failed'Current transaction state.
payload.updateIdstringLedger update ID (present when executed).
  • Handle Events — Examples for subscribing to and cleaning up these events.
  • SDK Methods — The functions that trigger these events.