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

Jump to bottom

Add --Xsnapsync-bft-enabled deprecation notice #1739

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+3 −2
Open

Add --Xsnapsync-bft-enabled deprecation notice #1739

Changes from 1 commit
Commits
Show all changes
6 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
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
43 changes: 38 additions & 5 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,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.
<Tabs>

Use `--Xsnapsync-bft-enabled` with `--sync-mode=SNAP` to enable snap sync in QBFT and IBFT 2.0 private networks.
<TabItem value="Syntax" label="Syntax" default>

:::
```bash
--snapsync-bft-enabled[=<true|false>]
```

</TabItem>

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

```bash
--snapsync-bft-enabled=true
```

</TabItem>

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

```bash
BESU_SNAPSYNC_BFT_ENABLED=true
```

</TabItem>

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

```bash
snapsync-bft-enabled=true
```

</TabItem>

</Tabs>

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.

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

Expand Down
Loading