Skip to content
CCPEDIAby Unity Nodes
LEARN · DOCUMENTATION

Documentation

Pages from 29 sources, kept in sync: the official Canton Network and Digital Asset docs, documentation from teams building on Canton, and readmes from their code. Search all of it, or start from a path below.

3,253pages
synced 4h ago29 sources
This week489pages updated upstreamNewestLogical Synchronizer UpgradesNov 6, 2026Official1,638pages from Canton and Digital Asset

Recently updated

1,638 pages
ShowingOfficial
OfficialCanton Network docs · Validator Deployment
Validator Network Resets
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 #validator-operations channel run by the Canton Foundation . A reset requires a full redeployment of your node and
Jun 10, 2026
OfficialCanton Network docs · Production Operations
Upgrade Canton Nodes
Upgrade To a New Release This section covers the processes to upgrade Canton participant nodes and synchronizers. Upgrading Daml applications is covered elsewhere. As elaborated in the versioning guide, new features, improvements and fixes are released regularly. To benefit from these changes, th
Jun 9, 2026
OfficialCanton Network docs · Module 4: Full-Stack Application Development
Query Contracts and Transactions with PQS
How to query contracts and transactions using SQL Query How to query contracts that are in Active Contract Set (ACS) To fetch contracts in the ACS use the active() table function 1 which is part of Participant Query Store’s (PQS) schema and can be used as any other PostgreSQL function.
Jun 8, 2026
OfficialCanton Network docs · Reference
Smart Contract Upgrading Reference
This document describes in detail what rules govern package validation upon upload and how contracts, choice arguments and choice results are upgraded or downgraded at runtime. These topics are for a large part covered in Smart Contract Upgrade. This document acts as a thorough reference. Static C
Jun 6, 2026
OfficialCanton Network docs · Overview
Installing a Compatible Daml SDK
You are not required to install the exact same Daml SDK versions used to build this Splice release. These versions are provided for reference only. .dar files built by older 3.x Daml SDKs are generally compatible with the Canton version used in this Splice release. For testing the interaction of
Jun 2, 2026
OfficialCanton Network docs · Validator Deployment
Custom Configuration
All the apps have an extended set of configuration options which might need tuning based on different scenarios. These configurations are accepted in the HOCON format. Adding ad-hoc configuration Every app accepts extra configuration through environment variables. All the environment variables p
May 28, 2026
OfficialCanton Network docs · PQS
PQS SQL
The PQS SQL API is provisioned directly in the PostgreSQL database. Data consumers interact with it through SQL — not through the PQS process itself. PQS data can be joined across contract tables to build projections (for example, joining holdings with account templates). The temporal offset model
May 26, 2026
OfficialCanton Network docs · Troubleshooting
Performance Issues
Performance degrades gradually, so it often goes unnoticed until transactions start timing out or the validator falls behind on event processing. This page covers the most common performance problems and their solutions. Slow Transactions If transaction latency has increased, check these areas i
May 25, 2026
OfficialCanton Network docs · Development Tools
Daml Profiler
The Daml Profiler allows you to to profile execution of your Daml code which can help spot bottlenecks and opportunities for optimization. Usage To test this out, we use the skeleton project included in the assistant. We first create the project and build the DAR. dpm new profile-tutorial -
May 22, 2026
OfficialCanton Network docs · Production Operations
Multi
Introduction In the Canton protocol, at the high level, there are three types of transactions that need to be signed: submissions, confirmations, and topology transactions. Submissions are a request to change on-ledger state, submitted by one or more parties. Confirmations are approvals by counter
May 22, 2026
OfficialCanton Network docs · Reference Projects
Splice Reference Apps
The Splice repository contains the reference applications that power the Global Synchronizer infrastructure. These applications handle validator operations, network scanning, wallet management, and super validator coordination. They serve as both production infrastructure and reference implementatio
May 21, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-wallet
Splice.Wallet.TransferPreapproval
Templates template TransferPreapprovalProposal Signatory: receiver Field | Type | Description | receiver | Party | provider | Party | expectedDso | Optional Party | The DSO party that the receiver expects to bet set on the transfer preapproval. Must be set. It is only optional due to being
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-wallet
Splice.Wallet.TransferOffer
Templates template AcceptedTransferOffer Signatory: sender, receiver Field | Type | Description | sender | Party | receiver | Party | dso | Party | amount | PaymentAmount | expiresAt | Time | trackingId | Text | • Choice AcceptedTransferOffer_Abort Controller: sender Returns: A
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-wallet-payments
Splice.Wallet.Payment
Templates template AcceptedAppPayment Signatory: sender, provider, map (\ r -> (DA.Internal.Record.getField @“receiver” r)) amuletReceiverAmounts Field | Type | Description | sender | Party | amuletReceiverAmounts | [ReceiverAmuletAmount] | provider | Party | dso | Party | lockedAmulet
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-validator-lifecycle
splice
• Splice.ValidatorOnboarding
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-wallet-payments
Splice.Wallet.Subscriptions
Templates template Subscription Main subscription object. Signatory: subscriptionSignatories subscriptionData Field | Type | Description | subscriptionData | SubscriptionData | reference | ContractId SubscriptionRequest | Reference to the subscription request, note that the contract will no
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-wallet-payments
splice
Deprecated (since splice-0.4.10): the modules below and their workflows are deprecated and should not be used in new applications. To implement a Canton Coin payment, use the Token Standard allocation workflow instead. Note that this immediately makes your application compatible with all Token Stand
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-wallet
splice
Note that these are internal modules to implement the Canton Coin specific wallet funcationality in the Splice Wallet served by a Validator Node. Avoid referencing these models in your own Daml code, as no guarantees are made about their stability and upgrade cadence. For implementing a wallet of y
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-wallet
Splice.Wallet.BuyTrafficRequest
Templates template BuyTrafficRequest A request by an end-user to the wallet’s automation to buy traffic for a sequencer member Signatory: endUserParty Field | Type | Description | dso | Party | endUserParty | Party | expiresAt | Time | Buy the traffic before this time. | trackingId | Tex
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-validator-lifecycle
Splice.ValidatorOnboarding
Templates template UsedSecret Template used by a sponsoring SV node for enforcing that an onboarding secret is used only once. Signatory: sv Field | Type | Description | sv | Party | The SV node that sponsored the onboarding. | secret | Text | An onboarding secret. | validator | Party | The
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-wallet
Splice.Wallet.MintingDelegation
Templates template MintingDelegation The right allowing the delegate to mint rewards on behalf of the beneficiary. Signatory: beneficiary, delegate Field | Type | Description | beneficiary | Party | The party on whose behalf minting is performed. | delegate | Party | The party authorized to
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-wallet
Splice.Wallet.TopUpState
Templates template ValidatorTopUpState The state of a given top-up loop. Records the last time when this validator purchased traffic for this sequencer member in order to: • allow for crash fault tolerant deduplication of traffic purchases • allow enforcing a rate limit to prevent the validat
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-wallet
Splice.Wallet.Install
Templates template WalletAppInstall Signatory: endUserParty, validatorParty Field | Type | Description | dsoParty | Party | validatorParty | Party | endUserName | Text | endUserParty | Party | • Choice Archive Controller: endUserParty, validatorParty Returns: () (no fields) • Cho
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-token-test-trading-app
Splice.Testing.Apps.TradingApp
An example of how to build an OTC trading app for multi-leg standard token trades. Used as part of the testing infrastructure to test the DvP workflows based on the token standard. Templates template OTCTrade Signatory: venue, tradingParties transferLegs Field | Type | Description | venue |
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-util-batched-markers
Splice.Util.FeaturedApp.BatchedMarkersProxy
This module provides a BatchedMarkersProxy that can be used to create multiple markers in one view. Templates template BatchedMarkersProxy Signatory: provider Field | Type | Description | provider | Party | dso | Party | • Choice Archive Controller: provider Returns: () (no fields)
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-util-featured-app-proxies
Splice.Util.FeaturedApp.WalletUserProxy
Utility template for proxying token standard choices so that featured app markers are created for a wallet app provider by their users when they are using token standard workflows. You can either use this template directly, or copy the code under a different package name and a different module name
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-util-token-standard-wallet
splice
Optional package implementing common workflows of wallets using the Token Standard. Not uploaded by default to a validator node. • Splice.Util.Token.Wallet.MergeDelegation See also the module-splice-util-featuredapp-walletuserproxy-40223 for code that simplifies integrating wallets with feature
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-util-batched-markers
splice
This package provides the BatchedMarkersProxy contract which can be used to create a batch of FeaturedAppActivityMarkers in a transaction with a single view which is more efficient to process. To use it first create one long-lived BatchedMarkersProxy contract and then use BatchedMarkersProxy_
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-util-featured-app-proxies
Splice.Util.FeaturedApp.DelegateProxy
Utility template for proxying token standard choices so that featured app markers are created when using extra parties for operating an app. You can either use this template directly, or copy the code under a different package name and a different module name . Note: use the WalletUserProxy if y
May 18, 2026
OfficialCanton Network docs · Splice APIs › Splice Daml Packages › splice-util-featured-app-proxies
splice
Optional package simplifying the integration of featured apps with the token standard. Not uploaded by default to a validator node. • Splice.Util.FeaturedApp.DelegateProxy • Splice.Util.FeaturedApp.WalletUserProxy
May 18, 2026
Showing 1,441 to 1,470 of 1,638Search all sources →