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

use PrintableString to Display CounterpartyForceClosed peer_msg #2114

Merged
merged 1 commit into from
Mar 22, 2023

Conversation

Evanfeenstra
Copy link
Contributor

This addresses #2108

It's a simple wrapper struct to safely print CounterpartyForceClosed peer_msg.

nothin like some Rust on a friday night

@codecov-commenter
Copy link

codecov-commenter commented Mar 18, 2023

Codecov Report

Patch coverage: 56.52% and project coverage change: -0.01 ⚠️

Comparison is base (217c3e0) 91.32% compared to head (bef56cb) 91.31%.

❗ Current head bef56cb differs from pull request most recent head 315fdf6. Consider uploading reports for the commit 315fdf6 to get more accurate results

📣 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    #2114      +/-   ##
==========================================
- Coverage   91.32%   91.31%   -0.01%     
==========================================
  Files         101      101              
  Lines       48791    48846      +55     
  Branches    48791    48846      +55     
==========================================
+ Hits        44558    44606      +48     
- Misses       4233     4240       +7     
Impacted Files Coverage Δ
lightning/src/util/string.rs 60.86% <25.00%> (-39.14%) ⬇️
lightning/src/util/events.rs 32.39% <50.00%> (+0.86%) ⬆️
lightning/src/ln/channelmanager.rs 89.10% <100.00%> (ø)
lightning/src/ln/functional_tests.rs 98.24% <100.00%> (ø)
lightning/src/ln/payment_tests.rs 97.42% <100.00%> (ø)
lightning/src/ln/reload_tests.rs 95.52% <100.00%> (ø)
lightning/src/ln/reorg_tests.rs 100.00% <100.00%> (ø)
lightning/src/ln/shutdown_tests.rs 98.04% <100.00%> (ø)

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

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.

Thanks for tackling this!

lightning/src/util/events.rs Outdated Show resolved Hide resolved
lightning/src/util/events.rs Outdated Show resolved Hide resolved
lightning/src/util/events.rs Outdated Show resolved Hide resolved
lightning/src/util/events.rs Outdated Show resolved Hide resolved
@Evanfeenstra
Copy link
Contributor Author

Thanks for tackling this!

No problem! Thanks for the suggestions, I implemented them

@Evanfeenstra
Copy link
Contributor Author

any tips on getting the ubuntu/windows/macos checks to pass?

Copy link
Contributor

@valentinewallace valentinewallace left a comment

Choose a reason for hiding this comment

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

Basically lgtm, just some nits

lightning/src/util/events.rs Outdated Show resolved Hide resolved
lightning/src/util/events.rs Outdated Show resolved Hide resolved
@TheBlueMatt
Copy link
Collaborator

any tips on getting the ubuntu/windows/macos checks to pass?

Should be fixed for you when you push, it was an MSRV break due to serde being awful.

lightning/src/util/string.rs Outdated Show resolved Hide resolved
lightning/src/util/string.rs Outdated Show resolved Hide resolved
lightning/src/util/string.rs Outdated Show resolved Hide resolved
lightning/src/util/events.rs Outdated Show resolved Hide resolved
Copy link
Contributor

@jkczyz jkczyz left a comment

Choose a reason for hiding this comment

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

Feel free to squash, IMO.

lightning/src/util/string.rs Outdated Show resolved Hide resolved
@Evanfeenstra
Copy link
Contributor Author

Feel free to squash, IMO.

ok, squashed and re-ordered the util::string file

@TheBlueMatt
Copy link
Collaborator

nit: SanitizedString makes it sound like the string inside is already sanitized, but its not, its a SanitizingString or maybe more aptly, Untrusted or PossiblyMalicious String.

More importantly, though, please keep your commit titles and messages to around 80 chars long - if you have more information to convey, you should have one line that is the title followed by a blank line and then some number of lines that provide more details.

Other than those looks good.

@jkczyz
Copy link
Contributor

jkczyz commented Mar 21, 2023

nit: SanitizedString makes it sound like the string inside is already sanitized, but its not, its a SanitizingString or maybe more aptly, Untrusted or PossiblyMalicious String.

Good point. I'd be fine with UntrustedString.

@Evanfeenstra
Copy link
Contributor Author

ok, renamed to UntrustedString

@TheBlueMatt
Copy link
Collaborator

Can you squash the fixup commits so that there aren't later commits fixing code introduced in earlier commits in the same PR? Other than that should be good, thanks!

@Evanfeenstra
Copy link
Contributor Author

Ok, it's in a single commit. Thanks for all the help yall!

@jkczyz jkczyz merged commit 3d479c9 into lightningdevkit:main Mar 22, 2023
k0k0ne pushed a commit to bitlightlabs/rust-lightning that referenced this pull request Sep 30, 2024
0.0.115 - Apr 24, 2023 - "Rebroadcast the Bugfixes"

API Updates
===========

 * The MSRV of the main LDK crates has been increased to 1.48 (lightningdevkit#2107).
 * Attempting to claim an un-expired payment on a channel which has closed no
   longer fails. The expiry time of payments is exposed via
   `PaymentClaimable::claim_deadline` (lightningdevkit#2148).
 * `payment_metadata` is now supported in `Invoice` deserialization, sending,
   and receiving (via a new `RecipientOnionFields` struct) (lightningdevkit#2139, lightningdevkit#2127).
 * `Event::PaymentFailed` now exposes a failure reason (lightningdevkit#2142).
 * BOLT12 messages now support stateless generation and validation (lightningdevkit#1989).
 * The `NetworkGraph` is now pruned of stale data after RGS processing (lightningdevkit#2161).
 * Max inbound HTLCs in-flight can be changed in the handshake config (lightningdevkit#2138).
 * `lightning-transaction-sync` feature `esplora-async-https` was added (lightningdevkit#2085).
 * A `ChannelPending` event is now emitted after the initial handshake (lightningdevkit#2098).
 * `PaymentForwarded::outbound_amount_forwarded_msat` was added (lightningdevkit#2136).
 * `ChannelManager::list_channels_by_counterparty` was added (lightningdevkit#2079).
 * `ChannelDetails::feerate_sat_per_1000_weight` was added (lightningdevkit#2094).
 * `Invoice::fallback_addresses` was added to fetch `bitcoin` types (lightningdevkit#2023).
 * The offer/refund description is now exposed in `Invoice{,Request}` (lightningdevkit#2206).

Backwards Compatibility
=======================

 * Payments sent with the legacy `*_with_route` methods on LDK 0.0.115+ will no
   longer be retryable via the LDK 0.0.114- `retry_payment` method (lightningdevkit#2139).
 * `Event::PaymentPathFailed::retry` was removed and will always be `None` for
    payments initiated on 0.0.115 which fail on an earlier version (lightningdevkit#2063).
 * `Route`s and `PaymentParameters` with blinded path information will not be
   readable on prior versions of LDK. Such objects are not currently constructed
   by LDK, but may be when processing BOLT12 data in a coming release (lightningdevkit#2146).
 * Providing `ChannelMonitorUpdate`s generated by LDK 0.0.115 to a
   `ChannelMonitor` on 0.0.114 or before may panic (lightningdevkit#2059). Note that this is
   in general unsupported, and included here only for completeness.

Bug Fixes
=========

 * Fixed a case where `process_events_async` may `poll` a `Future` which has
   already completed (lightningdevkit#2081).
 * Fixed deserialization of `u16` arrays. This bug may have previously corrupted
   the historical buckets in a `ProbabilisticScorer`. Users relying on the
   historical buckets may wish to wipe their scorer on upgrade to remove corrupt
   data rather than waiting on it to decay (lightningdevkit#2191).
 * The `process_events_async` task is now `Send` and can thus be polled on a
   multi-threaded runtime (lightningdevkit#2199).
 * Fixed a missing macro export causing
   `impl_writeable_tlv_based_enum{,_upgradable}` calls to not compile (lightningdevkit#2091).
 * Fixed compilation of `lightning-invoice` with both `no-std` and serde (lightningdevkit#2187)
 * Fix an issue where the `background-processor` would not wake when a
   `ChannelMonitorUpdate` completed asynchronously, causing delays (lightningdevkit#2090).
 * Fix an issue where `process_events_async` would exit immediately (lightningdevkit#2145).
 * `Router` calls from the `ChannelManager` now call `find_route_with_id` rather
   than `find_route`, as was intended and described in the API (lightningdevkit#2092).
 * Ensure `process_events_async` always exits if any sleep future returns true,
   not just if all sleep futures repeatedly return true (lightningdevkit#2145).
 * `channel_update` messages no longer set the disable bit unless the peer has
   been disconnected for some time. This should resolve cases where channels are
   disabled for extended periods of time (lightningdevkit#2198).
 * We no longer remove CLN nodes from the network graph for violating the BOLT
   spec in some cases after failing to pay through them (lightningdevkit#2220).
 * Fixed a debug assertion which may panic under heavy load (lightningdevkit#2172).
 * `CounterpartyForceClosed::peer_msg` is now wrapped in UntrustedString (lightningdevkit#2114)
 * Fixed a potential deadlock in `funding_transaction_generated` (lightningdevkit#2158).

Security
========

 * Transaction re-broadcasting is now substantially more aggressive, including a
   new regular rebroadcast feature called on a timer from the
   `background-processor` or from `ChainMonitor::rebroadcast_pending_claims`.
   This should substantially increase transaction confirmation reliability
   without relying on downstream `TransactionBroadcaster` implementations for
   rebroadcasting (lightningdevkit#2203, lightningdevkit#2205, lightningdevkit#2208).
 * Implemented the changes from BOLT PRs lightningdevkit#1031, lightningdevkit#1032, and lightningdevkit#1040 which resolve a
   privacy vulnerability which allows an intermediate node on the path to
   discover the final destination for a payment (lightningdevkit#2062).

In total, this release features 110 files changed, 11928 insertions, 6368
deletions in 215 commits from 21 authors, in alphabetical order:
 * Advait
 * Alan Cohen
 * Alec Chen
 * Allan Douglas R. de Oliveira
 * Arik Sosman
 * Elias Rohrer
 * Evan Feenstra
 * Jeffrey Czyz
 * John Cantrell
 * Lucas Soriano del Pino
 * Marc Tyndel
 * Matt Corallo
 * Paul Miller
 * Steven
 * Steven Williamson
 * Steven Zhao
 * Tony Giorgio
 * Valentine Wallace
 * Wilmer Paulino
 * benthecarman
 * munjesi
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.

5 participants