https://github.com/checkernetwork/node
Station is a visionary network that connects your computer's idle resources to the Filecoin network and rewards you with FIL
https://github.com/checkernetwork/node
Last synced: about 1 year ago
JSON representation
Station is a visionary network that connects your computer's idle resources to the Filecoin network and rewards you with FIL
- Host: GitHub
- URL: https://github.com/checkernetwork/node
- Owner: CheckerNetwork
- License: other
- Created: 2023-02-23T13:53:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T14:52:49.000Z (about 1 year ago)
- Last Synced: 2025-04-11T15:54:19.229Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://filstation.app
- Size: 31.9 MB
- Stars: 35
- Watchers: 3
- Forks: 13
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
:artificial_satellite:
Checker Node
> Checker Node is a node implementation for the
> [Checker Network](https://checker.network), suitable for running on all kinds
> of servers..
[](https://github.com/CheckerNetwork/node/actions/workflows/ci.yml)
## Deployment
Checker Node supports different deployment options:
- [Docker](#docker)
- [Manual Deployment (Ubuntu)](#manual-deployment-ubuntu)
## Installation
> **Note**: Checker Node requires Node.js, we recommend using the latest LTS
> version. You can install Node.js using your favorite package manager or get
> the official installer from
> [Node.js downloads](https://nodejs.org/en/download/).
With Node.js installed, run `npm` to install Checker Node.
```bash
$ npm install -g @checkernetwork/node
```
## Usage
```bash
$ FIL_WALLET_ADDRESS=... PASSPHRASE=... checker
```
## Common Configuration
Checker Node is configured using environment variables (see
[The Twelve-Factor App](https://12factor.net/config)).
The following configuration options are shared by all Checker commands:
- `$CACHE_ROOT` _(string; optional)_: Checker stores temporary files (e.g.
cached data) in this directory. Defaults to
- Linux: `${XDG_CACHE_HOME:-~/.cache}/checker-network-node`
- macOS: `~/Library/Caches/network.checker.node`
- Windows: `%TEMP%/Checker Network Node`
- `$STATE_ROOT` _(string; optional)_: Checker stores logs and subnet state in
this directory. Defaults to
- Linux: `${XDG_STATE_HOME:-~/.local/state}/checker-network-node`
- macOS: `~/Library/Application Support/network.checker.node`
- Windows: `%LOCALAPPDATA%/Checker Network Node`
**IMPORTANT:** The`$STATE_ROOT` directory must be local to the computer
running the Checker. This directory must not be shared with other computers
operated by the user, e.g. via Windows Domain profile or cloud storage like
iCloud Drive, Dropbox and OneDrive.
## Commands
### `$ checker`
Start a new Checker process. The Checker will run in foreground and can be
terminated by pressing Ctrl+C.
This command has the following additional configuration in addition to common
the configuration options described in
[Common Configuration](#common-configuration):
- `FIL_WALLET_ADDRESS` _(string; required)_: Address of the Filecoin wallet that
will receive rewards. The value must be a mainnet address starting with
`f410`, `0x`.
`f1` addresses currently are not supported. Rewards for Checker operators are
administered by a FEVM smart contract. It is currently technically complex to
make payments to f1 addresses.
If you just want to give `core` a quick spin, you can use the address
`0x000000000000000000000000000000000000dEaD`. Please note that any earnings
sent there will be lost.
- `PASSPHRASE` _(string; optional)_: a passphrase to protect the Checker
instance private key stored in a file inside the `STATE_ROOT` directory.
- `SUBNET_FILTER` _(string; optional)_: Run only the subnet with the given name.
Eg:
- `SUBNET_FILTER=spark`
This command outputs metrics and activity events:
```bash
$ checker
{
"totalJobsCompleted": 161,
"rewardsScheduledForAddress": "0.041033208757289921"
}
[4/19/2023, 9:26:54 PM] INFO Saturn Node will try to connect to the Saturn Orchestrator...
[4/19/2023, 9:26:54 PM] INFO Saturn Node was able to connect to the Orchestrator and will now start connecting to the Saturn network...
...
```
```bash
$ checker --json
{"type":"jobs-completed","total":161}
{"type":"activity:info","subnet":"Saturn","message":"Saturn Node will try to connect to the Saturn Orchestrator..."}
{"type":"activity:info","subnet":"Saturn","message":"Saturn Node was able to connect to the Orchestrator and will now start connecting to the Saturn network..."}
...
```
For the JSON output, the following event types exist:
- `jobs-completed`
- `total`
- `activity:info`
- `subnet`
- `message`
- `activity:error`
- `subnet`
- `message`
Set the flag `--experimental` to run subnets not yet considered safe for
production use. _Run this at your own risk!_
Checker Modules currently in experimental mode:
- [Arweave](https://github.com/CheckerNetwork/arweave-checker/)
- [Walrus](https://github.com/CheckerNetwork/walrus-checker/)
### `$ checker --help`
Show help.
```bash
$ checker --help
Usage: checker [options]
Options:
-j, --json Output JSON [boolean]
--experimental Also run experimental subnets [boolean]
--recreateCheckerIdOnError Recreate Checker ID if it is corrupted
[boolean]
-v, --version Show version number [boolean]
-h, --help Show help [boolean]
```
### `$ checker --version`
Show version number.
```bash
$ checker --version
@checkernetwork/node: 1.0.1
```
## Docker
Deploy Checker with [Docker](https://www.docker.com/). Please replace
`FIL_WALLET_ADDRESS` and ensure the passed `state` folder is persisted across
machine restarts.
```bash
$ docker run \
--name checker \
--detach \
--env FIL_WALLET_ADDRESS=0x000000000000000000000000000000000000dEaD \
-v ./state:/home/node/.local/state/
ghcr.io/CheckerNetwork/node
```
## Manual Deployment (Ubuntu)
On a fresh [Ubuntu](https://ubuntu.com/) machine:
```bash
# Install node.js
$ curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash - &&\
sudo apt-get install -y nodejs
# Install core
$ npm install -g @checkernetwork/node
# Create systemd service
# Don't forget to replace FIL_WALLET_ADDRESS and User
$ sudo tee /etc/systemd/system/checker.service > /dev/null <