From cb2c7c10075ee231f5e3cb581096ebfd3c46389b Mon Sep 17 00:00:00 2001 From: Techno Freak Date: Thu, 28 Apr 2022 16:16:36 +0300 Subject: [PATCH] chore: updated README --- README.md | 30 ++++++++++++++++++++++++++---- 1 file changed, 26 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8d9a152..458cbef 100644 --- a/README.md +++ b/README.md @@ -78,13 +78,13 @@ It subscribes to Tendermint JSON-RPC endpoint through Websockets (see [this](htt You can pass the artuments to the executable file to configure it. Here is the parameters list: -- `--node` - the gRPC node URL. Defaults to `localhost:9090` -- `--log-devel` - logger level. Defaults to `info`. You can set it to `debug` to make it more verbose. +- `--node` - the gRPC node URL. Defaults to `localhost:9090`. +- `--log-devel` - logger level. Defaults to `info`. You can set it to `debug` or even `trace` to make it more verbose. - `--telegram-token` - Telegram bot token - `--telegram-chat` - Telegram user or chat ID - `--slack-token` - Slack bot token - `--slack-chat` - Slack user or chat ID -- `--mintscan-prefix` - This bot generates links to Mintscan for validators, using this prefix. Links have the following format: `https://mintscan.io//validator/`. Defaults to `persistence`. +- `--mintscan-prefix` - This bot generates links to Mintscan for validators, using this prefix. Links have the following format: `https://mintscan.io//validator/`. - `--query` - See below. @@ -98,9 +98,25 @@ For example, we're using this tool to monitor new delegations for our validator ``` # sentvaloper1sazxkmhym0zcg9tmzvc4qxesqegs3q4u66tpmf is SOLAR Validator on Sentinel +# sent1sazxkmhym0zcg9tmzvc4qxesqegs3q4u9l5v5q is SOLAR Validator's self delegated wallet on Sentinel query = [ + # claiming rewards from validator's wallet + "withdraw_rewards.validator = 'sentvaloper1sazxkmhym0zcg9tmzvc4qxesqegs3q4u66tpmf'", + # incoming delegations from validator "delegate.validator = 'sentvaloper1sazxkmhym0zcg9tmzvc4qxesqegs3q4u66tpmf'", - "unbond.validator = 'sentvaloper1sazxkmhym0zcg9tmzvc4qxesqegs3q4u66tpmf'" + # redelegations from and to validator + "redelegate.source_validator = 'sentvaloper1sazxkmhym0zcg9tmzvc4qxesqegs3q4u66tpmf'", + "redelegate.destination_validator = 'sentvaloper1sazxkmhym0zcg9tmzvc4qxesqegs3q4u66tpmf'", + # unbonding from validator + "unbond.validator = 'sentvaloper1sazxkmhym0zcg9tmzvc4qxesqegs3q4u66tpmf'", + # tokens sent from validator's wallet + "transfer.sender = 'sent1sazxkmhym0zcg9tmzvc4qxesqegs3q4u9l5v5q'", + # tokens sent to validator's wallet + "transfer.recipient = 'sent1sazxkmhym0zcg9tmzvc4qxesqegs3q4u9l5v5q'", + # IBC token transferred from validator's wallet + "ibc_transfer.sender = 'sent1sazxkmhym0zcg9tmzvc4qxesqegs3q4u9l5v5q'", + # IBC token received at validator's wallet + "fungible_token_packet.receiver = 'sent1sazxkmhym0zcg9tmzvc4qxesqegs3q4u9l5v5q'", ] ``` @@ -108,6 +124,12 @@ Unfortunately there is no OR operator support. See [this](https://stackoverflow. See [the documentation](https://docs.tendermint.com/master/rpc/#/Websocket/subscribe) for more information. +One important thing to keep in mind: by default, Tendermint RPC now only allows 5 connections per client, so if you have more than 5 filters specified, this will fail when subscribing to 6th one. To fix this, change this parameter to something that suits your needs in `/config/config.toml`: + +``` +max_subscriptions_per_client = 5 +``` + ## Notifications channels Currently this program supports the following notifications channels: