Documentation

Contributing to canton-devkit Thanks for your interest in contributing! This document describes the conventions the project follows and what we look for in a pull request. Project Overview canton-devkit is a CLI tool for managing Canton LocalNet developer environments. It provides a single work

Agent skills Canton DevKit ships six skills that teach coding agents to use dpm localnet or canton-devkit localnet. They cover network lifecycle, DAR deployment, hot redeployment, ledger inspection, token testing, and CI. Skills provide workflow instructions; install [DevKit](getting-started.m

Total downloads: 134 across 39 releases. Monthly downloads | Month | Downloads | |---|---| | 2026-10 | 23 | | 2026-09 | 29 | | 2026-0

Running a local Canton network with Canton DevKit *A case study on Canton DevKit, a CLI and Web UI for local Canton and Splice networks and Canton Token Standard tokens. Built by Bit Dynamics under a Canton Dev Fund grant.* The problem Local Canton development needs a network you can start, res

Dashboard Customization Canton DevKit ships a Grafana dashboard that gives you a one-screen overview of a running LocalNet. The dashboard is provisioned from a JSON file on disk, so you can extend it, replace it, or restore it with normal file edits and a stack restart. This guide covers what ship

Design mockups React/JSX prototypes of every dpm localnet … CLI command and the M2 Web UI. Open index.html in a browser to render — it's a self-contained design-canvas with a Figma-like pan/zoom viewer. These files are acceptance specs, not shipping code: - CLI mockups (screens-*.jsx, t

End-to-End Testing Unit tests (go test ./...) cover DevKit's Go logic. End-to-end (E2E) tests cover the parts that only a *real* invocation exercises: the DPM component surface, shelling out to dpm/daml, Docker-backed LocalNet lifecycle, and the artifacts DevKit produces on disk. The reposit

Explorer The Explorer is the Web UI's window into a running LocalNet's ledger. It reads the Active Contract Set (ACS) and recent transactions from the participant's gRPC ledger API, so you can see what's on the ledger without writing a script. This guide covers what the Explorer can do today, the

FAQ: Canton LocalNet & DevKit Common questions about canton-devkit and Canton LocalNet. See also troubleshooting for failure-mode fixes and LocalNet lifecycle for the full operational guide. General What is Canton LocalNet? Canton LocalNet

Installation & Getting Started Canton DevKit is a single Go binary that orchestrates the Splice LocalNet Docker stack. It ships two ways: 1. DPM component (primary) — install through the Daml Package Manager and invoke as dpm localnet <command>. 2. Standalone binary (canton-devkit) — a

HackCanton Season 3 starter canton-devkit runs and tests your Daml application in a LocalNet. Both dpm localnet <cmd> and canton-devkit localnet <cmd> use the same command tree. Telegram support channel: https://t.me/+ysKrAz_QALk5NTM0 1. Install | Requirement | Why | Check | |---|---|---| |

Homebrew install canton-devkit ships a Homebrew formula for macOS (Apple Silicon) and Linux (x86_64). The formula lives in the dedicated tap repository bitdynamics-ab/homebrew-canton-devkit, following the standard Homebrew tap layout.

Known limitations Things DevKit does not (yet) do well, with the rationale and workarounds where applicable. This list is updated as limitations are resolved. Instance naming - --name must be a DNS label. Names are validated against RFC 1123: 1-63 chars of lowercase [a-z0-9-], must star

Canton LocalNet lifecycle Canton LocalNet is a multi-validator local Canton Network for development and integration testing (sequencers, mediators, participants, and Splice apps in Docker). It is not a production deployment path. Canton DevKit is a single-binary tool that runs and operates

Observability — Prometheus + Grafana The --profile observability flag on canton-devkit localnet up adds two containers to the compose project: - Prometheus scrapes canton:10013 and splice:10013 (both containers ship /app/monitoring.conf enabling the built-in OTel reporter — see asse

Packaging & Distribution canton-devkit ships through complementary channels: 1. DPM component (primary) — installed via dpm install package. 2. Standalone Go binary (additional) — direct download / install. 3. Package-manager convenience — a Homebrew tap wraps the same standalone b

Telemetry canton-devkit records anonymous, aggregate usage counters — merged into a daily total with no per-invocation rows — to help maintainers see what's used and what breaks. The only identifier sent is a single anonymous random install token (a UUID, not derived from any hardware

E2E Test Plan — Milestone 1: LocalNet Management CLI Total Tests: 19 Platforms: macOS (Apple Silicon), Linux (amd64), Windows (amd64) --- Overview This test plan validates the core LocalNet lifecycle management CLI delivered in Milestone 1. Conventions - Commands are shown in both f

E2E Test Plan — Milestone 2: Web UI, Observability, DAR & Contract Tooling Total Tests: 26 Platforms: macOS (Apple Silicon), Linux (amd64), Windows (amd64) Prerequisite: All Milestone 1 tests passing. --- Overview This test plan validates the Web UI, observability/monitoring stack,

E2E Test Plan — Milestone 3: Token Faucets & Token Standard Tooling (CIP-0112) Total Tests: 11 Platforms: macOS (Apple Silicon), Linux (amd64), Windows (amd64) Prerequisites: All Milestone 1 and Milestone 2 tests passing. --- Overview This test plan validates the CIP-0112 token stan

Tokens — Canton Token Standard on LocalNet canton-devkit ships first-class tooling for the Canton Token Standard so you can create an instrument, mint/transfer/burn holdings, fund parties, and reconcile balances against a live LocalNet — from the CLI or the Web UI, by readable party alias, wit

Troubleshooting Day-one setup (install, one working example, common breaks): HackCanton Season 3 starter. Failure modes and fixes. Start with canton-devkit localnet doctor — it runs the same host preflight as localnet up (Docker CLI, daemon, Compose v2, disk + memory headro

Splice version catalogue DevKit pins to a catalogue of tested Splice versions embedded in the binary so localnet up never composes-up an untested upstream tag. What DevKit fetches, and from where > Upstream repo: canton-network/splice > **

Daml contract source - bitdynamics-ab/canton-devkit/e2e-tests/daml-test-contracts/daml/Token.daml -- Copyright (c) 2025 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved. -- SPDX-License-Identifier: Apache-2.0 module Token where -- | Token is a contract that has n

CI examples Copy-pasteable workflows that run your Daml/Canton app tests against a throwaway Canton LocalNet managed by canton-devkit. | File | Platform | |---|---| | github-actions.yml | GitHub Actions | | gitlab-ci.yml | GitLab CI | The pattern

LocalNet in CI Stand up a disposable Canton LocalNet for integration tests, then tear it down — using canton-devkit's deterministic exit codes and readiness-wait. When to use The user asks to "test against Canton in CI", "add LocalNet to my pipeline", or "run integration tests in GitHub Actions

DAR upload & inspection Deploy and inspect Daml packages on a running LocalNet via dpm localnet dar (or canton-devkit localnet dar). When to use The user asks to "upload my DAR", "deploy the package to LocalNet", "see what packages are installed", or "diff two package versions". Safe wor

Hot-deploy (watch mode) Tighten the edit→build→deploy loop against a running LocalNet using dpm localnet dar watch and dar build-upload. When to use The user asks for "hot reload", "auto-redeploy on change", or "rebuild and upload in one step" while iterating on Daml code. Safe workflow

Inspect contracts & transactions Read live ledger state with dpm localnet contracts and tx (backed by Ledger API v2). These complement — they do not replace — Daml Shell's one-shot lookups. When to use The user asks to "watch contracts", "see transactions for a party", "what does party X se

Canton LocalNet lifecycle Manage a local Canton network using dpm localnet (or canton-devkit localnet standalone). Every command is idempotent and returns deterministic exit codes. When to use The user asks to "spin up Canton locally", "start a LocalNet", "check if the network is healthy",