Skip to content

Add Integration Test for Sweeper Fee-Bumping to Maximum Fee Rate #9733

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

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

gitsofaryan
Copy link

Description

This PR adds testBumpFeeUntilMaxReached, an integration test to validate the LND sweeper’s fee-bumping for wallet transactions. It ensures the sweeper escalates fees to the configured maximum (--sweeper.maxfeerate=100 sat/vbyte), respects budgets, and handles errors like "max fee rate exceeded". The test supports optimizing sweeper fee functions (e.g., cubic delay, linear, cubic eager) per issue #8763.

The test:

  • Sets up a node with --sweeper.maxfeerate=100, funds it with 1 BTC.
  • Sends 0.001 BTC at 1 sat/vbyte (unconfirmed).
  • Bumps fees via BumpFee RPC until 100 sat/vbyte, with a 50,000 sat budget.
  • Verifies fee rate (FeeSat / VSize) and confirms the transaction.

Results: Successfully reaches 100 sat/vbyte in ~3 bumps (1 → 10 → 50 → 100 sat/vbyte), passes all assertions.

Link to Associated Issue: Issue #8763 (adjust if needed).

Steps to Test

  1. Clone and Checkout:

    git clone https://github.com/lightningnetwork/lnd.git
    cd lnd
    git checkout <branch-name>
  2. Set Up:

    • Ensure Go (1.21+) and make are installed.
    • Run go mod tidy.
  3. Run Test:

    make clean && make itest icase=bump_fee_until_max_reached
  4. Verify Output:

    Initial fee rate: 1 sat/vbyte
    Attempt #1: fee rate = 10 sat/vbyte
    Attempt #2: fee rate = 50 sat/vbyte
    Attempt #3: fee rate = 100 sat/vbyte
    Stopped bumping at max fee rate
    
    • Confirm test passes (final fee rate ≥100 sat/vbyte).
  5. Test Edge Cases:

    • Set --sweeper.maxfeerate=50 in itest/lnd_fee_bump_max.go, rerun, verify 50 sat/vbyte limit.
    • Set Budget: 1000, confirm budget error.
  6. Review Code:

    • Check itest/lnd_fee_bump_max.go and itest/list_on_test.go.

Pull Request Checklist

Testing

  • PR passes CI checks (tested on commit kvdb/v1.4.15-37-g51add8a70-dirty).
  • Includes positive (reaching 100 sat/vbyte) and negative (error handling) tests.
  • Not a bug fix, so no regression tests needed.

Code Style and Documentation

📝 See Contribution Guidelines for further guidance.

Copy link
Contributor

coderabbitai bot commented Apr 18, 2025

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)
  • llm-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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

@gitsofaryan gitsofaryan marked this pull request as draft April 18, 2025 11:40
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.

1 participant