Documentation

JSON API AsyncAPI › /v2/commands/completions › subscribe /v2/commands/completions Subscribe completions WebSocket Updated 3.5 SUBSCRIBE /v2/commands/completions Deprecated: please use GetCompletions instead. Subscribe to command completion events. Protocol Details Protocol WebSocket C

JSON API AsyncAPI › /v2/updates/trees › publish /v2/updates/trees Publish trees WebSocket Updated 3.5 PUBLISH /v2/updates/trees Get update transactions tree stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. Protocol Detai

Ledger API JSON Ledger API OpenAPI Generated operation reference for the JSON Ledger API, with lifecycle history embedded on each operation page. OpenAPI 3.5 Operations 69 Source Canton release bundle JSON Ledger API specifications Specification Download the published OpenAPI specification

JSON API AsyncAPI › /v2/updates/trees › subscribe /v2/updates/trees Subscribe trees WebSocket Updated 3.5 SUBSCRIBE /v2/updates/trees Get update transactions tree stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. Protocol

JSON API AsyncAPI › /v2/updates › publish /v2/updates Publish updates WebSocket Updated 3.5 PUBLISH /v2/updates Read the ledger’s filtered update stream for the specified contents and filters. It returns the event types in accordance with the stream contents selected. Also the selection cri

JSON API AsyncAPI › /v2/updates › subscribe /v2/updates Subscribe updates WebSocket Updated 3.5 SUBSCRIBE /v2/updates Read the ledger’s filtered update stream for the specified contents and filters. It returns the event types in accordance with the stream contents selected. Also the selecti

Scan API GET /v0/rewards-collected OpenAPI Deprecated 0.5.10 Removed in 0.6.7 GET /v0/rewards-collected Removed in 0.6.7. Historical definition from 0.6.6. Deprecated . Get the total rewards collected ever Protocol Details Operation ID getRewardsCollected Published 0.6.6 Inputs Quer

Scan API GET /v0/top-providers-by-app-rewards OpenAPI Deprecated 0.5.10 Removed in 0.6.6 GET /v0/top-providers-by-app-rewards Removed in 0.6.6. Historical definition from 0.6.5. Deprecated . Get a list of top-earning app providers, and the total earned app rewards for each Protocol Detail

Scan API GET /v0/round-of-latest-data OpenAPI Deprecated 0.5.10 Removed in 0.6.7 GET /v0/round-of-latest-data Removed in 0.6.7. Historical definition from 0.6.6. Deprecated . Get the latest round number for which aggregated data is available and the ledger effective time at which the round

Scan API GET /v0/aggregated-rounds OpenAPI Deprecated 0.5.10 Removed in 0.6.7 GET /v0/aggregated-rounds Removed in 0.6.7. Historical definition from 0.6.6. Deprecated . Retrieve the current earliest and latest rounds aggregated for this Scan. Protocol Details Operation ID getAggregatedRo

TypeScript package dApp SDK TypeScript client library reference for dApp integrations. TypeScript Updated 1.2.0 Exports removed in 1.2.0 Package @canton-network/dapp-sdk Current release 1.7.1 Compared releases 9 Generated from published @canton-network/dapp-sdk TypeDoc snapshots. Table

TypeScript package Wallet SDK TypeScript client library reference for wallet integrations. TypeScript Added 1.5.1 Updated 1.5.1 Exports removed in 1.5.1 Package @canton-network/wallet-sdk Current release 1.5.1 Compared releases 4 Generated from published @canton-network/wallet-sdk TypeDoc

TypeScript package @daml/types TypeScript and JavaScript language bindings for Canton. TypeScript Updated 3.4.9 Package @daml/types Current release 3.5.2 Compared releases 7 Generated from published @daml/types TypeDoc snapshots. Table of Contents Name | Kind | Summary | Introduced |

Scan API GET /v0/top-validators-by-purchased-traffic OpenAPI Deprecated 0.5.10 Removed in 0.6.6 GET /v0/top-validators-by-purchased-traffic Removed in 0.6.6. Historical definition from 0.6.5. Deprecated . Get a list of validators and their domain fees spends, sorted by the amount of extra t

Scan API GET /v0/top-validators-by-validator-faucets OpenAPI Removed in 0.6.6 GET /v0/top-validators-by-validator-faucets Removed in 0.6.6. Historical definition from 0.6.5. Get a list of top validators by number of rounds in which they collected faucets, and basis statistics on their round

Scan API GET /v0/top-validators-by-validator-rewards OpenAPI Deprecated 0.5.10 Removed in 0.6.6 GET /v0/top-validators-by-validator-rewards Removed in 0.6.6. Historical definition from 0.6.5. Deprecated . Get a list of top-earning validators, and the total earned validator rewards for each

Scan API POST /v0/activities OpenAPI Updated 0.5.12 Deprecated 0.5.10 Removed in 0.6.8 POST /v0/activities Removed in 0.6.8. Historical definition from 0.6.7. Deprecated . Lists activities in descending order, paged, optionally starting after a provided event id. Protocol Details Operati

Scan API POST /v0/round-party-totals OpenAPI Deprecated 0.5.10 Removed in 0.6.7 POST /v0/round-party-totals Removed in 0.6.7. Historical definition from 0.6.6. Deprecated . Retrieve per-party Amulet statistics for up to 50 closed rounds. Protocol Details Operation ID listRoundPartyTotals

Scan API POST /v0/round-totals OpenAPI Deprecated 0.5.10 Removed in 0.6.7 POST /v0/round-totals Removed in 0.6.7. Historical definition from 0.6.6. Deprecated . List Amulet statistics for up to 200 closed rounds. Protocol Details Operation ID listRoundTotals Published 0.6.6 Inputs B

Scan API POST /v0/transactions OpenAPI Updated 0.5.12 Deprecated 0.5.10 Removed in 0.7.0 POST /v0/transactions Removed in 0.7.0. Historical definition from 0.6.14. Deprecated with known bugs that will not be fixed, use /v2/updates instead . Lists transactions, by default in ascending order,

Back to overview OpenRPC Spec User API An OpenRPC specification for the user to interact with the Wallet Gateway. JSON-RPC Added 1.10.0 Updated 1.10.0 Methods removed in 1.10.0 Latest source path api-specs/openrpc-user-api.json Publish version 1.11.1 OpenRPC version 1.2.6 Spec info.version

OpenRPC Reference Wallet Gateway Operation-first JSON-RPC reference pages with version history carried from the snapshot lifecycle report. OpenRPC 1.11.1 Publish version 1.11.1 Versions compared 0.24.0, 0.25.0, 0.26.0, 0.27.0, 1.1.0, 1.2.0, 1.2.1, 1.3.0, 1.4.0, 1.5.0, 1.6.0, 1.7.0, 1.8.0, 1.8.

Back to overview OpenRPC Spec Async dApp API An OpenRPC specification for remotely hosted Wallet Providers. Due to the remote nature, an implementing provider must bridge certain functionality on the client-side to satisfy the general dApp API spec. JSON-RPC Added 1.4.0 Updated 1.4.0 Latest s

Back to overview OpenRPC Spec Sync dApp API An OpenRPC specification for the dapp to interact with a Wallet Provider. JSON-RPC Added 1.4.0 Updated 1.4.0 Latest source path api-specs/openrpc-dapp-api.json Publish version 1.11.1 OpenRPC version 1.2.6 Spec info.version 0.5.0 Methods Metho

Back to overview OpenRPC Spec Signing API An OpenRPC specification for the Signing API which allows the Wallet Gateway to interact with a Wallet Providers. JSON-RPC Added 1.4.0 Latest source path api-specs/openrpc-signing-api.json Publish version 1.11.1 OpenRPC version 1.2.6 Spec info.vers

Backup and Restore This is the canonical guide for backing up and restoring Canton participant and synchronizer nodes (including database replication for disaster recovery). It is recommended that your database is frequently backed up so that the data can be restored in case of a disaster. In th

Canton node performance depends on database throughput, JVM configuration, sequencer capacity, and pruning strategy. This page covers the key tuning areas for validator and SV node operators. Database optimization PostgreSQL is the primary performance bottleneck in most Canton deployments. Con

Explain the difference between static and dynamic configuration. Move out specific configuration parts from here to their howto sections, such as multi-synchronizer below. Set Configuration Options Canton differentiates between static and dynamic configuration. Static configuration is immutable

Submit Externally Signed Transactions - Part 1 This tutorial demonstrates how to submit Daml commands to a Canton ledger using an external private key for transaction authorization. Before proceeding, it is recommended to review the external signing overview to understand the concept of external s

External Signing What you’ll learn In this set of tutorials, you will learn how to: • Use the Ledger API to onboard a party using an external key to sign transactions • Use the Ledger API to onboard a multi-hosted external party • Create a contract using external signing • Exercise a choice