Documentation

Back to overview Protobuf Package com.digitalasset.canton.admin 0 services, 0 endpoints, 0 messages gRPC Added 3.7.0 Updated 3.5.1 Methods removed in 3.5.1 Files 1 Services 0 Endpoints 0 Messages 0 Enums 0 Source Files community/admin-api/src/main/protobuf/com/digitalasset/canton/admi

Back to overview Protobuf Package com.digitalasset.canton.admin.topology.v30 0 services, 0 endpoints, 1 messages gRPC Files 1 Services 0 Endpoints 0 Messages 1 Enums 0 Source Files community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/topology/v30/common.proto Last avai

Back to overview Protobuf Package com.digitalasset.canton.crypto.admin.v30 1 services, 12 endpoints, 34 messages gRPC Files 1 Services 1 Endpoints 12 Messages 34 Enums 0 Source Files community/base/src/main/protobuf/com/digitalasset/canton/crypto/admin/v30/vault_service.proto Last av

Back to overview Protobuf Package com.digitalasset.canton.time.admin.v30 1 services, 2 endpoints, 4 messages gRPC Files 1 Services 1 Endpoints 2 Messages 4 Enums 0 Source Files community/base/src/main/protobuf/com/digitalasset/canton/time/admin/v30/synchronizer_time_service.proto Las

Back to overview Protobuf Package com.digitalasset.canton.topology.admin 0 services, 0 endpoints, 0 messages gRPC Added 3.7.0 Methods removed in 3.5.1 Files 1 Services 0 Endpoints 0 Messages 0 Enums 0 Source Files community/admin-api/src/main/protobuf/com/digitalasset/canton/topology/

Protobuf Reference Ledger API protobuf Operation-first gRPC pages with package-level browsing and recursive related schema sections. gRPC Added 3.7.0 Methods removed in 3.7.0 Source Canton protobuf trees from published release bundles Version filter stable Canton release bundles >= 3.2.0 Late

Back to overview Protobuf Package com.daml.ledger.api.v2.interactive.transaction.v1 0 services, 0 endpoints, 7 messages gRPC Files 1 Services 0 Endpoints 0 Messages 7 Enums 0 Source Files community/ledger-api-proto/src/main/protobuf/com/daml/ledger/api/v2/interactive/transaction/v1/in

Back to overview Protobuf Package com.daml.ledger.api.v2.testing 1 services, 2 endpoints, 3 messages gRPC Files 1 Services 1 Endpoints 2 Messages 3 Enums 0 Source Files community/ledger-api-proto/src/main/protobuf/com/daml/ledger/api/v2/testing/time_service.proto Last available sourc

Back to overview Protobuf Package com.digitalasset.canton.tea.v1 1 services, 4 endpoints, 8 messages gRPC Added 3.7.0 Files 1 Services 1 Endpoints 4 Messages 8 Enums 0 Source Files community/traffic-enforcement/api/protobuf/com/digitalasset/canton/tea/v1/traffic_service.proto Last av

Back to overview Protobuf Package v2 10 services, 27 endpoints, 128 messages, 8 enums gRPC Added 3.7.0 Methods removed in 3.7.0 Files 24 Services 10 Endpoints 27 Messages 128 Enums 8 Source Files value.proto Last available source file in the compared descriptor snapshots. Services 0

Back to overview Protobuf Package v2.admin 7 services, 31 endpoints, 88 messages, 4 enums gRPC Added 3.6.1 Files 8 Services 7 Endpoints 31 Messages 88 Enums 4 Source Files command_inspection_service.proto Last available source file in the compared descriptor snapshots. Services 1 M

Back to overview Protobuf Package v2.interactive 1 services, 6 endpoints, 27 messages, 1 enums gRPC Methods removed in 3.7.0 Files 2 Services 1 Endpoints 6 Messages 27 Enums 1 Source Files interactive_submission_common_data.proto Last available source file in the compared descriptor

Back to overview Protobuf Package com.digitalasset.canton.tea.v1 1 services, 4 endpoints, 8 messages gRPC Added 3.7.0 Files 1 Services 1 Endpoints 4 Messages 8 Enums 0 Source Files traffic_service.proto Last available source file in the compared descriptor snapshots. Services 1 Mes

Back to overview Protobuf Package v2.interactive.transaction.v1 0 services, 0 endpoints, 7 messages gRPC Files 1 Services 0 Endpoints 0 Messages 7 Enums 0 Source Files interactive_submission_data.proto Last available source file in the compared descriptor snapshots. Services 0 Mess

Back to overview Protobuf Package v2.testing 1 services, 2 endpoints, 3 messages gRPC Files 1 Services 1 Endpoints 2 Messages 3 Enums 0 Source Files time_service.proto Last available source file in the compared descriptor snapshots. Services 1 Messages 3 Enums 0 Source community/

gRPC API Ledger API gRPC Operation-first gRPC pages with package-level browsing and recursive related schema sections. gRPC Added 3.7.0 Methods removed in 3.7.0 Source Canton Ledger API protobuf release bundles Version filter stable Canton release bundles >= 3.4.4 Latest release v3.7.2 Packa

There are three ways to recover from disasters: • In simple cases where only a single node is affected but the overall network is still healthy, a Restore from backup is usually sufficient. • If a full backup is unavailable but an identities backup has been created, the balance of the SV can be re

Introduction Distributed tracing is a technique used for troubleshooting performance issues in a microservices environment like Canton. Tracing in Canton has been described in a page dedicated to monitoring ( Tracing ). This guide describes how to write Ledger API client applications so that distr

Release of Canton 3.7.0 Canton 3.7.0 has been released on October 29, 2026. Summary This minor release introduces protocol version 37 as a new protocol version. Synchronizers on protocol version 36 are not affected. The main themes: • Multi-synchronizer support with no feature flag required,

Release of Canton 3.7.1 Canton 3.7.1 has been released on October 30, 2026. Summary This patch release introduces configuration options for GCP KMS key deletion notice periods. What’s New Minor Improvements • GCP KMS key deletion notice periods can now be configured via destroyScheduledD

The Validator App exposing the validator APIs is part of a CN Validator or CN Supervalidator node. It connects to a Canton participant and provides the following functionality: • It manages the Canton participant. Examples are automatically setting up the participant’s connection to Canton Net

Contrary to other assets like Eth or Bitcoin, Canton Coin requires a party to explicitly agree to hold Canton Coin. This includes explicitly agreeing to any incoming transfers. Parties that are ok with accepting incoming Canton Coin transfers from any sender, can setup a TransferPreapproval. This

Overview • See the text of the CIP-0056 for an overview of the APIs that are part of the Canton Network Token Standard V1. • See the text of the CIP-0112 for an overview of the APIs that are part of the Canton Network Token Standard V2. • See the README in its source-code for background on how to

This section describes deploying a Super Validator (SV) node in kubernetes using Helm charts. The Helm charts deploy a complete node and connect it to a target cluster. Requirements • DevNet (0.9.4) • TestNet (0.9.4) • MainNet (0.9.3) • A running Kubernetes cluster in which you have administ

This section describes how to deploy a standalone validator node in Kubernetes using Helm charts. The Helm charts deploy a validator node along with associated wallet and CNS UIs, and connect it to a global synchronizer. Requirements • DevNet (0.9.4) • TestNet (0.9.4) • MainNet (0.9.3) • A r

Networks There are three different networks: DevNet, TestNet and MainNet. If you are only interested in setting up a validator node, you can set up a node on DevNet for practice, then jump to MainNet. If you’d like to build, test, or deploy an app, we recommend that you run a node on DevNet, TestN

• DevNet (0.9.4) • TestNet (0.9.4) • MainNet (0.9.3) DevNet and TestNet get reset roughly every 3 months with the resets spread out such that they never happen at the same time on DevNet and TestNet. The exact time is announced in the #supervalidator-operations channel run by the Global Synchr

• DevNet (0.9.4) • TestNet (0.9.4) • MainNet (0.9.3) To initialize your validator node, you need the following parameters that define the network you’re onboarding to and the secret required for doing so. • MIGRATION_ID — The current migration id of the network (dev/test/mainnet) you are trying

There are three ways to recover from disasters: • In simple cases where only a single node is affected but the overall network is still healthy, a Restore from backup is usually sufficient. • If a full backup is unavailable but an identities backup has been created, the balance of the validator ca

For more involved debugging and disaster recovery, direct access to the console of a Canton node (participant, sequencer, mediator) might be required. Steps to obtain such access: Requirements: • Direct access to the Canton node process • Canton binary Once you see the following banner for the