Introduce crate ibc-chain-registry and hermes config auto to automatically generate a config file

[AlianBenabdallah]

Closes: #2187

Status

Ready for review

config.toml

[global]
log_level = 'info'

[mode.clients]
enabled = true
refresh = true
misbehaviour = true

[mode.connections]
enabled = false

[mode.channels]
enabled = false

[mode.packets]
enabled = true
clear_interval = 100
clear_on_start = true
tx_confirmation = false

[rest]
enabled = false
host = '127.0.0.1'
port = 3000

[telemetry]
enabled = false
host = '127.0.0.1'
port = 3001

[[chains]]
id = 'cosmoshub-4'
type = 'CosmosSdk'
rpc_addr = 'https://rpc-cosmoshub.ecostake.com/'
websocket_addr = 'ws://rpc-cosmoshub.ecostake.com/websocket'
grpc_addr = 'https://grpc-cosmoshub-ia.notional.ventures/'
rpc_timeout = '10s'
account_prefix = 'cosmos'
key_name = 'testkey1'
key_store_type = 'Test'
store_prefix = 'ibc'
default_gas = 100000
max_gas = 400000
gas_multiplier = 1.1
max_msg_num = 30
max_tx_size = 2097152
clock_drift = '5s'
max_block_time = '30s'
memo_prefix = ''


[chains.trust_threshold]
numerator = '1'
denominator = '3'

[chains.gas_price]
price = 0.1
denom = 'uatom'

[chains.packet_filter]
policy = 'allowall'

[chains.address_type]
derivation = 'cosmos'

[[chains]]
id = 'osmosis-1'
type = 'CosmosSdk'
rpc_addr = 'https://rpc-osmosis.ecostake.com/'
websocket_addr = 'ws://rpc-osmosis.ecostake.com/websocket'
grpc_addr = 'https://grpc-osmosis-ia.notional.ventures/'
rpc_timeout = '10s'
account_prefix = 'osmo'
key_name = 'testkey2'
key_store_type = 'Test'
store_prefix = 'ibc'
default_gas = 100000
max_gas = 400000
gas_multiplier = 1.1
max_msg_num = 30
max_tx_size = 2097152
clock_drift = '5s'
max_block_time = '30s'
memo_prefix = ''


[chains.trust_threshold]
numerator = '1'
denominator = '3'

[chains.gas_price]
price = 0.1
denom = 'uosmo'

[chains.packet_filter]
policy = 'allowall'

[chains.address_type]
derivation = 'cosmos'

Description

• Introduces a new crate able to fetch data from the chain-registry. This crate is an alternative to Ocular which is not stable. Ocular can introduce dependency issues and does not verify that the websocket interface is enabled.
• Introduces command hermes config auto [OPTIONS] --output <PATH> -chains <CHAIN_NAME_1[:<KEY1>] CHAIN_NAME_2[:<KEY2>]> [--commit <COMMIT_HASH>] which fetches data from the chain-registry and automatically generates a config file.
• Gas settings are set to default value.

Design choices

• If a ChainConfig can not be retrieved. The command fails and outputs and error.
• Data is fetched from the latest commit of the chain-registry by default.

---

PR author checklist:

• Added changelog entry, using unclog.
• Added tests: integration (for Hermes) or unit/mock tests (for modules).
• Linked to GitHub issue.
• Updated code comments and documentation (e.g., docs/).
• Tagged one reviewer who will be the one responsible for shepherding this PR.

Reviewer checklist:

• Reviewed Files changed in the GitHub PR explorer.
• Manually tested (in case integration/unit/mock tests are absent).

[seanchen1991]

It doesn't seem like the CLI parameter names for the hermes config auto command adhere to ADR 010. Are users supposed to be able to pass in as many chain IDs and key names as they would like? Or are users only able to supply two chain IDs and two key names?

There's also a fair bit of duplicated code. For example, AssetList::fetch and ChainData::fetch are essentially the same functions. select_healthy_rpc and select_healthy_grpc as well. While you'd typically abstract these into traits, it looks like doing that with these functions isn't currently possible due to them being async, unless we want to pull in the async-trait crate, but that doesn't really seem worth it to me.

[AlianBenabdallah]

It doesn't seem like the CLI parameter names for the hermes config auto command adhere to ADR 010.

I will rename every parameter. I also think key-names could be optionnal.

Are users supposed to be able to pass in as many chain IDs and key names as they would like? Or are users only able to supply two chain IDs and two key names?

They are able to pass in as many chain_id and key_names as they'd like.

There's also a fair bit of duplicated code. For example, AssetList::fetch and ChainData::fetch are essentially the same functions. select_healthy_rpc and select_healthy_grpc as well. While you'd typically abstract these into traits, it looks like doing that with these functions isn't currently possible due to them being async, unless we want to pull in the async-trait crate, but that doesn't really seem worth it to me.

Done.

[AlianBenabdallah]

Awesome, great work Ali! Before we merge, can we also change --path to --output to avoid confusion between the path of the config file that's generated and a relay path between two blockchains?

@romac Done !

[seanchen1991]

@romac Now that v1 is released, can we re-open this PR and get it merged for v1.1? 🙂

[romac]

Yep, let's re-open all the PRs in v1.1 milestone

[seanchen1991]

@AlianBenabdallah Looks like there are some merge conflicts that need to be resolved, but once that's done, we can merge this 🙂

[AlianBenabdallah]

It is done and ready to merge !