🤖

UNREG BOT

Overview

This JavaScript tool continuously monitors your producer for missing blocks by querying the missingblocks API from Sentnl.io every minute. If your producer misses 12 blocks or more, you will receive notifications and your producer will be unregistered.

Features

Automated Monitoring: Checks the Sentnl.io missingblocks API every minute. Alerts: Optional notifications via Pushover to keep you informed. Producer Unreg: Automatically unregisters the producer if missing blocks are detected.

1. Setup

Configure a unregprod key for your Mainnet and Testnet Producers.

BPs need to configure a key to unreg their producers on mainnet and testnet, the key should be the same on both testnet and mainnet. NOTE: When you pass the key to your container you must pass the private key.

cleos set account permission sentnltestin unregprod EOS8M7yRKgP7Wh6QbHq66YiSJrondQvw2yYGqCEnDN67H6GwkoYtG active
cleos set action permission sentnltestin eosio unregprod unregprod

(Optional) Configure a pushover User and token

If you want to opt in to be send a notification when you producer has been unregistered, you will need to visit https://pushover.net You will need the USER key and TOKEN assigned to your app.

2. Building and running the conainer

To Build the Docker container

docker build -f Dockerfile -t unreg .

To Run the Docker container

docker run --name unreg  \
-d -e "UNREG_KEY=5K96vLHiz3TLV6Cw3Bn7DkPaqLXPXYqQEUCMeBysNFH6uvLwfZB" \
-e "TESTNET_NODE_NAME=sentnlagents" \
-e "MAINNET_NODE_NAME=sentnlagents" \
-e "PUSHOVER=true" \
-e "PUSHOVER_USER=xxxxxxxxxxxxxx" \
-e "PUSHOVER_TOKEN=xxxxxxxxxxxxx" \
-e "TESNET_PRIMARY_BP=172.16.0.71:8890" \
-e "TESNET_BACKUP_BP=172.16.0.71:8891" \
-e "MAINNET_PRIMARY_BP=172.16.0.71:8890" \
-e "MAINNET_BACKUP_BP=172.16.0.71:8890" \
unreg:latest

## ENV Variables

### (Optional variables) Pass in the HTTP address of your Primary and Backup BPs.

If you provide the HTTP addresses of your Primary and Backup Block Producers (BPs), the process will attempt to pause your Primary BP and resume your Backup BP in case of missing blocks. This won’t prevent your producer from being unregistered, but it will minimize the number of missed rounds while your producer is unregistered.

|ENV & ARG                 |Value                   |Description                                                                       |
|--------------------------|------------------------|----------------------------------------------------------------------------------|
|**UNREG_KEY**             |`xxxxxxxxxxxxxxxxxxxxx` | The unreg private key you created in step 1                                      |
|**TESTNET_NODE_NAME**     |`sentnlagents`          | Name of testnet producer                                                         |
|**MAINNET_NODE_NAME**     |`sentnlagents `         | Name of mainnet producer                                                         |
|**PUSHOVER**              |`true` or `false`       | This enables or disables Pushover notifications. Defaults to true.               |
|**PUSHOVER_USER=**        |`xxxxxxxxxxxxxxxxxxxxxx`| Pushover user if using notifications                                             |
|**PUSHOVER_TOKEN**        |`xxxxxxxxxxxxxxxxxxxxxx`| Pushover token if using notifications                                            |
|**TESNET_PRIMARY_BP**     |`xxxxxxxxxxxxxxxxxxxxxx`| Optionally specify Primary and Backup BPs                                        |
|**TESNET_BACKUP_BP**      |`xxxxxxxxxxxxxxxxxxxxxx`| Optionally specify Primary and Backup BPs                                        |
|**MAINNET_PRIMARY_BP**    |`xxxxxxxxxxxxxxxxxxxxxx`| Optionally specify Primary and Backup BPs                                        |
|**MAINNET_BACKUP_BP**     |`xxxxxxxxxxxxxxxxxxxxxx`| Optionally specify Primary and Backup BPs                                        |




### 4. Errors and Logs

To check the logs of your container you can run

```docker logs unreg```

ankh2054/unregbot