Configuring Iroha

Iroha is configured via a TOML file and/or Environment Variables.

The path to the configuration file should be passed through the --config CLI argument:

iroha --config iroha_config.toml

If the peer submits the genesis:

# `iroha_config.toml` should contain `genesis.file` and `genesis.private_key`
iroha --config iroha_config.toml --submit-genesis

Structure

• List links to all modules, giving high-level overview of them
• List required parameters

Module Name	Description	Required fields
Base	Basic, root-level parameters	chain_id, public_key, private_key
Genesis	Genesis block configuration	genesis.public_key, and possibly genesis.file & genesis.private_key
Network	?	network.address
Torii	?	torii.address
Sumeragi	?	sumeragi.trusted_peers if doesn't submit the genesis
Kura	?
Queue	?
Snapshot	?
Logger	?
Telemetry	?
Chain Wide	?

Example Configuration

• Show minimal TOML
• Show same minimal ENVs
• Refer to peer.template.toml in the repo, or show it here under the spoiler.

Extends feature

• You can compose configuration files together using the extends root-level field

---

Required Parameters

• public_key: explain the option
• private_key: explain the option
• address: explain the option
• genesis.public_key: explain the option
• genesis.private_key if the peer is the one who submits the genesis. explain the option
• sumeragi.trusted_peers: explain the option. It is not strictly required, but you might need to set it in most cases.
• torii.address: explain the option

Modules Overview

TODO: list each section (sumeragi, torii, kura etc) with links and short explanations of their responsibility.

• Base Options: explain
• Genesis: explain
• Sumeragi: explain
• Torii: explain
• Queue: explain
• Kura: explain
• Logger: explain
• Telemetry: explain
• Snapshot

---

TODO:

• Consider refining Number types to exact Integer, Float, Unsigned 64-bits integer?
• Is sumeragi.trusted_peers optional or required?
• Define more ENVs, and provide samples of how it should be parsed