API reference
Every published crate is documented on docs.rs, built from the released version. The links below always point at the latest release.
Start here
| Crate | |
|---|---|
canton | The Canton Network Rust SDK: one-stop entry point re-exporting the canton-* crate family. |
Ledger API
| Crate | |
|---|---|
canton-ledger | Async Canton Ledger API client (gRPC): commands, streaming, de-duplication, recovery. |
canton-auth | JWT/OIDC authentication for the Canton Rust SDK (client-credentials, caching, refresh). |
canton-core | Core types for the Canton Rust SDK: error model, telemetry, and the shared connection kernel (config, auth, TLS, retry). |
canton-admin | Canton admin client: party management, user self-inspect, and topology read (gRPC). |
canton-signer | Pluggable transaction signing for Canton interactive submission (HSM/KMS-compatible). |
canton-pqs | Typed read client for the Daml Participant Query Store (PQS/Scribe): typed predicates compiled to parameterized JSONB queries. |
Daml models and codegen
| Crate | |
|---|---|
canton-daml | Runtime types and Value codecs for canton-codegen-generated Daml bindings. |
canton-codegen | Type-safe Rust code generation from Daml packages (DAR to Rust). |
canton-codegen-cli | dpm codegen-rust: generate a typed Rust crate of bindings from a DAR. |
canton-lf | Daml-LF archive (DAR/DALF) reader and decoder for the Canton Rust SDK. |
canton-daml-stdlib | Pre-built typed Rust bindings for the Daml standard library (daml-stdlib, daml-prim, ghc-stdlib). |
Token standard
| Crate | |
|---|---|
canton-token | Canton Network token-standard workflows (CIP-56 and CIP-0112): registry client, choice contexts, transfers and allocations. |
canton-splice-api-featured-app-v1 | Pre-built typed Rust bindings for the Splice splice-api-featured-app-v1 DAR. |
canton-splice-api-token-metadata-v1 | Pre-built typed Rust bindings for the Splice splice-api-token-metadata-v1 DAR. |
canton-splice-api-token-holding-v1 | Pre-built typed Rust bindings for the Splice splice-api-token-holding-v1 DAR. |
canton-splice-api-token-holding-v2 | Pre-built typed Rust bindings for the Splice splice-api-token-holding-v2 package (CIP-0112). |
canton-splice-api-token-allocation-v1 | Pre-built typed Rust bindings for the Splice splice-api-token-allocation-v1 DAR. |
canton-splice-api-token-allocation-v2 | Pre-built typed Rust bindings for the Splice splice-api-token-allocation-v2 package (CIP-0112). |
canton-splice-api-token-burn-mint-v1 | Pre-built typed Rust bindings for the Splice splice-api-token-burn-mint-v1 DAR. |
canton-splice-api-token-transfer-events-v2 | Pre-built typed Rust bindings for the Splice splice-api-token-transfer-events-v2 package (CIP-0112). |
canton-splice-api-token-transfer-instruction-v1 | Pre-built typed Rust bindings for the Splice splice-api-token-transfer-instruction-v1 DAR. |
canton-splice-api-token-transfer-instruction-v2 | Pre-built typed Rust bindings for the Splice splice-api-token-transfer-instruction-v2 package (CIP-0112). |
canton-splice-api-token-allocation-instruction-v1 | Pre-built typed Rust bindings for the Splice splice-api-token-allocation-instruction-v1 DAR. |
canton-splice-api-token-allocation-instruction-v2 | Pre-built typed Rust bindings for the Splice splice-api-token-allocation-instruction-v2 package (CIP-0112). |
canton-splice-api-token-allocation-request-v1 | Pre-built typed Rust bindings for the Splice splice-api-token-allocation-request-v1 DAR. |
canton-splice-api-token-allocation-request-v2 | Pre-built typed Rust bindings for the Splice splice-api-token-allocation-request-v2 package (CIP-0112). |
Splice bindings
| Crate | |
|---|---|
canton-splice-amulet | Pre-built typed Rust bindings for the Splice splice-amulet DAR. |
canton-splice-wallet | Pre-built typed Rust bindings for the Splice splice-wallet DAR. |
canton-splice-wallet-payments | Pre-built typed Rust bindings for the Splice splice-wallet-payments DAR. |
Generated protocol types
| Crate | |
|---|---|
canton-proto | Generated Canton Ledger API v2 gRPC types and client stubs (internal to the SDK). |
canton-codegen-cli is a binary (dpm-codegen-rust), so it has no API
documentation; its usage is in Typed bindings from a DAR.