Documentation

When transactions fail, nodes disconnect, or the system behaves unexpectedly, the Canton Console provides the tools to diagnose the problem. This page walks through common debugging scenarios with concrete console commands. Debugging Stuck Transactions A transaction appears “stuck” when a comman

When a transaction fails, a contract goes missing, or your application behaves unexpectedly, Canton provides several tools to investigate. This page covers the debugging tools available and common workflows for diagnosing issues. dpm test Output dpm test runs your Daml Script tests and reports

Answers to questions that come up regularly in Canton Network application development. For validator operations questions, see the Common Issues FAQ . Getting Started What SDK version should I use? Use the latest stable Daml SDK (3.x series). The 2.x Daml SDK is for historical development and

This reference covers the most commonly used Canton Console commands, organized by task. All examples assume you’re connected to a participant console unless otherwise noted. When the Canton Console starts, it reads the configuration file and automatically binds a variable for each configured node.

Manage Daml packages and archives About A package is a unit of compiled Daml code corresponding to one Daml project. This package contains compiled Daml-LF code. Every package has a unique package-id. A Daml Archive (DAR) file consists of a main package along with all other packages on which t

Check and monitor Sequencer Node health This page describes how to inspect and understand the current status of a Sequencer Node, and how to continuously monitor it using health checks. See also the generic guide on How to check the status of a Node and monitor its health. Interactively check N

TLS API Configuration Both the gRPC Ledger API and the Admin API support the same TLS capabilities and can be configured using identical directives. TLS provides end-to-end channel encryption between the server and the client, and—depending on the configuration—can enforce either server-only or mu

Canton Console Canton offers a console (REPL) where entities can be dynamically started and stopped, and a variety of administrative or debugging commands can be run. All console commands must be valid Scala (the console is built on Ammonite - a Scala-based scripting and REPL framework). Note tha

API Configuration Participant nodes expose the Admin API, the gRPC Ledger API, and optionally the JSON Ledger API. This page explains how to configure general options that apply to both the Admin API and the gRPC Ledger API. For the configuration options that apply only to specific APIs, please r

The Canton Console is an interactive Scala REPL that connects to Canton nodes for administration, debugging, and automation. It provides direct access to participant, sequencer, and mediator operations through a typed API. For full operational documentation, see the Global Synchronizer section , wh

1.8.0 — 2026-08-10 🚀 Features • add securosys signing driver ( #2123 ) 🩹 Fixes • hide privileged auth credentials for non-admins ( #2257 ) • 1874 network connectivity UI ( #2211 ) 🧱 Updated Dependencies • Updated @canton-network/core-wallet-dapp-rpc-client to 1.10.0 • Updated @canton-n

Super Validators Where do I find all whitelisted node operators? All whitelisted SVs are listed in the public global synchronizer configurations repository . Where do I generate a Validator Onboarding Token? SVs generate a validator onboarding token in the SV UI. Validators How long is my V

1.7.0 — 2026-08-06 🚀 Features • add Dapp API URL copy action in Wallet Gateway header ( #2240 ) • add multi-session support ( #2161 ) 🩹 Fixes • wallet-gateway-remote: allow login without ledger ( #2198 ) • encryption key for access token ( #2193 ) • add pagination to list tx ( #2166 ) •

Runbooks provide a structured response to known incident types. Each runbook follows the same phases: detect, assess, act, verify, and document. Incident Response Template Use this template for any incident that does not have a dedicated runbook. • Detect — Identify the symptom. How was the iss

This section provides the full technical specification of the Canton protocol. Where the Learn pages introduce concepts at a high level, these reference pages describe the protocol mechanics in detail — the data structures, trust assumptions, message flows, and formal properties that underpin Canton

A Canton transaction passes through five distinct phases before it commits (or is rejected). Each phase involves specific node roles — participant nodes, sequencer nodes, and mediator nodes — communicating through encrypted, sequenced messages. No single node ever sees the full transaction in the cl

The User API is the JSON-RPC 2.0 API behind the User UI. Anything a person can do in the UI — manage sessions, networks, identity providers, wallets, and transactions — you can do programmatically with the same API. Use it to script wallet setup, build a custom wallet UI embedded in your app, or aut

This is the shortest path to a running Wallet Gateway: install it, generate a configuration file, start it against a Canton network, and confirm its three endpoints respond. It targets a local setup you can adapt to your own validator. You need Node.js (tested with v24) and access to a Canton netw

The User API is a JSON-RPC 2.0 API for managing a user’s wallets, networks, identity providers, sessions, and transactions. The User UI is built on it, and you can call it directly from scripts, a backend, or a custom UI. • Base path : /api/v0/user (configurable via server.userPath) • Protocol

When a dApp wants to act on your behalf, it does not sign anything itself. It asks the Wallet Gateway to run a transaction, and the Wallet Gateway routes it to you for approval and to your signing provider for signing. This keeps approval and key custody under your control: private keys never reach

This section is about cryptographic keys in Canton. As a preliminary, it outlines general options for storing secrets in Canton. Then, it gives an overview of the various kinds of cryptographic keys and how Canton uses and stores them. Storage of secrets This section outlines the general options

The Sandbox is a single-participant Canton node that runs locally on your machine. Start it with dpm sandbox for quick development cycles without the overhead of Docker or a full network. Starting the Sandbox dpm sandbox This starts a Canton participant node with an in-memory ledger.

Use the docs below when interacting with the on-ledger state of the decentralized applications that are part of Splice. • splice-amulet-name-service — Canton Name Service (CNS) for human-readable party names. • splice-dso-governance — Decentralized Synchronizer Operator governance contracts. • sp

How To Implement Time Constraints Contract time constraints may be implemented using either: • ledger time primitives (i.e. isLedgerTimeLT, isLedgerTimeLE, isLedgerTimeGT and isLedgerTimeGE) or assertions (i.e. assertWithinDeadline and assertDeadlineExceeded) • the use of ledger tim

In data and functional-101 you learned how to define your own data types and functions. However, you don’t have to implement everything from scratch. Daml comes with the Daml standard library, which contains types, functions, and typeclasses that cover a large range of use cases. In this chapte

Ledger API overview What is the Ledger API The Ledger API is an API that’s exposed by any Participant Node. Users access and manipulate the ledger state through the Ledger API. There are two protocols available for the Ledger API: gRPC and JSON. The core services are implemented using gRPC and P

Overview: Template Structure This page covers what a template looks like: what parts of a template there are, and where they go. For the structure of a Daml file outside a template, see file-structure. Template Outline Structure Here’s the structure of a Daml template: template NameOfT

Canton KMS Driver developer guide Introduction This tutorial describes how to develop a Key Management System (KMS) Driver that allows Canton to perform cryptographic operations using an external KMS or Hardware Security Module (HSM). First the KMS Driver APIs are explained, followed by a guide

Key management service (KMS) configuration By default Canton keys are generated in the node and stored in the node’s primary storage. We currently support a version of Canton that can use a KMS to either: (a) protect Canton’s private keys at rest or (b) protect the private keys both at rest and at

In each round, each live validator records its liveness activity with a ValidatorLivenessActivityRecord . CIP-0096 discontinued validator liveness rewards, phasing the per-validator liveness reward cap down to $0 effective 2026-04-30. Validators now earn CC only through activity rewards — see Canto