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 improvements #44

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

Docs improvements #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f36879
Update CHANGELOG.md
truflorau Aug 12, 2024
626c5ba
Update README.md
truflorau Aug 12, 2024
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
4 changes: 2 additions & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
- chore: move `createClientIfNotExist` [\#18](https://github.com/babylonchain/babylon-relayer/pull/18) ([SebastianElvis](https://github.com/SebastianElvis))
- chore: cleanup example config files [\#17](https://github.com/babylonchain/babylon-relayer/pull/17) ([SebastianElvis](https://github.com/SebastianElvis))
- feat: store client ID in LevelDB rather than config file [\#16](https://github.com/babylonchain/babylon-relayer/pull/16) ([SebastianElvis](https://github.com/SebastianElvis))
- feat: replace in-process lock with a filesystem lock for running concurrent relayers [\#15](https://github.com/babylonchain/babylon-relayer/pull/15) ([SebastianElvis](https://github.com/SebastianElvis))
- feat: replace the in-process lock with a filesystem lock for running concurrent relayers [\#15](https://github.com/babylonchain/babylon-relayer/pull/15) ([SebastianElvis](https://github.com/SebastianElvis))
- chore: bump relayer dependency [\#14](https://github.com/babylonchain/babylon-relayer/pull/14) ([SebastianElvis](https://github.com/SebastianElvis))
- fix: write client ID back to config file on-the-fly [\#13](https://github.com/babylonchain/babylon-relayer/pull/13) ([SebastianElvis](https://github.com/SebastianElvis))

Expand All @@ -26,7 +26,7 @@

**Closed issues:**

- Update to latest `main` branch of relayer [\#28](https://github.com/babylonchain/babylon-relayer/issues/28)
- Update to the latest `main` branch of relayer [\#28](https://github.com/babylonchain/babylon-relayer/issues/28)

## [v0.3.0](https://github.com/babylonchain/babylon-relayer/tree/v0.3.0) (2023-06-07)

Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ make test

## Configuration

The configuration of Babylon relayer is exactly the same as the official IBC relayer.
The configuration of the Babylon relayer is exactly the same as the official IBC relayer.
Please read [the IBC relayer's documentation](https://github.com/cosmos/relayer/tree/main/docs).
This repo also provides some example configurations under the `example/` directory.

Note that some chains (e.g., Injective and EVMOS) impose extra codec formats for its RPC calls.
Note that some chains (e.g., Injective and EVMOS) impose extra codec formats for their RPC calls.
To support such chains, one needs to add an `"extra-codecs"` entry to its config json file.
An example can be found in `examples/chains/injective.json`.

Expand All @@ -50,7 +50,7 @@ To add paths to `config.yaml`:
babylon-relayer paths add-dir examples/paths
```

To restore secret keys from mnenomics:
To restore secret keys from mnemonics:
```console
babylon-relayer keys restore $CHAIN $KEY_NAME $MNEMONICS
```
Expand Down