Skip to content

Latest commit

 

History

History
103 lines (86 loc) · 4.46 KB

config.md

File metadata and controls

103 lines (86 loc) · 4.46 KB
Raw

Configuration

While most of the commands will be specified via command-line flags, it would be very tedious to pass in all configuration options every time. Thus, we allow 3 ways to configure most items - config file (app.yaml), environmental variables, and command line flags. With the later taking precedence over the former. Environmental variables will all begin with RELAYER_ for both binaries.

Config File Location

All files will be looked for relative to a "home" directory. As this is meant to be run as a daemon (unix service), the default home directory for ibc-relayer will be /etc/relayer.d. On the other hand, the user-focused ibc-setup will default to $HOME/.ibc-setup as the "home" directory.

This may be overriden via the RELAYER_HOME env variable, or --home CLI flag.

Registry Format

The principle config file is registry.yaml, which is a required file and is encoded in yaml format. It contains all the chain-specific information needed to connect to the chains. They are all considered to be Cosmos SDK chains and compatible with 0.41. We may make changes in a future version (thus all files are versioned as 1).

version: 1

chains:
  oysternet:
    chain_id: oysternet-1
    # Bech32 prefix for addresses
    prefix: wasm
    # This determines the gas payments we make (and defines the fee token)
    gas_price: 0.025usponge
    # this defines the gas limits we are going to use
    gas_limits:
      # max amount of gas to be used when performing client init transactions
      init_client: 150000
      # # max amount of gas to be used when performing client update transactions
      update_client:
        600000
        # max amount of gas to be used when performing connection init transactions
      init_connection:
        150000
        # max amount of gas to be used when performing connection handshakes transactions
      connection_handshake:
        300000
        # max amount of gas to be used when performing channel init transactions
      init_channel:
        150000
        # max amount of gas to be used when performing channel handshakes transactions
      channel_handshake:
        300000
        # max amount of gas to be used when receiving packets
      receive_packet:
        300000
        # max amount of gas to be used when receiving acknowledgments
      ack_packet:
        300000
        # max amount of gas to be used when receiving timeout packets
      timeout_packet:
        300000
        # max amount of gas to be used when performing transfer transactions
      transfer: 180000
    # the path we use to derive the private key from the mnemonic
    hd_path: 44'/108'/0'/1'
    # if you include an optional faucet, it will load the relayer with tokens in `ibc-setup init`
    faucet: https://faucet.musselnet.cosmwasm.com
    # you can include multiple RPC endpoints and it will rotate through them if
    # one is down
    rpc:
      - https://rpc.musselnet.cosmwasm.com:443
      - https://rpc.musselnet.aneka.com:443
  bifrost:
    # ...

The chains variable is a lookup based on human-friendly chain names (can be different that the chain_id). It should contain all needed info to configure a relayer connection to that chain.

Other Configuration

In addition to the required registry.yaml, there is an optional app.yaml file that is used as a fall back for any environmental variable. Unless otherwise specified, all command line flags can be defined either as environmental variables or in app.yaml. If they are not defined in any of these places, this will raise an error.

There is a simple pattern for this. Take two examples:

  • CLI flags: --src and --log-level
  • Env Vars (Prefix RELAYER_, use _ not -): RELAYER_SRC and RELAYER_LOG_LEVEL
  • app.yaml (Same name as flag, but using _ not -): src: and log_level:

Chain Selection

Every command will need to know what chains to connect to. The registry file may contain dozens of different chains and be reused by validators making various connections. We just need to pass in a pair of names to each command, so it can look up all needed configuration.

--src=musselnet and --dest=bifrost will define the two chains to connect to, as well as the direction. If creating a connection/channel, we init on the "src" side. If relaying packets, we may relay packets from one chain to another (some configurations will be bi-directional).

As mentioned above, if a CLI flag is not found, we will check for an environmental variable, and ultimately app.yaml.