This document is meant to be an exhaustive reference of all TOML configuration fields available in Steward. Some of these fields are also used by the Orchestrator.
You can see all available configuration fields with their default values by running
steward print-configTo generate a default config file, simply redirect stdout to a file:
# You must update these values to your own configuration
steward print-config > config.tomlType: string
Path to the location where steward keys will manage keys on-disk
keystore = ""
Configuration related interactions with the Cosmos chain in question
Type: float
Multiplied by estimated gas fee per transaction. Currently Sommelier fee requirements are 0.0 so this can be left as default.
[cosmos]
gas_adjustment = 1.0
Type: string
Your validator node's gRPC endpoint
[cosmos]
grpc = "http://localhost:9090"
Type: string
The path used to derive accounts from your private keys. For Steward to work this must match whatever derivation path was used for the delegate and operator accounts you registered in the validator set on-chain.
[cosmos]
key_derivation_path = "m/44'/118'/0'/0/0"
Type: integer
Used by the Orchestrator. The max number of Msgs to send to Sommelier at once.
[cosmos]
msg_batch_size = 5
Type: string
The bech32 prefix to use for representing account addresses
[cosmos]
prefix = "somm"
For setting transaction fees
Type: float
The amount of denom you are willing to pay per gas for transactions.
⚠️ This should be kept set to 0.0 for now
[cosmos.gas_price]
amount = 0.0
Type: string
The denomination of the gas fee amount. Sommelier handles fees in usomm.
[cosmos.gas_price]
denom = "usomm"
Config related to interaction with Ethereum
Type: integer
How many Ethereum blocks back the Orchestrator should search for the last event nonce relayed to Cosmos.
[ethereum]
blocks_to_search = 5000
Type: float
Multiplied by estimated gas fee per transaction. If your Ethereum transactions are failing due to insufficient gas, try increasing this value.
[ethereum]
gas_price_multiplier = 1.0
Type: float
Multiplied by estimated gas limit per transaction. If your Ethereum transactions are failing due to insufficient gas, try increasing this value.
[ethereum]
gas_multiplier = 1.0
Type: string
The path used to derive Etherum addresses from your private keys.
[ethereum]
key_derivation_path = "m/44'/60'/0'/0/0"
Type: string
The node endpoint to be used for Ethereum interactions
[ethereum]
rpc = "http://localhost:8545"
Configuration related to the gravity bridge
Type: string
The address of the gravity contract on Ethereum
[gravity]
contract = "0x0000000000000000000000000000000000000000"
Type: string
The denomination in which fees will be paid to relayers. This value must be a denom supported by the configured chain (whatever chain the node at cosmos.grpc is validating on).
[gravity]
fees_denom = "usomm"
Keys config
Type: string
The name of the key in keystore used for delegate signing by both Steward and the Orchestrator. The key name is the name of the key file without the file extension.
[keys]
delegate_key = ""
Config related to the Orchestrator metrics server
Type: string
The server endpoint for monitoring Orchestrator metrics
[metrics]
listen_addr = "127.0.0.1:3000"
Config related to the Steward server
Type: string
The IP address at which the Steward server will run
[server]
address = "0.0.0.0"
Type: string
The path to the trusted CA used to sign the Strategy Provider's client certificate
⚠️ Please leave this value unset for now as it defaults to the Seven Seas CA internally
[server]
client_ca_cert_path = ""
Type: integer
The port on which the Steward server will be hosted
[server]
port = 5734
Type: string
The path to your signed Steward server certificate
[server]
server_cert_path = ""
Type: string
The path to the PKCS8-formatted key used to generate the server certificate
[server]
server_key_path = ""
This example will not work as is, you'll need to supply your own values.
keystore = "/some/path/keystore"
[cosmos]
gas_adjustment = 1.0
grpc = "https://127.0.0.1:9090"
key_derivation_path = "m/44'/118'/0'/0/0"
prefix = "somm"
msg_batch_size = 5
[cosmos.gas_price]
# Please keep amount set to 0.0 at this time
amount = 0.0
denom = "usomm"
[ethereum]
blocks_to_search = 5000
gas_price_multiplier = 1.0
gas_multiplier = 1.1
key_derivation_path = "m/44'/60'/0'/0/0"
rpc = "http://localhost:8545"
[gravity]
contract = "0x0000000000000000000000000000000000000000"
fees_denom = "usomm"
[keys]
delegate_key = "mykey"
[metrics]
listen_addr = "127.0.0.1:3000"
# Please leave the client_ca_cert_path field unset for now
[server]
address = "0.0.0.0"
port = 5734
server_cert_path = "/server/cert/path"
server_key_path = "/server/key/path"