Skip to content

feat: enable bip157 filters by default #6711

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
Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

feat: enable bip157 filters by default #6711

wants to merge 4 commits into from
+13 −3

Conversation

PastaPastaPasta
Copy link
Member

Issue being fixed or feature implemented

This pull request introduces updates to improve privacy and functionality for light clients and pruned nodes by serving BIP157 compact block filters by default. The changes update default settings and configuration values to reflect this enhancement.

What was done?

  • Release Notes: Updated the release notes to highlight that BIP157 compact block filters are now enabled by default. The -blockfilterindex option defaults to basic instead of 0 (disabled), and the -peerblockfilters option defaults to true instead of false. This change improves privacy for light clients and enhances support for pruned nodes.

  • Default Peer Block Filters: Changed the default value of DEFAULT_PEERBLOCKFILTERS from false to true in the network processing configuration.

  • Default Block Filter Index: Updated the default value of DEFAULT_BLOCKFILTERINDEX from "0" to "basic" in the validation configuration.

How Has This Been Tested?

Built locally

Breaking Changes

None

Checklist:

Go over all the following points, and put an x in all the boxes that apply.

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have made corresponding changes to the documentation
  • I have assigned this pull request to a milestone (for repository code-owners and collaborators only)

@PastaPastaPasta
Enable BIP157 block filters index and serving by default
0a39e88 
This change enables compact block filters (BIP157) functionality by default:
- Sets DEFAULT_BLOCKFILTERINDEX to "basic" instead of "0"
- Sets DEFAULT_PEERBLOCKFILTERS to true instead of false

This improves privacy for light clients and enables better pruned node support.
@PastaPastaPasta
docs: Add release notes for PR dashpay#6708
3c601b6 
Documents the change to enable BIP157 block filters by default.
@PastaPastaPasta
docs: Fix PR number in release notes - rename to 6711
70ed730 
Updates the release notes file name and PR reference from 6708 to 6711.
@PastaPastaPasta PastaPastaPasta added this to the 23 milestone Jun 5, 2025
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jun 5, 2025 •
edited
Loading

Walkthrough

The changes update default configuration values to enable BIP157 compact block filters by default. Specifically, the default for the -blockfilterindex option is changed from "0" (disabled) to "basic", and the default for the -peerblockfilters option is changed from false to true. These changes are reflected in the documentation and in the relevant source files by updating the corresponding constants. Additionally, initialization logic was modified to ensure that if the -blockfilterindex argument is set but no explicit values are provided, the default "basic" value is inserted before processing. No other code logic or public API declarations were altered.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 70ed730 and 9663948.

📒 Files selected for processing (1)
  • src/init.cpp (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: arm-linux-gnueabihf / Build depends
  • GitHub Check: x86_64-w64-mingw32 / Build depends
  • GitHub Check: x86_64-pc-linux-gnu_nowallet / Build depends
  • GitHub Check: x86_64-pc-linux-gnu_multiprocess / Build depends
  • GitHub Check: x86_64-apple-darwin / Build depends
  • GitHub Check: x86_64-pc-linux-gnu / Build depends
🔇 Additional comments (1)
src/init.cpp (1)

1135-1139: LGTM! Correctly handles the default value insertion for block filter index.

This implementation properly addresses the case where -blockfilterindex is specified without explicit values. When args.GetArgs("-blockfilterindex") returns an empty vector despite the argument being set, the code correctly inserts the new default value (DEFAULT_BLOCKFILTERINDEX = "basic") to ensure the subsequent processing loop has the expected default filter type to work with.

The logic aligns well with the PR objective to enable BIP157 compact block filters by default while maintaining backward compatibility for explicit value specifications.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@PastaPastaPasta
Fix initialization error when using default blockfilterindex value
9663948 
When blockfilterindex defaults to "basic" but no explicit command line
argument is provided, GetArgs("-blockfilterindex") returns an empty vector.
This caused the validation logic to fail with "Cannot set -peerblockfilters
without -blockfilterindex" error.

Add check for empty names vector and use the default value when needed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
23
Development

Successfully merging this pull request may close these issues.
1 participant
@PastaPastaPasta