lightningdevkit / rust-lightning

A highly modular Bitcoin Lightning library written in Rust. It's rust-lightning, not Rusty's Lightning!
Other
1.17k stars 368 forks source link

[Splicing] Preserve funding_transaction for the later lifecycle of the channel, simple solution #3380

Closed optout21 closed 1 month ago

optout21 commented 1 month ago

Fixes #3300

In splicing, the funding transaction (not just the ID) is needed during splice negotiation. Funding transaction is kept in field ChannelContext.funding_transaction. However, the way it is currently used is that it is cleared when the tx is broadcast, and this fact is used in some logic.

This change:

Note that in some cases the funding transaction may get broadcasted more than once, which is a change in behavior.

Alternative is to preserve behavior, with some extra field, #3317 .

TheBlueMatt commented 1 month ago

We shouldn't keep broadcasting forever, but I think we can trivially solve that by just checking if the funding tx has confirmed before broadcasting?

jkczyz commented 1 month ago

We shouldn't keep broadcasting forever, but I think we can trivially solve that by just checking if the funding tx has confirmed before broadcasting?

Is that what is checked immediately below where the funding tx was previously taken?

https://github.com/lightningdevkit/rust-lightning/blob/ee23649af97e48362f78a844a3b6130cb13104b4/lightning/src/ln/channel.rs#L5492-L5496

Or are there other places we'd need to worry about?

TheBlueMatt commented 1 month ago

Is that what is checked immediately below where the funding tx was previously taken?

Not quite, that will keep broadcasting forever if the channel is 0conf or keep broadcasting after the funding is confirmed at minimum_depth - 1 confirmations, which is a bit weird.

optout21 commented 1 month ago

Not quite, that will keep broadcasting forever if the channel is 0conf or keep broadcasting after the funding is confirmed at minimum_depth - 1 confirmations, which is a bit weird.

Indeed, once the funding transaction is confirmed, it makes no sense to rebroadcast, funding_tx_confirmation_height is not checked here.

TheBlueMatt commented 1 month ago

I think with just that change I'd be happy with this PR :)

coderabbitai[bot] commented 1 month ago

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
optout21 commented 1 month ago

Changed the test for preventing re-broadcast to look whether the funding transaction is confirmed or not (instead of looking at ChannelReady state). With this, the test updated had to be reverted, the behavior is the same as before.

optout21 commented 1 month ago

Addressed @jkczyz 's comments; not yet squashed

optout21 commented 1 month ago

Squashed with no changes