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

    Interface AftermathOptions

    Options accepted by Aftermath.create. All fields are optional — pass {} for the canonical mainnet setup.

    interface AftermathOptions {
        addresses?: ConfigAddresses;
        api?: AftermathApi;
        apiEndpoint?: string;
        baseUrl?: string;
        fullnodeUrl?: string;
        network?: SuiNetwork;
    }
    Index
    addresses? api? apiEndpoint? baseUrl? fullnodeUrl? network?
    addresses?: ConfigAddresses

    Preloaded on-chain addresses. When supplied, create skips the network round-trip that normally fetches them.

    api?: AftermathApi

    Pre-built AftermathApi instance. When supplied, create uses it directly and skips address discovery and Sui client setup entirely.

    apiEndpoint?: string

    Override for the API path segment between host and package prefix. Defaults to "api". Override only when targeting a backend that mounts the Aftermath API under a different path.

    baseUrl?: string

    Explicit override for the Aftermath API host (e.g. "http://localhost:8080"). Useful for staging or local backends.

    fullnodeUrl?: string

    Explicit override for the Sui fullnode URL.

    network?: SuiNetwork

    The target Sui network. Determines the canonical API host and Sui fullnode URL when no explicit overrides are supplied.

    "MAINNET"

    Settings
    Member Visibility

    On This Page
    Properties