diff --git a/CHANGELOG.md b/CHANGELOG.md index b099d80020..c8d323847c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,8 @@ event_source = { mode = 'pull', interval = '1s' }` in the per-chain configuration. +Check the `event_source` setting in the example [`config.toml`](config.toml) file in the Hermes repository for more details. + ### Note for operators > ⚠️ Be aware that this release contains breaking changes to the Hermes configuration. @@ -20,7 +22,7 @@ in the per-chain configuration. ### BREAKING CHANGES -- The `websocket_addr` and `batch_delay` settings have been removed in favour of the new `event_source` setting. +- The `websocket_addr` configuration option has been removed in favour of the new `event_source` setting. Please consult the [`UPGRADING.md`](UPGRADING.md) document for more details. - Bump MSRV to 1.71 ([\#3478](https://github.com/informalsystems/hermes/issues/3478)) diff --git a/UPGRADING.md b/UPGRADING.md index d262e2a924..73980ca4f8 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -1,6 +1,30 @@ # Upgrading Hermes to a newer version -## v.1.5.0 +## v1.6.0 + +> These instructions assume that you are running Hermes v1.5.0 or newer. +> If you are running an older version, please refer to the upgrading instructions +> for the older release candidates in reverse chronological order to update to +> v1.5.0 first and then follow these instructions. + +- The `websocket_addr` configuration option has been removed in favour of the new `event_source` setting. + + In every chain configuration section, replace the `websocket_addr = 'WS_URL'` setting with: + + ```toml + event_source = { mode = 'push', url = '$WS_URL', batch_delay = '200ms' } + ``` + + The `batch_delay` option can be used to determine how long should the WebSocket + event source should wait to emit an event batch after having received the first + event for the current height. If the setting is too high, the event source will + have to wait for the next `NewBlock` event until it can emit the batch. + If the setting is too low, the event batch might be emitted before all events + for the latest height have been received, causing more delays until all events + are processed. 500ms is a conservative but fairly safe default. Try lowering + if you believe Hermes is not relaying packets fast enough for you. + +## v1.5.0 > These instructions assume that you are running Hermes v1.0.0 or newer. > If you are running an older version, please refer to the upgrading instructions