tether-wrk-base

A base worker class extending bfx-wrk-base.

Introduction

The tether-wrk-base class is designed to initialize and configure services for the base worker. It simplifies the setup of facilities such as service storage and networking, starts an RPC server, and provides methods for handling RPC requests.

Architecture

To run this worker, the init() function must be called in the constructor during the worker's initialization.

The worker is run using bfx-svc-boot-js. The initial code is written in worker.js, which is used to load the code in workers/base.wrk.tether.js via a Bash command:

node worker.js --wtype tether-wrk-base --env development --debug true

For more details, refer to the repository bfx-svc-boot-js.

Documentation

Methods

init()

This method initializes the class by:

• Loading the configuration from the config/common.json file.
• Setting up facilities for service storage and networking.
• Configuring the logger with the appropriate log level (debug or info).

getRpcKey()

This method returns the RPC public key of the worker.

getRpcClientKey()

This method returns the RPC client key of the worker.

_startRpcServer()

This method starts the RPC server using the hp-svc-facs-net facility. It can be overridden if extra logic is needed while starting the RPC server.

_start(cb)

This method manages the complete startup process of the worker:

• It calls the parent class's _start() method to initialize the base components.
• It starts the RPC server and defines an RPC function ping to test if the worker is operational.
• It saves the RPC server's public key in the worker's status.

Configuration

• Configuration is loaded from the config/common.json file. Example of common.json:

  {
    "debug": 0
  }

  The debug key controls the logging level in the worker.

• The class sets up the following facilities:

  • hp-svc-facs-store: A facility that exposes persistent Holepunch datastores. This facility does not require any additional configuration files.

  • hp-svc-facs-net: A facility that provides access to the Holepunch networking stack (Hyperswarm). Its configuration is loaded from config/facs/net.config.json. Example of net.config.json:

    {
      "r0": {
        "allow": [],
        "allowLocal": true
      }
    }

    • allow: An array used as an allowlist to validate incoming connections based on their remotePublicKey.
    • allowLocal: If set to true, the function allows connections originating from the local IP address.

• The setup-config.sh script is used to convert all config.json.example files into config.json.