Config
Show usage
To see the available sub-commands for the config
command run:
hermes help config
The available sub-commands are the following:
DESCRIPTION:
Validate Hermes configuration file
USAGE:
hermes config <SUBCOMMAND>
OPTIONS:
-h, --help Print help information
SUBCOMMANDS:
auto Automatically generate a configuration file by fetching data from the
chain-registry. If a pair of chains exists in the _IBC folder of the
chain-registry then a corresponding packet filter is added to the configuration
help Print this message or the help of the given subcommand(s)
validate Validate the relayer configuration
Automatically generate configuration
Use config auto
to automatically generate a configuration file from the chain-registry.
WARNING: Currently, gas parameters are set to default value and require to be set manually.
DESCRIPTION:
Automatically generate a configuration file by fetching data from the chain-registry. If a pair of
chains exists in the _IBC folder of the chain-registry then a corresponding packet filter is added
to the configuration
USAGE:
hermes config auto [OPTIONS] --output <PATH> --chains <CHAIN_NAME:OPTIONAL_KEY_NAME>
OPTIONS:
--commit <COMMIT_HASH> Commit hash from which the chain configs will be generated. If
it's not set, the latest commit will be used.
-h, --help Print help information
REQUIRED:
--chains <CHAIN_NAME:OPTIONAL_KEY_NAME>...
Names of the chains to include in the config. Every chain must be in the chain registry.
--output <PATH>
Path to the configuration file
Example
Use config auto
to generate a configuration file able to relay between cosmoshub
and osmosis
. This command assumes the existence of a key file for cosmoshub-4
and osmosis-1
in $HOME/.hermes/keys
.
hermes config auto --output ~/example_config.toml --chains cosmoshub osmosis
2022-08-16T17:27:26.966233Z INFO ThreadId(01) using default configuration from '~/.hermes/config.toml'
2022-08-16T17:27:27.800213Z INFO ThreadId(01) cosmoshub-4: uses key "key_cosmoshub"
2022-08-16T17:27:27.841167Z INFO ThreadId(01) osmosis-1: uses key "key_osmosis"
2022-08-16T17:27:27.841890Z WARN ThreadId(01) Gas parameters are set to default values.
SUCCESS "Config file written successfully : ~/example_config.toml."
It is also possible to manually specify a key name for any chain.
hermes config auto --output ~/example_config.toml --chains cosmoshub:random_key osmosis
2022-08-16T17:29:56.902499Z INFO ThreadId(01) using default configuration from '~/.hermes/config.toml'
2022-08-16T17:29:57.288874Z INFO ThreadId(01) cosmoshub-4: uses key "random_key"
2022-08-16T17:29:57.289728Z INFO ThreadId(01) osmosis-1: uses key "key_osmosis"
2022-08-16T17:29:57.290314Z WARN ThreadId(01) Gas parameters are set to default values.
SUCCESS "Config file written successfully : ~/example_config.toml."
WARNING : Do not forget to modify the gas settings before relaying !
Validate configuration
Use config validate
to perform a quick syntactic validation of
your configuration file.
DESCRIPTION:
Validate the relayer configuration
USAGE:
hermes config validate
OPTIONS:
-h, --help Print help information
Example
Validate the default config file, the path inferred automatically to be
$HOME/.hermes/config.toml
.
hermes config validate
Which should output something similar to:
Jul 12 16:31:07.017 INFO using default configuration from '$HOME/.hermes/config.toml'
SUCCESS: "validation passed successfully"
Validate a config file at an arbitrary location:
hermes --config $CONFIGPATH config validate
This one should fail validation because we mistakenly added two separate sections for the same chain ibc-1
:
error: hermes fatal error: config error: config file has duplicate entry for the chain 'ibc-1'