Open Cap Table Protocol Canton SDK - v0.2.239
    Preparing search index...

    Interface ClientConfig

    Top-level configuration for creating API clients.

    Most fields are intentionally mutable because BaseClient and EnvLoader merge defaults into the config at construction time (e.g., filling in provider, authUrl, partyId from environment variables).

    interface ClientConfig {
        apis?: {
            LEDGER_JSON_API?: ApiConfig;
            SCAN_API?: ApiConfig;
            VALIDATOR_API?: ApiConfig;
        };
        authUrl?: string;
        debug?: boolean;
        logger?: Logger;
        managedParties?: string[];
        network: NetworkType;
        partyId?: string;
        provider?: string;
        userId?: string;
    }
    Index

    Properties

    apis? authUrl? debug? logger? managedParties? network partyId? provider? userId?

    Properties

    apis?: {
        LEDGER_JSON_API?: ApiConfig;
        SCAN_API?: ApiConfig;
        VALIDATOR_API?: ApiConfig;
    }
    authUrl?: string
    debug?: boolean

    Enable debug mode with verbose console logging. When true, logs all API requests/responses to console. Can also be enabled via CANTON_DEBUG=1 environment variable.

    logger?: Logger
    managedParties?: string[]
    network: NetworkType
    partyId?: string

    Party ID. Mutable so it can be set at runtime after client initialization (e.g., LocalNet discovery).

    provider?: string
    userId?: string

    Settings

    Member Visibility

    On This Page

    Properties