Class Reticulum

constructor

• new Reticulum(
      config?: {
          compressionProvider?: Object;
          storageAdapter?: Object;
          useImplicitProof?: boolean;
      },
  ): Reticulum

  Initializes the Reticulum engine.

  Parameters

  • config: {
        compressionProvider?: Object;
        storageAdapter?: Object;
        useImplicitProof?: boolean;
    } = {}

    Configuration options for the node.

    • OptionalcompressionProvider?: Object

      Engine for handling bz2 Resources (e.g., for rngit).

    • OptionalstorageAdapter?: Object

      Interface for persisting identities and caches.

    • OptionaluseImplicitProof?: boolean

      §6.5.2 PROOF form for opportunistic DATA: true (default, upstream) emits the 64-byte implicit body; false emits the 96-byte explicit body.

  Returns Reticulum

compressionProvider

localDestinations

storage

transport

useImplicitProof

addInterface

• addInterface(rnsInterface: Interface, isDefault?: boolean): void

  Attaches a physical or virtual network interface to the router.

  Parameters

  • rnsInterface: Interface

    An instantiated interface (TCP, WebSocket, RNode)

  • isDefault: boolean = false

    If true, unroutable packets fallback to this interface

  Returns void

broadcast

• broadcast(packet: Packet): void

  Broadcasts a packet from a specific destination to the mesh.

  Parameters

  • packet: Packet

  Returns void

deregisterDestination

• deregisterDestination(destination: Destination): void

  Removes a local destination, ceasing all incoming traffic to that application endpoint.

  Parameters

  • destination: Destination

  Returns void

registerDestination

• registerDestination(destination: Destination): void

  Binds an application-level Destination to the network. When your web components spin up and instantiate a Yjs provider, this is where they register their collaborative endpoints to receive traffic.

  Parameters

  • destination: Destination

  Returns void

removeInterface

• removeInterface(rnsInterface: Interface): void

  Removes an interface and purges its routes from the TransportCore.

  Parameters

  • rnsInterface: Interface

    An instantiated interface (TCP, WebSocket, RNode)

  Returns void