diff --git a/README.md b/README.md index a8df344..39b30aa 100644 --- a/README.md +++ b/README.md @@ -64,33 +64,17 @@ Options: --help Show this message and exit. ``` -## Beacon Compatibility - -Beacon type | Compatibility ------------------|------------------ -Lighthouse | Full. -Prysm | Full. -Teku | Not (yet) tested. -Nimbus | Not (yet) tested. -Lodestar | Not (yet) tested. - -The beacon type is relative to the beacon node connected to the -watcher, **not to the beacon node connected to the validator client -containing a validator key you want to watch**. The watcher is -agnostic of the infrastructure mananing validators keys you want to -watch, this means you can run it on an external location if you want -blackbox monitoring. - ## Configuration The configuration uses the YAML format: -``` +```yaml # Example config file for the Ethereum validator watcher. beacon_url: http://localhost:5051/ beacon_timeout_sec: 90 network: mainnet +metrics_port: 8000 watched_keys: - public_key: '0xa1d1ad0714035353258038e964ae9675dc0252ee22cea896825c01458e1807bfad2f9969338798548d9858a571f7425c' @@ -123,6 +107,27 @@ the configuration file), `scope:network` (entire network without the keys in the configuration file) `scope:all-network` (entire network) labels. +The configuration can be updated in real-time, the watcher will reload +it dynamically on the next epoch. This allows to have growing sets of +validators, for instance if you deploy new keys. + +## Beacon Compatibility + +Beacon type | Compatibility +-----------------|------------------ +Lighthouse | Full. +Prysm | Full. +Teku | Not (yet) tested. +Nimbus | Not (yet) tested. +Lodestar | Not (yet) tested. + +The beacon type is relative to the beacon node connected to the +watcher, **not to the beacon node connected to the validator client +containing a validator key you want to watch**. The watcher is +agnostic of the infrastructure mananing validators keys you want to +watch, this means you can run it on an external location if you want +blackbox monitoring. + ## Installation From source: