Documentation

On this page Authentication canton-deploy sends a JWT with every Ledger, Admin, and JSON API call. The token is resolved in this order: • --token • CANTON_DEPLOY_TOKEN • config token • config oauth2 (OAuth2 client credentials; the client secret is read from an environment variable, never fro

On this page canton-deploy Deploy Daml packages to a Canton validator directly from your Daml project: build, upload, vet, allocate parties, onboard users, run scripts, and inspect what is on the ledger. Built by LYNC · Supported by the Canton Foundation canton-deploy is a DPM component. You invok

Command JSON estimate and simulate take a path to a Ledger API command payload. There is no required folder layout; pass the file path that fits your project. { "commands": [{ "CreateCommand": { "templateId": "#my-pkg:Main:MyTemplate", "createArguments": { "owner": "Alice::", "amount": "100.

On this page Commands Shared flags include: --network --host --admin-port --ledger-port --http-port --grpc-authority --http-host --token --log-file Exit code 0 indicates success. --log-file appends output for CI. Command Reference Command | What it does | deploy | Build (unless --skip

On this page Commands Command | Use it for | estimate <file> | Readiness checks plus traffic cost for one command JSON file. | simulate <file> | Prepared transaction view and node breakdown for a command JSON file. | inspect | Validator readiness checks. Default is light and fast. | inspect -

On this page Configuration Settings live in canton-deploy.config.js at the project root or a parent directory. Select a named network with --network. Run: dpm canton-deploy init or copy canton-deploy.config.example.js. If the nearest package.json contains "type": "module", use can

On this page Configure Put canton-profiler.config.js in the directory where you run the command. Configuration precedence is: CLI flags, then environment variables, then config file values, then defaults. // canton-profiler.config.js module.exports = { defaultNetwork: 'testnet', networks: { te

On this page Contracts The contracts command lists active contracts through the JSON API. List Contracts dpm canton-deploy contracts --network localnet Filter by Party dpm canton-deploy contracts --network localnet --party 'Alice::1220...' Filter by Template dpm canton-deploy c

On this page Deploy your first Daml package to Canton in 5 minutes In this guide we will start a local Canton participant, deploy a Daml project to it with one command, and see the result on the ledger. Then we will point the same project at DevNet or TestNet by changing one flag. You will use the c

On this page Deployment Basic Deployment dpm canton-deploy deploy --network localnet By default, deploy builds the project, uploads the DAR set, optionally vets it, onboards configured parties and users, and can run a Daml Script. Deploy Flags Flag | Meaning | --upload-via admin|ledger |

On this page Environment Variables canton-deploy supports the following environment variables: Variable | Purpose | CANTON_DEPLOY_NETWORK | Default --network | CANTON_DEPLOY_HOST | Override host | CANTON_DEPLOY_ADMIN_PORT / CANTON_DEPLOY_LEDGER_PORT / CANTON_DEPLOY_HTTP_PORT | Ports |

On this page Examples LocalNet For LocalNet, first add canton-open-source to components (for example canton-open-source:3.5.17) and run dpm install package. Start the sandbox in a separate terminal: dpm sandbox --ledger-api-port 5001 --admin-api-port 5002 --json-api-port 7575 Then, f

On this page Gas Profiler - DPM Component Install, configure, run, and troubleshoot dpm canton-profiler for Canton validator pre-flight checks. What is the Canton Gas Profiler? The Canton Gas Profiler is a dpm component that estimates what a transaction will cost and whether it will succeed — befo

On this page Getting Started Install canton-deploy Work from your Daml project root, the directory containing daml.yaml or the multi-package.yaml root. Add canton-deploy to components: components: - damlc:3.5.2 - daml-script:3.5.2 - oci://ghcr.io/lync-world/canton-deploy:0.2.2 DPM does

On this page Getting Started Quick start • Add the component to daml.yaml. • Run dpm install package from the directory containing daml.yaml. • Create canton-profiler.config.js in the project root. • Set a JWT source in config, or pass --token for one-off runs. • Run inspect --quick to c

On this page Parties and Users List Parties dpm canton-deploy parties --network localnet Only show parties hosted on this participant: dpm canton-deploy parties --network localnet --local Allocate a Party dpm canton-deploy allocate-party Alice --network localnet Configuration

On this page Remote Validators Name-Routed Proxies Splice validators deployed with Docker Compose put the participant APIs behind nginx on a single port and route by name. Point canton-deploy at that port and set the routing names: Key | Purpose | grpcAuthority | gRPC :authority for the Ledger A

On this page Scripts canton-deploy can execute Daml Scripts through dpm script. Run a Script dpm canton-deploy run My.Module:setup --network localnet You can provide a DAR and input file: dpm canton-deploy run Setup:seed --network devnet --dar .daml/dist/my-app-0.1.0.dar --input-file

On this page Troubleshooting 1. dpm install package Says canton-deploy:0.2.2 Was Not Found A bare canton-deploy:0.2.2 resolves against Digital Asset's component registry. Until canton-deploy is published there, use the full GHCR reference: components: - oci://ghcr.io/lync-world/canton-depl

Troubleshooting Ledger is unreachable Check: host, ledgerPort, TLS settings, token expiry, and grpcAuthority when routing through nginx or a tunnel. Admin checks show skip Check: adminPort and adminGrpcAuthority. A skipped Admin check means STANDARD mode can still work, but FULL-only balan

Warnings W001–W011 Code | Meaning | What to check | W001 | Payload near or over gRPC size limit. | Command size, batch shape, grpcMaxInboundBytes. | W002 | Estimated cost exceeds highCostWarnCc. | Workflow design, payload size, threshold value. | W003 | Traffic balance appears insufficient. | Ba