Merge pull request #2939 from TheBlueMatt/2024-03-no-wake-on-shutdown-121

Avoid writing `ChannelManager` when hitting lnd bug 6039

Avoid writing `ChannelManager` when hitting lnd bug 6039

When we hit lnd bug 6039, we end up sending error messages to peers
in a loop. This should be fine, but because we used the generic
`PersistenceNotifierGuard::notify_on_drop` lock above the specific
handling, we end up writing `ChannelManager` every time we manage a
round-trip to our peer.

This can add up quite quickly, and isn't actually changing, so we
really need to avoid writing the `ChannelManager` in this case.

Merge pull request #2902 from TheBlueMatt/2024-02-fix-route-ser-121-bindings

[121-bindings] Fix Route serialization round-trip

Fix `Route` serialization round-trip

When the `max_total_routing_fee_msat` parameter was added to
`RouteParameters`, the serialization used `map` to get the max fee,
accidentally writing an `Option<Option<u64>>`, but then read it as
an `Option<u64>`. Thus, any `Route`s with a `route_params` written
will fail to be read back.

Luckily, this is an incredibly rarely-used bit of code, so only one
user managed to hit it.

Fix blinded path serialization in `Route`

`Route`'s blinded_path serialization logic writes a blinded path
`Option` per path hop, however on read we (correctly) only read one
blinded path `Option` per path. This causes serialization of
`Route`s with blinded paths to fail to round-trip.

Here we fix this by writing blinded paths per path.

Merge pull request #2848 from TheBlueMatt/2024-01-121-bindings

0.0.121 bindings changes

Avoid slices without inner references

As we cannot express slices without inner references in bindings
wrappers.

Replace `EventsProvider` on `OnionMessageHandler` with a single fn

`OnionMessageHandler`s are expected to regularly release a set of
nodes which we need to directly connect to to deliver onion
messages. In order to do so, they currently extend
`EventsProvider`, returning that set as `Event::ConnectionNeeded`s.

While this works fine in Rust, the `EventsProvider` interface
doesn't map well in bindings due to it taking a flexible trait impl
as a method argument.

Instead, here, we convert `OnionMessageHandler` to include a single
function which returns nodes in the form of a `node_id` and
`Vec<SocketAddress>`. This is a bit simpler, if less flexible, API,
and while largely equivalent, is easier to map in bindings.

Make the custom message traits cloneable as they're deep in nested structs

Make ChannelMonitor always clonable

Rather than `ChannelMonitor` only being clonable when the signer is
clonable, we require all signers to be clonable and then make all
`ChannelMonitor`s clonable.

`crate`-only several BOLT12 methods that require unbounded generics

These are not expressible in C/most languages, and thus must be
hidden.

Mark several types no-export which should be exported eventually

Hard-code scorer parameters to `ProbabilisticScoringFeeParameters`

The scorer currently relies on an associated type for the fee
parameters. This isn't supportable at all in bindings, and for
lack of a better option we simply hard-code the parameter for all
scorers  to `ProbabilisticScoringFeeParameters`.

Add some no-exporting of more offers code

These really could be handled in the bindings, but for lack of
immediate users there's not a strong reason to, so instead we just
disable them for now.

Avoid enums containing references with lifetimes

Having struct fields with references to other structs is tough in
our bindings logic, but even worse if the fields are in an enum.
Its simplest to just take the clone penalty here.

Export `outbound_payment` structs in their respective modules

Re-exports in Rust make `use` statements a little shorter, but for
otherwise don't materially change a crate's API. Sadly, the C
bindings generator currently can't figure out re-exports, but it
also exports everything into one global namespace, so it doesn't
matter much anyway.

Use an explicit `Sign` type on the `ChannelMonitor` read tuple

The bindings currently get confused by the implicit `Sign` type, so
we temporarily remove it on the `impl` here.

Restrict ChannelInfo::as_directed_from visibility

Bindings can't handle references in return types, so reduce the
visibility to pub(crate).

Make `as_directed_to` non-public

...as the bindings generation does not currently have the ability
to map a reference to a `NodeId` inside a tuple.

Stop relying on a `Clone`able `NetworkGraph` ref in `DefaultRouter`

While there's not really much harm in requiring a `Clone`able
reference (they almost always are), it does make our bindings
struggle a bit as they don't support multi-trait bounds (as it
would require synthesizing a new C trait, which the bindings don't
do automatically). Luckily, there's really no reason for it, and we
can just call the `DefaultMessageRouter` directly when we want to
route a message.

[bindings] Move additional score params from `&()` to `Default`

In 26c1639ab69d6780c97a118f09e42cb42304088a (and later in
50c55dcf32466e3ccf17acea50697fc664950deb) we switched to using
`Default::default()` to initialize `()` for scoring parameters in
tests. A number of `()`s slipped back in recently, which we replace
here.

Drop manual `Debug` impl on RGS' `GraphSyncError`

As it does the same thing as a derived `Debug` does anyway.

Move RGS `GraphSyncError` into the top-level module

The top-level module is only a few hundred lines, so there's not a
lot of reason to hide the `GraphSyncError` in its own module.
Instead, we simply move it to the top-level `lib.rs`, which doesn't
change the public API as it was previously re-exported at the top
level.

Store `EntropySource` in `DefaultRouter` instead of passing it

...as an arg to `Router`. Passing an `EntropySource` around all
the time is a bit strange as the `Router` may or may not actually
use it, and the `DefaultRouter` can just as easily store it.

[bindings] No-export `RouteHopCandidate` lifetime'd fields

The bindings cannot express lifetimes, so exposing any field which
is a reference (and not `clone`-able, at least for garbage
collected language bindings) is unsafe for those expecting a
high-level interface.

Thus, we simply no-export the `RouteHopCandidate` inner struct
fields which are references (there are relevant accessors for them
anyway).

[bindings] Mark `WithContext` log wrapper with no-export

There's not a lot of reason for downstream users to use the
`WithContext` wrapper, it mostly exists for our own downstream
crates anyway, and dealing with lifetimes in bindings isn't super
practical, so simply no-export it.

[bindings] Drop the lifetime bound on `Record` for bindings builds

Because log `Record`s are now being passed by ownership to `log`,
the bindings get quite annoyed that there's a lifetime hanging
around. We already don't use this lifetime in bindings (the
`FormatArgs` is converted to a string and stored on the heap), so
we can just drop the lifetime, even though it requires some
macro'ing of the struct definition to do so.

Merge pull request #2844 from TheBlueMatt/2024-01-cut-121

Release 0.0.121

Bump versions to LDK 0.0.121/invoice 0.29

Add CHANGELOG entry for 0.0.121

Merge pull request #2841 from TheBlueMatt/2024-01-batch-deadlock

Fix deadlock when handling bad calls to `batch_funding.._generated`

Merge pull request #2842 from jkczyz/2024-01-fix-peer-handler-unwrap

Fix panic when peer is mid-handshake

Remove unnecessary unwraps

Fix panic when peer is mid-handshake

Peer::their_node_id is set to Some during the handshake process.
However, df3ab2ee2753e7f9ec02ddf1c8a51db77c50e35d accesses the field
unconditionally, causing a panic. This may be triggered if a gossip
message is received mid-handshake from another peer or if the user calls
broadcast_node_announcement during this time. The latter tends to be
executed on a timer.

Ensure that Peer::their_node_id is only accessed once the handshake is
complete.

Fix deadlock when handling bad calls to `batch_funding.._generated`

When handling calls to `batch_funding_transaction_generated` which
were missing outputs for one of the batch channels, we'd previously
deadlock when trying to clean up the now-closed channels. This
fixes that and adds a new test case for it.

Found by the full_stack_target fuzzer.

Merge pull request #2835 from TheBlueMatt/2024-01-cut-120

Change v0.0.120 release name

Change v0.0.120 release name

"Un"blinded makes more sense, since the fuzzer was unblinded :)

Merge pull request #2834 from TheBlueMatt/2024-01-cut-120

Cut 0.0.120

Bump crate versions to 0.0.120/invoice 0.28

Add CHANGELOG entry for 0.0.120

Merge pull request #2818 from valentinewallace/2024-01-blinded-path-retries

Avoid retrying over previously failed blinded paths

Merge pull request #2828 from TheBlueMatt/2024-01-crypto-module

Move cryptographic algorithms and utilities to a new `crypto` mod

Test that we won't retry over previously failed blinded paths.

Test util: separate out code to construct a blinded path.

Avoid building routes over previously failed blinded payment paths.

Store previously failed blinded paths on outbound payment failure.

Useful so we don't retry over these paths.

Persist previously failed blinded paths in RouteParameters.

Useful so we don't retry over these paths.

Add failed_within_blinded_path to DecodedOnionFailure.

Will be used to ensure correctness when we store previously failed blinded
paths to avoid retrying over them.

Add failed_within_blinded_path to onion util internal struct.

Will be used to ensure correctness when we store previously failed blinded
paths to avoid retrying over them.

Merge pull request #2831 from jkczyz/2024-01-fix-cltv-expiry-delta

Use consistent `cltv_expiry_delta` in `ForwardTlvs`

Merge pull request #2832 from p2pderivatives/fix-ln-net-tokio-dropping-messages

Fix lightning-net-tokio sometimes dropping messages

Merge pull request #2812 from valentinewallace/2023-12-blinded-forwarding

Complete route blinding support

Fix lightning-net-tokio sometimes dropping messages

Use consistent cltv_expiry_delta in ForwardTlvs

When converting from CounterpartyForwardingInfo to PaymentRelay, the
cltv_expiry_delta is copied. Then, when forming a blinded payment path,
the value is mutated so that esoteric values don't reveal information
about the path. However, the value was only used in computing
PaymentConstraints and wasn't actually updated in PaymentRelay. Move the
logic for modifying the cltv_expiry_delta to the conversion code to
avoid this inconsistency.

Advertise route blinding feature as supported.

Now that we fully support forwarding blinded payments, we should advertise
support so nodes on the network can include us in their blinded paths.

Fix sender double-including shadow offset in CLTV expiry height.

The excess delta is included in the final RouteHop::cltv_expiry_delta, so by
adding it explicitly to cur_cltv we were erroneously including it twice in the
total cltv expiry.

This could've add up to an extra MAX_SHADOW_CLTV_DELTA_OFFSET (432) blocks to
the total cltv expiry.

Rename test var to be more descriptive.

Complete remaining TODOs for failing blinded non-intro forwards.

Add failure mode info to BlindedForward struct.

See added docs.

Move cryptographic algorithms and utilities to a new `crypto` mod

As we'd generally like the `lightning` crate to, over time, have
more modules rather than being very monolithic, we should move the
cryptographic things into their own module, which we do here.

We also take this opportunity to move stream adapters into their
own module and make clear that the ChaChaPoly `decrypt` method is
variable time.

Merge pull request #2824 from shuoer86/main

Fix typos

Fix typo lightning/src/util/wakers.rs

Fix typo lightning/src/routing/router.rs

Fix typo lightning/src/ln/peer_handler.rs

Fix typo lightning-invoice/src/ser.rs

Fix typo CONTRIBUTING.md

Merge pull request #2800 from optout21/channel-close-add-funding

Add channel funding txo to Channel Event::ChannelClosed

Merge pull request #2822 from TheBlueMatt/2024-01-pm-dyn-ref

Drop `PeerManager` type bound on `UtxoLookup` entirely

Make BlindedFailure enum pub.

Necessary to include it in the public PendingHTLCInfo struct in the next commit.

Test successful payment to 3-hop blinded path.

Fix final blinded hop CLTV expiry on send.

Previously, we were setting the final blinded hop's CLTV expiry height to
best_block_height + total_blinded_path_cltv_delta + shadow_cltv_offset. This is
incorrect, it should instead be set to best_block_height + shadow_cltv_offset
only -- it doesn't make sense to include the delta for the other blinded hops
in the final hop's expiry.

The reason this too-high final cltv value didn't cause test failures previously
is because of a 2nd bug that is fixed in an upcoming commit where the sender
adds the shadow offset twice to the total path CLTV expiry. This 2nd offset
meant that intermediate nodes had some buffer CLTV to subtract their delta from
while still (usually) have enough leftover to meet the expiry in the final hop's
onion.

Support forwarding blinded HTLCs as non-intro node.

Error handling will be completed in upcoming commit(s).

Merge pull request #2801 from valentinewallace/2023-12-rb-groundwork-followups

#2128 follow-ups

Merge pull request #2820 from TheBlueMatt/2024-01-fuzz-ooo-monitor-updates

Test individual monitor update compl in chanmon_consistency fuzzer

Merge pull request #2821 from TheBlueMatt/2024-01-om-direct-export

Expose `onion_message` items directly rather than via re-exports

Add channel funding txo to Channel Event::ChannelClosed

Merge pull request #2791 from valentinewallace/2023-12-multihop-recv-followups

Follow-ups to #2688

Expose `onion_message` items directly rather than via re-exports

When we originally added the `onion_message` module, there weren't
a lot of public items in it, and it didn't make a lot of sense to
export the whole sub-module structure publicly. So, instead, we
exported the public items via re-exports directly in the
`onion_message` top-level module. However, as time went on, more
and more things entered the module, which left the top-level module
rather cluttered.

Worse, in 0.0.119, we exposed
`onion_message::messenger::SendSuccess` via the return type of
`send_message`, but forgot to re-export the enum itself, making
it impossible to actually use from external code.

Here we address both issues and simply replace the re-export with
the underlying sub-module structure.

Merge pull request #2809 from TheBlueMatt/2023-12-closing-event-cleanup-fixes

Clean Up Funding Error Handling and shutdown

Drop `PeerManager` type bound on `UtxoLookup` entirely

In 67659677d4fdb6bf418d66dfa37c61706425232b we relaxed the bounds
set on `UtxoLookup` to enable those using `RoutingMessageHandler`
other than `P2PGossipSync` to use `UtxoLookup`. Sadly, because this
requires having a concrete `PeerManager` type which does *not* use
`UtxoLookup` in the `RoutingMessageHandler` type, this broke users
who were directly using `P2PGossipSync`.

We could split `UtxoLookup` into two, with different bounds, for
the two use-cases, but instead here we simply switch to storing a
reference to the `PeerManager` via a `dyn Fn` which allows us to
wake the `PeerManager` when we need to.

Fixes #2813

Rename parameter from err_packet to err_contents.

This name is more accurate since the method has been generalized to support
malformed HTLCs.

Remove outdated comment.

Normalize order of (sha256_of_onion, failure_code) in trait.

This helps avoid destructuring the tuple.

DRY malformed HTLC handling during htlc batch processing.

Fix logger usage during batched htlc processing of malforms.

Introduced due to a rebase error.

Clean up code DRY'd in previous commit.

Rename OutboundOnionPayload::BlindedReceive::amt_msat to be more descriptive.

Rename OutboundOnionPayload::Receive::amt_msat to be more descriptive.

Rename InboundOnionPayload::BlindedReceive::amt_msat to be more descriptive.

Rename InboundOnionPayload::Receive::amt_msat to be more descriptive.

Rename OutboundOnionPayload::BlindedReceive::outgoing_cltv_value.

There is no outgoing HTLC for received HTLCs, so rename to be more accurate.

Rename OutboundOnionPayload::Receive::outgoing_cltv_value.

There is no outgoing HTLC for received HTLCs, so rename to be more accurate.

Rename InboundOnionPayload::BlindedReceive::outgoing_cltv_value.

There is no outgoing HTLC for received HTLCs, so rename to be more accurate.

Rename InboundOnionPayload::Receive::outgoing_cltv_value

.. since there is no outgoing cltv for received HTLCs.

Rename outgoing_cltv_value internal var.

There is no outgoing CLTV for received HTLCs, so this new var makes more sense.

Rename InboundOnionErr to InboundHTLCErr.

The prior name seems to reference onion decode errors specifically, when in
fact the error contents are generic failure codes for any error that occurs
during HTLC receipt.

Remove trailing whitespace.

Merge pull request #2748 from TheBlueMatt/2023-11-2675-followups

Doc and style followups from #2675

Update docs on `HTLC` and `DelayedPayment` keys for clarity

This also adds required linebreaks to keep the docs to a reasonable
width.

Drop the unused `PaymentKey` type

935a716cc6c4fada075e2b740a70bb1b7b349d49 added new wrappers for the
various channel keys, including a payment_key. However, the
`payment_key` has been unused in lightning since the introduction
(and broad requiring) of the `static_remotekey` feature.

Thus, we simply remove it (and an incredibly stale TODO) here.