Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove --Xsnapsync-bft-enabled #1739

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
+5 −43
Open

Remove --Xsnapsync-bft-enabled #1739

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
55abb6e
Add documentation for snapsync-bft-enabled option
Nov 26, 2024
8738293
Move the option usage to private networks
Nov 26, 2024
c2f3932
Update docs about --Xsnapsync-bft-enabled deprecation and removal in …
Nov 28, 2024
770c20b
Revert private options change
Nov 28, 2024
6263b6a
Merge branch 'main' into 7924-bft-snapsync
pullurib Nov 28, 2024
70d8668
fix a typo
Nov 28, 2024
0e7c449
Fix formatting
Nov 28, 2024
e81d09e
remove all notes
Dec 3, 2024
99caf3b
Merge branch 'main' into 7924-bft-snapsync
alexandratran Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 5 additions & 14 deletions docs/private-networks/concepts/node-sync-private.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
10 changes: 0 additions & 10 deletions docs/private-networks/how-to/configure/consensus/ibft.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
10 changes: 0 additions & 10 deletions docs/private-networks/how-to/configure/consensus/qbft.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
9 changes: 0 additions & 9 deletions docs/public-networks/reference/cli/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5589,15 +5589,6 @@ The synchronization mode. Use `SNAP` for [snap sync](../../concepts/node-sync.md

:::

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

:::

pullurib marked this conversation as resolved.
Show resolved Hide resolved
### `target-gas-limit`

<Tabs>
Expand Down
Loading