https://github.com/syscoin/sentinel

SyscoinCore Sentinel Engine
https://github.com/syscoin/sentinel

Last synced: 9 months ago
JSON representation

SyscoinCore Sentinel Engine

• Host: GitHub
• URL: https://github.com/syscoin/sentinel
• Owner: syscoin
• License: mit
• Created: 2017-11-15T00:54:57.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-12-08T18:29:48.000Z (over 2 years ago)
• Last Synced: 2024-04-13T03:30:08.948Z (about 2 years ago)
• Language: Python
• Size: 179 KB
• Stars: 5
• Watchers: 12
• Forks: 13
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Syscoin Sentinel

[![Build Status](https://travis-ci.org/syscoin/sentinel.svg?branch=master)](https://travis-ci.org/syscoin/sentinel)

> An automated governance helper for Syscoin Masternodes.

Sentinel is an autonomous agent for persisting, processing and automating Syscoin governance objects and tasks. It is a Python application which runs alongside the Syscoin instance on each Syscoin Masternode.

## Table of Contents

- [Install](#install)

  - [Dependencies](#dependencies)

- [Usage](#usage)

- [Configuration](#configuration)

- [Troubleshooting](#troubleshooting)

- [Maintainer](#maintainer)

- [Contributing](#contributing)

- [License](#license)

## Install

These instructions cover installing Sentinel on Ubuntu 18.04 / 20.04.

### Dependencies

Update system package list and install dependencies:

    $ sudo apt-get update

    $ sudo apt-get -y install git python3 virtualenv

Make sure Python version 3.6.x or above is installed:

    python3 --version

Make sure the local Syscoin daemon running is at least version 4.3.0.

    $ syscoind --version | head -n1

### Install Sentinel

Clone the Sentinel repo and install Python dependencies.

    $ git clone https://github.com/syscoin/sentinel.git && cd sentinel

    $ virtualenv -p $(which python3) ./venv

    $ ./venv/bin/pip install -r requirements.txt

## Usage

Sentinel is "used" as a script called from cron every minute.

### Set up Cron

Set up a crontab entry to call Sentinel every minute:

    $ crontab -e

In the crontab editor, add the lines below, replacing '/path/to/sentinel' to the path where you cloned sentinel to:

    * * * * * cd /path/to/sentinel && ./venv/bin/python bin/sentinel.py >/dev/null 2>&1

### Test Configuration

Test the config by running tests:

    $ ./venv/bin/py.test ./test

With all tests passing and crontab setup, Sentinel will stay in sync with syscoind and the installation is complete

## Configuration

An alternative (non-default) path to the `syscoin.conf` file can be specified in `sentinel.conf`:

    syscoin_conf=/path/to/syscoin.conf

## Troubleshooting

To view debug output, set the `SENTINEL_DEBUG` environment variable to anything non-zero, then run the script manually:

    $ SENTINEL_DEBUG=1 ./venv/bin/python bin/sentinel.py

## PoDA

To run PoDA fill out the 3 environment variables inside of tananbaum-up.sh (for testnet) from your cloudflare R2 account:

PODA_DB_ACCOUNT_ID=

PODA_DB_KEY_ID=

PODA_DB_ACCESS_KEY=

Then simply run:

    $ make tanenbaum-up

To shutdown:

    $ make tanenbaum-down

To cleanup:

    $ make tanenbaum-clean

This will start syscoind, sync it up, and setup a cronjob internally to push PoDA blobs to R2 which rollups can use. It will also start a server which allows you to request PoDA blobs via a versionhash. It is running on port 80 that is accessible by localhost (you may serve this to the web).

Format for fetching (example):

    $ https://localhost/vh/01155b5f6fc6aad6e3551301462fa27748553cc75a64841ae7beaf335713ccb8

    where `01155b5f6fc6aad6e3551301462fa27748553cc75a64841ae7beaf335713ccb8` is the versionhash of a blob.

## Maintainer

[@sidhujag](https://github.com/sidhujag)

## Contributing

Please follow the [Syscoin guidelines for contributing](https://github.com/syscoin/syscoin/blob/master/CONTRIBUTING.md).

Specifically:

* [Contributor Workflow](https://github.com/syscoin/syscoin/blob/master/CONTRIBUTING.md#contributor-workflow)

    To contribute a patch, the workflow is as follows:

    * Fork repository

    * Create topic branch

    * Commit patches

    In general commits should be atomic and diffs should be easy to read. For this reason do not mix any formatting fixes or code moves with actual code changes.

    Commit messages should be verbose by default, consisting of a short subject line (50 chars max), a blank line and detailed explanatory text as separate paragraph(s); unless the title alone is self-explanatory (like "Corrected typo in main.cpp") then a single title line is sufficient. Commit messages should be helpful to people reading your code in the future, so explain the reasoning for your decisions. Further explanation [here](http://chris.beams.io/posts/git-commit/).

## License

Released under the MIT license, under the same terms as Syscoin itself. See [LICENSE](LICENSE) for more info.