@number0/iroh
    Preparing search index...

    Interface ServicesPresetOptions

    Options for [preset_iroh_services].

    Supply exactly one of api_secret or api_secret_from_env.

    interface ServicesPresetOptions {
        apiSecret?: string;
        apiSecretFromEnv?: boolean;
        endpointSecretKey?: number[];
        relays?: string[];
    }
    Index
    apiSecret? apiSecretFromEnv? endpointSecretKey? relays?
    apiSecret?: string

    Encoded API secret string (services1...). The relay access token is minted from this.

    apiSecretFromEnv?: boolean

    If true, read the API secret from IROH_SERVICES_API_SECRET.

    endpointSecretKey?: number[]

    The endpoint's own identity key (32 bytes) — not your API secret. The access token is scoped to it, so pass the same key you persist for your endpoint's identity. A fresh key is generated when omitted.

    Set the key here, not via EndpointBuilder.secretKey: a key applied after this preset would replace the one the token is scoped to. Doing that throws — even for bit-identical bytes — rather than silently failing auth: this preset pins the key.

    relays?: string[]

    Your project's relay URLs. Defaults to the n0 public relays when omitted, matching iroh_services::preset(). Passing an empty list is an error rather than a silent fallback — that is nearly always a filtered list that came back empty.

    Settings
    Member Visibility

    On This Page
    Properties