Skip to content

Commit d765b69

Browse files
pulluribBhanu PulluriAlexandra Tranalexandratranmacfarla
authored
Remove --Xsnapsync-bft-enabled (#1739)
* Add documentation for snapsync-bft-enabled option Signed-off-by: Bhanu Pulluri <bhanu.pulluri@kaleido.io> * Move the option usage to private networks * remove all notes Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net> --------- Signed-off-by: Bhanu Pulluri <bhanu.pulluri@kaleido.io> Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net> Co-authored-by: Bhanu Pulluri <bhanu.pulluri@kaleido.io> Co-authored-by: Alexandra Tran <alexandra.tran@consensys.net> Co-authored-by: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com> Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com>
1 parent 31c7c3d commit d765b69

File tree

4 files changed

+5
-43
lines changed

4 files changed

+5
-43
lines changed

docs/private-networks/concepts/node-sync-private.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,9 @@ To sync Besu on a private network:
2222
The following is an overview of the private network sync modes.
2323
Select the sync mode based on your network's requirements and node purposes.
2424

25-
| Sync mode | Description | Requirements | Limitations |
26-
|--------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|-------------|
27-
| [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. |
25+
| Sync mode | Description | Requirements | Limitations |
26+
|--------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---------------------------------------------------------------------------------|
27+
| [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. |
2828
| [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. |
29-
| [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. |
30-
| [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. |
31-
32-
:::warning Early access feature
33-
34-
`--Xsnapsync-bft-enabled` is an early access feature available in Besu version 24.7.1 and later.
35-
It is not stable, so use this option with caution.
36-
37-
Use `--Xsnapsync-bft-enabled` with `--sync-mode=SNAP` to enable snap sync in QBFT and IBFT 2.0 private networks.
38-
39-
:::
29+
| [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. |
30+
| [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. |

docs/private-networks/how-to/configure/consensus/ibft.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,6 @@ You can use a plugin to securely store a validator's key using the [`--security-
3333

3434
:::
3535

36-
:::info Early access feature
37-
38-
`--Xsnapsync-bft-enabled` is an early access feature available in Besu version 24.7.1 and later.
39-
It is not stable, so use this option with caution.
40-
41-
Use `--Xsnapsync-bft-enabled` with `--sync-mode=SNAP` to enable
42-
[snap sync](../../../concepts/node-sync-private.md) in IBFT 2.0 networks.
43-
44-
:::
45-
4636
## Genesis file
4737

4838
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.

docs/private-networks/how-to/configure/consensus/qbft.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,6 @@ You can use a plugin to securely store a validator's key using the [`--security-
3333

3434
:::
3535

36-
:::info Early access feature
37-
38-
`--Xsnapsync-bft-enabled` is an early access feature available in Besu version 24.7.1 and later.
39-
It is not stable, so use this option with caution.
40-
41-
Use `--Xsnapsync-bft-enabled` with `--sync-mode=SNAP` to enable
42-
[snap sync](../../../concepts/node-sync-private.md) in QBFT networks.
43-
44-
:::
45-
4636
## Genesis file
4737

4838
To use QBFT, define a [genesis file](../../../../public-networks/concepts/genesis-file.md) that contains the QBFT properties.

docs/public-networks/reference/cli/options.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5802,15 +5802,6 @@ The synchronization mode. Use `SNAP` for [snap sync](../../concepts/node-sync.md
58025802

58035803
:::
58045804

5805-
:::warning Early access feature
5806-
5807-
`--Xsnapsync-bft-enabled` is an early access feature available in Besu version 24.7.1 and later.
5808-
It is not stable, so use this option with caution.
5809-
5810-
Use `--Xsnapsync-bft-enabled` with `--sync-mode=SNAP` to enable snap sync in QBFT and IBFT 2.0 private networks.
5811-
5812-
:::
5813-
58145805
### `target-gas-limit`
58155806

58165807
<Tabs>

0 commit comments

Comments
 (0)