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

    Provides the shared HTTP, transaction, event, and WebSocket transport logic used by the SDK's API clients.

    Subclasses supply endpoint-specific methods and use the protected request helpers. Requests normalize HTTP, network, timeout, abort, and response decoding failures to AftermathTransportError.

    Hierarchy (View Summary)

    Index
    • Creates a caller without making a network request.

      config.baseUrl takes precedence over config.network. If neither value supplies a host, a later request fails with a normalized network error. The caller stores the supplied configuration object, so later changes to mutable request fields such as config.accessToken affect subsequent requests. The derived host and endpoint are fixed at construction time.

      Parameters

      • config: CallerConfig = {}

        The network, API host, endpoint, and optional access token.

      • apiUrlPrefix: string = ""

        The package or service path inserted after the API endpoint.

      Returns Caller

    config: CallerConfig

    The mutable configuration used for subsequent requests.

    • Returns the canonical Aftermath API host for a Sui network.

      To target a custom or local host, pass baseUrl in CallerConfig to the constructor instead.

      Parameters

      • network: SuiNetwork

        The Sui network whose host to return.

      Returns string

      The network's HTTPS or local HTTP API host.

    • Returns the canonical Sui fullnode URL for a network.

      Parameters

      • network: SuiNetwork | undefined

        The network whose fullnode URL to return. undefined defaults to mainnet.

      Returns string

      The network's fullnode URL.