polytone-keepalive's Introduction

polytone-keepalive

This is a script to keep Polytone's IBC light clients alive using the open-source IBC relayer Hermes.

See the IBC-Go docs on light client pauses. Essentially, if a client is not used for a period of time (its "trust period"), it will be paused, requiring a governance proposal to restart it. This script will check the light clients specified and use Hermes to update recently inactive clients, keeping them alive to prevent needing to restart them via governance proposals. If it fails to do so for any reason, it will send a notification to a Discord channel for troubleshooting.

Usage

This expects Polytone connections to already exist. Follow this guide to do so.

Install Hermes and configure it.
Install the dependencies:
```
npm install
```

Create config.toml from config.toml.example and fill in the values, configuring the same chains as in your Hermes config as well as the polytone client connections to keep alive. Chain names must match known chain names from the Chain Registry's list of chains in chains.ts.

[[chains]]
name = "<CHAIN A NAME>"
rpc = "<CHAIN A RPC>"
notify_balance_threshold = 1000000

[[chains]]
name = "<CHAIN B NAME>"
rpc = "<CHAIN B RPC>"
notify_balance_threshold = 1000000

[[connections]]
chain_a = "<CHAIN A NAME>"
client_a = "<CHAIN A IBC CLIENT>"

chain_b = "<CHAIN B NAME>"
client_b = "<CHAIN B IBC CLIENT>"

Create a Discord webhook by following this guide:

https://discordjs.guide/popular-topics/webhooks.html#creating-webhooks

Then, add the webhook URL to config.toml.
Run the script:
```
npm run keepalive
```
Set up a cron job to run this script periodically. For example, to run it every 3 days:
```
0 0 */3 * * cd /path/to/polytone-keepalive && npm run keepalive
```

Recommend Projects

da0-da0 / polytone-keepalive Goto Github PK