kernl API
    Preparing search index...

    Interface RatchetMessagingOptions

    What the ratchet backend needs: the signer backends' options plus the storage the library's sealed state is kept in.

    const options: RatchetMessagingOptions = { ...signerOptions, storage: localStorage };
    interface RatchetMessagingOptions {
        accountChanges?: Observable<unknown>;
        discoveryTimeouts?: { fastMs: number; fetchMs: number };
        pool: ApplesaucePool;
        selfPubkey: () => string | undefined;
        signer: () => ISigner | undefined;
        storage: StorageLike;
        tiers: RelayTiers;
    }

    Hierarchy

    Index
    accountChanges? discoveryTimeouts? pool selfPubkey signer storage tiers
    accountChanges?: Observable<unknown>

    Emits when the active account changes, so the inbox follows it without waiting for the next call.

    discoveryTimeouts?: { fastMs: number; fetchMs: number }

    How long the library waits for relays to return the account's device list, as { fetchMs, fastMs }. Defaults to the library's 10 s and 2 s.

    pool: ApplesaucePool
    selfPubkey: () => string | undefined

    The active account's public key, read on every call.

    signer: () => ISigner | undefined

    The active account's signer, read on every call. The only key holder the backend uses.

    storage: StorageLike

    Where the library's device key and session state are kept, sealed to the account.

    tiers: RelayTiers

    Settings
    Member Visibility

    On This Page
    Properties