Skip to content
Belma Gutlic edited this page Apr 3, 2020 · 9 revisions

Welcome to the Hactar wiki!

Hactar wiki covers complete documentation on Hactar architecture including frontend, backend and daemon application.

Hactar is a miner analyzer for Filecoin network. Filecoin is a blockchain network for hosting files which has miners that get paid for storing files and mining blocks. As miners have the clear incentive to make money on the provided service, we want to make sure they keep up with it and get the right statistics on their performance, how much money they are making and how to possibly improve that. As part of Filecoin’s Wave 1 development grant, NodeFactory built this app.

Contents

Overview

Hactar architecture consists of:

  • Frontend web application (React)
  • Backend application (Node.js)
  • Daemon application running along user’s lotus and miner node (Go)

Daemon application is built in Go for easier integration with Filecoin node software such as lotus. However, for this version it is a separate standalone module but in the future it might be a part of some kind of plugin system.

Hactar backend system is hosted by us on a remote server and it is used for storing actively sent data by the daemon application. This data is then processed by the frontend application and displayed to the user.

Note that data is reported in intervals depending on the data type. For now these are fixed intervals (1 to 15 mintues) but there is a possibility to enable customization of those settings per user.

List of data that is reported:

  • Lotus node version (and if update is available)
  • Miner power
  • Sector size
  • Number of sectors
  • Total power
  • Owner address
  • Balance
  • Mining rewards history (graph)
  • Uptime history (chart)
  • Disk space history (chart)
  • Deals

Also, Hactar serves as node monitoring service where email is sent in case a miner node is offline. Email notifications can be disabled per node.

Getting started

You can start using Hactar free of charge with our hosted services here. Steps for setup:

  1. Register on Hactar website
  2. Download daemon release.
  3. Start Hactar daemon on your server where miner is running
  4. Login in daemon with credentials used on website and leave it running for reports!

In case you want to self host the service, follow the instructions in our repositories:

Third party usage

List of third party applications that Hactar is using.

CI/CD

On backend we use Circle CI and for daemon application and frontend we use Github actions. On backend it runs tasks such as eslint, tests and building Docker image. For daemon application it is used to make and upload the release asset.

Hactar landing page is deployed to IPFS. Frontend to Netlify and backend to our Kubernetes cluster.

Email service

For sending emails Sendinblue service is used.

Error tracking

Sentry is used to track errors that could happen on user end while running daemon application.

Issues

In case you have any issues with Hactar, feel free to join our Discord and ask us in the #hactar channel. Alternatively, feel free to open issue on Github in the appropriate repo (backend/frontend/daemon).

Clone this wiki locally