Polkadot Apps
    Preparing search index...

    Interface StatementStoreConfig

    Configuration for StatementStoreClient.

    Inside a container, the client automatically uses the Host API's native statement store protocol (no endpoint needed). The endpoint is a fallback for outside-container usage (development, testing).

    interface StatementStoreConfig {
        appName: string;
        defaultTtlSeconds?: number;
        enablePolling?: boolean;
        endpoint?: string;
        pollIntervalMs?: number;
        transport?: StatementTransport;
    }
    Index

    Properties

    appName defaultTtlSeconds? enablePolling? endpoint? pollIntervalMs? transport?

    Properties

    appName: string

    Application namespace used as the primary topic (topic1).

    All statements published by this client are tagged with blake2b(appName). Subscribers filter on this topic to receive only relevant statements.

    "ss-webrtc", "mark3t-presence", "my-app"
    defaultTtlSeconds?: number

    Default time-to-live for published statements in seconds.

    Statements automatically expire after this duration. Can be overridden per-publish via PublishOptions.ttlSeconds.

    30
    enablePolling?: boolean

    Whether to enable the polling fallback.

    When true (default), the client polls for statements periodically in addition to the real-time subscription. Only active when the transport supports queries (RPC mode, not host mode).

    true
    endpoint?: string

    Fallback WebSocket endpoint for the statement store node.

    The client always tries the Host API first (inside a container). This endpoint is only used as a fallback when the host is unavailable. Defaults to the paseo bulletin RPC from @polkadot-apps/host.

    "wss://paseo-bulletin-rpc.polkadot.io"
    pollIntervalMs?: number

    Polling interval in milliseconds for the fallback poller.

    The client uses both subscriptions (real-time) and polling (fallback) to ensure no statements are missed. Set to 0 to disable polling. Polling is only active when the transport supports queries (RPC mode).

    10_000
    transport?: StatementTransport

    Provide a custom transport instead of auto-detection.

    When set, the client skips host/RPC auto-detection and uses this transport directly. Useful for testing or advanced BYOD setups.

    Settings

    Member Visibility

    On This Page

    Properties