Fix misc doc warnings.

Fix doc warnings and cleanup in `msgs.rs`

Fix doc warnings and cleanup in `ser.rs`

Merge pull request #1823 from mariocynicys/expose-tlv-macros2

Expose `impl_writeable_tlv_based` macro

Merge pull request #1507 from ViktorTigerstrom/2022-05-store-channels-per-peer

Store `channels` per-peer

Merge pull request #1944 from TheBlueMatt/2022-01-lockorder-windows-robust

Make `debug_sync` regex more robust

Merge pull request #1943 from andrei-21/feature/handle-read-dir-errors

Handle `read_dir()` errors in persister

Make `debug_sync` regex more robust

On windows the symbol names appear to sometimes be truncated,
which causes the symbol name to not include the `::new` at the end.
This causes the regex to mis-match and track the wrong location
for the mutex construction, leading to bogus lockorder violations.

For example, in testing the following symbol name appeared on
Windows, without the function name itself:

`lightning::debug_sync::RwLock<std::collections::hash::map::HashMap<lightning::chain::transaction::OutPoint,lightning::chain::chainmonitor::MonitorHolder<lightning::util::enforcing_trait_impls::EnforcingSigner>,std::collections::hash::map::RandomState> >::`

Move tests from debug_sync to a new submodule

This will allow us to change the module regex match in debug_sync
to make it more robust.

Move `debug_sync` to the new `sync` folder

Move `no-std` sync implementations to a folder to clean up

Handle read_dir() errors in persister

Remove the `ChannelManager::channel_state`

Expect `pending_msg_events` to be in random peer order in tests

Store `pending_msg_events` per peer

Use correct node in `test_invalid_upfront_shutdown_script`

Avoid unnecessary looping over all peers' channels

Update `id_to_peer` docs with consistency guarantees info

Remove one tab level when accessing a `peer_state`

Remove unnecessary channel counterparty checks

Add handle unkown peer test

Add duplicate temporary_channel_id for 2 peers test

Unify failure to query `Channel` error messages

Avoid unnecessary immediate retake `per_peer_state` lock

Remove unnecessary `per_peer_state` branch

After `channels` are now stored in the `per_peer_state`, some logic can
be simplified and extra accessing of the `per_peer_state` can be
removed.

Store channels per peer

Merge pull request #1941 from andrei-21/feature/rework-unwrap

Rework `unwrap()` call in persistence

Fix an incorrect assertion in tlv stream encoding

Types must be unique and monotonically increasing (using < instead of <=)

Expose `impl_writeable_tlv_based` macro

Every exported macro needed to have all the macros used inside it:
1- to be exported as well.
2- be called from the `$crate` namespace so it works in other crates.

Some structs in `lightning::util::ser` needed to be made public as they were used inside the exported macros.

Use the macros like this:
```Rust
lightning::impl_writeable_tlv_based!(...)
```

Merge pull request #1940 from TheBlueMatt/2023-01-nostd-try-lock

Rework unwrap() call in persistence

Make the no-std `RwLockGuard` `try_lock` actually try

There doesn't appear to be any reason to have `try_lock` fail, and
future work shouldn't need to check for std to use `try_lock`.

Add `try_write` function to `FairRwLock`

Add `ChannelManager::PeerState::latest_features` docs

Add `counterparty_node` to test macros

Merge pull request #1927 from jkczyz/2022-12-invoice-rework

Pre-work for BOLT 12 invoices

Define blinded hop features for use in BOLT 12

BOLT 12 invoices may contain blinded_payinfo for each hop in a blinded
path. Each blinded_payinfo contains features, whose length must be
encoded since there may be multiple hops.

Note these features are also needed in the BOLT 4 encrypted_data_tlv
stream. But since they are a single TLV record, the length must *not* be
encoded there.

Define BOLT 12 invoice features with MPP support

Use explicit WithoutLength for BOLT 12 features

Most BOLT 12 features are used as the value of a TLV record and thus
don't use an explicit length. One exception is the features inside the
blinded payinfo subtype since the TLV record contains a list of them.
However, these features are also used in the BOLT 4 encrypted_data_tlv
TLV stream as a single record, where the length is implicit.

Implement Readable and Writeable for Features wrapped in WithoutLength
such that either serialization can be used where required.

Remove Option from InvoiceRequest::signature

Refunds don't have signatures and now use their own abstraction.
Therefore, signatures can be required in invoice requests as per the
spec.

Correct documentation about Refund::payer_id

The docs incorrectly stated that Refund::payer_id is for signing, where
it is only used for identifying a node if Refund::paths is not present.

Merge pull request #1812 from valentinewallace/2022-10-chanman-router-param

Parameterize `ChannelManager` by a `Router`

Test utils: allow queueing >2 persistence update results

ser_macros: rename check_tlv_order

.. to disamgibutate from check_encoded_tlv_order

Provide a `static_value` TLV field serialization type

This is useful in the type serialization definition macros to avoid
writing or reading a field at all, simply using a static value on
each reload.

Parameterize Simple*ChannelManager with DefaultRouter and ProbScorer

Take in-flight HTLCs by reference in Router::find_route

Useful in upcoming work when for payment retries.

Implement routing against the netgraph in tests

Merge pull request #1935 from TheBlueMatt/2022-12-no-non-time-panic

Ensure derive_channel_keys doesn't panic if per-run seed is high

Parameterize ChannelManager by a Router trait

This will be used in upcoming work to fetch routes on-the-fly for payment
retries, which will no longer be the responsibility of InvoicePayer.

Ensure the per-channel key derivation counter doesn't role over

Previously, the `derive_channel_keys` derivation ID asserted that
the high bit of the per-channel key derivation counter doesn't
role over as it checked the 31st bit was zero. As we no longer do
that, we should ensure the assertion in `generate_channel_keys_id`
asserts that we don't role over.

Merge pull request #1934 from TheBlueMatt/2022-12-113-bindings-upstream

Trivial Bindings Updates

Merge pull request #1936 from TheBlueMatt/2023-01-in-flight-clone

`#[derive(Clone)]` for `InFlightHtlcs`

`#[derive(Clone)]` for `InFlightHtlcs`

This is useful for bindings, and generally isn't a bad thing for
users to have access to.

Ensure `derive_channel_keys` doesn't panic if per-run seed is high

b04d1b868fe28bea2e4c711e6e6d2470d2b98d77 changed the way we
calculate the `channel_keys_id` to include the 128-bit
`user_channel_id` as well, shifting the counter up four bytes and
the `starting_time_nanos` field up into the second four bytes.

In `derive_channel_keys` we hash the full `channel_keys_id` with an
HD-derived key from our master seed. Previously, that key was
derived with an index of the per-restart counter, re-calculated by
pulling the second four bytes out of the `user_channel_id`. Because
the `channel_keys_id` fields were shifted up four bytes, that is
now a reference to the `starting_time_nanos` value. This should be
fine, the derivation doesn't really add any value here, its all
being hashed anyway, except that derivation IDs must be below 2^31.
This implies that we panic if the user passes a
`starting_time_nanos` which has the high bit set. For those using
the nanosecond part of the current time this isn't an issue - the
value cannot exceed 1_000_000, which does not have the high bit
set, however, some users may use some other per-run seed.

Thus, here we simply drop the high bit from the seed, ensuring we
don't panic. Note that this is backwards compatible as it only
changes the key derivation in cases where we previously panicked.

Ideally we'd drop the derivation entirely, but that would break
backwards compatibility of key derivation.

No-export `&self` methods on non-cloneable enum(s)

Specifically, `OnionMessageContents` is a non-cloneable enum, which
isn't stored opaque so we cannot call `&self` methods on it.
Because its methods aren't critical to the API for now, we simply
no-export them rather than trying to work out an alternative
approach.

Store an owned `Score` in `ScorerAccountingForInFlightHtlcs`

`ScorerAccountingForInFlightHtlcs` generally stores a `Score`
reference generated by calling `LockableScore::lock`, which
actually returns an arbitrary `Score`. Given `Score` is implemented
directly on lock types, it makes sense to simply hold a fully owned
`Score` in `ScorerAccountingForInFlightHtlcs` rather than a mutable
reference to one.

Merge pull request #1929 from valentinewallace/2022-12-outbound-payment-mod-followup

Outbound payment module follow-up

outbound_payment: put method signature closing paren on next line

in long method signatures

Merge pull request #1931 from TheBlueMatt/2022-12-1910-followups

Trivial #1910 Followups

Fix capitalization broken in 9d7bb73b599a7a9d8468a2f0c54d28f0ce6cf5

9d7bb73b599a7a9d8468a2f0c54d28f0ce6cf543 broke some capitalization
in docs for `sign_invoice`, which we fix here as well as taking
this opportunity to clean up the `sign_invoice` docs more
generally.

Clean up use ordering introduced in 9d7bb73b599a7a9d8468a2f0c54d28f

9d7bb73b599a7a9d8468a2f0c54d28f0ce6cf543 moved some code around
unnecessarily, which we fix here.

Fix cfg(test) indentation

Make add_new_pending_payment private to module

And expose it in testing only, for safety

Merge pull request #1928 from valentinewallace/2022-12-fix-main

Fix `main` build

Fix main build

Merge pull request #1910 from arik-so/2022-12-keys-interface-name-split

Split KeysInterface into EntropySource, NodeSigner, and SignerProvider

Merge pull request #1923 from valentinewallace/2022-12-outbound-payment-mod

Abstract `ChannelManager` outbound payment logic

Split out KeysInterface into EntropySource, NodeSigner, and SignerProvider.

Rename send_payment and retry_payment for retries

Once ChannelManager supports payment retries, it will make more sense for its
current send_payment method to be named send_payment_with_route because
retrying should be the default. Here we get a head start on this by making the
rename in outbound_payment, but not changing the public interface yet.

Reduce visibility of outbound payment methods

Start parameters on a newline if they don't fit

Separating out this commit to keep the main refactor move-only

Remove unnecessary mut in finalize_claims

Swap pending_outbound_payments for OutboundPayments struct

This allows us to move a lot of outbound payment logic out of ChannelManager
and into the new outbound_payment module, and helps avoid growing
ChannelManager when we add retry logic to it in upcoming work.

Move PaymentSendFailure into outbound_payment module

And re-export it in channelmanager.rs so it can remain public

Move PendingOutboundPayment to new outbound_payment module

We want to move all outbound payment-related things to this new module, to help
break up ChannelManager so future payment retries work doesn't increase the
size of ChannelManager.

Merge pull request #1922 from wpaulino/avoid-remaining-redundant-commitment-broadcasts

Avoid redundant broadcast of local commitment transaction

Merge pull request #1908 from jkczyz/2022-11-refund

BOLT 12 refund encoding and building

Avoid redundant broadcast of local commitment transaction

This change follows the rationale of commit 62236c7 and addresses the
last remaining redundant local commitment broadcast.

There's no need to broadcast our local commitment transaction if we've
already seen a confirmed one as it'll be immediately rejected as a
duplicate/conflict.

This will also help prevent dispatching spurious events for bumping
commitment and HTLC transactions through anchor outputs since the
dispatch for said events follows the same flow as our usual commitment
broadcast.

Merge pull request #1920 from TheBlueMatt/2022-12-rel-date

Update release date on 0.0.113 in changelog

Merge pull request #1903 from TheBlueMatt/2022-12-1867-followups

Clarify docs on `provide_channel_parameters`

Update release date on 0.0.113 in changelog

Merge pull request #1917 from TheBlueMatt/2022-12-0.0.113

Cut 0.0.113

Bump crate versions to 0.0.113/invoice 0.21

Add release notes for 0.0.113

Fixes #1890

Only do backtrace builds on stable to fix MSRV break in CI

Merge pull request #1918 from TheBlueMatt/2022-12-one-blinded-path

Unify blinding nomenclature to call them "paths" not "routes".

Refund parsing tests

Tests for checking refund semantics when parsing invoice_request bytes
as defined by BOLT 12.

Refund building tests

Tests for checking invoice_request message semantics when building a
refund as defined by BOLT 12.

Builder for creating refunds

Add a builder for creating refunds given a payer_id and other required
fields. Other settings are optional and duplicative settings will
override previous settings. Building produces a semantically valid
`invoice_request` message representing the refund, which then may be
communicated out of band (e.g., via QR code).

Refund parsing from bech32 strings

Implement Bech32Encode for Refund, which supports creating and parsing
QR codes for the merchant-pays-user (i.e., offer for money) flow.

Refund encoding and parsing

Define an interface for BOLT 12 refunds (i.e., an `invoice_request`
message without an `offer_node_id`). A refund is more generally an
"offer for money". While it is encoded using the same TLV streams as an
`invoice_request` message, it has different semantics.

Update references to "blinded route" to "blinded path"

Finishing the work from the previous two commits.

Rename `blinded_route` variables and module to `blinded_path`

Following up on the previous commit, this also renames variables
and the module used to `blinded_path`.

Unify blinding nomenclature to call them "paths" not "routes".

Currently the `onion_message` module exposes the blinded route
object as *both* `BlindedRoute` and `BlindedPath`. This is somewhat
confusing, and given they are really paths, not routes (at least in
the sense that a route could be multi-path, though for OMs they are
not), here we unify to only call them paths.

Remove Option from OfferContents::signing_pubkey

Refunds (i.e., `invoice_request` without an `offer`) will have its own
contents type, so OfferContents::signing_pubkey can be required.

Correct docs on `generate_channel_keys`

03de0598afd032e9fd5dbbaca0aabc6a367ce4f5 appeared to revert updated
docs due to a rebase error. This reverts the docs on
`generate_channel_keys` to the state they were in prior to that
commit, with one additional doc.

Clarify docs on `provide_channel_parameters`

Its very confusing to say that LDK will call
`provide_channel_parameters` more than once - its true for a
channel, but not for a given instance. Instead, phrase the docs
with reference to a specific instance, which is much clearer.

Merge pull request #1915 from TheBlueMatt/2022-12-jit-reload-consistency

Drop forwarded HTLCs which were still pending at persist-time

Drop forwarded HTLCs which were still pending at persist-time

If, after forwarding an intercepted payment to our counterparty, we
restart with a ChannelMonitor update having been persisted, but the
corresponding ChannelManager update not having been persisted,
we'll still have the intercepted HTLC in the
`pending_intercepted_htlcs` map on start (and potentially a pending
`HTLCIntercepted` event). This will cause us to allow the user to
handle the forwarded HTLC twice, potentially double-forwarding it.

This builds on 0bb87ddad71d2e33199ebad79e9f709f869f2130, which
provided a preemptive fix for the general relay case (though it was
not an actual issue at the time). We simply check for the HTLCs
having been forwarded on startup and remove them from the map.

Fixes #1858