From 55abb6efca70392fcd9dbb949d13010b4c359183 Mon Sep 17 00:00:00 2001 From: Bhanu Pulluri Date: Tue, 26 Nov 2024 15:14:54 -0500 Subject: [PATCH 1/7] Add documentation for snapsync-bft-enabled option Signed-off-by: Bhanu Pulluri --- docs/public-networks/reference/cli/options.md | 43 ++++++++++++++++--- 1 file changed, 38 insertions(+), 5 deletions(-) diff --git a/docs/public-networks/reference/cli/options.md b/docs/public-networks/reference/cli/options.md index 37977a000a..3b7fe730b5 100644 --- a/docs/public-networks/reference/cli/options.md +++ b/docs/public-networks/reference/cli/options.md @@ -5589,14 +5589,47 @@ The synchronization mode. Use `SNAP` for [snap sync](../../concepts/node-sync.md ::: -:::warning Early access feature +### `snapsync-bft-enabled` -`--Xsnapsync-bft-enabled` is an early access feature available in Besu version 24.7.1 and later. -It is not stable, so use this option with caution. + -Use `--Xsnapsync-bft-enabled` with `--sync-mode=SNAP` to enable snap sync in QBFT and IBFT 2.0 private networks. + -::: +```bash +--snapsync-bft-enabled[=] +``` + + + + + +```bash +--snapsync-bft-enabled=true +``` + + + + + +```bash +BESU_SNAPSYNC_BFT_ENABLED=true +``` + + + + + +```bash +snapsync-bft-enabled=true +``` + + + + + +Enables or disables snapsync in [IBFT 2.0](../../how-to/configure-besu/networks/ibft.md) and [QBFT](../../how-to/configure-besu/networks/qbft.md) private networks. The default is `false`. + +Use `--snapsync-bft-enabled` with `--sync-mode=SNAP` to enable snapsync in QBFT and IBFT 2.0 private networks. ### `target-gas-limit` From 8738293a08ab3138741581b1183a60fb69fbd3bb Mon Sep 17 00:00:00 2001 From: Bhanu Pulluri Date: Tue, 26 Nov 2024 17:52:08 -0500 Subject: [PATCH 2/7] Move the option usage to private networks Signed-off-by: Bhanu Pulluri --- .../private-networks/reference/cli/options.md | 42 +++++++++++++++++++ docs/public-networks/reference/cli/options.md | 42 ------------------- 2 files changed, 42 insertions(+), 42 deletions(-) diff --git a/docs/private-networks/reference/cli/options.md b/docs/private-networks/reference/cli/options.md index 12b178328c..8b6c4b948f 100644 --- a/docs/private-networks/reference/cli/options.md +++ b/docs/private-networks/reference/cli/options.md @@ -922,6 +922,48 @@ privacy-url="http://127.0.0.1:8888" The URL on which the [Tessera node](../../tutorials/privacy/index.md#3-create-tessera-configuration-files) is running. +### `snapsync-bft-enabled` + + + + + +```bash +--snapsync-bft-enabled[=] +``` + + + + + +```bash +--snapsync-bft-enabled=true +``` + + + + + +```bash +BESU_SNAPSYNC_BFT_ENABLED=true +``` + + + + + +```bash +snapsync-bft-enabled=true +``` + + + + + +Enables or disables snapsync in IBFT 2.0 and QBFT private networks. The default is `false`. + +Use `--snapsync-bft-enabled` with `--sync-mode=SNAP` to enable snapsync in QBFT and IBFT 2.0 private networks. + [accounts permissions configuration file]: ../../how-to/use-permissioning/local.md#permissions-configuration-file diff --git a/docs/public-networks/reference/cli/options.md b/docs/public-networks/reference/cli/options.md index 3b7fe730b5..e6d71b2506 100644 --- a/docs/public-networks/reference/cli/options.md +++ b/docs/public-networks/reference/cli/options.md @@ -5589,48 +5589,6 @@ The synchronization mode. Use `SNAP` for [snap sync](../../concepts/node-sync.md ::: -### `snapsync-bft-enabled` - - - - - -```bash ---snapsync-bft-enabled[=] -``` - - - - - -```bash ---snapsync-bft-enabled=true -``` - - - - - -```bash -BESU_SNAPSYNC_BFT_ENABLED=true -``` - - - - - -```bash -snapsync-bft-enabled=true -``` - - - - - -Enables or disables snapsync in [IBFT 2.0](../../how-to/configure-besu/networks/ibft.md) and [QBFT](../../how-to/configure-besu/networks/qbft.md) private networks. The default is `false`. - -Use `--snapsync-bft-enabled` with `--sync-mode=SNAP` to enable snapsync in QBFT and IBFT 2.0 private networks. - ### `target-gas-limit` From c2f3932c24530625f612eefcc103b99739243085 Mon Sep 17 00:00:00 2001 From: Bhanu Pulluri Date: Thu, 28 Nov 2024 12:08:03 -0500 Subject: [PATCH 3/7] Update docs about --Xsnapsync-bft-enabled deprecation and removal in future release Signed-off-by: Bhanu Pulluri --- docs/public-networks/reference/cli/options.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/public-networks/reference/cli/options.md b/docs/public-networks/reference/cli/options.md index e6d71b2506..86afe50ffd 100644 --- a/docs/public-networks/reference/cli/options.md +++ b/docs/public-networks/reference/cli/options.md @@ -5589,6 +5589,16 @@ The synchronization mode. Use `SNAP` for [snap sync](../../concepts/node-sync.md ::: +:::Deprecation warning Early access feature + +`--Xsnapsync-bft-enabled` is an early access feature available in Besu version 24.7.1 and later. +It is not stable, so use this option with caution. This option is now deprecated and will be removed in a future release. + +Use `--Xsnapsync-bft-enabled` with `--sync-mode=SNAP` to enable snap sync in QBFT and IBFT 2.0 private networks. +When `--Xsnapsync-bft-enabled` will be removed in a future release, snap sync will be enabled by default in QBFT and IBFT 2.0 private networks. + +::: + ### `target-gas-limit` From 770c20bc21bc89709cd1c8f21a9e80a57464e96e Mon Sep 17 00:00:00 2001 From: Bhanu Pulluri Date: Thu, 28 Nov 2024 12:26:08 -0500 Subject: [PATCH 4/7] Revert private options change Signed-off-by: Bhanu Pulluri --- .../private-networks/reference/cli/options.md | 42 ------------------- 1 file changed, 42 deletions(-) diff --git a/docs/private-networks/reference/cli/options.md b/docs/private-networks/reference/cli/options.md index 8b6c4b948f..12b178328c 100644 --- a/docs/private-networks/reference/cli/options.md +++ b/docs/private-networks/reference/cli/options.md @@ -922,48 +922,6 @@ privacy-url="http://127.0.0.1:8888" The URL on which the [Tessera node](../../tutorials/privacy/index.md#3-create-tessera-configuration-files) is running. -### `snapsync-bft-enabled` - - - - - -```bash ---snapsync-bft-enabled[=] -``` - - - - - -```bash ---snapsync-bft-enabled=true -``` - - - - - -```bash -BESU_SNAPSYNC_BFT_ENABLED=true -``` - - - - - -```bash -snapsync-bft-enabled=true -``` - - - - - -Enables or disables snapsync in IBFT 2.0 and QBFT private networks. The default is `false`. - -Use `--snapsync-bft-enabled` with `--sync-mode=SNAP` to enable snapsync in QBFT and IBFT 2.0 private networks. - [accounts permissions configuration file]: ../../how-to/use-permissioning/local.md#permissions-configuration-file From 70d8668c04cf9573df5ac96617e1369138c2c636 Mon Sep 17 00:00:00 2001 From: Bhanu Pulluri Date: Thu, 28 Nov 2024 12:29:37 -0500 Subject: [PATCH 5/7] fix a typo Signed-off-by: Bhanu Pulluri --- docs/public-networks/reference/cli/options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/public-networks/reference/cli/options.md b/docs/public-networks/reference/cli/options.md index c68c9d2954..4b434c72ee 100644 --- a/docs/public-networks/reference/cli/options.md +++ b/docs/public-networks/reference/cli/options.md @@ -5589,7 +5589,7 @@ The synchronization mode. Use `SNAP` for [snap sync](../../concepts/node-sync.md ::: -:::Deprecation warning Early access feature +::: Deprecation warning Early access feature `--Xsnapsync-bft-enabled` is an early access feature available in Besu version 24.7.1 and later. It is not stable, so use this option with caution. This option is now deprecated and will be removed in a future release. From 0e7c449697221e344f40b79aedce50ce97cde548 Mon Sep 17 00:00:00 2001 From: Bhanu Pulluri Date: Thu, 28 Nov 2024 12:33:02 -0500 Subject: [PATCH 6/7] Fix formatting Signed-off-by: Bhanu Pulluri --- docs/public-networks/reference/cli/options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/public-networks/reference/cli/options.md b/docs/public-networks/reference/cli/options.md index 4b434c72ee..87dab02a1d 100644 --- a/docs/public-networks/reference/cli/options.md +++ b/docs/public-networks/reference/cli/options.md @@ -5589,7 +5589,7 @@ The synchronization mode. Use `SNAP` for [snap sync](../../concepts/node-sync.md ::: -::: Deprecation warning Early access feature +:::warning Early access feature [Deprecated] `--Xsnapsync-bft-enabled` is an early access feature available in Besu version 24.7.1 and later. It is not stable, so use this option with caution. This option is now deprecated and will be removed in a future release. From e81d09e224f841e9d20a60a18f1900e8107938f8 Mon Sep 17 00:00:00 2001 From: Alexandra Tran Date: Mon, 2 Dec 2024 20:33:11 -0800 Subject: [PATCH 7/7] remove all notes Signed-off-by: Alexandra Tran --- .../concepts/node-sync-private.md | 19 +++++-------------- .../how-to/configure/consensus/ibft.md | 10 ---------- .../how-to/configure/consensus/qbft.md | 10 ---------- docs/public-networks/reference/cli/options.md | 10 ---------- 4 files changed, 5 insertions(+), 44 deletions(-) diff --git a/docs/private-networks/concepts/node-sync-private.md b/docs/private-networks/concepts/node-sync-private.md index 6ea0ef330d..0b5e28b37a 100644 --- a/docs/private-networks/concepts/node-sync-private.md +++ b/docs/private-networks/concepts/node-sync-private.md @@ -22,18 +22,9 @@ To sync Besu on a private network: The following is an overview of the private network sync modes. Select the sync mode based on your network's requirements and node purposes. -| Sync mode | Description | Requirements | Limitations | -|--------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|-------------| -| [Snap](../../public-networks/concepts/node-sync.md#snap-synchronization) | Recommended for fastest sync and lowest storage requirements on Mainnet. Downloads as many leaves of the trie as possible and reconstructs the trie locally. Faster than fast sync. | Besu version 24.3.0 or later | Cannot switch from fast sync to snap sync mid-process. | +| Sync mode | Description | Requirements | Limitations | +|--------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---------------------------------------------------------------------------------| +| [Snap](../../public-networks/concepts/node-sync.md#snap-synchronization) | Recommended for fastest sync and lowest storage requirements on Mainnet. Downloads as many leaves of the trie as possible and reconstructs the trie locally. Faster than fast sync. | Besu version 24.3.0 or later | Cannot switch from fast sync to snap sync mid-process. | | [Checkpoint](../../public-networks/concepts/node-sync.md#checkpoint-synchronization) | Syncs from a specific checkpoint block configured in the genesis file. Fastest sync mode with lowest storage requirements. | Besu version 22.4.3 or later | Not supported for QBFT or IBFT 2.0 networks without a checkpoint configuration. | -| [Fast](../../public-networks/concepts/node-sync.md#fast-synchronization-deprecated) | Downloads block headers and transaction receipts, verifies chain from genesis block. | None | Deprecated. Not supported with private transactions. | -| [Full](../../public-networks/concepts/node-sync.md#full-synchronization) | Default for all private networks. Downloads and verifies the entire blockchain and state from genesis block, building an archive node with full state history. | None | Slowest sync mode, requires the most disk space. | - -:::warning Early access feature - -`--Xsnapsync-bft-enabled` is an early access feature available in Besu version 24.7.1 and later. -It is not stable, so use this option with caution. - -Use `--Xsnapsync-bft-enabled` with `--sync-mode=SNAP` to enable snap sync in QBFT and IBFT 2.0 private networks. - -::: +| [Fast](../../public-networks/concepts/node-sync.md#fast-synchronization-deprecated) | Downloads block headers and transaction receipts, verifies chain from genesis block. | None | Deprecated. Not supported with private transactions. | +| [Full](../../public-networks/concepts/node-sync.md#full-synchronization) | Default for all private networks. Downloads and verifies the entire blockchain and state from genesis block, building an archive node with full state history. | None | Slowest sync mode, requires the most disk space. | diff --git a/docs/private-networks/how-to/configure/consensus/ibft.md b/docs/private-networks/how-to/configure/consensus/ibft.md index 5dc12fe5be..aa816dbe96 100644 --- a/docs/private-networks/how-to/configure/consensus/ibft.md +++ b/docs/private-networks/how-to/configure/consensus/ibft.md @@ -33,16 +33,6 @@ You can use a plugin to securely store a validator's key using the [`--security- ::: -:::info Early access feature - -`--Xsnapsync-bft-enabled` is an early access feature available in Besu version 24.7.1 and later. -It is not stable, so use this option with caution. - -Use `--Xsnapsync-bft-enabled` with `--sync-mode=SNAP` to enable -[snap sync](../../../concepts/node-sync-private.md) in IBFT 2.0 networks. - -::: - ## Genesis file To use IBFT 2.0, Besu requires an IBFT 2.0 [genesis file](../../../../public-networks/concepts/genesis-file.md). The genesis file defines properties specific to IBFT 2.0. diff --git a/docs/private-networks/how-to/configure/consensus/qbft.md b/docs/private-networks/how-to/configure/consensus/qbft.md index 71b1a25e31..016cf91885 100644 --- a/docs/private-networks/how-to/configure/consensus/qbft.md +++ b/docs/private-networks/how-to/configure/consensus/qbft.md @@ -33,16 +33,6 @@ You can use a plugin to securely store a validator's key using the [`--security- ::: -:::info Early access feature - -`--Xsnapsync-bft-enabled` is an early access feature available in Besu version 24.7.1 and later. -It is not stable, so use this option with caution. - -Use `--Xsnapsync-bft-enabled` with `--sync-mode=SNAP` to enable -[snap sync](../../../concepts/node-sync-private.md) in QBFT networks. - -::: - ## Genesis file To use QBFT, define a [genesis file](../../../../public-networks/concepts/genesis-file.md) that contains the QBFT properties. diff --git a/docs/public-networks/reference/cli/options.md b/docs/public-networks/reference/cli/options.md index 87dab02a1d..b65ca3bc3b 100644 --- a/docs/public-networks/reference/cli/options.md +++ b/docs/public-networks/reference/cli/options.md @@ -5589,16 +5589,6 @@ The synchronization mode. Use `SNAP` for [snap sync](../../concepts/node-sync.md ::: -:::warning Early access feature [Deprecated] - -`--Xsnapsync-bft-enabled` is an early access feature available in Besu version 24.7.1 and later. -It is not stable, so use this option with caution. This option is now deprecated and will be removed in a future release. - -Use `--Xsnapsync-bft-enabled` with `--sync-mode=SNAP` to enable snap sync in QBFT and IBFT 2.0 private networks. -When `--Xsnapsync-bft-enabled` will be removed in a future release, snap sync will be enabled by default in QBFT and IBFT 2.0 private networks. - -::: - ### `target-gas-limit`