Skip to content

chainreg: use feerate estimator in regtest and simnet#9257

Merged
guggero merged 2 commits into
lightningnetwork:masterfrom
starius:estimatefeerate-regtest2
Dec 3, 2024
Merged

chainreg: use feerate estimator in regtest and simnet#9257
guggero merged 2 commits into
lightningnetwork:masterfrom
starius:estimatefeerate-regtest2

Conversation

@starius

@starius starius commented Nov 12, 2024

Copy link
Copy Markdown
Collaborator

Change Description

If feeurl is not provided and LND is running in bitcoind or btcd mode, use fee estimator provided by bitcoind or btcd instead of using static fee estimator (which always returns 50 sats/vbyte).

This enables simulating high feerate environment in regtest and simnet not only via feeurl, but also by filling mempool with high feerate transactions, which is closer to what happens in mainnet.

Also skip creating bitcoind or btcd fee estimator, if feeurl is provided. Before LND logged both "Initializing bitcoind backed fee estimator" and "Using external fee estimator" if running in bitcoind mode with feeurl provided, but actually feeurl was used, so this is not a change of behavior.

Steps to Test

  • Setup regtest/simnet network with LND, e.g. in docker. Deploy LND from this branch.
  • Run lncli wallet estimatefeerate 2 and make sure that sat_per_vbyte in response is 1. If you see value 50, this means that the deployed LND is not from this branch (previous behavior was to always return 50).
  • Fill mempool with high feerate transactions, e.g. using mempool-filler tool
  • Run lncli wallet estimatefeerate 2 again and make sure sat_per_vbyte is higher than 1.

I tested bitcoind/regtest and btcd/simnet modes.

Pull Request Checklist

Testing

  • Your PR passes all CI checks.
  • Tests covering the positive and negative (error paths) are included.
  • Bug fixes contain tests triggering the bug to prevent regressions.

Code Style and Documentation

📝 Please see our Contribution Guidelines for further guidance.

@coderabbitai

coderabbitai Bot commented Nov 12, 2024

Copy link
Copy Markdown
Contributor

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.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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

@starius starius marked this pull request as ready for review November 12, 2024 12:49
@starius starius force-pushed the estimatefeerate-regtest2 branch 2 times, most recently from 6ef0409 to 3222cb7 Compare November 12, 2024 15:25
@ziggie1984 ziggie1984 self-requested a review November 19, 2024 22:18
@lightninglabs-deploy

Copy link
Copy Markdown
Collaborator

@ziggie1984: review reminder

@yyforyongyu yyforyongyu left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Pending a release note, otherwise LGTM🙏

If feeurl is not provided and LND is running in bitcoind or btcd mode, use
fee estimator provided by bitcoind or btcd instead of using static fee estimator
(which always returns 50 sats/vbyte).

This enables simulating high feerate environment in regtest and simnet not only
via feeurl, but also by filling mempool with high feerate transactions, which is
closer to what happens in mainnet.

Also skip creating bitcoind or btcd fee estimator, if feeurl is provided. Before
LND logged both "Initializing bitcoind backed fee estimator" and "Using external
fee estimator" if running in bitcoind mode with feeurl provided, but actually
feeurl was used, so this is not a change of behavior.
@starius starius force-pushed the estimatefeerate-regtest2 branch from 3222cb7 to 23b025c Compare November 27, 2024 13:32
@starius

starius commented Nov 27, 2024

Copy link
Copy Markdown
Collaborator Author

Pending a release note, otherwise LGTM🙏

Thanks! Added to release notes.

@ziggie1984 ziggie1984 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I wonder if it makes sense to have the possiblity to have the static estimator still in place if needed via a config value even if bitcoind and btcd backends are selected ?

@starius

starius commented Nov 27, 2024

Copy link
Copy Markdown
Collaborator Author

I wonder if it makes sense to have the possiblity to have the static estimator still in place if needed via a config value even if bitcoind and btcd backends are selected ?

It is possible via feeurl flag pointing to a static URL returning the static fee.

@ziggie1984 ziggie1984 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Cool, yeah for itests we already use theWebFeeService so I guess there is no real usecase for the static fee-estimator and as you mentioned if people still need it in manual testing they should run their own web fee service.

@starius starius requested a review from yyforyongyu December 3, 2024 16:17

@yyforyongyu yyforyongyu left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM⛵️

@guggero guggero merged commit 48fba10 into lightningnetwork:master Dec 3, 2024
@ziggie1984

Copy link
Copy Markdown
Collaborator

Just as a reminder, most of the time bitcoind in regtest mode will not really have enough data to come up with an estimation due to the lack of mempool transaction, hence for most of the regtest setups if not many mempool transaction are created manually, the fallbackfee will be used and the estimator will in fact behave like a static estimator again.

fallBackFeeRate := chainfee.SatPerKVByte(25 * 1000)

@starius starius deleted the estimatefeerate-regtest2 branch December 4, 2024 15:00
bitromortac added a commit to bitromortac/faraday that referenced this pull request Mar 5, 2026
We update expected channel open fees because due to
lightningnetwork/lnd#9257 fee estimation in regtest was halved from
50 sat/vbyte to 25 sat/vbyte.
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.

5 participants