https://github.com/volumefi/paloma-validating

checks if the local machine is validating and reports it via web server
https://github.com/volumefi/paloma-validating

Last synced: about 2 months ago
JSON representation

checks if the local machine is validating and reports it via web server

• Host: GitHub
• URL: https://github.com/volumefi/paloma-validating
• Owner: VolumeFi
• License: apache-2.0
• Created: 2023-02-15T17:16:31.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-25T19:37:54.000Z (9 months ago)
• Last Synced: 2024-04-26T20:48:39.314Z (9 months ago)
• Language: JavaScript
• Size: 21.5 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Paloma Checker

This project is a simple Node.js script that periodically checks the status of a Paloma server and reports its validation status over HTTP.

Prerequisites

Install Node.js (>= v14.17.3)

A running Paloma network node

Set up a .env file with the necessary environment variables:

DISABLE_VOTE_POWER:set to true if you don't want validator voting power to impact validation

START_IN_PAUSED_STATE: set to true if you want the validating flag set to true at startup

PORT: set the server's listening port

Getting Started

Clone the repository: git clone 

Navigate to the project's root folder cd paloma-checker

Install the dependencies: npm install

Modify the .env file based on the prerequisites

Start the server: node index.js

The Paloma Checker will report the validating status over HTTP at http://:/. Use the following endpoints to control validating:

/pause: Sets the validating flag to true.

/unpause: Performs the original functionality.

Configuration

Configuration is done through the .env file with the following environment variables:

DISABLE_VOTE_POWER: set to true if you don't want validator voting power to impact validation (default: false)

START_IN_PAUSED_STATE: set to true if you want the validating flag set to true at startup (default: false)

PORT: port for the server to listen on (default: 3000)