Struct Config 

pub struct Config { /* private fields */ }

Configuration for an SDK gRPC client (shared by canton-ledger and canton-admin).

Implementations

impl Config

pub fn new(endpoint: impl Into<String>) -> Self

Create a configuration targeting endpoint, with no authentication and no retrying.

pub fn with_token(self, token: impl Into<String>) -> Self

Authenticate with a fixed bearer token.

pub fn with_oidc<T: TokenSource + 'static>(self, provider: T) -> Self

Authenticate with a dynamic token source (e.g. an OIDC provider with client-credentials and auto-refresh).

pub fn with_retry(self, retry: RetryConfig) -> Self

Enable retrying of unary calls on retriable errors, per retry.

pub fn with_tls(self, tls: TlsConfig) -> Self

Use TLS for the gRPC channel (server-side and, if configured, mutual).

pub fn with_timeout(self, timeout: Duration) -> Self

Set the per-request timeout on the gRPC channel (default 30s). Long submitAndWait calls under load may need a higher bound.

pub fn with_max_decoding_message_size(self, bytes: usize) -> Self

The largest gRPC response to decode, in bytes (default DEFAULT_MAX_DECODING_MESSAGE_SIZE, 128 MiB).

Raise it for a participant that returns very large ACS pages or transactions; lower it to bound the memory a single response can claim.

pub fn max_decoding_message_size(&self) -> usize

The largest gRPC response this configuration will decode, in bytes.

pub fn endpoint(&self) -> &str

The gRPC endpoint of the target service, e.g. http://localhost:3901.

pub fn auth(&self) -> &Auth

The configured authentication mode.

pub fn retry(&self) -> Option<&RetryConfig>

The configured retry policy, if any.

pub fn connect_channel(&self) -> Result<Channel>

Build a lazily-connected gRPC Channel for this configuration.

Returns immediately; the TCP/TLS handshake happens on the first RPC. TLS is applied when Config::with_tls was set or the endpoint is https; a with_tls endpoint given as http:// is normalised to https:// so TLS is never silently downgraded (see the private resolve_endpoint).

Errors

Returns Error::InvalidRequest if the endpoint URI or the TLS configuration is invalid.

impl Config

pub fn from_env() -> Result<Self>

Build a configuration from a LocalNet exported into the environment — the app-provider participant, with its token.

See the module documentation for the variables read and the two things worth knowing about the URLs.

Errors

Returns Error::InvalidRequest when no endpoint variable is set, naming the variable and the command that exports it. A missing token is not an error: an unauthenticated LocalNet is a normal thing to point this at.

pub fn from_env_for(role: &str) -> Result<Self>

The same, for a participant other than the default: "app-user", "sv", or any role the exporter knows.

Errors

As Config::from_env, naming that role’s variable.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

Hand-written so the endpoint’s userinfo is redacted. auth and tls redact themselves; the endpoint was the remaining way a credential reached a log through a Config, and a Config is exactly the thing an application attaches to a tracing span while debugging a connection.

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.