Update messages for Taproot types. #2005

arik-so · 2023-02-02T21:35:42Z

This PR creates Taproot-specific types, such as MuSig2 nonces as well as PartialSignatureWithNonce. It also updates the channel opening and regular channel operation mechanism related messages to support these types using TLVs.

This PR does not introduce Taproot type support for channel-close-related messages.

lightning/src/ln/msgs.rs

codecov-commenter · 2023-02-02T21:51:37Z

Codecov Report

Patch coverage: 45.12% and project coverage change: -0.12 ⚠️

Comparison is base (0e28bcb) 91.38% compared to head (bc97b82) 91.27%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2005      +/-   ##
==========================================
- Coverage   91.38%   91.27%   -0.12%     
==========================================
  Files         102      102              
  Lines       49767    49976     +209     
  Branches    49767    49976     +209     
==========================================
+ Hits        45482    45618     +136     
- Misses       4285     4358      +73

Impacted Files	Coverage Δ
lightning/src/ln/msgs.rs	`84.10% <17.64%> (-1.75%)`	⬇️
lightning/src/util/ser.rs	`90.54% <32.00%> (-2.81%)`	⬇️
lightning/src/ln/channel.rs	`90.09% <100.00%> (+0.04%)`	⬆️
lightning/src/ln/functional_tests.rs	`98.22% <100.00%> (+<0.01%)`	⬆️

... and 14 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

ariard · 2023-02-09T00:46:40Z

lightning/src/ln/msgs.rs

@@ -49,6 +51,18 @@ use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
 /// 21 million * 10^8 * 1000
 pub(crate) const MAX_VALUE_MSAT: u64 = 21_000_000_0000_0000_000;

+/// A public nonce used for Musig2, comprised of two ECPoints


I don't know if the name should be labeled MuSig2BIPPublicNonce (ideally the bip number but no one yet to the best of my knowledge) or whatever to dissociate that's the two-point nonces variant of MuSig2 we're using (in case we introduce a variant on musig2 itself in the future for optimisations whatever)

that's actually a point I brought up in the musig2 bip itself, but for now we have solved it here by not declaring the type here, and instead using my (hopefully ephemeral) musig2 crate, which exposes it simply as PublicNonce.

ariard · 2023-02-09T00:53:09Z

lightning/src/ln/msgs.rs

+#[derive(Clone, Debug, PartialEq)]
+pub struct Musig2SecretNonce(pub(crate) SecretKey, pub(crate) SecretKey);
+
+/// A partial signature that also contains the Musig2 nonce its signer used


I think "channel-level signer" just not confused with a nested signer as even a partial signature could be generated by multiple "same-channel-side" signers. Or any notation making it clear which signer we're referring to.

ariard · 2023-02-09T00:54:26Z

lightning/src/ln/msgs.rs

@@ -257,6 +273,10 @@ pub struct FundingCreated {
 	pub funding_output_index: u16,
 	/// The signature of the channel initiator (funder) on the initial commitment transaction
 	pub signature: Signature,
+	/// The partial signature of the channel initiator (funder)
+	pub partial_signature_with_nonce: Option<PartialSignatureWithNonce>,


can be called initiator_partial_signature_with_nonce even if more verbose than spec

ariard · 2023-02-09T00:55:01Z

lightning/src/ln/msgs.rs

@@ -268,6 +288,8 @@ pub struct FundingSigned {
 	pub channel_id: [u8; 32],
 	/// The signature of the channel acceptor (fundee) on the initial commitment transaction
 	pub signature: Signature,
+	/// The partial signature of the channel acceptor (fundee)
+	pub partial_signature_with_nonce: Option<PartialSignatureWithNonce>,


can be called fundee_partial_signature_with_nonce even if more verbose than spec

ariard · 2023-02-09T00:55:35Z

lightning/src/ln/msgs.rs

@@ -407,6 +429,8 @@ pub struct CommitmentSigned {
 	pub signature: Signature,
 	/// Signatures on the HTLC transactions
 	pub htlc_signatures: Vec<Signature>,
+	/// The partial Taproot signature on the commitment transaction
+	pub partial_signature_with_nonce: Option<PartialSignatureWithNonce>,


can be called commitment_partial_signature_with_nonce even if more verbose than spec

hm, I disagree, because signature is not also called commitment_signature

TheBlueMatt · 2023-03-30T00:08:38Z

Let's add a CI job for cfg(taproot) so we dont break it every 5th PR like we have anchors.

TheBlueMatt · 2023-03-30T22:45:39Z

lightning/src/ln/msgs.rs

+/// A partial signature that also contains the Musig2 nonce its signer used
+#[cfg(taproot)]
+#[derive(Clone, Debug, PartialEq, Eq)]
+pub struct PartialSignatureWithNonce(pub(crate) musig2::types::PartialSignature, pub(crate) musig2::types::PublicNonce);


Do these need to be pub(crate) vs just pub?

hm, perhaps at some point in the future we'll want to expose the inner details externally, but for now I'd leave it at pub(crate)

I mean it doesn't matter because its behind a cfg flag anyway, but in general I think we should/are move to making all messages public so that users can build their own complete custom messages.

lightning/src/util/ser.rs

TheBlueMatt · 2023-04-03T18:15:05Z

lightning/src/util/ser.rs

+impl Readable for musig2::types::PublicNonce {
+	fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
+		let buf: [u8; PUBLIC_KEY_SIZE * 2] = Readable::read(r)?;
+		let nonce = musig2::types::PublicNonce::from_slice(&buf).unwrap();


Oops, somehow I missed this - we can't unwrap during deserialization, you have a few of them. We have to map to an Err and return that.

TheBlueMatt reviewed Feb 2, 2023

View reviewed changes

lightning/src/ln/msgs.rs Outdated Show resolved Hide resolved

ariard reviewed Feb 9, 2023

View reviewed changes

TheBlueMatt added the blocked on rust-bitcoin Blocked until we update rust-bitcoin/etc label Feb 9, 2023

arik-so force-pushed the 2023-01-taproot-message-types branch 3 times, most recently from 62e40c9 to dbcdfbe Compare March 29, 2023 23:56

arik-so force-pushed the 2023-01-taproot-message-types branch from dbcdfbe to 363a922 Compare March 30, 2023 17:09

TheBlueMatt reviewed Mar 30, 2023

View reviewed changes

lightning/src/util/ser.rs Outdated Show resolved Hide resolved

arik-so force-pushed the 2023-01-taproot-message-types branch from 363a922 to 2f6c321 Compare March 31, 2023 01:45

wpaulino self-requested a review March 31, 2023 01:49

arik-so force-pushed the 2023-01-taproot-message-types branch 4 times, most recently from 922799e to 7633e04 Compare March 31, 2023 17:46

arik-so marked this pull request as ready for review March 31, 2023 17:53

arik-so force-pushed the 2023-01-taproot-message-types branch from 7633e04 to 3bd93db Compare March 31, 2023 19:49

TheBlueMatt removed the blocked on rust-bitcoin Blocked until we update rust-bitcoin/etc label Mar 31, 2023

arik-so force-pushed the 2023-01-taproot-message-types branch from 3bd93db to 8e800d1 Compare March 31, 2023 23:57

TheBlueMatt previously approved these changes Apr 3, 2023

View reviewed changes

lightning/src/util/ser.rs Show resolved Hide resolved

arik-so dismissed TheBlueMatt’s stale review via b6b7b91 April 3, 2023 17:28

arik-so force-pushed the 2023-01-taproot-message-types branch from 8e800d1 to b6b7b91 Compare April 3, 2023 17:28

wpaulino previously approved these changes Apr 3, 2023

View reviewed changes

TheBlueMatt reviewed Apr 3, 2023

View reviewed changes

arik-so dismissed wpaulino’s stale review via c6df720 April 3, 2023 20:07

arik-so force-pushed the 2023-01-taproot-message-types branch from b6b7b91 to c6df720 Compare April 3, 2023 20:07

arik-so added 2 commits April 3, 2023 13:17

Introduce MuSig2-related types for Taproot channels.

6080ce8

Update the AcceptChannel message for Taproot support.

64a8007

arik-so added 5 commits April 3, 2023 13:17

Update the FundingCreated message for Taproot support.

0219a8d

Update the FundingSigned message for Taproot support.

5c79c8e

Update the CommitmentSigned message for Taproot support.

fe25bbb

Update the RevokeAndACK message for Taproot support.

15dbe55

Add Taproot CI test.

bc97b82

arik-so force-pushed the 2023-01-taproot-message-types branch from c6df720 to bc97b82 Compare April 3, 2023 20:17

wpaulino approved these changes Apr 3, 2023

View reviewed changes

TheBlueMatt approved these changes Apr 3, 2023

View reviewed changes

TheBlueMatt merged commit 09f5e50 into lightningdevkit:main Apr 4, 2023

arik-so mentioned this pull request May 25, 2023

Taproot Pending Requirement Tracking #2295

Open

54 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update messages for Taproot types. #2005

Update messages for Taproot types. #2005

arik-so commented Feb 2, 2023

codecov-commenter commented Feb 2, 2023 •

edited

Loading

ariard Feb 9, 2023

arik-so Mar 31, 2023

ariard Feb 9, 2023

ariard Feb 9, 2023

ariard Feb 9, 2023

ariard Feb 9, 2023

arik-so Mar 31, 2023

TheBlueMatt commented Mar 30, 2023

TheBlueMatt Mar 30, 2023

arik-so Mar 31, 2023

TheBlueMatt Mar 31, 2023

TheBlueMatt Apr 3, 2023

Update messages for Taproot types. #2005

Update messages for Taproot types. #2005

Conversation

arik-so commented Feb 2, 2023

codecov-commenter commented Feb 2, 2023 • edited Loading

Codecov Report

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

TheBlueMatt commented Mar 30, 2023

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

codecov-commenter commented Feb 2, 2023 •

edited

Loading