Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split out EcdsaChannelSigner method from BaseSign, and rename it to ChannelSigner #1967

Merged
merged 4 commits into from
Jan 24, 2023

Conversation

arik-so
Copy link
Contributor

@arik-so arik-so commented Jan 18, 2023

No description provided.

@arik-so arik-so force-pushed the 2023-01-rename-signer-traits branch 4 times, most recently from 897f881 to 48aca53 Compare January 18, 2023 19:48
@codecov-commenter
Copy link

codecov-commenter commented Jan 18, 2023

Codecov Report

Base: 90.71% // Head: 90.97% // Increases project coverage by +0.26% 🎉

Coverage data is based on head (712c60e) compared to base (153b048).
Patch coverage: 93.33% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1967      +/-   ##
==========================================
+ Coverage   90.71%   90.97%   +0.26%     
==========================================
  Files          97       98       +1     
  Lines       50677    52857    +2180     
  Branches    50677    52857    +2180     
==========================================
+ Hits        45971    48086    +2115     
- Misses       4706     4771      +65     
Impacted Files Coverage Δ
lightning/src/chain/channelmonitor.rs 91.07% <ø> (ø)
lightning/src/chain/mod.rs 68.18% <ø> (ø)
lightning/src/chain/onchaintx.rs 95.39% <ø> (ø)
lightning/src/ln/chan_utils.rs 93.56% <ø> (ø)
lightning/src/ln/channel.rs 88.79% <ø> (ø)
lightning/src/ln/channelmanager.rs 87.21% <ø> (ø)
lightning/src/ln/functional_tests.rs 96.91% <ø> (-0.22%) ⬇️
lightning/src/util/persist.rs 95.23% <ø> (ø)
lightning/src/util/test_utils.rs 72.04% <ø> (ø)
lightning/src/chain/keysinterface.rs 83.46% <85.71%> (ø)
... and 15 more

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 at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@arik-so arik-so force-pushed the 2023-01-rename-signer-traits branch from 48aca53 to 2539e40 Compare January 18, 2023 21:12
@@ -90,7 +90,7 @@ impl EnforcingSigner {
}
}

impl BaseSign for EnforcingSigner {
impl EcdsaChannelSigner for EnforcingSigner {
Copy link
Contributor

@wpaulino wpaulino Jan 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also rename EnforcingSigner to EnforcingEcdsaChannelSigner?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point. My bigger question is actually what to do with Sign. Should it perhaps be gone entirely and the writeable trait should be required explicitly where Sign is required?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That sounds good to me. ECDSA signers still require Writeable for compatibility reasons, but the taproot signer shouldn't require it since it'll never be stored and we'll always re-derive.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can just make EcdsaChannelSigner inherit Writeable instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah if they all require it, that would probably be nicer. I'll see how many compilation errors that's gonna produce.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actually wonder whether we might wanna parametrize EnforcingSigner with an ECDSA and a Taproot signer subvariant. If it's ok, I'll punt on this to a PR where we introduce actual Taproot types.

@arik-so arik-so force-pushed the 2023-01-rename-signer-traits branch from 2539e40 to 6d2d526 Compare January 19, 2023 23:54
@arik-so arik-so marked this pull request as ready for review January 20, 2023 01:33
wpaulino
wpaulino previously approved these changes Jan 20, 2023
@TheBlueMatt
Copy link
Collaborator

Please wrap commit titles and messages at around 80 chars long

/// Returns the holder's channel public keys and basepoints.
fn pubkeys(&self) -> &ChannelPublicKeys;

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wont pubkeys potentially be different with taproot? Presumably it may have a different set of keys?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why? As far as I can tell, only the signatures will be different.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess I'm surprised it doesn't need some kind of additional data for key construction, but ok.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope, nothing has changed here. We'll need to handle the nonces separately as part of the taproot signer trait.

@@ -249,12 +246,35 @@ pub trait BaseSign {
/// irrelevant or duplicate preimages.
fn validate_holder_commitment(&self, holder_tx: &HolderCommitmentTransaction,
preimages: Vec<PaymentPreimage>) -> Result<(), ()>;

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Won't validate_holder_commitment potentially be different on taproot channels? The preimage set will need to include some PTLC secrets, which would require a different signer?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you might be right. I wasn't really considering PTLCs yet, but perhaps it should indeed be moved. However, I think the more important question is whether the method signature would actually change. I know @wpaulino is planning a bunch of commitment-builder-related refactors, any thoughts?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see this PR as a starting point for the base ChannelSigner trait. We should hold off on moving any items we are not 100% sure will also apply to the taproot signer. Once we start getting through the bulk of the changes, we'll have a better idea of what should go where.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess so, I'm just really not a fan of moving-removing-unmoving-and-then-moving-again over and over. It causes a bunch of churn for downstream code, which isn't so nice. If we're confident this PR is where we'll want stuff for taproot-v1, though, I'm okay with that.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be fair, the introduction of PTLCs (unclear if it'll even happen this year) will require a few changes from users anyway, so moving this back to the ECDSA signer will be just a small part of that.

Copy link
Collaborator

@TheBlueMatt TheBlueMatt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the future, please include rationale for why a commit does what it does in the commit's description, rather than only having a title.

@arik-so arik-so merged commit 45a6f33 into lightningdevkit:main Jan 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants