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.

Sign up for GitHub

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

Jump to bottom

docs: fix typos #273

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix typos #273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 spec/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion spec/future-work.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions spec/ibc-relayer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`
Expand Down
2 changes: 1 addition & 1 deletion spec/keys.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down