Skip to content

Commit

Permalink
address reviewer feedback
Browse files Browse the repository at this point in the history 
Signed-off-by: Alexandra Tran <[email protected]>
  • Loading branch information
@alexandratran
alexandratran committed Feb 21, 2025
1 parent 5954059 commit 052ddbd
Show file tree
Hide file tree
Showing 2 changed files with 122 additions and 122 deletions.
122 changes: 0 additions & 122 deletions docs/reference/cli/options.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,46 +56,6 @@ WEB3SIGNER_CONFIG_FILE=/home/me/me_node/config.yaml
</TabItem>
</Tabs>

### `commit-boost-api-enabled`

<Tabs>
<TabItem value="Syntax" label="Syntax" default>

```bash
--commit-boost-api-enabled[=<BOOLEAN>]
```

</TabItem>
<TabItem value="Example" label="Example">

```bash
--commit-boost-api-enabled=true
```

</TabItem>
<TabItem value="Environment variable" label="Environment variable">

```bash
TEKU_COMMIT_BOOST_API_ENABLED=true
```

</TabItem>
<TabItem value="Configuration file" label="Configuration file">

```bash
commit-boost-api-enabled: true
```

</TabItem>
</Tabs>

Enables or disables the [Commit-Boost API](https://commit-boost.github.io/commit-boost-client/api).
The default is `false`.

You can specify proxy keystores for Commit-Boost using
[`--proxy-keystores-path`](#proxy-keystores-path) and
[`--proxy-keystores-password-file`](#proxy-keystores-password-file).

### `data-path`

<Tabs>
Expand Down Expand Up @@ -825,88 +785,6 @@ metrics-push-prometheus-job="my-custom-job"

The job name when in `push` mode. The default is `web3signer-job`.

### `proxy-keystores-password-file`

<Tabs>
<TabItem value="Syntax" label="Syntax" default>

```bash
--proxy-keystores-password-file=<FILE>
```

</TabItem>
<TabItem value="Example" label="Example">

```bash
--proxy-keystores-password-file=password.txt
```

</TabItem>
<TabItem value="Environment variable" label="Environment variable">

```bash
TEKU_PROXY_KEYSTORES_PASSWORD_FILE=password.txt
```

</TabItem>
<TabItem value="Configuration file" label="Configuration file">

```bash
proxy-keystores-password-file: "password.txt"
```

</TabItem>
</Tabs>

The path to the password file used to encrypt or decrypt the proxy keystores
specified by [`--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`

<Tabs>
<TabItem value="Syntax" label="Syntax" default>

```bash
--proxy-keystores-path=<PATH>
```

</TabItem>
<TabItem value="Example" label="Example">

```bash
--proxy-keystores-path=/home/me/proxy-keystores
```

</TabItem>
<TabItem value="Environment variable" label="Environment variable">

```bash
TEKU_PROXY_KEYSTORES_PATH=/home/me/proxy-keystores
```

</TabItem>
<TabItem value="Configuration file" label="Configuration file">

```bash
proxy-keystores-path: "/home/me/proxy-keystores"
```

</TabItem>
</Tabs>

The path to a writeable directory to store v3 and v4 proxy keystores
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`.

Specify a password file for the proxy keystores using
[`--proxy-keystores-password-file`](#proxy-keystores-password-file).

### `swagger-ui-enabled`

<Tabs>
Expand Down
122 changes: 122 additions & 0 deletions docs/reference/cli/subcommands.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1984,6 +1984,45 @@ eth2.azure-vault-name: "AzureKeyVault"
Name of the vault to access.
Subdomain of `vault.azure.net`.

#### `commit-boost-api-enabled`

<Tabs>
<TabItem value="Syntax" label="Syntax" default>

```bash
--commit-boost-api-enabled[=<BOOLEAN>]
```

</TabItem>
<TabItem value="Example" label="Example">

```bash
--commit-boost-api-enabled=true
```

</TabItem>
<TabItem value="Environment variable" label="Environment variable">

```bash
WEB3SIGNER_ETH2__COMMIT_BOOST_API_ENABLED=true
```

</TabItem>
<TabItem value="Configuration file" label="Configuration file">

```bash
eth2.commit-boost-api-enabled: true
```

</TabItem>
</Tabs>

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`

<Tabs>
Expand Down Expand Up @@ -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`

<Tabs>
<TabItem value="Syntax" label="Syntax" default>

```bash
--proxy-keystores-password-file=<FILE>
```

</TabItem>
<TabItem value="Example" label="Example">

```bash
--proxy-keystores-password-file=password.txt
```

</TabItem>
<TabItem value="Environment variable" label="Environment variable">

```bash
WEB3SIGNER_ETH2_PROXY_KEYSTORES_PASSWORD_FILE=password.txt
```

</TabItem>
<TabItem value="Configuration file" label="Configuration file">

```bash
eth2.proxy-keystores-password-file: "password.txt"
```

</TabItem>
</Tabs>

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`

<Tabs>
<TabItem value="Syntax" label="Syntax" default>

```bash
--proxy-keystores-path=<PATH>
```

</TabItem>
<TabItem value="Example" label="Example">

```bash
--proxy-keystores-path=/home/me/proxy-keystores
```

</TabItem>
<TabItem value="Environment variable" label="Environment variable">

```bash
WEB3SIGNER_ETH2_PROXY_KEYSTORES_PATH=/home/me/proxy-keystores
```

</TabItem>
<TabItem value="Configuration file" label="Configuration file">

```bash
eth2.proxy-keystores-path: "/home/me/proxy-keystores"
```

</TabItem>
</Tabs>

The path to a directory to store the generated v3 and v4 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`

<Tabs>
Expand Down

0 comments on commit 052ddbd

Please sign in to comment.