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

Add --time-threshold flag example use case #1155

Merged
merged 2 commits into from
Apr 3, 2023
Merged

Add --time-threshold flag example use case #1155

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2eb5485
--time-threshold example use cases
boojamya Mar 30, 2023
492821e
Merge branch 'main' into dan/threshold-docs
boojamya Apr 3, 2023
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
8 changes: 6 additions & 2 deletions docs/advanced_usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,20 @@ By default, the Relayer will automatically update clients (`MsgUpdateClient`) if
> This auto-update functionality is specifically useful on low trafficked paths where messages aren't regularly being relayed.


You can choose to update clients more regularly by using the `--time-threshold` flag when running the `rly start` command.
Alternitavely, you can choose to update clients more frequently by using the `--time-threshold` flag when running the `rly start` command.

Example:

- You are relaying on a path that has a client trusting period of 9 minutes.
- Say... You are relaying on a path that has a client trusting period of 9 minutes.
- If no messages are sent for 6 minutes and the client is 3 minutes (1/3) to expiration, the relayer will automatically update the client.
- If you wish to update the client more frequently, say anytime two minutes have passed without a `MsgUpdateClient` being sent, use flag: `--time-threshold 2m`

Selecting a time-threshold that is greater than 2/3 of the client trusting period will deem itself useless.

Use cases for configuring the `--time-threshold` flag:
- The underlying chain node that the relayer is using as an endpoint has restrictive pruning. Client updates are needed more frequently since states 2/3 trusting period ago would not be available due to pruning.
- Mitiage relayer operational errors allowing more frequent updates incase a relayer node goes down for > the client trusting period.

\* It is not mandatory for relayers to include the `MsgUpdateClient` when relaying packets, however most, if not all relayers currently do.

---
Expand Down