{"id":30621398,"url":"https://github.com/syscoin/sentinel","last_synced_at":"2025-08-30T14:29:14.961Z","repository":{"id":43464753,"uuid":"110764280","full_name":"syscoin/sentinel","owner":"syscoin","description":"SyscoinCore Sentinel Engine","archived":false,"fork":false,"pushed_at":"2023-12-08T18:29:48.000Z","size":183,"stargazers_count":5,"open_issues_count":1,"forks_count":13,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-04-13T03:30:08.948Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/syscoin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-11-15T00:54:57.000Z","updated_at":"2024-01-26T23:50:08.000Z","dependencies_parsed_at":"2023-12-08T19:47:41.553Z","dependency_job_id":null,"html_url":"https://github.com/syscoin/sentinel","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/syscoin/sentinel","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/syscoin%2Fsentinel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/syscoin%2Fsentinel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/syscoin%2Fsentinel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/syscoin%2Fsentinel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/syscoin","download_url":"https://codeload.github.com/syscoin/sentinel/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/syscoin%2Fsentinel/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272860699,"owners_count":25005478,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-30T02:00:09.474Z","response_time":77,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-08-30T14:28:14.482Z","updated_at":"2025-08-30T14:29:14.952Z","avatar_url":"https://github.com/syscoin.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Syscoin Sentinel\n\n[![Build Status](https://travis-ci.org/syscoin/sentinel.svg?branch=master)](https://travis-ci.org/syscoin/sentinel)\n\n\u003e An automated governance helper for Syscoin Masternodes.\n\nSentinel 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.\n\n## Table of Contents\n- [Install](#install)\n  - [Dependencies](#dependencies)\n- [Usage](#usage)\n- [Configuration](#configuration)\n- [Troubleshooting](#troubleshooting)\n- [Maintainer](#maintainer)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Install\n\nThese instructions cover installing Sentinel on Ubuntu 18.04 / 20.04.\n\n### Dependencies\n\nUpdate system package list and install dependencies:\n\n    $ sudo apt-get update\n    $ sudo apt-get -y install git python3 virtualenv\n\nMake sure Python version 3.6.x or above is installed:\n\n    python3 --version\n\nMake sure the local Syscoin daemon running is at least version 4.3.0.\n\n    $ syscoind --version | head -n1\n\n### Install Sentinel\n\nClone the Sentinel repo and install Python dependencies.\n\n    $ git clone https://github.com/syscoin/sentinel.git \u0026\u0026 cd sentinel\n    $ virtualenv -p $(which python3) ./venv\n    $ ./venv/bin/pip install -r requirements.txt\n\n## Usage\n\nSentinel is \"used\" as a script called from cron every minute.\n\n### Set up Cron\n\nSet up a crontab entry to call Sentinel every minute:\n\n    $ crontab -e\n\nIn the crontab editor, add the lines below, replacing '/path/to/sentinel' to the path where you cloned sentinel to:\n\n    * * * * * cd /path/to/sentinel \u0026\u0026 ./venv/bin/python bin/sentinel.py \u003e/dev/null 2\u003e\u00261\n\n### Test Configuration\n\nTest the config by running tests:\n\n    $ ./venv/bin/py.test ./test\n\nWith all tests passing and crontab setup, Sentinel will stay in sync with syscoind and the installation is complete\n\n## Configuration\n\nAn alternative (non-default) path to the `syscoin.conf` file can be specified in `sentinel.conf`:\n\n    syscoin_conf=/path/to/syscoin.conf\n\n## Troubleshooting\n\nTo view debug output, set the `SENTINEL_DEBUG` environment variable to anything non-zero, then run the script manually:\n\n    $ SENTINEL_DEBUG=1 ./venv/bin/python bin/sentinel.py\n\n## PoDA\nTo run PoDA fill out the 3 environment variables inside of tananbaum-up.sh (for testnet) from your cloudflare R2 account:\nPODA_DB_ACCOUNT_ID=\nPODA_DB_KEY_ID=\nPODA_DB_ACCESS_KEY=\n\nThen simply run:\n\n    $ make tanenbaum-up\n\nTo shutdown:\n\n    $ make tanenbaum-down\n\n\nTo cleanup:\n\n    $ make tanenbaum-clean\n\n\nThis 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).\n\nFormat for fetching (example):\n\n    $ https://localhost/vh/01155b5f6fc6aad6e3551301462fa27748553cc75a64841ae7beaf335713ccb8\n    where `01155b5f6fc6aad6e3551301462fa27748553cc75a64841ae7beaf335713ccb8` is the versionhash of a blob.\n\n## Maintainer\n\n[@sidhujag](https://github.com/sidhujag)\n\n## Contributing\n\nPlease follow the [Syscoin guidelines for contributing](https://github.com/syscoin/syscoin/blob/master/CONTRIBUTING.md).\n\nSpecifically:\n\n* [Contributor Workflow](https://github.com/syscoin/syscoin/blob/master/CONTRIBUTING.md#contributor-workflow)\n\n    To contribute a patch, the workflow is as follows:\n\n    * Fork repository\n    * Create topic branch\n    * Commit patches\n\n    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.\n\n    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/).\n\n## License\n\nReleased under the MIT license, under the same terms as Syscoin itself. See [LICENSE](LICENSE) for more info.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyscoin%2Fsentinel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsyscoin%2Fsentinel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyscoin%2Fsentinel/lists"}