From 972346201b6bdd37cd5ecc511381cc47fa572a71 Mon Sep 17 00:00:00 2001 From: vuittont60 <81072379+vuittont60@users.noreply.github.com> Date: Tue, 31 Oct 2023 17:45:28 +0800 Subject: [PATCH] docs: fix typos --- spec/config.md | 2 +- spec/future-work.md | 2 +- spec/ibc-relayer.md | 4 ++-- spec/keys.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/spec/config.md b/spec/config.md index bbb46575..c4923c8e 100644 --- a/spec/config.md +++ b/spec/config.md @@ -13,7 +13,7 @@ as a daemon (unix service), the default home directory for `ibc-relayer` will be On the other hand, the user-focused `ibc-setup` will default to `$HOME/.ibc-setup` as the "home" directory. -This may be overriden via the `RELAYER_HOME` env variable, or `--home` CLI flag. +This may be overridden via the `RELAYER_HOME` env variable, or `--home` CLI flag. ## Registry Format diff --git a/spec/future-work.md b/spec/future-work.md index 7be281c8..2ce811ea 100644 --- a/spec/future-work.md +++ b/spec/future-work.md @@ -66,7 +66,7 @@ to send tokens to their account. ## Multiple Relayer Keys -Allow the relayer to have multiple accounts under it's control, which it can switch when one runs low, +Allow the relayer to have multiple accounts under its control, which it can switch when one runs low, or simply to allow sending more messages concurrently without worrying about sequence numbers. We could also support fee grants here (SDK v0.42+), so we could have eg. 10 signing keys that all pull diff --git a/spec/ibc-relayer.md b/spec/ibc-relayer.md index f36b2ab0..4f873608 100644 --- a/spec/ibc-relayer.md +++ b/spec/ibc-relayer.md @@ -1,9 +1,9 @@ # IBC Relayer The IBC Relayer is a simple binary with one command: `start`. When run, it will read configuration -data and then seek to continually relay all packets over all channels on it's pre-configured connection. +data and then seek to continually relay all packets over all channels on its pre-configured connection. -The most interesting elements of the Relayer is [configuring it's logging](./logging.md) for easy debugging, +The most interesting elements of the Relayer is [configuring its logging](./logging.md) for easy debugging, as well as [checking metrics](./metrics.md) to set up alerts or Grafana dashboards. `ibc-relayer start --src=ABC --dest=XYZ --connection=connection-3 --key-file=relayer.key` diff --git a/spec/keys.md b/spec/keys.md index 8b8637b0..fb58a69d 100644 --- a/spec/keys.md +++ b/spec/keys.md @@ -8,7 +8,7 @@ the keys and addresses for all chains it connects to. Note that two relayers _may_ safely share the same mnemonic phrase _only if_ they point to different chains. eg. one is A-B, the other is C-D. If they both had a chain in common, they would share an address and cause all kinds of issue with sequence numbers when trying to send packets in parallel. -In general, it is good practice to provide each relayer instance with it's own mnemonic phrase. +In general, it is good practice to provide each relayer instance with its own mnemonic phrase. ## Configuration