Skip to content

feat: add flags to disable broadcast and receiving of tx gossip #1194

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

Merged
merged 3 commits into from
Jun 20, 2025

Conversation

jonastheis
Copy link

@jonastheis jonastheis commented Jun 4, 2025

1. Purpose or design rationale of this PR

This PR adds two flags to disable tx gossip broadcast and tx gossip receiving, respectively.

  • txgossip.disablebroadcast: disable broadcast of transactions to other peers
  • txgossip.disablereceiving: disable receiving of transactions from other peers

2. PR title

Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:

  • build: Changes that affect the build system or external dependencies (example scopes: yarn, eslint, typescript)
  • ci: Changes to our CI configuration files and scripts (example scopes: vercel, github, cypress)
  • docs: Documentation-only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that doesn't fix a bug, or add a feature, or improves performance
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

3. Deployment tag versioning

Has the version in params/version.go been updated?

  • This PR doesn't involve a new deployment, git tag, docker image tag, and it doesn't affect traces
  • Yes

4. Breaking change label

Does this PR have the breaking-change label?

  • This PR is not a breaking change
  • Yes

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features
    • Added command-line options to disable transaction gossip broadcasting and receiving.
    • Users can now selectively prevent the node from broadcasting or receiving transaction gossip via CLI flags.
  • Improvements
    • Help documentation updated to include the new flags under the "ROLLUP" section.
    • Informational logs are shown when transaction gossip features are disabled.
  • Bug Fixes
    • Transaction broadcast loop and transaction acceptance now respect the new disable flags, preventing unwanted gossip activity when disabled.
  • Version Update
    • Patch version incremented to 57.

Copy link

coderabbitai bot commented Jun 4, 2025

Walkthrough

Two new CLI flags were introduced to control transaction gossip broadcasting and receiving. These flags propagate through the configuration system, adding corresponding fields to config structs and logic to conditionally enable or disable transaction broadcast and acceptance in the Ethereum handler. Help documentation and flag groupings were updated accordingly.

Changes

File(s) Change Summary
cmd/geth/main.go, cmd/geth/usage.go Added two new CLI flags for disabling transaction gossip broadcast and receiving; updated flag groupings and help output.
cmd/utils/flags.go Defined new global boolean flags, updated config struct, and set config fields based on CLI context; added logging.
eth/ethconfig/config.go Added two boolean fields to the main Ethereum config struct for the new gossip options.
eth/backend.go Passed new config fields to handler configuration during backend initialization.
eth/handler.go Added config and handler fields; updated handler constructor and Start method to respect the new flags.
eth/handler_eth.go Modified AcceptTxs method to check the new disableTxReceiving flag before accepting transactions.
params/version.go Incremented patch version from 56 to 57.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant Config
    participant Backend
    participant Handler

    User->>CLI: Start with --txgossip.disablebroadcast / --txgossip.disablereceiving
    CLI->>Config: Set TxGossipBroadcastDisabled / TxGossipReceivingDisabled
    Config->>Backend: Pass config with new flags
    Backend->>Handler: Initialize with DisableTxBroadcast / DisableTxReceiving
    Handler->>Handler: On Start, skip broadcast loop if DisableTxBroadcast
    Handler->>Handler: On AcceptTxs, return false if DisableTxReceiving
Loading

Suggested reviewers

  • jonastheis
  • omerfirmak

Poem

Two new flags for gossip's fate,
To broadcast or receive, now you can dictate.
The handler listens, the config obeys,
With a hop and a skip, in new bunny ways.
🐇✨
Toggle the chatter, let silence or noise,
The blockchain now listens to your choice!


📜 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 68e4e09 and 3df18c4.

📒 Files selected for processing (1)
  • params/version.go (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • params/version.go
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (go)
✨ 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.

@yiweichi yiweichi marked this pull request as ready for review June 19, 2025 20:47
@yiweichi yiweichi merged commit 02b33db into develop Jun 20, 2025
4 checks passed
@yiweichi yiweichi deleted the feat/disable-tx-gossip branch June 20, 2025 10:54
@coderabbitai coderabbitai bot mentioned this pull request Jun 20, 2025
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants