Documentation

0.5.0 Released on September 11th, 2025 • Memo field added to create transfer const [transferCommand, disclosedContracts2] = await sdk.tokenStandard!.createTransfer( sender!.partyId, receiver!.partyId, '100', { instrumentId: 'Amulet',

1.6.0 — 2026-07-08 🚀 Features • add service account auth UI, fix existing issues in networks ( #2077 ) • service account support ( #1952 ) 🩹 Fixes • add SSE to python automation example ( #2090 ) 🧱 Updated Dependencies • Updated @canton-network/core-wallet-dapp-rpc-client to 1.8.0 • Up

0.10.0 Released on October 2nd, 2025 • Self-issue feature app rights you can now grant yourself feature app rights (similar to the wallet UI) for both internal and external parties // For external parties const [command,disclosedContracts] = sdk.tokenStandard!.selfGrantFeatureAppRights()

1.5.0 — 2026-06-29 🚀 Features • support service account auth config for ledger API access ( #2045 ) • accept ApiKey authorization headers ( #2044 ) • support API key mgmt in frontend ( #2039 ) • add backend support for API keys ( #2013 ) 🩹 Fixes • vaults select for fireblocks ( #2059 ) •

0.11.0 Released on October 10th, 2025 • Added support to tap internal parties previously you could only tap external parties using signing flow, now it can be done for internal parties. this is useful for tapping the validator operator party right after startup in case of missing funds. aw

0.13.0 Released on October 22th, 2025 Release 0.13.0 & 0.13.1 have broken dependencies, use 0.14.0 instead. • Important!: await completion has changed signature // old version async waitForCompletion( ledgerEnd: number | Types['GetLedgerEndResponse'], timeoutMs: numb

0.15.0 Released on October 29th, 2025 Due to CommonJS compatibility, the module type needs to be explicitly declared in certain cases. If you see an error like ERROR: Top-level await is currently not supported with the "cjs" output format and are intended on using ESM then you should set "type

0.12.0 Released on October 15th, 2025 • Important!: The custom meta-data on create transfer have changed format //previous format await sdk.tokenStandard!.createTransfer( sender!.partyId, receiver!.partyId, '100', { instrumentId: 'Amulet',

0.14.0 Released on October 23th, 2025 • Fixed broken dependency problem introduced in 0.13.X

0.13.1 Released on October 22th, 2025 Release 0.13.0 & 0.13.1 have broken dependencies, use 0.14.0 instead. • Greatly reduced the size of the SDK from ~ 80 MB to ~ 35 MB • introduced optional limit field for listHoldingsUtxo

1.4.0 — 2026-05-28 🚀 Features • hide auth details from listNetwork and mint self-signed token server-side ( #1872 ) • signMessage end-to-end and Sign-In-With-Canton over WalletConnect ( #1718 ) 🩹 Fixes • wg fe tests ( #1900 ) • rename JsCommands to Commands ( #1833 ) • fix package.json wi

Canton provides a set of tools and APIs for building applications against the ledger. This page covers what each component does and when to use it. Daml SDK The Daml SDK bundles the compiler, code generators, sandbox, and supporting tools you need to develop Canton applications. The main entry p

The Ledger API is the primary programmatic interface to a Canton participant node. Applications use it to submit commands (create contracts, exercise choices), read the transaction stream, and manage parties and packages. The Ledger API is exposed in two protocol bindings — gRPC and JSON over HTTP

Canton’s architecture differs fundamentally from traditional blockchains. Understanding these components is essential for designing and debugging Canton applications. The Big Picture Canton separates coordination from storage . Synchronizers coordinate transaction ordering; participant nodes (va

Release of Canton 3.5.7 Canton 3.5.7 has been released on July 01, 2026. Summary This release provides a new Ledger API endpoint to obtain command completions and fixes a number of minor issues. What’s New New GetCompletions endpoint on the command completion service Background The c

The Java bindings produce type-safe classes from your compiled Daml packages. These classes let you create contracts, exercise choices, and process ledger events in Java without manually constructing gRPC messages or JSON payloads. Code Generation Generate Java bindings from a compiled DAR file:

Daml Script is the primary testing tool for Daml contracts. You write test scenarios as Script () values in Daml source files, then run them with dpm test. Scripts execute on a fresh, empty ledger and can allocate parties, submit commands, query state, and assert expected outcomes. For the comp

Release of Canton 3.5.5 Canton 3.5.5 has been released on June 17, 2026. Summary This is a maintenance release that fixes an exceptional but severe bug around logical synchronizer upgrades and brings a few improvements. What’s New Dependencies of vetted packages can be unvetted (PV35+) O

Release of Canton 3.5.2 Canton 3.5.2 has been released on June 03, 2026. Summary This is a maintenance release that fixes an out of memory issue during synchronizer reconnect, addresses security vulnerabilities in the Canton docker base image, as well as minor improvements. Minor Improvement

Release of Canton 3.5.3 Canton 3.5.3 has been released on June 03, 2026. Summary This is a maintenance release that fixes an issue around mediator restart and LSU. Bugfixes Mediator cannot reconnect to sequencer after processing LSU sequencing test message During LSU, after processing a

Release of Canton 3.5.4 Canton 3.5.4 has been released on June 10, 2026. Summary This is a maintenance release that fixes a bug around modify synchronizers and brings a few improvements. What’s New Minor Improvements • Config flag canton.participants.participant.parameter.alpha-multi-syn

Release of Canton 3.5.1 Canton 3.5.1 has been released on May 27, 2026. What’s New Contract Keys Overview Canton 3.5 introduces contract keys. Compared to a similar feature available in Canton 2.x, there are two notable differences: • The keys are not unique, meaning multiple contracts may sha

Release of Canton 3.5.6 Canton 3.5.6 has been released on June 24, 2026. Summary This is a maintenance release that fixes an exceptional severe bug around logical synchronizer upgrades and brings a few improvements. What’s New Minor Improvements • Connection pool metrics: • Add a psid

Participants form the core part of Canton’s distributed ledger architecture. A Participant provides a party-specific view of the distributed ledger, processes its Daml logic, and participates in the Canton protocol with other participants via the synchronizer. In essence, a Canton Participant is the

The Active Contracts Head Snapshot (ACHS) is an optional feature that maintains a continuously updated snapshot of the currently active contracts. When enabled, the ACHS accelerates GetActiveContracts (ACS) queries by allowing them to read directly from a pre-computed snapshot rather than scanning

The backend is the layer between your frontend and the Canton ledger. It submits commands, reads transactions, and queries contract state. This page uses cn-quickstart as a running example. cn-quickstart is a full-stack reference application that implements a software licensing workflow on Canton N

Daml Codegen for JavaScript Use the Daml Codegen for JavaScript (dpm codegen-js) to generate JavaScript/TypeScript code representing all Daml data types defined in a Daml Archive (.dar) file. The generated code makes it easier to construct types and work with JSON when using the JSON Ledger API

The Daml Compiler At the core of the Daml toolchain lies the Daml Compiler, also known as damlc. Its primary usage is to compile Daml source code, which defines smart contracts and their behaviours, into a lower-level language called Daml-LF, which Canton participants can evaluate in order to ru

Canton application development spans four environments, each serving a different stage of the development and deployment lifecycle. Your application moves through them sequentially: LocalNet for development, DevNet for early integration, TestNet for pre-production validation, and MainNet for product

The interaction of a Daml application with the ledger is inherently asynchronous: applications send commands to the ledger, and some time later they see the effect of that command on the ledger. Many things can fail during this time window: • The application can crash. • The participant node can c