Skip to content

Disambiguate blinded path ForwardNodes between payment + message #3265

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

Merged

Conversation

TheBlueMatt
Copy link
Collaborator

We currently have two structs with identical names in our public API - blinded_path::message::ForwardNode and
blinded_path::payment::ForwardNode. This makes the API somewhat awkward to use - users have to try (and fail) to import ForwardNode twice only to then have to change their imports.

More importantly, however, this makes the API very hard to use in some bindings languages where rename-imports or module imports aren't available.

Thus, here, we rename both to give them context.

@TheBlueMatt TheBlueMatt added this to the 0.0.124 milestone Aug 21, 2024
Copy link

codecov bot commented Aug 21, 2024

Codecov Report

Attention: Patch coverage is 91.48936% with 4 lines in your changes missing coverage. Please review.

Project coverage is 89.79%. Comparing base (bbfa15e) to head (2ce2fe9).
Report is 10 commits behind head on main.

Files Patch % Lines
lightning/src/onion_message/messenger.rs 50.00% 3 Missing ⚠️
lightning/src/util/test_utils.rs 50.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3265      +/-   ##
==========================================
- Coverage   89.82%   89.79%   -0.03%     
==========================================
  Files         125      125              
  Lines      102867   102867              
  Branches   102867   102867              
==========================================
- Hits        92398    92370      -28     
- Misses       7753     7779      +26     
- Partials     2716     2718       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jkczyz
Copy link
Contributor

jkczyz commented Aug 21, 2024

Looks like fuzz code needs to be updated.

@TheBlueMatt TheBlueMatt force-pushed the 2024-08-globally-unique-names branch from fd8fc08 to 9ab9eca Compare August 21, 2024 19:26
@TheBlueMatt
Copy link
Collaborator Author

Fixed.

@TheBlueMatt TheBlueMatt force-pushed the 2024-08-globally-unique-names branch from 9ab9eca to 2c69fbd Compare August 21, 2024 19:47
We currently have two structs with identical names in our public
API - `blinded_path::message::ForwardNode` and
`blinded_path::payment::ForwardNode`. This makes the API somewhat
awkward to use - users have to try (and fail) to import
`ForwardNode` twice only to then have to change their imports.

More importantly, however, this makes the API very hard to use in
some bindings languages where rename-imports or module imports
aren't available.

Thus, here, we rename both to give them context.
@TheBlueMatt TheBlueMatt force-pushed the 2024-08-globally-unique-names branch from 2c69fbd to 2ce2fe9 Compare August 21, 2024 19:48
@TheBlueMatt TheBlueMatt merged commit dced69d into lightningdevkit:main Aug 21, 2024
19 of 21 checks passed
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.

3 participants