Documentation

Daml Studio is the Visual Studio Code extension for Daml development. It provides real-time feedback as you write Daml code, including type errors, syntax highlighting, and integrated test visualization. Installation Via dpm The extension is installed automatically when you set up the Daml SDK

The Admin API provides administrative access to Canton participant, sequencer, and mediator nodes. It is used for node configuration, topology management, key management, and operational tasks that are not exposed through the Ledger API. Never expose the Admin API to the public internet. Restrict

Canton provides a set of SDKs, CLI tools, and development environments for building, testing, and deploying applications. This page maps out what each component does and how they relate to each other. Tool Landscape SDKs The Daml SDK is the primary development kit. It includes the Daml compile

This documentation serves multiple audiences building on or operating Canton Network. Find your path below. By Role Application Developers Build applications on Canton Network using Daml smart contracts and the Ledger API. Start here if you want to: • Write smart contracts in Daml • Build fron

Overview CIP-0104 introduces traffic-based app rewards, replacing the on-ledger Splice.Amulet.FeaturedAppActivityMarker mechanism with an off-ledger reward computation based on actual network traffic. This provides more accurate and scalable reward accounting for featured app providers. Why Tr

These sections give an overview of some of the functionalities enabled through your SV node as well as general information useful to SV node operators. 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 validato

Alongside ephemeral status such as open rounds in the scan_current_state_api , there are more fixed data records for aspects of a Splice network. DSO party ID The DSO party ID is unique to every Splice network, and is a signatory or observer of most core Splice Daml templates. Therefore, you nee

Alongside information about the overall Splice network operations , Scan provides some more specific details about current Amulet-related network state. Validator Traffic Credits and Purchases Sequencing messages on the global synchronizer, which is an integral part of the Canton commit protocol

Scan provides endpoints to query about the ongoing operations of the Global Synchronizer, based on information recorded on-ledger. Validator Liveness Rather than Listing_all_Validators , which can yield a large number of irrelevant records, /v0/validators/validator-faucets?validator_ids=… yields

The Scan APIs consist of the following APIs: • scan_bulk_data_api : A comprehensive API that provides access to the exact and full history of updates and ACS snapshots as recorded on the SV participant node. • scan_global_synchronizer_connectivity_api • scan_global_synchronizer_operations_api •

Scan provides a couple shortcuts for using the scan_bulk_data_api to look up Amulet and Amulet Name Service records. Amulet Summaries While it’s possible to figure total Amulet balance from the scan_bulk_data_api , figuring the effect of holding fees can be tricky for a new Splice app unfamiliar

Canton Improvement Proposals (CIPs) are the formal mechanism for proposing changes, standards, and improvements to Canton Network. What are CIPs? CIPs are design documents providing information to the Canton community, describing new features, processes, or standards for Canton Network. CIP Typ

Canton uses an extended UTXO (eUTXO) ledger model where contracts are discrete objects that are created and archived, rather than mutable account balances. This model is fundamental to how Canton achieves privacy and composability. Contracts as UTXOs In Canton, the ledger is a collection of acti

This page describes common patterns for integrating Canton Network building blocks into applications. These patterns help you design effective integrations while respecting Canton’s privacy model. Pattern Overview Wallet Integration Pattern Use Case Add Canton Coin management to your applica

ACS Active Contract Set Active Contract Set The set of contracts that are currently active on the ledger as per the view of a given participant. Amulet The generic name for the code and the logic implementing Canton Coin. Amulet Name Service The generic name for the code and logic implement

Setup How do I get onboarded to TestNet or MainNet? Onboarding to TestNet requires a Super Validator (SV) sponsor. Contact the SV you are working with, or reach out through the #validator-operations-onboarding Slack channel to find a sponsor. The sponsor submits a vote to approve your validato

Number of Parties per Validator While the underlying Canton participant supports up to 1 million parties per node, limitations in the validator app currently mean that only up to 200 parties are supported when the validator app is involved. The limit of 200 parties is expected to be lifted in the

Every node exposes a set of metrics on the port 10013 under the path /metrics. These metrics can be used to monitor the health of the node, and to diagnose issues. Apps expose metrics on the port 10013, under the path /metrics in the Prometheus format. For a validator the following component

Ingress The validators have no external ingress requirements and don’t need to whitelist any other SVs or validators. Egress The validators must be able to connect to all the SVs, thus whitelisting of egress on port 443 for the IPs of all the SVs is required (refer to the network diagram for a

Canton distinguishes between parties and users, as documented in detail in Manage Daml parties . In essence, a party is an identity on-ledger, while a user represents an off-ledger entity that can be associated with one or more parties. By default, when a user logs in for the first time in the wall

This section features solutions shared by community members. While they haven’t been formally tested by the Splice maintainers, users are encouraged to verify the information independently. Contributions to enhance accuracy and completeness are always welcome. This guide introduces a community-con

This section features solutions shared by community members. While they haven’t been formally tested by the Splice maintainers, users are encouraged to verify the information independently. Contributions to enhance accuracy and completeness are always welcome. Managing deployments for Validator an

This section features solutions shared by community members. While they haven’t been formally tested by the Splice maintainers, users are encouraged to verify the information independently. Contributions to enhance accuracy and completeness are always welcome. To deploy a validator node with Keycl

This reference provides detailed translations from Ethereum concepts to their Canton equivalents. Use this as a quick reference when you encounter familiar terms and need to understand their Canton counterpart. Core Protocol Concepts Ethereum | Canton | Key Differences | Blockchain | Synchroniz

Moving from Solidity to Daml requires a significant mental shift. This page explains the paradigm differences and how to adapt your thinking. Programming Model Comparison Aspect | Solidity | Daml | Paradigm | Imperative, object-oriented | Functional, declarative | State | Mutable storage | Imm

Canton Improvement Proposals (CIPs) are formal design documents that describe standards, protocol changes, governance procedures, and guidelines for Canton Network. They serve as the primary mechanism through which the community proposes and ratifies changes to the network. The CIP process is model

The Global Synchronizer is governed by its Super Validators (SVs) acting collectively as the Decentralized Synchronizer Operator (DSO). Governance decisions are made through on-chain voting using Daml contracts defined in the splice-dso-governance package. DSO Governance Model The DSO is a dec

The Global Synchronizer is the shared infrastructure that enables transactions between parties on different validators. It is operated by a set of super-validators (SVs) under the governance of the Canton Foundation. The synchronizer coordinates transaction ordering and consensus but never sees the

For changes shipping in each component, see the corresponding release notes: • Splice and the Global Synchronizer — Splice release notes , release history , weekly patch releases • Wallet SDK — Wallet SDK release notes • Canton and Daml SDK — Canton release notes • CIPs — Canton Improvement Prop

Every transaction on the Global Synchronizer costs traffic. Canton Coin (CC) is the native currency you use to purchase traffic credits. As an application developer, you need to understand this relationship so your users’ transactions go through without interruption. Canton Coin Canton Coin is t