Skip to content

Commit

Permalink
docs: add ics section to docs for relayer and chains (#520)
Browse files Browse the repository at this point in the history
* add ics to chains and relayer setting

* add ics relayer link to chains
  • Loading branch information
Anmol1696 committed Jul 11, 2024
1 parent 6fd5244 commit ab3893a
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/pages/config/chains.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -317,3 +317,21 @@ chains:
To more about CometMock, have a look at the [blog](https://informal.systems/blog/cometmock) that explains its working

> Note: Current support of cometmock has been tested with multiple chains with verion `0.34.x` and `0.37.x`.

## `ics` (optional)
The `ics` directive allows you to enable interchain security on the chain. This is useful when you want to test a chain which is ICS enabled

```yaml
chains:
- id: neutron-1
name: neutron
numValidators: 1
ics:
enabled: true
provider: cosmoshub-4 # chain id of the provider chain
- id: cosmoshub-4
name: cosmoshub
numValidators: 1
```

> Note: To complete the ICS setup one also needs to setup the relayer with ics enabled. Have a look at the [relayer](https://docs.cosmology.zone/starship/config/relayers#ics)
30 changes: 30 additions & 0 deletions docs/pages/config/relayers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -139,3 +139,33 @@ Available endpoints on

One can use the exposer endpoint on the relayer to create channel from outside.
Note: Still an experimental feature on exposer

## `ics` (optional, hermes only)
ICS directive in the `relayers` directive is used for `hermes` relayer to specify the ICS setup to use

```yaml
chains:
- id: neutron-1
name: neutron
numValidators: 1
ics:
enabled: true
provider: cosmoshub-4 # chain id of the provider chain
- id: cosmoshub-4
name: cosmoshub
numValidators: 1
relayers:
- name: neutron-cosmos
type: hermes
replicas: 1
chains:
- neutron-1
- cosmoshub-4
ics:
enabled: true
consumer: neutron-1
provider: cosmoshub-4
```

If `ics` is enabled, then the `consumer` and `provider` chain must be specified. With that, we automagically open the consumer and provider ports for the relayer.

0 comments on commit ab3893a

Please sign in to comment.