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

chore: fix link and errors #1544

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

chore: fix link and errors #1544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
842a708
Update README.md
nnsW3 Feb 26, 2025
c904d02
Update advanced_usage.md
nnsW3 Feb 26, 2025
48b6396
Update config_migration.md
nnsW3 Feb 26, 2025
ff20594
Update troubleshooting.md
nnsW3 Feb 26, 2025
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 README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
![banner](./docs/images/comp.gif)

[![Project Status: Initial Release](https://img.shields.io/badge/repo%20status-active-green.svg?style=flat-square)](https://www.repostatus.org/#active)
![GitHub Workflow Status](https://github.com/cosmos/relayer/actions/workflows/build.yml/badge.svg)
[![GitHub Workflow Status](https://github.com/cosmos/relayer/actions/workflows/build.yml/badge.svg)](https://github.com/cosmos/relayer/actions/workflows/build.yml)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue?style=flat-square&logo=go)](https://godoc.org/github.com/cosmos/relayer)
[![Go Report Card](https://goreportcard.com/badge/github.com/cosmos/relayer)](https://goreportcard.com/report/github.com/cosmos/relayer)
[![License: Apache-2.0](https://img.shields.io/github/license/cosmos/relayer.svg?style=flat-square)](https://github.com/cosmos/relayer/blob/main/LICENSE)
Expand Down
4 changes: 2 additions & 2 deletions docs/advanced_usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Feegrant configurations can be applied to each chain in the relayer. Note that O
For example, configure feegrants for Kujira:
- `rly chains configure feegrant basicallowance kujira default --num-grantees 10`
- Note: above, `default` is the key that will need to contain funds (the granter)
- 10 grantees will be configured, so those 10 address will sign TXs in round robin order.
- 10 grantees will be configured, so those 10 addresses will sign TXs in round robin order.

An external feegrant configuration can be applied with the following command:
- `rly chains configure feegrant basicallowance cosmoshub cosmosaddr --grantees grantee3`
Expand All @@ -88,7 +88,7 @@ To remove the feegrant configuration:

There can be scenarios where a standard flush fails to clear a packet due to differences in the way packets are observed. The standard flush depends on the packet queries working properly. Sometimes the packet queries can miss things that the block scanning performed by the relayer during standard operation wouldn't. For packets affected by this, if they were emitted in recent blocks, the `--block-history` flag can be used to have the standard relayer block scanning start at a block height that many blocks behind the current chain tip. However, if the stuck packet occurred at an old height, farther back than would be reasonable for the `--block-history` scan from historical to current, there is an additional set of flags that can be used to zoom in on the block heights where the stuck packet occurred.

For example, say a relayer is configured between Chain A and B. The relayer was not operational during the time a user on Chain A sends a packet to Chain B. Due to an issue in the queries to Chain A, the typical flush of the relayer does not relay the packet. Say that many days go by before recognition of the issue by the relayer operator. The relayer operator could start up the relayer with a massive `--block-history` to query all blocks from the time of the stuck packet until the current block, but that could take many hours to query through each block. Instead, the relayer operator can flush out the packet by doing the following:
For example, say a relayer is configured between Chain A and B. The relayer was not operational during the time a user on Chain A sent a packet to Chain B. Due to an issue in the queries to Chain A, the typical flush of the relayer does not relay the packet. Say that many days go by before recognition of the issue by the relayer operator. The relayer operator could start up the relayer with a massive `--block-history` to query all blocks from the time of the stuck packet until the current block, but that could take many hours to query through each block. Instead, the relayer operator can flush out the packet by doing the following:

```bash
rly start $PATH_NAME --stuck-packet-chain-id $CHAIN_A_CHAIN_ID --stuck-packet-height-start $CHAIN_A_STUCK_PACKET_HEIGHT --stuck-packet-height-end $CHAIN_A_STUCK_PACKET_HEIGHT -d
Expand Down
4 changes: 2 additions & 2 deletions docs/config_migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ To migrate, you will need to re-initialize your config file. Follow the steps be
rly config init
```

3) Add chains to relay for to the config. This fetches chain meta-data from `cosmos/chain-registry`. Example:
3) Add chains to relay to the config. This fetches chain meta-data from `cosmos/chain-registry`. Example:
```sh
rly chains add cosmoshub osmosis juno
```
Expand All @@ -29,4 +29,4 @@ OPTIONAL: Manually add channel filters. See: [configure-channel-filter]https://g
>NOTE: Naming of the auto-configured paths has changed to be less abbreviated. So for example "hubosmo" is now "cosmoshub-osmosis". These paths are bi-directional and only need to be added to the config once. So having both "hubosmo" and "osmohub" is not necessary, you just need "cosmoshub-osmosis"


As long as you do not delete `~/.relayer/config/keys/`, you will not have to restore your keys.
As long as you do not delete `~/.relayer/config/keys/`, you will not have to restore your keys.
8 changes: 4 additions & 4 deletions docs/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ If output:
```shell
-> chns(✘) clnts(✘) conn(✘)
```
Verify that you have a healthy RPC address. This means the relayer was unable to query the latest height of one or both the chains.
Verify that you have a healthy RPC address. This means the relayer was unable to query the latest height of one or both chains.

If:
```shell
Expand Down Expand Up @@ -132,9 +132,9 @@ A workaround is available in which the `min-gas-amount` may be set in the chain'

<br>
This is most likely an rpc issue.
The latest block time on the source and destination chain have likely drifted apart.
The latest block time on the source and destination chain has likely drifted apart.

You can confirm by this by checking the latest block time on each chain:
You can confirm this by checking the latest block time on each chain:

```shell
grpcurl -plaintext <GRP-URL:PORT> cosmos.base.tendermint.v1beta1.Service.GetLatestBlock | grep '"time":'
Expand All @@ -147,4 +147,4 @@ The solution here is to either use a different RPC endpoint OR if you are in con
<br>
<br>

[<-- Create Path Across Chains](create-path-across-chain.md) - [Features -->](./features.md)
[<-- Create Path Across Chains](create-path-across-chain.md) - [Features -->](./features.md)