Class EndpointBuilder

A mutable handle to an endpoint builder.

Mirrors the uniffi EndpointBuilder. A "preset" in JS is simply any function (builder: EndpointBuilder) => void — call one of the built-in [presetN0] / [presetMinimal] / [presetN0DisableRelay] helpers (which install the crypto provider) and then layer on your own configuration.

const b = Endpoint.builder()
presetMinimal(b)
b.alpns([alpn])
const ep = await b.bind()

Constructors

constructor

Methods

alpns applyMinimal applyN0 applyN0DisableRelay bind bindAddr relayMode secretKey

Constructors

constructor

Methods

alpns

  • alpns(alpns: number[][]): void

    Set the advertised ALPNs.

    Parameters

    • alpns: number[][]

    Returns void

applyMinimal

  • applyMinimal(): void

    Replay the minimal preset (crypto provider only, no external deps).

    Returns void

applyN0

  • applyN0(): void

    Replay the n0 production preset (relays + discovery + crypto provider).

    Returns void

applyN0DisableRelay

  • applyN0DisableRelay(): void

    Replay the n0 preset with relays disabled.

    Returns void

bind

bindAddr

  • bindAddr(addr: string): void

    Set the address the endpoint binds to (host:port).

    Parameters

    • addr: string

    Returns void

relayMode

secretKey

  • secretKey(bytes: number[]): void

    Set the endpoint secret key (32 bytes).

    Parameters

    • bytes: number[]

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods