Documentation

Topology management All Participant Nodes and Synchronizer components must know the topology state of a Synchronizer, which includes all identities on the Synchronizer and their associated keys. The two-phase commit protocol on a Synchronizer can therefore assume that identities and keys are commo

Third-party Daml apps As an SV operator, you are most welcome to review, install, and use third-party Daml apps provided you install third-party Daml apps on a validator node separate from your SV node . Installing additional Daml apps on an SV node is not supported and may compromise its secure o

Run and prune To run PQS you need the following: • PostgreSQL database server • Daml Sandbox or Canton Participant Node as the source of ledger data • Any access tokens or TLS certificates required by the above • PQS’ pqs.jar or Docker image Running PQS PQS application mostly runs as

The splice-topology-key-monitor Helm chart deploys a small service that watches the topology state of a participant and logs a warning whenever a topology transaction or proposal signed by one of a configured set of keys appears. Use it to get alerted when one such key is used. The chart is avai

In Daml, you must specify who can view data using stakeholder annotations in your template definitions. To change who can see the data, you would typically need to recreate a contract with a template that computes different stakeholder parties. Explicit contract disclosure allows you to delegate co

Structure This section looks at the structure of a ledger that records the interactions between the parties as ledger changes. The definitions presented here address the first question: “What do changes and ledgers look like?”. The basic building blocks of the recorded interactions are actions, wh

This page covers advanced console operations: topology management, key rotation, and repair procedures. These operations go beyond day-to-day administration and typically require a deeper understanding of Canton’s internal state. Topology management Canton uses a topology state to track the mapp

While all components in the system are designed to be crash-fault-tolerant, there is always a chance of failures from which the system cannot immediately recover, e.g. due to misconfiguration or bugs. In such cases, you will need to restore a component or a full validator node from backups or from d

Backup of Node Identities Once your SV node is up and onboarded, please make sure to backup the node identities of your SV node. Note that this information is highly sensitive, and contains the private keys of your participant, sequencer and mediator, so make sure to store it in a secure location,

Transaction failures on the Global Synchronizer produce specific error codes that point to the root cause. This page covers the three most common categories: authorization errors, package vetting issues, and timeouts. Authorization Errors Authorization failures appear when a party attempts an ac

Repair procedures Choose one of the following repair procedures based on the type of participant node fault in need of repair. Repairing participant nodes is dangerous and complex. Therefore, you are discouraged from attempting to repair participant nodes on your own unless you have expert knowl

Smart Contract Upgrade Overview What is Smart Contract Upgrade (SCU)? Smart Contract Upgrade (SCU) allows Daml models (packages in DAR files) to be updated on Canton transparently, provided some guidelines in making the changes are followed. For example, you can fix an application bug by uploa

Canton Improvement Proposals (CIPs) are the governance mechanism for the Global Synchronizer. A CIP is discussed on the cip-discuss mailing list, voted on by the Super Validator node operators, and announced on cip-announce once approved. The canonical text of every CIP lives in the canton-foundatio

This page is a reference for configuring, bootstrapping, and operating synchronizer nodes. Setup order • Configure — Write Canton configs for sequencer/mediator APIs, sequencer backend, and TLS (sections below). • Start — Start the synchronizer nodes with those configs. • Bootstrap — Initialize

Metrics The following sections contain the common metrics exposed for Daml services supporting a Prometheus metrics reporter. For the metric types referenced below, see the relevant Prometheus documentation . Participant Metrics daml.cache.evicted_weight • Summary : The sum of weights of cac

When developing Daml applications using SDK tools, your local setup will most likely not perform any Ledger API request authorization —by default, any valid Ledger API request will be accepted by the sandbox. This is not the case for participant nodes of deployed ledgers. For every Ledger API reque

High-level Overview Canton Network is a public layer 1 blockchain network with privacy. It is designed for financial institutions and DeFi alike to facilitate secure, interoperable, and privacy-preserving transactions and drive the confluence of TradFi and DeFi. Key Features: • It uniquely balan

End users work with the Wallet Gateway through its User UI : a web app the Wallet Gateway serves at its root URL. From it they log in, create and manage parties, review transactions, and approve requests from dApps. This guide covers logging in and managing parties in the UI. To drive the same opera

A Wallet Gateway connects users to one or more networks . Each network points at a Canton validator’s Ledger API and references an identity provider (IDP) that issues the JWT used to authenticate against that validator. This guide covers both, plus the authentication methods a network can use. Netw

Service account automation lets a backend job, CI pipeline, or other service submit ledger transactions through the Wallet Gateway without a person in the loop. It uses the same dApp API as interactive dApps (prepareExecute, txChanged events), but the request is authenticated with a user-generat

The dApp API is the CIP-0103 JSON-RPC 2.0 API that dApps call to connect to a wallet, list accounts, and prepare and execute transactions. The Wallet Gateway exposes it, but you almost never call it directly. • Base path : /api/v0/dapp (configurable via server.dappPath) • Protocol : JSON-RPC 2

Self issued access token is a way to authenticate to a canton ledger without an external Identity Provider, by signing access token with party private key. Ledger will accept access token signed by party if following requirements are fulfilled: • Ledger User has property primary_party_authenticati

Common issues you may hit when running the Wallet Gateway, with fixes. Database connection errors The Wallet Gateway fails to start with database connection errors. • PostgreSQL : verify the database exists (psql -U postgres -l), check credentials in your config, ensure PostgreSQL is running

The Wallet Gateway does not have to hold private keys. Signing is delegated to a signing provider chosen per wallet, so you decide where each wallet’s keys live and who performs the cryptographic signing. Different wallets in the same Wallet Gateway can use different providers, and you select the pr

For anything beyond local development, run the Wallet Gateway as a container. It ships in both Docker and Helm variants, and the images and charts are public on the GitHub Container Registry, so no access request is required. • Docker registry : ghcr.io/digital-asset/wallet-gateway/docker/wallet-

This reference complements the task-oriented guides with the details you need for production: the store backends in full, backup and recovery, signing store security, and how to handle secrets across environments. For the config file’s overall shape, see Configure the Wallet Gateway . For networks

The Wallet Gateway reads a single JSON configuration file that defines who the Wallet Gateway is, how it serves requests, where it persists data, and which networks and identity providers it starts with. This guide covers the file’s structure and the kernel, server, store, and hashing scheme section

Overview Circle and Digital Asset have partnered to develop and implement a USDC token on Canton Network. This implementation requires users to send USDC on L1 chains (starting with Ethereum) to Circle’s xReserve contract which is then created as a USDC token on Canton Network. Conversely a withdr

Once a wallet is connected, your dApp can read the user’s Canton parties, sign messages, submit transactions, and query the ledger through the authenticated session. All examples use the high-level SDK. For the equivalent low-level calls, see the Provider API . List the user’s parties A user m

This is the shortest working integration: install the SDK, initialize it, let the user connect a wallet, read their party, and submit a transaction. It uses only the high-level SDK. You do not need the Provider API to build a dApp. 1 Install the SDK • npm • yarn • pnpm npm install @canto