Skip to content

Commit c1aa3c9

Browse files
committed
Update example config
1 parent 01beacf commit c1aa3c9

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

config.example.toml

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ frequency_get_header_ms = 300
105105
[[mux]]
106106
# Unique ID for the mux config
107107
id = "test_mux"
108-
# Which validator pubkeys to match against this mux config. This can be empty or omitted if a loader is specified.
108+
# Which validator pubkeys to match against this mux config. This can be empty or omitted if a loader is specified.
109109
# Any keys loaded via the loader will be added to this list.
110110
validator_pubkeys = [
111111
"0x80c7f782b2467c5898c5516a8b6595d75623960b4afc4f71ee07d40985d20e117ba35e7cd352a3e75fb85a8668a3b745",
@@ -124,15 +124,24 @@ id = "example-relay"
124124
headers = { X-MyCustomHeader = "ADifferentCustomValue" }
125125

126126
# Configuration for the Signer Module, only required if any `commit` module is present, or if `pbs.with_signer = true`
127+
# Currently two types of Signer modules are supported (only one can be used at a time):
128+
# - Remote: a remote Web3Signer instance
129+
# - Local: a local Signer module
130+
# More details on the docs (https://commit-boost.github.io/commit-boost-client/get_started/configuration/#local-signer)
127131
# OPTIONAL
128-
[signer]
132+
# Remote:
133+
# [signer.remote]
134+
# URL of the Web3Signer instance
135+
# url = "https://remote.signer.url"
136+
# Local:
137+
[signer.local]
129138
# Docker image to use for the Signer module.
130139
# OPTIONAL, DEFAULT: ghcr.io/commit-boost/signer:latest
131140
docker_image = "ghcr.io/commit-boost/signer:latest"
132141
# Configuration for how the Signer module should load validator keys. Currently two types of loaders are supported:
133142
# - File: load keys from a plain text file (unsafe, use only for testing purposes)
134143
# - ValidatorsDir: load keys from a `keys` and `secrets` file/folder (ERC-2335 style keystores). More details can be found in the docs (https://commit-boost.github.io/commit-boost-client/get_started/configuration/)
135-
[signer.loader]
144+
[signer.local.loader]
136145
# File: path to the keys file
137146
key_path = "./keys.example.json"
138147
# ValidatorsDir: format of the keystore (lighthouse, prysm, teku or lodestar)
@@ -152,7 +161,7 @@ key_path = "./keys.example.json"
152161
# Configuration for how the Signer module should store proxy delegations. Currently one type of store is supported:
153162
# - File: store keys and delegations from a plain text file (unsafe, use only for testing purposes)
154163
# OPTIONAL, if missing proxies are lost on restart
155-
[signer.store]
164+
[signer.local.store]
156165
# File: path to the keys file
157166
proxy_dir = "./proxies"
158167

docs/docs/get_started/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Note that in this setup, the signer module will not be started.
3131

3232
## Signer module
3333

34-
Commit-Boost supports both local and remote signers. The signer module is responsible for signing the transactions that other modules generates.
34+
Commit-Boost supports both local and remote signers. The signer module is responsible for signing the transactions that other modules generates. Please note that only one signer at a time is allowed.
3535

3636
### Local signer
3737

0 commit comments

Comments
 (0)