Canton devkit (dpm component) - a unified toolkit for Canton app development (LocalNet, dar helpers, etc) #18 Milestone 1: LocalNet Management — CLI

OPENIssue
by pedrodneves28-05-2026
400K CC requested
View on GitHub ↗← All Proposals

Milestone 1: LocalNet Management — CLI

  • Estimated Delivery: Month 3
  • Focus: Single-command LocalNet lifecycle management via CLI.
  • Deliverables / Metrics:

- dpm localnet up/down/restart/clean/status/logs CLI commands (and equivalent canton-devkit localnet ... standalone commands) with auto-generated configs, keys, identities, and printed endpoints and credentials. - Version pinning (--version) and basic named-instance isolation (--name) using deterministic Docker Compose project names, labels, and explicit port configuration. - Snapshot and restore (dpm localnet snapshot/restore) for saving and replaying LocalNet state. - Native DPM component packaging (component.yaml plus OCI publishing in the release CI) so DevKit is installable via dpm install package from Milestone 1 onward. - Standalone Go binary release artifacts for macOS arm64, Linux amd64, and Windows amd64, published with checksums (same binary as the DPM component). - Installation and "Getting Started" guide for both DPM-component and standalone install paths on macOS, Linux, and Windows, including Docker prerequisite checks and troubleshooting. - Docker preflight checks in dpm localnet up for Docker CLI availability, daemon connectivity, Docker Compose v2, required ports, disk space, memory, and host-specific prerequisites such as Linux Docker permissions or Docker Desktop availability on macOS/Windows. - Basic dpm localnet doctor diagnostics covering Docker CLI availability, daemon connectivity, Docker Compose v2, platform support, required ports, disk space, memory, and host-specific prerequisites. - Deterministic exit codes and readiness wait behavior suitable for basic headless automation. - Compatibility matrix documenting the initially supported Splice LocalNet version and supported macOS/Linux/Windows platforms. - Demo script showing startup, readiness, status, logs, teardown, and one two-instance run using explicit non-conflicting ports. - Internal testing plus at least one external tester validating that a new developer can go from zero to running LocalNet in under 10 minutes.

  • Adoption Metrics: at least 3 companies/teams have reviewed the tool and tested it for LocalNet setup and lifecycle usage.

| Milestone | Target deadline | Funding Request | | :--- | :--- | :--- | | Milestone 1 (LocalNet Management — CLI) | Month 3 | 400,000 CC upon committee acceptance. |

_Originally posted by @pedrodneves in https://github.com/canton-foundation/canton-dev-fund/issues/18#issuecomment-4565797082_