aftermath-ts-sdk - v3.3.3
    Preparing search index...

    Interface CallerConfig

    Configuration for constructing a Caller. Includes network specification and optional access token for authentication.

    interface CallerConfig {
        accessToken?: string;
        apiEndpoint?: string;
        baseUrl?: string;
        network?: SuiNetwork;
    }
    Index
    accessToken? apiEndpoint? baseUrl? network?
    accessToken?: string

    Access token used for authenticated requests, if required.

    apiEndpoint?: string

    URL path segment placed between the host and the package prefix when building API call URLs ({host}/{apiEndpoint}/{package}/...). Defaults to "api". Override only when targeting a backend that mounts the Aftermath API under a different path.

    baseUrl?: string

    Explicit override for the API host (e.g. "http://localhost:8080"). Takes precedence over the network-derived default. Use this to point the SDK at a custom or local backend.

    network?: SuiNetwork

    The target Sui network (e.g., "MAINNET", "TESTNET"). Determines the default API host when baseUrl is not supplied.

    Settings
    Member Visibility

    On This Page
    Properties