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

docs: update relayer KB to add a remove existing relayer section #2022

Merged
merged 4 commits into from
Jan 28, 2022
Merged

docs: update relayer KB to add a remove existing relayer section #2022

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bf78f83
add a remove existing relayer section
barriebyron Jan 25, 2022
53a11f6
Update docs/kb/relayer.md
Jan 27, 2022
624a70f
Merge branch 'develop' into relayer-edits
Jan 27, 2022
5f43010
Merge branch 'develop' into relayer-edits
Jan 27, 2022
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
17 changes: 16 additions & 1 deletion docs/kb/relayer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,19 @@ The optional `--advanced` flag lets you configure port and version for the custo

By default, relayer configuration is stored in `$HOME/.relayer/`.

## Remove existing relayers

If you previously used the Starport relayer, follow these steps to remove existing relayer and Starport configurations:

1. Stop your blockchain or blockchains.
2. Delete previous configuration files:

```bash
rm -rf ~/.starport/relayer
```

3. Restart your blockchains.

## Relayer configure example

All values can be passed with flags.
Expand All @@ -33,4 +46,6 @@ starport relayer configure --advanced --source-rpc "http://0.0.0.0:26657" --sour

## Connect blockchains and watch for IBC packets

The `starport relayer connect` command connects configured blockchains and watches for IBC packets to relay.
The `starport relayer connect` command connects configured blockchains and watches for IBC packets to relay.

**Tip:** You can observe the relayer packets on the terminal window where you connected your relayer.