[2/?]: lnwallet+channeldb: add new AuxLeafStore for dynamic aux leaves #8684

guggero · 2024-04-24T13:04:07Z

Depends/bases on #8683.

Replaces #8562 (with correct base branch and upstream feature branch).

In this commit, we add a new abstraction, the AuxLeafStore that's capable of dynamically deriving hte aux leaves for a new commitment state given the channel point and custom blob stored. The custom blob can be used by external programers to store custom information for a channel which can then be used to derive the aux leaves for each new state. All added features in this PR as optional, and if not set, don't alter the normal channel flow.

NOTE: In this PR, I've started to also commit my local go.work files, as I have some submodules change, and committing the go.work file allows the PR to build w/o any temporary commits or PRs.

TODO

Add custom blob to commit diff
Use leaf store to refresh blob for each new state
Thread through to the remaining resolvers

Summary by CodeRabbit

New Features
- Introduced customizable script paths for channel and commitment transactions, enhancing flexibility and potential for future upgrades.
- Added support for auxiliary tapscript leaves in commitment transactions, allowing for extended functionality.
Enhancements
- Extended the wallet's capability to create commitment transactions with customizable options.
Refactor
- Improved code structure related to script generation and handling of custom data blobs within channel data structures.
Tests
- Expanded test coverage to include new features and enhancements, ensuring robustness and reliability.

Link to all PRs in the saga:

github-actions · 2024-04-24T13:04:32Z

Pull reviewers stats

Stats of the last 30 days for lnd:

User	Total reviews	Time to review	Total comments
guggero 🥇	21 ▀▀▀	12h 42m	25 ▀
Roasbeef 🥈	13 ▀▀	7d 8h 43m ▀	76 ▀▀▀
ellemouton 🥉	7 ▀	5h 10m	7
bhandras	6 ▀	13h 56m	1
ziggie1984	6 ▀	8d 18h 41m ▀	45 ▀▀
morehouse	4 ▀	7d 11h 12m ▀	19 ▀
ProofOfKeags	3	7d 8h 56m ▀	40 ▀▀
yyforyongyu	2	12h 24m	1
Crypt-iQ	2	7d 5h 38m ▀	8
saubyk	2	3d 17h 37m	0
ffranr	1	3d 16h 49m	5
dstadulis	1	14d 35m ▀▀	1
bitromortac	1	14d 3h 18m ▀▀	3
Chinwendu20	1	23h 27m	1

coderabbitai · 2024-04-24T13:05:18Z

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

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

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 as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

guggero · 2024-04-25T17:09:01Z

I can't approve the PR because I re-opened it. But I reviewed it and worked my feedback directly into the commits.
So I'm approving it with this comment: LGTM 🎉

Perhaps we'll want to wait for #8692 to be merged to fix the linter issue. But can also address that once we merge the 0-19-staging branch into master.

Roasbeef

LGTM 🪁

Roasbeef · 2024-04-26T01:57:51Z

I think it's missing a commit somewhere?

Error: lnwallet/commitment.go:632:27: undefined: input.AuxTapLeaves

Roasbeef · 2024-04-26T02:06:30Z

From this diff: 1343306#diff-4eeb8157d2accb3776a8957d079aea699569d4feeaf43d9d082fe0889b4b1ec6R25

guggero · 2024-04-26T10:08:16Z

Oops, will fix.

guggero · 2024-04-29T09:30:42Z

Bumped go.mod to use tlv/v1.2.5 and with that also removed the go.work file (as that caused some issues with the linter). Also fixed the commit order, should be good to go now.

GeorgeTsagk

Looks good 🍀

channeldb/channel.go

input/taproot.go

lnwallet/commitment.go

GeorgeTsagk · 2024-04-30T11:59:00Z

channeldb/revocation_log.go

@@ -72,116 +148,60 @@ var (
 // made into tlv records without further conversion.
 type HTLCEntry struct {
 	// RHash is the payment hash of the HTLC.
-	RHash [32]byte
+	RHash tlv.RecordT[tlv.TlvType0, SparsePayHash]


haven't fully wrapped my head around why we implemented sparse hash when we could have used fn.Option?

That's to remain backward compatibility with existing data in the database. The sparse hash writes the TLV type and a length of 0 while an optional record would not be written at all (so neither type nor length). So the encoding on disk would be different.

In this commit, we update all the taproot scripts to also accept an optional aux leaf. This aux leaf can be used to add more redemption paths for advanced channels, or just as an extra commitment space.

In this commit, for each channel, we'll now start to store an optional custom blob. This can be used to store extra information for custom channels in an opauqe manner.

We'll need this later on to ensure we can always interact with the new aux blobs at all stages of commitment transaction construction.

In this commit, we also add the custom TLV blob to the internal commitment struct that we use within the in-memory commitment linked list. This'll be useful to ensure that we're tracking the current blob for our in memory commitment for when we need to write it to disk.

In this commit, we add some useful type definitions for the aux leaf.

In this commit, we add a new AuxLeafStore which can be used to dynamically fetch the latest aux leaves for a given state. This is useful for custom channel types that will store some extra information in the form of a custom blob, then will use that information to derive the new leaf tapscript leaves that may be attached to reach state.

This'll be useful for custom channel types that want to store extra information that'll be useful to help handle channel revocation cases.

This may be useful for custom channel types that base everything off the index (a global value) rather than the output index (can change with each state).

In this commit, we add a TLV blob to the PaymentDescriptor struct. We also now thread through this value from the UpdateAddHTLC message to the PaymentDescriptor mapping, and the other way around.

In this commit, we start to thread thru the new aux tap leaf structures to all relevant areas. This includes: commitment outputs, resolution creation, breach handling, and also HTLC scripts.

guggero added taproot taproot chans custom chans labels Apr 24, 2024

guggero added this to the 0.19.0 milestone Apr 24, 2024

guggero requested review from Roasbeef and GeorgeTsagk April 24, 2024 13:04

guggero mentioned this pull request Apr 24, 2024

lnwallet+channeldb: add new AuxLeafStore for dynamic aux leaves #8562

Closed

3 tasks

guggero force-pushed the aux-leaf-fetcher branch from e04f50d to 9f4677d Compare April 24, 2024 15:04

guggero mentioned this pull request Apr 24, 2024

[3/5]: multi: add new AuxFundingController for custom external funding flows #8622

Merged

guggero changed the title ~~lnwallet+channeldb: add new AuxLeafStore for dynamic aux leaves~~ [2/?]: lnwallet+channeldb: add new AuxLeafStore for dynamic aux leaves Apr 24, 2024

guggero force-pushed the aux-leaf-fetcher branch from 9f4677d to 4969b5a Compare April 25, 2024 17:06

Roasbeef approved these changes Apr 26, 2024

View reviewed changes

guggero mentioned this pull request Apr 26, 2024

input+lnwallet: update taproot scripts to accept optional aux leaf #8556

Closed

dstadulis assigned guggero Apr 27, 2024

guggero force-pushed the aux-leaf-fetcher branch from 4969b5a to 5baf204 Compare April 29, 2024 09:29

guggero force-pushed the funding-tapcript branch from 08a6c9c to c4b9d94 Compare April 29, 2024 19:36

guggero force-pushed the aux-leaf-fetcher branch from 5baf204 to 11f3626 Compare April 29, 2024 19:36

GeorgeTsagk approved these changes Apr 30, 2024

View reviewed changes

guggero force-pushed the aux-leaf-fetcher branch from 11f3626 to 4e807bb Compare April 30, 2024 14:41

guggero force-pushed the funding-tapcript branch from c4b9d94 to 26ce8ee Compare April 30, 2024 14:41

Base automatically changed from funding-tapcript to 0-19-staging April 30, 2024 16:12

Roasbeef and others added 7 commits May 1, 2024 10:13

input+lnwallet: update taproot scripts to accept optional aux leaf

6cf4491

In this commit, we update all the taproot scripts to also accept an optional aux leaf. This aux leaf can be used to add more redemption paths for advanced channels, or just as an extra commitment space.

mod: bump tlv to v1.2.5

51c2a1a

channeldb: new custom blob nested TLV

cbaa0c7

In this commit, for each channel, we'll now start to store an optional custom blob. This can be used to store extra information for custom channels in an opauqe manner.

lnwallet: export the HtlcView struct

5733bbb

We'll need this later on to ensure we can always interact with the new aux blobs at all stages of commitment transaction construction.

input: add some utility type definitions for aux leaves

fc44ff4

In this commit, we add some useful type definitions for the aux leaf.

guggero force-pushed the aux-leaf-fetcher branch from 4e807bb to 3fb4bb6 Compare May 1, 2024 08:29

Roasbeef and others added 7 commits May 1, 2024 11:19

channeldb: convert HTLCEntry to use tlv.RecordT

f3655da

channeldb: convert RevocationLog to use RecordT

0bf2050

channeldb: add custom blobs to RevocationLog+HTLCEntry

d5f595e

This'll be useful for custom channel types that want to store extra information that'll be useful to help handle channel revocation cases.

channeldb: add HtlcIndex to HTLCEntry

2cf3854

This may be useful for custom channel types that base everything off the index (a global value) rather than the output index (can change with each state).

lnwallet: add TLV blob to PaymentDescriptor + htlc add

2ac360a

In this commit, we add a TLV blob to the PaymentDescriptor struct. We also now thread through this value from the UpdateAddHTLC message to the PaymentDescriptor mapping, and the other way around.

multi: thread thru the AuxLeafStore everywhere

33f2db1

lnwallet: thread thru input.AuxTapleaf to all relevant areas

72f7b80

In this commit, we start to thread thru the new aux tap leaf structures to all relevant areas. This includes: commitment outputs, resolution creation, breach handling, and also HTLC scripts.

guggero force-pushed the aux-leaf-fetcher branch from 3fb4bb6 to 72f7b80 Compare May 1, 2024 09:20

guggero merged commit 81970ea into 0-19-staging May 1, 2024
25 of 27 checks passed

guggero deleted the aux-leaf-fetcher branch May 1, 2024 13:54

This was referenced May 15, 2024

[tracking]: enable lnd taproot scripts to accept optional aux leaf lightninglabs/taproot-assets#848

Closed

[feature]: add AuxLeafStore for dynamic aux leaves in lnd lightninglabs/taproot-assets#849

Closed

guggero mentioned this pull request May 22, 2024

[6/5]: invoice+rpc: add exit hop InvoiceAcceptor sub-systems and RPC calls #8771

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[2/?]: lnwallet+channeldb: add new AuxLeafStore for dynamic aux leaves #8684

[2/?]: lnwallet+channeldb: add new AuxLeafStore for dynamic aux leaves #8684

guggero commented Apr 24, 2024 •

edited

github-actions bot commented Apr 24, 2024

coderabbitai bot commented Apr 24, 2024

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

guggero commented Apr 25, 2024

Roasbeef left a comment

Roasbeef commented Apr 26, 2024

Roasbeef commented Apr 26, 2024

guggero commented Apr 26, 2024

guggero commented Apr 29, 2024

GeorgeTsagk left a comment

GeorgeTsagk Apr 30, 2024

guggero May 1, 2024

[2/?]: lnwallet+channeldb: add new AuxLeafStore for dynamic aux leaves #8684

[2/?]: lnwallet+channeldb: add new AuxLeafStore for dynamic aux leaves #8684

Conversation

guggero commented Apr 24, 2024 • edited

Summary by CodeRabbit

github-actions bot commented Apr 24, 2024

Pull reviewers stats

coderabbitai bot commented Apr 24, 2024

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

guggero commented Apr 25, 2024

Roasbeef left a comment

Choose a reason for hiding this comment

Roasbeef commented Apr 26, 2024

Roasbeef commented Apr 26, 2024

guggero commented Apr 26, 2024

guggero commented Apr 29, 2024

GeorgeTsagk left a comment

Choose a reason for hiding this comment

GeorgeTsagk Apr 30, 2024

Choose a reason for hiding this comment

guggero May 1, 2024

Choose a reason for hiding this comment

guggero commented Apr 24, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)