From eca068bc548a2f188266c7ca3baed7e073715c8b Mon Sep 17 00:00:00 2001 From: Gabriel Fukushima Date: Wed, 30 Aug 2023 12:47:52 +1000 Subject: [PATCH 1/4] fix: pruning-at-boot default Signed-off-by: Gabriel Fukushima --- docs/how-to/configure-slashing-protection.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/how-to/configure-slashing-protection.md b/docs/how-to/configure-slashing-protection.md index 760ac4a..6e6e885 100644 --- a/docs/how-to/configure-slashing-protection.md +++ b/docs/how-to/configure-slashing-protection.md @@ -138,16 +138,16 @@ Enable pruning by setting [`--slashing-protection-pruning-enabled`](../reference/cli/subcommands.md#slashing-protection-pruning-enabled) to `true`. -By default, Web3Signer prunes the database on startup, and then after each pruning interval. -You can disable pruning at startup and start pruning after the pruning interval by setting +Web3Signer can prune the database on startup, and then after each pruning interval. +By default, this feature is disable. You can enable pruning at startup and start pruning after the pruning interval by setting [`--slashing-protection-pruning-at-boot-enabled`](../reference/cli/subcommands.md#slashing-protection-pruning-at-boot-enabled) -to `false`. +to `true`. You can include additional optional pruning configuration options. For example, run: ```bash -web3signer eth2 --slashing-protection-db-url="jdbc:postgresql://localhost/web3signer" --slashing-protection-db-username=postgres --slashing-protection-db-password=password --slashing-protection-pruning-enabled=true --slashing-protection-pruning-at-boot-enabled=false --slashing-protection-pruning-epochs-to-keep=5000 --slashing-protection-pruning-interval=18 +web3signer eth2 --slashing-protection-db-url="jdbc:postgresql://localhost/web3signer" --slashing-protection-db-username=postgres --slashing-protection-db-password=password --slashing-protection-pruning-enabled=true --slashing-protection-pruning-at-boot-enabled=true --slashing-protection-pruning-epochs-to-keep=5000 --slashing-protection-pruning-interval=18 ``` :::caution Warning From 3d57631f6437b7b3c7776be789a43e962f5af110 Mon Sep 17 00:00:00 2001 From: Gabriel Fukushima Date: Wed, 30 Aug 2023 13:28:53 +1000 Subject: [PATCH 2/4] Update docs/how-to/configure-slashing-protection.md Co-authored-by: Jason Frame --- docs/how-to/configure-slashing-protection.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to/configure-slashing-protection.md b/docs/how-to/configure-slashing-protection.md index 6e6e885..472d509 100644 --- a/docs/how-to/configure-slashing-protection.md +++ b/docs/how-to/configure-slashing-protection.md @@ -139,7 +139,7 @@ Enable pruning by setting to `true`. Web3Signer can prune the database on startup, and then after each pruning interval. -By default, this feature is disable. You can enable pruning at startup and start pruning after the pruning interval by setting +By default, this feature is disabled. You can enable pruning at startup and start pruning after the pruning interval by setting [`--slashing-protection-pruning-at-boot-enabled`](../reference/cli/subcommands.md#slashing-protection-pruning-at-boot-enabled) to `true`. From 658578968dae4e2352e9d43601d01a2849e1ee6c Mon Sep 17 00:00:00 2001 From: Gabriel Fukushima Date: Wed, 30 Aug 2023 14:13:00 +1000 Subject: [PATCH 3/4] fix: pruning-at-boot default in the subcommand reference Signed-off-by: Gabriel Fukushima --- docs/reference/cli/subcommands.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/reference/cli/subcommands.md b/docs/reference/cli/subcommands.md index e2e7c96..130ef39 100644 --- a/docs/reference/cli/subcommands.md +++ b/docs/reference/cli/subcommands.md @@ -1693,28 +1693,28 @@ The default is `true`. # Example ```bash ---slashing-protection-pruning-at-boot-enabled=false +--slashing-protection-pruning-at-boot-enabled=true ``` # Environment variable ```bash -WEB3SIGNER_ETH2_SLASHING_PROTECTION_PRUNING_AT_BOOT_ENABLED=false +WEB3SIGNER_ETH2_SLASHING_PROTECTION_PRUNING_AT_BOOT_ENABLED=true ``` # Configuration file ```yaml -eth2.slashing-protection-pruning-at-boot-enabled: false +eth2.slashing-protection-pruning-at-boot-enabled: true ``` -When set to `false`, [slashing protection database +When set to `true`, [slashing protection database pruning](../../how-to/configure-slashing-protection.md#prune-the-slashing-protection-database) is -disabled at boot and only takes place at the scheduled [pruning intervals](#slashing-protection-pruning-interval). +enabled at boot as well as in the defined interval [pruning intervals](#slashing-protection-pruning-interval). -The default is `true`. +The default is `false`. #### `slashing-protection-pruning-db-pool-configuration-file` From 290bad84e17ed83722236c5b59d853d05df75e19 Mon Sep 17 00:00:00 2001 From: Alexandra Tran Carrillo <12214231+alexandratran@users.noreply.github.com> Date: Wed, 30 Aug 2023 10:16:25 -0700 Subject: [PATCH 4/4] Update docs/reference/cli/subcommands.md --- docs/reference/cli/subcommands.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/cli/subcommands.md b/docs/reference/cli/subcommands.md index 130ef39..222646b 100644 --- a/docs/reference/cli/subcommands.md +++ b/docs/reference/cli/subcommands.md @@ -1712,7 +1712,7 @@ eth2.slashing-protection-pruning-at-boot-enabled: true When set to `true`, [slashing protection database pruning](../../how-to/configure-slashing-protection.md#prune-the-slashing-protection-database) is -enabled at boot as well as in the defined interval [pruning intervals](#slashing-protection-pruning-interval). +enabled at startup and at the defined [pruning intervals](#slashing-protection-pruning-interval). The default is `false`.