Release Hermes v0.3.2 (#970)

* Update changelog

* Bump version to 0.3.2

* Update guide for `keys` command

* Show key name in JSON output

* Update `tx raw ft-transfer` help message in guide

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
-## Unreleased
+## v0.3.2
+*May 21st, 2021*
+
+This is minor release which brings substantial performance improvements
+to the relayer (relaying 1000 packets now takes 2-5min instead of 1h+),
+better UX for the `ft-transfer` command, and automatic deployment of
+Docker images to Docker Hub.
 
 ### FEATURES
 
@@ -11,13 +17,13 @@
   - Add support for multiple keys to the keyring ([#963])
 
 - [release]
-  - Released the official [Hermes image](https://hub.docker.com/r/informalsystems/hermes) on Docker Hub ([#894])
+  - Released the official [Hermes image][hermes-docker] on Docker Hub ([#894])
   - Automatically deploy Docker Hub image during release ([#967])
 
 ### IMPROVEMENTS
 
 - [ibc-relayer]
-  - Bulk events from all transactions included in a block ([#957])
+  - Batch together all events from all transactions included in a block ([#957])
 
 ### BUG FIXES
 
@@ -34,6 +40,8 @@
 [#963]: https://github.com/informalsystems/ibc-rs/issues/963
 [#967]: https://github.com/informalsystems/ibc-rs/issues/967
 
+[hermes-docker]: https://hub.docker.com/r/informalsystems/hermes
+
 ## v0.3.1
 *May 14h, 2021*
 

guide/README.md

@@ -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.1`.
+Current version: `0.3.2`.
 
 The version of this guide is aligned with the [versioning of the ibc crates](../README.md).
 

guide/src/SUMMARY.md

@@ -1,6 +1,6 @@
 # Summary
 
-# Hermes (v0.3.1)
+# Hermes (v0.3.2)
 
 ---
 - [Introduction](./index.md)

guide/src/commands/global.md

@@ -3,7 +3,7 @@
 Hermes accepts global options which affect all commands.
 
 ```shell
-hermes 0.3.1
+hermes 0.3.2
 Informal Systems <hello@informal.systems>
 Implementation of `hermes`, an IBC Relayer developed in Rust.
 

guide/src/commands/keys/index.md

@@ -73,12 +73,13 @@ POSITIONAL ARGUMENTS:
 
 FLAGS:
     -f, --file FILE           the path to the key file (conflicts with --mnemonic)
+    -n, --name NAME           name of the key (defaults to the `key_name` defined in the config)
 ```
 
 To add a private key file to a chain:
 
 ```shell
-hermes -c config keys add [CHAIN_ID] -f [PRIVATE_KEY_FILE]
+hermes -c config.toml keys add [CHAIN_ID] -f [PRIVATE_KEY_FILE]
 ```
 
 If the command is successful a message similar to the one below will be displayed:
@@ -87,6 +88,14 @@ If the command is successful a message similar to the one below will be displaye
 Success: Added key testkey ([ADDRESS]) on [CHAIN ID] chain
 ```
 
+> **Key name:**
+> By default, the key will be named after the `key_name` property specified in the configuration file.
+> To use a different key name, specify the `--name` option when invoking `keys add`.
+>
+> ```
+> hermes -c config.toml keys add [CHAINID] -f [PRIVATE_KEY_FILE] -n [KEY_NAME]
+> ```
+
 #### Restore a private key to a chain from a mnemonic
 
 ```shell
@@ -100,14 +109,15 @@ POSITIONAL ARGUMENTS:
     chain_id                  identifier of the chain
 
 FLAGS:
-    -n, --name NAME           key name
     -m, --mnemonic MNEMONIC   mnemonic to restore the key from
+    -t, --coin-type COIN-TYPE coin type of the key to restore, default: 118 (Atom)
+    -n, --name NAME           name of the key (defaults to the `key_name` defined in the config)
 ```
 
 To restore a key from its mnemonic:
 
 ```shell
-hermes -c config keys restore [CHAIN_ID] -m "[MNEMONIC]"
+hermes -c config.toml keys restore [CHAIN_ID] -m "[MNEMONIC]"
 ```
 
 If the command is successful a message similar to the one below will be displayed:
@@ -116,6 +126,14 @@ If the command is successful a message similar to the one below will be displaye
 Success: Restore key testkey ([ADDRESS]) on [CHAIN ID] chain
 ```
 
+> **Key name:**
+> By default, the key will be named after the `key_name` property specified in the configuration file.
+> To use a different key name, specify the `--name` option when invoking `keys restore`.
+>
+> ```
+> hermes -c config.toml keys restore [CHAINID] -m "[MNEMONIC]" -n [KEY_NAME]
+> ```
+
 ### List keys
 
 In order to list the private keys added to chains use the `keys list` command
@@ -136,11 +154,43 @@ POSITIONAL ARGUMENTS:
 To list the private key file that was added to a chain:
 
 ```shell
-hermes -c config keys list [CHAIN_ID]
+hermes -c config.toml keys list [CHAIN_ID]
+```
+
+If the command is successful a message similar to the one below will be displayed:
+
+```
+Success:
+- user2 (cosmos1attn9fxrcvjz483w3tu4cfz77ldmlyujly3q3k)
+- testkey (cosmos1dw88vdekeeuta5u50p6n5lt5v5c6y2we0pu8nz)
+```
+
+**JSON:**
+
+```shell
+hermes --json -c config.toml keys list [CHAIN_ID] | jq
 ```
 
 If the command is successful a message similar to the one below will be displayed:
 
 ```json
-[CHAIN_ID] -> [KEY_NAME] ([ADDRESS])
+{
+  "result": {
+    "testkey": {
+      "account": "cosmos1dw88vdekeeuta5u50p6n5lt5v5c6y2we0pu8nz",
+      "address": [ 107, 142, 118, 55, 54, 206, 120, 190, 211, 148, 120, 117, 58, 125, 116, 101, 49, 162, 41, 217 ],
+      "coin_type": 118,
+      "private_key": "(snip)",
+      "public_key": "xpub6Gc7ZUt2q1BiQYjhUextPv5bZLwosHigZYqEquPD6FkAGmHDrLiBgE5Xnh8XGZp79rAXtZn1Dt3DNQHxxgCgVQqfRMfVsRiXn6mwULBnYq7"
+    },
+    "user2": {
+      "account": "cosmos1attn9fxrcvjz483w3tu4cfz77ldmlyujly3q3k",
+      "address": [ 234, 215, 50, 164, 195, 195, 36, 42, 158, 46, 138, 249, 92, 36, 94, 247, 219, 191, 147, 146 ],
+      "coin_type": 118,
+      "private_key": "(snip)",
+      "public_key": "xpub6FmDbeGTWVjSvHrqHfrpnMTZxpPX1V7XFiq5nMuvgwX9jumt1yUuwNAUQo8Nn36unbFShg6iSjkfMBgeY49wik7rF91N2SHvarpX62ByWMf"
+    }
+  },
+  "status": "success"
+}
 ```

guide/src/commands/raw/packet.md

@@ -24,11 +24,12 @@ POSITIONAL ARGUMENTS:
     amount                    amount of coins (samoleans, by default) to send (e.g. `100000`)
 
 FLAGS:
-    -o, --timeout-height-offset TIMEOUT-HEIGHT-OFFSET
-    -t, --timeout-seconds TIMEOUT-SECONDS
-    -r, --receiver RECEIVER   receiving account address on the destination chain
-    -d, --denom DENOM         denomination of the coins to send (default: samoleans)
-    -n, --number-msgs NUMBER-MSGS
+    -o, --timeout-height-offset TIMEOUT-HEIGHT-OFFSET  timeout in number of blocks since current
+    -t, --timeout-seconds TIMEOUT-SECONDS              timeout in seconds since current
+    -r, --receiver RECEIVER                            receiving account address on the destination chain
+    -d, --denom DENOM                                  denomination of the coins to send (default: samoleans)
+    -n, --number-msgs NUMBER-MSGS                      number of messages to send
+    -k, --key KEY                                      use the given signing key (default: `key_name` config)
 ```
 
 __Example__

guide/src/index.md

@@ -1,4 +1,4 @@
-# Hermes Guide (v0.3.1)
+# Hermes Guide (v0.3.2)
 
 This guide can help you setup, configure, and operate Hermes to transfer
 packets between two IBC enabled chains.