Skip to content

Commit 176f023

Browse files
romacadizere
andauthored
Release Hermes v0.6.0 (#1134)
* Bump crates to 0.6.0 * Update version number in guide * Add documentation on config reload to the guide * Add help section about state dump via `SIGUSR1` signal * Add TOC to config guide page * Update state dump guide section and link it from reload config section * Added warning in guide config * Fixed panic for clear_packets_interval * Upgrade path in the changelog * Guide upt for query channel ends * config validate in the guide * Update guide with new state dump format * Update guide/src/config.md Co-authored-by: Romain Ruetschi <[email protected]> * Bump `ibc-proto` to v0.8.2 Co-authored-by: Adi Seredinschi <[email protected]>
1 parent ce36391 commit 176f023

File tree

21 files changed

+683
-216
lines changed

21 files changed

+683
-216
lines changed

CHANGELOG.md

Lines changed: 48 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,57 @@
11
# Changelog
22

3-
## Unreleased
3+
## v0.6.0
4+
*July 12th, 2021*
45

56
Many thanks to Fraccaroli Gianmarco (@Fraccaman) for helping us improve the
67
reliability of Hermes ([#697]).
78

8-
__! Configuration file changes:__
9-
The Hermes config.toml configuration file has went through a few revisions
10-
in this release. The changes are as follows:
11-
- Added inline documentation for all options.
12-
- Added a filtering mechanism to allow packet relaying only on
13-
specific channels. Consequently, there are two new options in the
14-
configuration file:
15-
1. A global `filter` parameter to enable or disable filtering globally.
16-
2. A per-chain `.filters` option that expects a list of channel and
17-
port identifiers, so that packet relaying will be restricted to this
18-
list for the corresponding chain.
19-
- Added a packet clearing configuration option, to parametrize the frequency
20-
at which Hermes will clear pending packets. This is a global option, called
21-
`clear_packets_interval`, which applies to all chains in the configuration.
22-
23-
Note that both the `filter` and `clear_packets_interval` features apply
24-
only to Hermes passive relaying mode (command `hermes start`), and will
25-
not affect the other commands.
9+
This release includes two major features to Hermes: (1) support for reloading
10+
the chains from the configuration file at runtime, and (2) a filtering mechanism
11+
to restrict Hermes activity based on predefined parameters (e.g., packet relaying
12+
on certain ports and channels exclusively, and ignoring activity for clients
13+
that have non-standard trust threshold).
14+
15+
In addition to these two, we have also added a health checkup mechanism, plus new
16+
`config validate` and `query channel ends` CLIs.
17+
18+
### Upgrading from 0.5.0 to 0.6.0
19+
20+
When upgrading from Hermes v0.5.0 to v0.6.0, the most important
21+
point to watch out for is the configuration file.
22+
The Hermes config.toml configuration file has went through a few revisions,
23+
with the changes described below.
24+
25+
#### Added inline documentation for all options.
26+
27+
Please have a look around the [config.toml](./config.toml) directly.
28+
29+
#### Added a packet filtering mechanism based on channel/port identifiers
30+
31+
This feature will restrict the channels on which Hermes relays packets.
32+
There are two new options in the configuration file:
33+
34+
1. A global `filter` parameter to enable or disable filtering globally.
35+
2. A per-chain `.filters` option that expects a `policy` (either `allow` or
36+
`deny`) plus a list of channel and
37+
port identifiers. If policy is `allow`, then packet relaying will be restricted to this
38+
list for the corresponding chain. If the policy is `deny`, then any packets
39+
from this list will be ignored.
40+
41+
#### Added filtering based on client state
42+
43+
The global `filter` option additionally enables filtering of all activities
44+
based on client state trust threshold. If enabled, Hermes will ignore all
45+
activity for clients that have a trust threshold different than `1/3`.
46+
47+
#### Added a packet clearing configuration option
48+
49+
This will enable the parametrization of the frequency
50+
at which Hermes will clear pending packets. This is a global option, called
51+
`clear_packets_interval`, which applies to all chains in the configuration.
52+
53+
54+
The full list of changes is described below.
2655

2756
### FEATURES
2857

0 commit comments

Comments
 (0)