Skip to main content

Crate canton_admin

Crate canton_admin 

Source
Expand description

Canton administrative client: party management, user self-inspect, and topology read.

Canton exposes these across two gRPC endpoints, so this crate provides two clients:

Both build on the shared canton_core::Config (endpoint, auth, TLS, retry).

use canton_admin::{AdminClient, Config};

let admin = AdminClient::connect_lazy(Config::new("http://localhost:3901"))?;
let me = admin.current_user().await?;
println!("acting as: {:?}", admin.acting_parties().await?);

Modules§

proto
Generated Ledger API admin protobuf types (party & user management).
protocol_proto
Generated Canton protocol types (topology mapping items).
topology_proto
Generated Canton admin-API topology types (query/result envelopes).

Structs§

AdminClient
A client for Canton’s Ledger-API admin services: PartyManagementService and UserManagementService.
Config
Configuration for an SDK gRPC client (shared by canton-ledger and canton-admin).
Entry
One topology mapping result: the mapping item plus its BaseResult context (store, validity window, serial, …). #[non_exhaustive] so fields can be added without a breaking change.
RetryConfig
Retry policy for unary calls.
TlsConfig
TLS settings for the gRPC channel.
TopologyClient
A client for Canton’s TopologyManagerReadService (admin API).

Enums§

Error
The single error type for the whole Canton Rust SDK.
PackageStatus
Store
Which topology store to query.

Type Aliases§

Result
SDK-wide result alias. Re-exported by the facade as canton::Result.