[2/7] channeldb: add new types and interfaces for gossip 1.75 #8164

ellemouton · 2023-11-09T12:22:19Z

Depends on #8044

This PR is part of the Gossip 1.75 epic

It does the following:

Rename the existing ChannelEdgeInfo, ChannelEdgePolicy and ChannelAuthProof types to ChannelEdgeInfo1, ChannelEdgePolicy1 and ChannelAuthProof1 respectively.
Adds new ChannelEdgeInfo, ChannelEdgePolicy and ChannelAuthProof interfaces and ensure that the existing types implement the appropriate interfaces.
Adds new ChannelEdgeInfo2, ChannelEdgePolicy2 and ChannelAuthProof2 types and ensure that they implement the above interfaces.
Finally, the encoding & decoding code (along with tests) is added for the new ChannelEdgeInfo2 and ChannelEdgePolicy2.

There are no functional changes in this PR & the new types are not yet used here.

coderabbitai · 2024-02-12T13:21:35Z

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.

Roasbeef · 2024-09-18T23:07:57Z

The target branch can be updated to point to master.

Roasbeef · 2024-09-18T23:15:53Z

channeldb/models/interfaces.go

+
+// ChannelAuthProof is an interface that describes the proof of ownership of
+// a channel.
+type ChannelAuthProof interface {


Nice, this is basically a sealed interface. There're some linters we can use to implement checks for exhaustive switch statements, so then they become a bit more like sum types.

Roasbeef · 2024-09-18T23:18:25Z

channeldb/models/channel_auth_proof.go

+// announcement. It contains a single Schnorr signature.
+type ChannelAuthProof2 struct {
+	// SchnorrSigBytes are the raw bytes of the encoded schnorr signature.
+	SchnorrSigBytes []byte


[schnorr.SignatureSize]byte?

Roasbeef · 2024-09-18T23:19:49Z

channeldb/models/channel_edge_info.go

+// ChannelEdgeInfo2 describes the information about a channel announced with
+// lnwire.ChannelAnnouncement2 that we will persist.
+type ChannelEdgeInfo2 struct {
+	lnwire.ChannelAnnouncement2


Don't see where this was added in this commit.

Roasbeef · 2024-09-18T23:21:13Z

channeldb/models/channel_edge_info.go

+
+	// If both bitcoin keys are not present in the announcement, then we
+	// should previously have stored the funding script found on-chain.
+	if pubKey1 == nil || pubKey2 == nil {


Roasbeef · 2024-09-18T23:24:16Z

channeldb/models/channel_edge_policy.go

@@ -198,3 +198,57 @@ func (c *ChannelEdgePolicy1) Sig() (input.Signature, error) {
 // A compile-time check to ensure that ChannelEdgePolicy1 implements the
 // ChannelEdgePolicy interface.
 var _ ChannelEdgePolicy = (*ChannelEdgePolicy1)(nil)
+
+type ChannelEdgePolicy2 struct {


Missing a godoc comment.

Roasbeef · 2024-09-18T23:25:06Z

channeldb/models/channel_edge_policy.go

@@ -198,3 +198,57 @@ func (c *ChannelEdgePolicy1) Sig() (input.Signature, error) {
 // A compile-time check to ensure that ChannelEdgePolicy1 implements the
 // ChannelEdgePolicy interface.
 var _ ChannelEdgePolicy = (*ChannelEdgePolicy1)(nil)
+
+type ChannelEdgePolicy2 struct {
+	lnwire.ChannelUpdate2


Any particular reason why we're using composition here, instead of creating new attributes for the fields we care about (potentially with more concrete types)?

Ah I guess we can just re-use the existing serialization as well? Potentially yet another reason to TLV everywhere for the wire messages.

Roasbeef · 2024-09-18T23:26:43Z

channeldb/models/channel_edge_policy.go

+type ChannelEdgePolicy2 struct {
+	lnwire.ChannelUpdate2
+
+	ToNode [33]byte


Missing godoc comment.

Also based on the comment above, I think we should also make these TLVs on disk in the db. Then we can just combine with the records above to serialize, maintaining extensibility for the future, and also re-using a ton of code to boot.

Roasbeef · 2024-09-18T23:27:42Z

channeldb/edge_info.go

+	// edgeInfo2EncodingType will be used as a prefix for edge's advertised
+	// using the ChannelAnnouncement2 message. The type indicates how the
+	// bytes following should be deserialized.
+	edgeInfo2EncodingType edgeInfoEncodingType = 0


Why's the encoding type used, if we're using TLV at this level?

Roasbeef · 2024-09-18T23:28:13Z

channeldb/edge_info.go

+	// EdgeInfo2Sig is the tlv type used within the serialisation of
+	// ChannelEdgeInfo2 for storing the signature of the
+	// lnwire.ChannelAnnouncement2 message.
+	EdgeInfo2Sig = tlv.Type(1)


Can use tlv.RecordT now alongside the new structs. Most of these types already have records created for them as well.

To prepare for the addition of ChannelAuthProof2 along with a ChannelAuthProof interface, rename ChannelAuthProof to ChannelAuthProof1.

In preparation for the addition of ChannelEdgePolicy2 and a ChannelEdgePolicy interface, rename ChannelEdgePolicy to ChannelEdgePolicy1.

In preparaion for adding ChannelEdgeInfo2 and a ChannelEdgeInfo interface, rename ChannelEdgeInfo to ChannelEdgeInfo1.

Add new ChannelEdgeInfo and ChannelAuthProof interfaces and ensure that they are implemented by ChannelEdgeInfo1 and ChannelAuthProof respectively.

And ensure that ChannelEdgePolicy1 implements it.

And ensure that it implements the ChannelEdgeInfo interface.

And ensure that it implements the ChannelEdgePoicy interface.

This commit moves the serialisation, deserialisation and update functions for ChannelEdgePolicy1 and ChannelEdgeInfo1 into their own files.

In this commit, we update the `putChanEdgeInfo` function to take in the models.ChannelEdgeInfo interface. If the passed value is the legacy models.ChannelEdgeInfo1, then the encoding and decoding remains the same but if it is the new models.ChannelEdgeInfo2 then: - the encoding will be prefixed with a 0xff byte. This should not clash with the encoding of the legacy struct since that encoding will always start with a pub key (of node 1) which means it will always start with 0x02 or 0x03. - The 0xff is then followed by a type-byte which will be used to identify the encoding that follows (this is to make it future proof). For now, there is only one possible type-byte here. - This is then followed by the TLV encoding of ChannelEdgeInfo2.

Similarly to the previous commit, here we add the encoding for the new ChannelEdgePolicy2. This is done in the same was as for ChannelEdgeInfo2: - a 0xff prefix - followed by a type-byte - followed by the TLV encoding of the ChannelEdgePolicy2.

ellemouton added the gossip label Nov 9, 2023

ellemouton marked this pull request as draft November 9, 2023 12:22

ellemouton mentioned this pull request Nov 9, 2023

[epic]: Gossip 1.75 #7961

Open

21 tasks

ellemouton changed the title ~~[3/n] channeldb: add new types and interfaces for gossip 1.75~~ [2/n] channeldb: add new types and interfaces for gossip 1.75 Nov 16, 2023

ellemouton force-pushed the g175ChanDBUpdates branch from 3b4acec to b068fc0 Compare November 16, 2023 15:13

ellemouton force-pushed the g175ChanDBUpdates branch from b068fc0 to 0fbc058 Compare December 5, 2023 10:13

ellemouton marked this pull request as ready for review December 5, 2023 10:13

ellemouton changed the title ~~[2/n] channeldb: add new types and interfaces for gossip 1.75~~ [2/7] channeldb: add new types and interfaces for gossip 1.75 Dec 6, 2023

This was referenced Dec 6, 2023

[3/7] multi: start using the new interfaces throughout the codebase #8252

Draft

[6/7]: discovery: sync gossip using block heights & ranges #8255

Draft

ellemouton force-pushed the g175ChanDBUpdates branch from 0fbc058 to be56e6f Compare January 11, 2024 07:06

ellemouton changed the base branch from master to elle-g175Messages January 11, 2024 07:07

ellemouton force-pushed the elle-g175Messages branch from 91f4488 to 2da93b7 Compare February 12, 2024 13:19

ellemouton requested review from bitromortac, yyforyongyu, ProofOfKeags, Crypt-iQ and Roasbeef as code owners February 12, 2024 13:19

ellemouton removed request for Roasbeef, ProofOfKeags, yyforyongyu, Crypt-iQ and bitromortac February 12, 2024 13:19

ellemouton force-pushed the g175ChanDBUpdates branch from be56e6f to 2d9ef0c Compare February 12, 2024 13:20

saubyk assigned ellemouton Jun 27, 2024

ellemouton force-pushed the elle-g175Messages branch from 2da93b7 to 093462b Compare September 2, 2024 11:05

ellemouton force-pushed the g175ChanDBUpdates branch from 2d9ef0c to 12d2106 Compare September 2, 2024 11:05

ellemouton force-pushed the elle-g175Messages branch from 093462b to a826e6e Compare September 11, 2024 12:33

ellemouton force-pushed the g175ChanDBUpdates branch from 12d2106 to a205f32 Compare September 11, 2024 12:34

Roasbeef requested changes Sep 18, 2024

View reviewed changes

ellemouton changed the base branch from elle-g175Messages to master September 23, 2024 01:55

ellemouton added 12 commits September 23, 2024 11:00

multi: rename ChannelAuthProof

107d36e

To prepare for the addition of ChannelAuthProof2 along with a ChannelAuthProof interface, rename ChannelAuthProof to ChannelAuthProof1.

multi: rename ChannelEdgePolicy

f672ed2

In preparation for the addition of ChannelEdgePolicy2 and a ChannelEdgePolicy interface, rename ChannelEdgePolicy to ChannelEdgePolicy1.

multi: rename ChannelEdgeInfo

69e796a

In preparaion for adding ChannelEdgeInfo2 and a ChannelEdgeInfo interface, rename ChannelEdgeInfo to ChannelEdgeInfo1.

channeldb: add ChanneEdgeInfo and ChannelAuthProof interfaces

b04b59a

Add new ChannelEdgeInfo and ChannelAuthProof interfaces and ensure that they are implemented by ChannelEdgeInfo1 and ChannelAuthProof respectively.

channeldb: add ChannelEdgePolicy interface

8435f36

And ensure that ChannelEdgePolicy1 implements it.

channeldb: add ChannelAuthProof2

4ac39fa

channeldb: add ChannelEdgeInfo2

3492f56

And ensure that it implements the ChannelEdgeInfo interface.

channeldb: add ChannelEdgePolicy2

f43269a

And ensure that it implements the ChannelEdgePoicy interface.

channeldb+refactor: move ser/deser funcs to separate files

e1b2362

This commit moves the serialisation, deserialisation and update functions for ChannelEdgePolicy1 and ChannelEdgeInfo1 into their own files.

docs: update release notes

8dd1fa6

ellemouton force-pushed the g175ChanDBUpdates branch from a205f32 to 8dd1fa6 Compare September 23, 2024 02:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[2/7] channeldb: add new types and interfaces for gossip 1.75 #8164

[2/7] channeldb: add new types and interfaces for gossip 1.75 #8164

ellemouton commented Nov 9, 2023 •

edited

Loading

coderabbitai bot commented Feb 12, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Roasbeef commented Sep 18, 2024

Roasbeef Sep 18, 2024

Roasbeef Sep 18, 2024

Roasbeef Sep 18, 2024

Roasbeef Sep 18, 2024

Roasbeef Sep 18, 2024

Roasbeef Sep 18, 2024

Roasbeef Sep 18, 2024

Roasbeef Sep 18, 2024

Roasbeef Sep 18, 2024

Roasbeef Sep 18, 2024

[2/7] channeldb: add new types and interfaces for gossip 1.75 #8164

Are you sure you want to change the base?

[2/7] channeldb: add new types and interfaces for gossip 1.75 #8164

Conversation

ellemouton commented Nov 9, 2023 • edited Loading

coderabbitai bot commented Feb 12, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Roasbeef commented Sep 18, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ellemouton commented Nov 9, 2023 •

edited

Loading

coderabbitai bot commented Feb 12, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)