Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Guide update & release 0.4.0 #1028

Merged
merged 27 commits into from
Jun 3, 2021
Merged
Show file tree
Hide file tree
Changes from 26 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
307dd19
Added details about the help command in the guide
adizere Jun 1, 2021
35c96de
Bump version to 0.4.0
romac Jun 1, 2021
8109317
Update guide to account for `start-multi` being promoted to `start`
romac Jun 1, 2021
c2b6a5e
Fix changelog
ancazamfir Jun 2, 2021
e2d9fac
Document telemetry section of config file
romac Jun 2, 2021
5311d20
Fixup documentation for global section of configuration file
romac Jun 2, 2021
c830ec4
Document type of each config option
romac Jun 2, 2021
4ca033c
Remove unsused config default method
romac Jun 2, 2021
702ea96
Guide update for the query clients method.
adizere Jun 2, 2021
b8a682a
Merge branch 'master' into team/rel_v0.4.0
adizere Jun 2, 2021
8826ee8
Typo fix
adizere Jun 2, 2021
1a90128
Re-add Cargo.lock for proto-compiler crate
romac Jun 2, 2021
893f7dc
Document addition of `host` param to telemetry config
romac Jun 2, 2021
f1ffec3
Document telemetry service
romac Jun 2, 2021
ee1051b
Update changelog with telemetry
ancazamfir Jun 2, 2021
2eac3c7
Add changelog entry for #1026
romac Jun 2, 2021
10af4ec
Merge branch 'master' into team/rel_v0.4.0
adizere Jun 3, 2021
155faac
Channel worker updates
ancazamfir Jun 3, 2021
2cf0d45
Add missing files
ancazamfir Jun 3, 2021
2f3e3cb
Update feature matrix
ancazamfir Jun 3, 2021
8a8f84b
Merge branch 'master' into team/rel_v0.4.0
romac Jun 3, 2021
1074286
Update mdbook to v0.4.7
romac Jun 3, 2021
5b2c5a8
Update mdbook to v0.4.9
romac Jun 3, 2021
4200ff0
Add cosmos-sdk versions supported
ancazamfir Jun 3, 2021
6da3777
Merge branch 'team/rel_v0.4.0' of https://github.com/informalsystems/…
ancazamfir Jun 3, 2021
51abdac
Higlight compat info
romac Jun 3, 2021
d0ab8d0
Write summary of 0.4.0 release
romac Jun 3, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/guide.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
- name: Setup mdbook
uses: peaceiris/actions-mdbook@v1
with:
mdbook-version: "0.4.6"
mdbook-version: "0.4.9"

- name: Setup mdbook-mermaid
uses: actions-rs/cargo@v1
Expand Down
14 changes: 11 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ for raising multiple issues that helped us improve the reliability of Hermes.
### FEATURES

- [ibc-relayer]
- Add telemetry and Prometheus endpoint ([#868], [#1032])
- Add support for event based channel relaying ([#822])
- Graceful handling of packet events in the presence of multiple relayers ([#983])

Expand All @@ -25,8 +26,10 @@ for raising multiple issues that helped us improve the reliability of Hermes.
### BUG FIXES

- [ibc-relayer]
- Fix for a client worker bug; Hermes `start` returns error if no chain is reachable ([#972])
- Client worker aborts gracefully if the client is expired or frozen ([#1022])
- Fix client worker initialization error ([#972])
- Fix `hermes start` panic when all chains are unreachable ([#972])
- Ensure expired or frozen client worker logs message and terminates ([#1022])
- Fix regression where Hermes would not recover after a node went down and up again ([#1026])

- [gaiad-manager]
- Import hermes keys properly even if wallet HD derivation path is set ([#975])
Expand All @@ -39,6 +42,7 @@ for raising multiple issues that helped us improve the reliability of Hermes.
- Promote `start-multi` command to `start` ([#911])

[#822]: https://github.com/informalsystems/ibc-rs/issues/822
[#868]: https://github.com/informalsystems/ibc-rs/issues/868
[#871]: https://github.com/informalsystems/ibc-rs/issues/871
[#911]: https://github.com/informalsystems/ibc-rs/issues/911
[#972]: https://github.com/informalsystems/ibc-rs/issues/972
Expand All @@ -50,6 +54,8 @@ for raising multiple issues that helped us improve the reliability of Hermes.
[#998]: https://github.com/informalsystems/ibc-rs/issues/998
[#1003]: https://github.com/informalsystems/ibc-rs/issues/1003
[#1022]: https://github.com/informalsystems/ibc-rs/issues/1022
[#1026]: https://github.com/informalsystems/ibc-rs/issues/1026
[#1032]: https://github.com/informalsystems/ibc-rs/issues/1032
[gaiad-manager]: https://github.com/informalsystems/ibc-rs/blob/master/scripts/gm/README.md
[#1039]: https://github.com/informalsystems/ibc-rs/issues/1039

Expand All @@ -68,7 +74,8 @@ Docker images to Docker Hub.

- [ibc-relayer]
- Add support for multiple keys to the keyring ([#963])

- Add telemetry and Prometheus endpoint ([#868])

- [release]
- Released the official [Hermes image][hermes-docker] on Docker Hub ([#894])
- Automatically deploy Docker Hub image during release ([#967])
Expand All @@ -87,6 +94,7 @@ Docker images to Docker Hub.

> Nothing

[#868]: https://github.com/informalsystems/ibc-rs/issues/868
[#894]: https://github.com/informalsystems/ibc-rs/pull/894
[#957]: https://github.com/informalsystems/ibc-rs/issues/957
[#960]: https://github.com/informalsystems/ibc-rs/issues/960
Expand Down
17 changes: 8 additions & 9 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ mdBook is a utility to create modern online books from Markdown files.
This guide should be permanently deployed at its latest stable version at
[hermes.informal.systems](https://hermes.informal.systems).

Current version: `0.3.2`.
Current version: `0.4.0`.

The version of this guide is aligned with the [versioning of the ibc crates](../README.md).

Expand Down
11 changes: 6 additions & 5 deletions guide/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Summary

# Hermes (v0.3.2)
# Hermes (v0.4.0)

---
- [Introduction](./index.md)
Expand All @@ -11,16 +11,15 @@
- [Pre-requisites](./pre_requisites.md)
- [Installation](./installation.md)
- [Configuration](./config.md)
- [Telemetry](./telemetry.md)
- [Tutorials](./tutorials/index.md)
- [Local chains](./tutorials/local-chains/index.md)
- [Install Gaia](./tutorials/local-chains/gaia.md)
- [Start the local chains](./tutorials/local-chains/start.md)
- [Identifiers](./tutorials/local-chains/identifiers.md)
- [Connect the chains using relay paths](./tutorials/local-chains/relay-paths/index.md)
- [Create a new path](./tutorials/local-chains/relay-paths/create-new-path.md)
- [Packet relaying on existing path](./tutorials/local-chains/relay-paths/existing-path.md)
- [Packet relaying on new path](./tutorials/local-chains/relay-paths/new-path.md)
- [Concurrent packet relaying on multiple paths](./tutorials/local-chains/relay-paths/multiple-paths.md)
- [Relay packets on multiple paths](./tutorials/local-chains/relay-paths/multiple-paths.md)
- [Connect the chains using raw transactions](./tutorials/local-chains/raw/index.md)
- [Configure clients](./tutorials/local-chains/raw/client.md)
- [Connection handshake](./tutorials/local-chains/raw/connection.md)
Expand All @@ -33,7 +32,9 @@
- [Clients](./commands/path-setup/clients.md)
- [Connections](./commands/path-setup/connections.md)
- [Channels](./commands/path-setup/channels.md)
- [Packet relaying](./commands/relaying.md)
- [Relaying](commands/relaying/index.md)
- [Packet Messages](./commands/relaying/packets.md)
- [Channel Open Handshake Messages](commands/relaying/channel.md)
- [Listen mode](./commands/listen/index.md)
- [Client upgrade](./commands/upgrade/index.md)
- [Testing client upgrade](./commands/upgrade/test.md)
Expand Down
3 changes: 1 addition & 2 deletions guide/src/commands/global.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,12 @@
Hermes accepts global options which affect all commands.

```shell
hermes 0.3.2
hermes 0.4.0
Informal Systems <[email protected]>
Implementation of `hermes`, an IBC Relayer developed in Rust.

FLAGS:
-c, --config CONFIG path to configuration file
-h, --help print help message
-j, --json enable JSON output
```

Expand Down
2 changes: 1 addition & 1 deletion guide/src/commands/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Commands to manage keys (private keys) for each chain.

Commands to manage clients, connections, channels.

**[Packet Relaying](./relaying.md)**
**[Relaying](./relaying/index.md)**

Commands to start the relayer and relay packets.

Expand Down
2 changes: 1 addition & 1 deletion guide/src/commands/path-setup/connections.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,4 +212,4 @@ figure it out by looking up the given client on `ibc-0`.

## Non-zero Delay Connection

A connection can be created with a delay period parameter. This parameter specifies a period of time that must elpase after a successful client state update and before a packet with proofs using its commitment root can pe processed on chain. For more information see [how packet delay works](../relaying.md#packet-delay) and the [connection delay specification](https://github.com/cosmos/ibc/tree/master/spec/core/ics-003-connection-semantics).
A connection can be created with a delay period parameter. This parameter specifies a period of time that must elpase after a successful client state update and before a packet with proofs using its commitment root can pe processed on chain. For more information see [how packet delay works](../relaying/index.md#packet-delay) and the [connection delay specification](https://github.com/cosmos/ibc/tree/master/spec/core/ics-003-connection-semantics).
2 changes: 1 addition & 1 deletion guide/src/commands/path-setup/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This section describes a number of commands that can be used to manage clients,


## Create
Use the `create` commands to create a new clients, connections and channels.
Use the `create` commands to create new clients, connections and channels.

```shell
USAGE:
Expand Down
42 changes: 38 additions & 4 deletions guide/src/commands/queries/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,14 @@ USAGE:
hermes query clients <OPTIONS>

DESCRIPTION:
Query clients
Query the identifiers of all clients on a chain

POSITIONAL ARGUMENTS:
chain_id identifier of the chain to query

FLAGS:
-s, --src-chain-id ID filter for clients which target a specific chain id (implies '-o')
-o, --omit-chain-ids omit printing the source chain for each client (default: false)
```

__Example__
Expand All @@ -26,10 +30,40 @@ Query all clients on `ibc-1`:
hermes query clients ibc-1
```

```rust
```json
Success: [
ClientChain {
client_id: ClientId(
"07-tendermint-0",
),
chain_id: ChainId {
id: "ibc-0",
version: 0,
},
},
ClientChain {
client_id: ClientId(
"07-tendermint-1",
),
chain_id: ChainId {
id: "ibc-2",
version: 2,
},
},
]
```

Query all clients on `ibc-1` having `ibc-2` as their source chain:

```shell
hermes query clients ibc-1 -s ibc-2
```

```json
Success: [
ClientId("07-tendermint-0"),
ClientId("07-tendermint-1"),
ClientId(
"07-tendermint-1",
),
]
```

Expand Down
104 changes: 0 additions & 104 deletions guide/src/commands/relaying.md

This file was deleted.

Loading