Skip to main content

Core (full node)

Introduction​

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

Releases​

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
  • SDK for blueprint development
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​

Configuration​

For comprehensive full node configuration, see the CLI section.

Troubleshooting​

See Core (full node) troubleshooting.

Monitoring​

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:

poetry run hathor-cli help

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

poetry run hathor-cli 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.

Blueprint SDK​

Provides framework, API, and testing tools for blueprint development.

Miscellaneous​