Documentation

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

Causality Daml ledgers do not totally order all transactions. So different parties may observe two transactions on different Participant Nodes in different orders via the gRPC Ledger API. Moreover, different Participant Nodes may output two transactions for the same party in different orders. This

Daml Shell Daml Shell is a component that enables you to interactively query ledger data made available in the Participant Query Store (PQS) PostgreSQL database. Overview Daml Shell provides an interactive terminal session to examine the current and historical state of the ledger by querying

Work through this checklist before running a Wallet Gateway in production. Each item links to the relevant configuration. Authentication and identity • Use OAuth / OpenID Connect IDPs. Reserve self-signed tokens for development. See Networks & identity providers . • Use client_credentials for

Use this table to look up the v1 equivalent of a v0 controller method. For context and before/after examples, see the migration overview and the namespace pages. Migration reference table v0 controller + method | v1 namespace + method | createKeyPair() | sdk.keys.generate() | sdk.userLedg

Release of Canton 3.5.10 Canton 3.5.10 has been released on July 23, 2026. Summary This is a maintenance release that brings UX and hardening improvements. What’s New Minor Improvements • Fixed an edge case that could cause deserialization of proto durations to fail • Fixed an issue wher

Configure a Featured Party Under CIP-104 , app rewards are attributed to featured parties based on the network traffic generated by application workflows. For Registry transactions, such as mints, transfers, burns, and other asset lifecycle operations, rewards are earned by the featured party ass

Registry App versions are numbered using an X.Y format. X represents the major version, and Y represents the minor version. Each minor release adopts a new set of Daml models. These are compatible upgrades of the models released in the previous minor release. The major version is incremented

0.4.0 Released on September 10th, 2025 • Range filter for listHoldingTransactions(afterOffset?: string,beforeOffset?: string) • Transfer pre-approval support: const sdk = new WalletSDKImpl().configure({ logger, authFactory: localNetAuthDefault, ledgerFactory: localNetLedgerDef

To enable deposits to be sent to specific user accounts at exchanges, an account identifier needs to be sent to the exchange along with the transfer information. In Canton, this is implemented with the “memo tag” pattern . Exchanges — using memo tags to receive and allocate funds Memos are store

When integrating with the Canton Network, we recommend that wallet providers support the necessary features outlined below to optimal user experience. Additionally, there are optional features that can further enhance the integration and provide additional value to users. Necessary Features The

Welcome to the DA Registry FAQ. If you cannot find the answer you are looking for here, please reach out to your Digital Asset support representative . General & Platform Who can use the DA Registry? The DA Registry is designed for organizations that want to operate a tokenization platform. Th

The dApp SDK is a TypeScript library for connecting web applications to wallets on Canton Network. It lets your frontend discover wallets, authenticate the user, read their parties, request signatures, and submit transactions. Use the SDK to: • Discover available wallets : browser extensions, remo