Core (full node)

Introduction

This article provides all resources associated to Hathor core (full node).

Releases

• Latest version:
• Deprecated versions: v0.59 and earlier
• Release notes at GitHub

Description

Hathor core is the official and reference client for operating a full node in Hathor Network.

Functionalities

• Full node — i.e., full blockchain (ledger) and network routing
• Tools for development of Hathor system
• Support for integration of external systems with Hathor Network

info

It does not provide wallet and miner. There are specific components of Hathor system for these functionalities, which are used alongside it.

Interfaces

• CLI: for full node operation and development of Hathor.
• P2P: for communication between network nodes.
• HTTP API: for full node operation and communication with network clients (wallets, explorers, miners, etc.).
• WebSocket API: for asynchronous communication with network clients.

Installation

• Install from source code: for the development environment of Hathor core, derived clients, and blueprints.

• Install using Docker: for production environment or for the development of other software.

• Install alongside headless wallet using Docker compose: for production environment or for the development of other software, when it is necessary to run the headless wallet together.

Configuration

For comprehensive full node configuration, see the CLI section.

• Highlighted configurations: complement the CLI help by detailing full node configurations that require further explanation and/or additional steps to use.

• Bootstrap the full node with a snapshot of the ledger: to expedite the synchronization of the full node with its peers.

Troubleshooting

See Core (full node) troubleshooting.

Monitoring

• Monitoring — main reference: to consult about monitoring while operating full nodes.

• Metrics: reference material regarding metrics tracked by Hathor core.

• Install a monitoring system: step-by-step to install a Prometheus-based monitoring system.

• Monitoring system — PoC: example of a Prometheus-based monitoring solution.

Upgrade

See Upgrade Hathor core.

CLI

Hathor core CLI is used to run a full node, and provide tools for the development of Hathor system components. For its comprehensive reference, use the subcommand hathor-cli help. For example:

From source code

poetry run hathor-cli help

Using Docker

docker run hathornetwork/hathor-core help

Now, for all possible configurations for full node operation, use the subcommand hathor-cli run_node --help. For example:

From source code

poetry run hathor-cli run_node --help

Using Docker

docker run hathornetwork/hathor-core run_node --help

P2P interface

P2P API is used for communication between network nodes. It uses a custom protocol over TLS and TCP.

HTTP API

HTTP API is used for full node operation and communication with network clients. Network clients encompass all systems that are not nodes of the network. This includes wallets, explorers, miners, and other integrated systems.

See HTTP API reference.

Websocket API

Websocket API is used for asynchronous communication with network clients, complementing the HTTP API. At the moment, it supports the following use cases:

• Mining: full node notifies miners when a new block was found in the network; and miners send blocks they find to full node.
• Ledger events: full node notifies clients about ledger (blockchain) events — i.e., any change in the state of the ledger, such as new transactions, new blocks, voided inputs, and reorganizations of the best blockchain.
• Transactions history streaming: provides faster loading for wallet applications.

Miscellaneous

• Repository at GitHub

• Official images at Docker Hub

• Report a bug or request a feature: open an issue at Hathor core repository at GitHub.

• Ask for support: if after consulting this documentation, you still need help to operate and use Hathor core, send a message to the #development channel on Hathor Discord server for assistance from Hathor team and community members.