Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.canton.network/llms.txt

Use this file to discover all available pages before exploring further.

This section was copied from existing reviewed documentation. Source: docs/src/app_dev/overview/index.rst Reviewers: Skip this section. Remove markers after final approval.
If you are a new Canton Network developer, please check out the TL;DR for new Canton Network developers.

​
Canton Network Applications

Canton Network applications are used to operate business processes spanning multiple organizations or business entities. Use the following documentation to build Canton Network applications and get them featured on the Canton Network:

​
RPC APIs Overview

When building an application for the Canton Network, you will typically integrate with some of the HTTP or gRPC APIs provided by the Global Synchronizer and Validator Nodes. Use the guidance below to learn which ones to use and how to use them.
  • Use the app_dev_ledger_api to access the view of the ledger as seen by the parties hosted on a Validator Node and submit transaction to the ledger.
  • Use the app_dev_scan_api to access the view of the ledger and its infrastructure as seen by all SV Nodes. Note that this view is the one visible to the DSO party and does not include any of the data that is private to the parties hosted on Validator Nodes. Use the app_dev_ledger_api to access the data of parties hosted on the Validator Node.
  • Use the app_dev_validator_api to access higher-level functionality provided by the Splice Validator App running alongside the Canton Participant node in a Validator Node.
See the diagram below to learn about which components serve which APIs and how they are connected to each other. App Network Diagram

​
Splice Daml APIs Overview

Splice implements several decentralized applications whose on-ledger state and workflows are implemented in Daml. An Interface defined in Daml code is a public API that you should develop against because they are stable. These public APIs are used in interoperability standards, like the Canton Network Token Standard. Use these Daml APIs to minimize the coupling between your application’s Daml code and the Daml code of your dependencies. For example, the Interfaces in the Splice implementation loosely couple an application with the implementation so that a Splice upgrade avoids forcing a corresponding upgrade of an application’s Daml code. See the app_dev_daml_api for an overview of the Daml APIs defined in Splice and their purpose.

​
Splice Daml Models Overview

A Daml model’s Templates and Choices are considered internal implementation details. For example, the Canton Network Token Standard is the public API for working with tokens, including Canton Coin. The Canton Network Token Standard implementation operates on top of the AmuletRules_Transfer choice (this provides backwards compatibility). It is worthwhile and recommended to study these implementation details because you can learn a lot by examination. Use the following resources to learn how to interact with the Daml models state and workflows.
  • Learn how to read and write Daml code from: https://docs.digitalasset.com/build/3.4/
  • Learn about the Daml packages that are part of Splice and their data models and workflows from app_dev_daml_models.