diff --git a/docs/reference/cli/subcommands.md b/docs/reference/cli/subcommands.md index 5218cdb..6741bdc 100644 --- a/docs/reference/cli/subcommands.md +++ b/docs/reference/cli/subcommands.md @@ -1984,6 +1984,45 @@ eth2.azure-vault-name: "AzureKeyVault" Name of the vault to access. Subdomain of `vault.azure.net`. +#### `commit-boost-api-enabled` + + + + +```bash +--commit-boost-api-enabled[=] +``` + + + + +```bash +--commit-boost-api-enabled=true +``` + + + + +```bash +WEB3SIGNER_ETH2_COMMIT_BOOST_API_ENABLED=true +``` + + + + +```bash +eth2.commit-boost-api-enabled: true +``` + + + + +Enables or disables the [Commit-Boost API](https://commit-boost.github.io/commit-boost-client/api). +The default is `false`. + +You can specify the directory to store the generated Commit-Boost proxy keystores using +[`--proxy-keystores-path`](#proxy-keystores-path). + #### `gcp-project-id` @@ -2320,6 +2359,89 @@ Possible values are: | `gnosis` | Consensus layer | Production | Gnosis main network. | | `chiado` | Consensus layer | Test | Multi-client Gnosis testnet. | +#### `proxy-keystores-password-file` + + + + +```bash +--proxy-keystores-password-file= +``` + + + + +```bash +--proxy-keystores-password-file=password.txt +``` + + + + +```bash +WEB3SIGNER_ETH2_PROXY_KEYSTORES_PASSWORD_FILE=password.txt +``` + + + + +```bash +eth2.proxy-keystores-password-file: "password.txt" +``` + + + + +The path to the password file used to encrypt or decrypt the proxy keystores +located at [`--proxy-keystores-path`](#proxy-keystores-path), +when using the [Commit-Boost API](https://commit-boost.github.io/commit-boost-client/api). + +[`--commit-boost-api-enabled`](#commit-boost-api-enabled) must be set +to `true`. + +#### `proxy-keystores-path` + + + + +```bash +--proxy-keystores-path= +``` + + + + +```bash +--proxy-keystores-path=/home/me/proxy-keystores +``` + + + + +```bash +WEB3SIGNER_ETH2_PROXY_KEYSTORES_PATH=/home/me/proxy-keystores +``` + + + + +```bash +eth2.proxy-keystores-path: "/home/me/proxy-keystores" +``` + + + + +The path to a directory to store the generated proxy keystores when using the +[Commit-Boost API](https://commit-boost.github.io/commit-boost-client/api). +The Web3Signer process should have read-write access to this directory. + +[`--commit-boost-api-enabled`](#commit-boost-api-enabled) must be set +to `true`. + +Specify a password file for the proxy keystores using +[`--proxy-keystores-password-file`](#proxy-keystores-password-file). + #### `slashing-protection-db-health-check-interval-milliseconds`