# Base Configuration

Configure WorkerBee for different environments and use cases.

# 🔧 Basic Configuration

# WorkerBee Config Interface

export interface IStartConfiguration {
  /**
   * Wax chain options
   */
  chainOptions?: Partial<{
    /**
     * Endpoint for all of the API requests
     *
     * @default "https://api.hive.blog/"
     * @type {string}
     */
    apiEndpoint: string;
    /**
     * Endpoint for all of the REST API requests
     *
     * @default "https://api.syncad.com"
     * @type {string}
     */
    restApiEndpoint: string;
    /**
     * Timeout for all of the API requests in milliseconds.
     * Set to 0 to disable timeout
     *
     * @default 2_000
     * @type {number}
     */
    apiTimeout: number;
  }>;

  /**
   * Explicit instance of chain interface to be used by workerbee.
   * This option is exclusive to chainOptions
   */
  explicitChain?: IHiveChainInterface;
}

# 🛰️ API Endpoint Configuration

# Popular Hive API Endpoints

You can find a full list of Hive API endpoints in the official Hive documentation and then choose the one that best fits your needs:

Consensus Node Requirements

WorkerBee with standard filters requires connection to a consensus node (full node) for optimal functionality. Consensus nodes provide:

Complete blockchain history and block data access
Real-time streaming of all operations and transactions
Full account state and balance information
Historical data for analysis and monitoring

Light API nodes may have limited functionality with WorkerBee filters, particularly those monitoring blockchain infrastructure, account changes, or requiring historical data access.

import { WorkerBee } from "@hiveio/workerbee";

// Choose based on your location and requirements
const bot = new WorkerBee({
  chainOptions: {
    apiEndpoint: 'https://api.openhive.network' // Consensus node
  }
});

await bot.start();

# Recommended Consensus Nodes

The following public endpoints provide full consensus node functionality:

https://api.hive.blog - Primary Hive API (consensus node)
https://api.openhive.network - OpenHive network (consensus node)
https://anyx.io - Community consensus node
https://rpc.ausbit.dev - Australian consensus node
https://api.hive.blue - Consensus node with high availability

Choose an endpoint geographically close to your application for better performance.

# 🕒 Timing Configuration

# Timeout Configuration

Sometimes you need to adjust the timeout settings based on your network conditions:

import { WorkerBee } from "@hiveio/workerbee";

// Choose based on your location and requirements
const bot = new WorkerBee({
  chainOptions: {
    apiTimeout: 0
  }
});

await bot.start();

Setting apiTimeout to 0 disables the timeout, which can be useful for long-running requests or low-quality networks.

# 🪐 Wax chain usage

As shown in the WorkerBee Config Interface, you can provide an explicit chain that will be used for performing all API calls and data transformations. The Wax Chain instance is also accessible via the chain property on the WorkerBee instance.

If an explicit chain is not provided (which is optional), a default chain instance will be created when the start method is called.

Remember that before starting the bot, if no explicit chain was provided, the chain property will be undefined.