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:
AdminClient— party management (PartyManagementService) and user self-inspect (UserManagementService), served on the Ledger API port (e.g.:3901), the same channel/auth as the ledger client. Party admin RPCs require theParticipantAdminright; self-inspect (AdminClient::current_user/AdminClient::current_user_rights) works with any authenticated token.TopologyClient— topology read (party→participant mappings, namespace delegations, vetted packages) viaTopologyManagerReadService, served on the Canton admin API port (e.g.:3902).
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§
- Admin
Client - A client for Canton’s Ledger-API admin services:
PartyManagementServiceandUserManagementService. - Config
- Configuration for an SDK gRPC client (shared by
canton-ledgerandcanton-admin). - Entry
- One topology mapping result: the mapping
itemplus itsBaseResultcontext(store, validity window, serial, …).#[non_exhaustive]so fields can be added without a breaking change. - Retry
Config - Retry policy for unary calls.
- TlsConfig
- TLS settings for the gRPC channel.
- Topology
Client - A client for Canton’s
TopologyManagerReadService(admin API).
Enums§
- Error
- The single error type for the whole Canton Rust SDK.
- Package
Status - Store
- Which topology store to query.
Type Aliases§
- Result
- SDK-wide result alias. Re-exported by the facade as
canton::Result.