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.

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

Add documentation for snapsync-bft-enabled option #1739

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

pullurib
Copy link

Description

Issue(s) fixed

#7924

Fixes #

@pullurib pullurib requested a review from a team as a code owner November 26, 2024 20:18
Copy link

vercel bot commented Nov 26, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
besu-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 26, 2024 10:53pm

Copy link
Contributor

@alexandratran alexandratran left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution! Since this option only applies to private networks (IBFT 2.0 and QBFT networks), can you move this documentation to the private networks command line options reference page?

@@ -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`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want to add the version of besu that this becomes available eg (since 24.12.0)

@macfarla
Copy link
Contributor

ok per comments on the besu PR this option is being removed altogether

Use `--Xsnapsync-bft-enabled` with `--sync-mode=SNAP` to enable snap sync in QBFT and IBFT 2.0 private networks.

:::

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so if the option is being removed altogether, we want this change (deletion)

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so if the option is being removed altogether, we DON'T want this change (addition)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants