DynComms [2/n]: Refactor Channel State Machine

[ProofOfKeags]

Change Description

~~Depends on #8270.~~

This is a series of single responsibility commits that improve the state of affairs within the channel state machine. The ultimate goal here in service of the Dynamic Commitments project is to make it such that we no longer have the updateLogs contain paymentDescriptors as the fundamentally tracked unit of update. This is unfortunately a long road which requires a number of changes which on their face do not seem necessary. I assure you that every one of these commits is ultimately in service of that goal, though.

It is highly recommended that you review commits one by one and in order. One of the consequences of having atomic, semantics-invariant commits is that some subsequent commits may ultimately make prior commits partially or fully obsolete. This is the price of making commit-by-commit review easy.

There is no specific requirement that every commit in this PR go in at once. This PR is mergeable at every commit and will be semantics-invariant.

Godspeed 🫡

Steps to Test

make unit pkg=lnwallet

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

• [ ] The change obeys the Code Documentation and Commenting guidelines, and lines wrap at 80.
• [ ] Commits follow the Ideal Git Commit Structure.
• [ ] Any new logging statements use an appropriate subsystem and logging level.
• [ ] Any new lncli commands have appropriate tags in the comments for the rpc in the proto file.
• [ ] There is a change description in the release notes, or [skip ci] in the commit message for small changes.

📝 Please see our Contribution Guidelines for further guidance.

[coderabbitai[bot]]

[!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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

[ProofOfKeags]

Did a quick review - have a mixed feeling now that we are pushing towards a symmetric design with the help of Dual, and sometimes the usage gives me a "too smart" vibe, maybe I'm being too cautious.

The main reason I am doing this is so we can select the appropriate field with the knowledge of which party we are looking for. This eliminates the following pattern:

thing := superStructure.localThing
if party == lntypes.Remote {
        thing = superStructure.remoteThing
}

and replaces it with a single-assignment expression:

thing := superStructure.things.GetForParty(party)

[lightninglabs-deploy]

@proofofkeags, remember to re-request review from reviewers when ready

[carlaKC]

Completed a high level pass on this, great refactor with really nice commit structure 🙏 Noticed that a lot of this is pulled out into #9097 - is that what we should review?

[ProofOfKeags]

Closing this as it is superseded by #9158 and #9097