Filecoin Plus Tracker Bot
💡 Deployment: Currently the bot is running via Github actions here.
This repository contains the source code for the Filecoin Plus Tracker Bot. The program is responsible for monitoring the Filecoin blockchain and tracking the state and events for the Filecoin Plus program. Tracked data is stored in a GitHub repository acting as public registry.
Getting Started
This section provides instructions on how to install and configure the bot.
Prerequisites
- Node.js v16 or higher
- NPM
Installation
To install the project, clone the repository and install the dependencies:
git clone https://github.com/threesigmaxyz/filplus-allocator-bot.git
npm installConfiguration
Set the following environment variables below according to the specified requirements.
| Environment Variable | Description | Example Values |
|---|---|---|
| GITHUB_TOKEN | A PAT required to serve as authentication for read and write permissions | github_pat_******************* |
| REPO_OWNER | The name of the owner account of the repository | filecoin-project |
| REPO_NAME | The repository identifier where we want to persist the data | Allocator-Registry |
| REPO_BRANCH | The path of the location of the allocators | filecoin-registry-bot |
| LOTUS_URL | The URL of the Lotus node to connect to | https://api.node.glif.io/rpc/v1 |
| LOTUS_TOKEN | The token of the Lotus node to connect to | ******************* |
Usage
To run the bot, execute the following command:
npm run startRun in GitHub Actions
To run the bot in GitHub Actions, follow the steps below:
- Copy the contents of the example workflow file to your repository.
- Set the
GITHUB_TOKEN,GITHUB_TOKENandGITHUB_TOKENin your repository secrets.
This will setup an hourly schedule to run the bot, additionally, you can manually trigger the workflow to run.
About Us
Three Sigma is a venture builder firm focused on blockchain engineering, research, and investment. Our mission is to advance the adoption of blockchain technology and contribute towards the healthy development of the Web3 space. If you are interested in joining our team, please contact us here.