Documentation
    Preparing search index...

    Interface CreateNodeOptions

    Node-specific options accepted by createNode, on top of the platform-agnostic NodeOptions.

    interface CreateNodeOptions {
        addrs?: string[];
        agentsReceivedCallback: AgentsReceivedCallback;
        bootstrapRelays?: string[];
        connectedToRelayCallback?: ConnectedToRelayCallback;
        handshakeTimeoutMs?: number;
        iceServerUrls?: string[];
        id?: string;
        messageHandler: MessageHandler;
        networkAccessBytes?: NetworkAccessBytes;
        networkAccessHandler: NetworkAccessHandler;
        peerConnectedCallback: PeerConnectedCallback;
        peerDisconnectedCallback?: PeerDisconnectedCallback;
    }

    Hierarchy (View Summary)

    Index

    Properties

    addrs? agentsReceivedCallback bootstrapRelays? connectedToRelayCallback? handshakeTimeoutMs? iceServerUrls? id? messageHandler networkAccessBytes? networkAccessHandler peerConnectedCallback peerDisconnectedCallback?

    Properties

    addrs?: string[]

    Raw libp2p multiaddr listen addresses, e.g. "/p2p-circuit", "/webrtc".

    For testing only. In production leave this unset and let the transport use defaultNodeListenAddrs.

    Defaults to defaultNodeListenAddrs.

    agentsReceivedCallback: AgentsReceivedCallback

    Called when agent-info bytes have been received from a peer.

    bootstrapRelays?: string[]

    Relay multiaddrs to dial at startup. The transport invokes NodeOptions.connectedToRelayCallback once the dialable circuit address has been received.

    connectedToRelayCallback?: ConnectedToRelayCallback

    Called when the bootstrap connection to a relay is complete.

    handshakeTimeoutMs?: number

    Timeout in milliseconds for the outbound access handshake response. Defaults to 10_000 ms.

    iceServerUrls?: string[]

    List of ICE server URLs needed for establishing direct connections.

    id?: string

    Optional human-readable identifier attached to log records.

    messageHandler: MessageHandler

    Handler for incoming application messages.

    networkAccessBytes?: NetworkAccessBytes

    Network access bytes sent in handshake responses (and outbound handshakes for nodes).

    Defaults to new Uint8Array([0]) — an empty array breaks the counter-handshake because .send() would be a no-op.

    networkAccessHandler: NetworkAccessHandler

    Handler invoked for every incoming access handshake. Returns true to grant access, false to deny. Denials are sticky for the session.

    peerConnectedCallback: PeerConnectedCallback

    Called when an inbound peer completes the access handshake. Fire-and-forget.

    peerDisconnectedCallback?: PeerDisconnectedCallback

    Called when a peer disconnects. Fire-and-forget.

    Settings

    Member Visibility

    On This Page

    Properties