Merge pull request #1325 from ViktorTigerstrom/2022-02-filter-route-hints

Filter route hints when creating invoices

Add phantom invoice route hints filtering tests

Filter route hints for phantom invoices

Filter the route hints in `create_phantom_invoice` based on the
following criteria:

* Only one channel for every counterparty node per phantom
payment-receiving node in the invoice
* Always select the channel with the highest inbound capacity
* For each payment-receiving node, filter out channels with a lower
inbound capacity than the invoice amount, if any channel exists with
enough capacity to cover the invoice amount
* If any public channels exists for a payment-receiving node, push a
single RouteHintHop with the phantom route and let the sender find the
path to the payment-receiving node through the public channels.

Add tests for create invoice route hints filtering

Filter route hints for create invoice

Filter the route hints in `create_invoice_from_channelmanager` based on
the following criteria:

* Only one channel per counterparty node
* Always select the channel with the highest inbound capacity
* Filter out channels with a lower inbound capacity than the invoice
amount, if any channel exists with enough capacity to cover the invoice
amount
* If any public channel exists, the invoice route_hints should be empty,
and the sender will need to find the path to the payment-receiving node
by looking at the public channels instead

Merge pull request #1331 from TheBlueMatt/2022-02-no-copy-invoice-fields

Use &mut self in invoice updaters, not take-self-return-Self

Merge pull request #1311 from TheBlueMatt/2022-02-0conf-part-1

Support for SCID Aliases

Merge pull request #1341 from jkczyz/2022-03-expiry-time-panic

Correct docs about invoice_expiry_delta_secs panic

Merge pull request #1349 from TheBlueMatt/2022-03-listen-send-sync

Require `chain::Listen` impls in block sync be `Send + Sync`

Merge pull request #1348 from TheBlueMatt/2022-03-timer-tick-count

Reduce the number of timer ticks a peer is allowed to take

Merge pull request #1355 from lightningdevkit/dependabot/cargo/lightning/regex-0.2.11

Update regex requirement from 0.1.80 to 0.2.11 in /lightning

Correct docs about invoice_expiry_delta_secs panic

Support receiving multiple funding_locked messages

As a part of adding SCID aliases to channels, we now have to accept
otherwise-redundant funding_locked messages which serve only to
update the SCID alias. Previously, we'd failt he channel as such
an update used to be bogus.

Provide our peers with SCID aliases and forward payments with them

This creates an SCID alias for all of our outbound channels, which
we send to our counterparties as a part of the `funding_locked`
message and then recognize in any HTLC forwarding instructions.

Note that we generate an SCID alias for all channels, including
already open ones, even though we currently have no way of
communicating to our peers the SCID alias for already-open
channels.

Handle `short_to_id` state updates on channel closure via macros

This avoids needing to update channel closure code in many places
as we add multiple SCIDs for each channel and have to track them.

Track SCID aliases from our counterparty and use them in invoices

New `funding_locked` messages can include SCID aliases which our
counterparty will recognize as "ours" for the purposes of relaying
transactions to us. This avoids telling the world about our
on-chain transactions every time we want to receive a payment, and
will allow for receiving payments before the funding transaction
appears on-chain.

Here we store the new SCID aliases and use them in invoices instead
of he "standard" SCIDs.

Add support for deserializing the new SCID alias in funding_locked

Clean up the `handle_monitor_err!()` macro argument forms somewhat

`handle_monitor_err!()` has a number of different forms depending
on which messages and actions were outstanding when the monitor
updating first failed. Instead of matching by argument count, its
much more readable to put an explicit string in the arguments to
make it easy to scan for the called form.

Merge pull request #1286 from tnull/add_random_cltv_offsets

Add random 'shadow route' CLTV delta offsets to improve privacy

Make lightning-block-sync's init module slightly more generic

Users who want to use lightning-block-sync's init module would
be reasonable in wanting to use it in a multithreaded environment,
however because it takes a list of listeners as dyn chain::Listen
without any Send or Sync bound they fail in doing so.

Here we make the type bounds on `chain::Listen` generic across
`chain::Listen + ?Sized`, which the existing bound of `&dyn
chain::Listen` satisfies. Thus, this is strictly less restrictive
and allows for the use of `&dyn chain::Listen + Send + Sync`.

Update regex requirement from 0.1.80 to 0.2.11 in /lightning

Updates the requirements on [regex](https://github.com/rust-lang/regex) to permit the latest version.
- [Release notes](https://github.com/rust-lang/regex/releases)
- [Changelog](https://github.com/rust-lang/regex/blob/master/CHANGELOG.md)
- [Commits](https://github.com/rust-lang/regex/compare/0.1.80...0.2.11)

---
updated-dependencies:
- dependency-name: regex
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

Add a random per-path CLTV offset for privacy.

Merge pull request #1347 from jkczyz/2022-03-log-approximation

Use log approximation in ProbabilisticScorer

Check for no-std compatibility across dependencies

To ensure no-std is honored across dependencies, add a crate depending
on lightning crates supporting no-std. This should ensure any
regressions are caught. Otherwise, cargo doesn't seem to catch some
incompatibilities (e.g., f64::log10 unavailable in core) and seemingly
across other dependencies as describe here:

https://blog.dbrgn.ch/2019/12/24/testing-for-no-std-compatibility/

Fix compilation warnings with --features=no-std

Use log approximation in ProbabilisticScorer

Since f64::log10 exists in std but not core, unconditionally use log
approximation so --feature=no-std will compile.

Move private channel and short-conf tests to new module

Add a new functional test utility to open an unannounced channel

Give `ChannelManager`s `channel_udpate`s for pub chans in test

This makes tests slightly more realistic by delivering
`channel_update`s to `ChannelManager`s, ensuring we have
forwarding data stored locally for all channels, including public
ones.

Reduce the number of timer ticks a peer is allowed to take

In 2d3a2108979adca6b7632e2d59c10e4b131e8bf4, we increased the
default ping timer in `lightning-background-processor` to ten
seconds from five. However, we didn't change the timer count at
which we disconnect peers if they're not responding, which we
likely should have done. We do so here, as well as update the
documentation for `PeerManager::timer_tick_occurred` to suggest
always ticking the timer every ten seconds instead of five.

Merge pull request #1317 from TheBlueMatt/2022-02-fix-bunk-test

Fix what `bolt2_open_channel_sending_node_checks_part1` tests

Clean up `TestKeysInterface` random bytes override interface

Its very confusing to have multiple fields that do the same thing,
one of which isn't even used for its stated purpose anymore after
the previous few commits.

Fix what `bolt2_open_channel_sending_node_checks_part1` tests

There are currently two issues with
`bolt2_open_channel_sending_node_checks_part1` which counteract
each other and hide that the test isn't testing what it should be.

First of all, the final `create_channel` call actually fails
because we try to open a channel with ourselves, instead of
panicing as the test is supposed to check for.

However, when we fix the create_channel call to panic, when we
drop `nodes[1]` after `create_channel` panics, we fail the
no-pending-messages test as it as an expeted `accept_channel` in
its outbound buffer. This causes a double-panic.

Previously, these two offset each other - instead of panicing in
`create_channel` we'd panic in the Node drop checks.

This fixes both by fetching the `accept_channel` before we go into
the panic'ing `create_channel` call (who's arguments were
corrected).

Merge pull request #1343 from lightningdevkit/dependabot/github_actions/actions/checkout-3

Bump actions/checkout from 2 to 3

Merge pull request #1346 from TheBlueMatt/2022-03-clones

Add Clone to a few structs which contain only a few fields

Add Clone to a few structs which contain only a few fields

Specifically, `PhantomRouteHints`, `FixedPenaltyScorer`, and
`ScoringParamters`.

Merge pull request #1310 from TheBlueMatt/2022-02-bump-msrv

Bump MSRV to 1.41.1.

Bump actions/checkout from 2 to 3

Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 3.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v2...v3)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

Merge pull request #1339 from TheBlueMatt/2022-02-0.0.105-sec

0.0.105 Security Fixes

Update CHANGELOG with security info for 0.0.105

Merge branch '2022-02-bal-panic' into 2022-02-0.0.105-sec

Merge branch '2022-02-fix-multi-hop-hint-panic' into 2022-02-0.0.105-sec

Merge pull request #1322 from TheBlueMatt/2022-02-0.0.105

Cut 0.0.105

Ensure `get_claimable_balances` never panicks in tests

... by calling it both before and after every chain event in
testing and fuzzing.

This requires fixing some blockchain inconsistencies in
`do_test_onchain_htlc_reorg`, `do_retry_with_no_persist`, and
`do_test_dup_htlc_onchain_fails_on_reload` where we'd connect
conflicting transactions in the same chain.

Fix HTLC tx balance calculation on local commitment transactions

When handling the broadcast of a local commitment transactions
(with associated CSV delays prior to spendability), we incorrectly
handled the CSV delays on HTLC transactions. This caused us to miss
spendable outputs for HTLCs which were awaiting a CSV delay.

Further, because of this, we could hit an assertion as
`get_claimable_balances` asserted that HTLCs were resolved after
the funding spend was resolved, which was not true if the HTLC did
not have a CSV delay attached (due to the above bug or due to it
being an HTLC claim by our counterparty).

This fixes both bugs, also converting some assertions to
`debug_assert`s to avoid future issues as balance mis-calculation
is not currently an indication of potential funds loss.

Thanks to Cash App for reporting this bug.

Bump crate versions to 0.0.105/invoice 0.13

Fill out CHANGELOG for 0.0.105

Correct default value for A* heuristic for non-public nodes

This doesn't (appear) to change behavior, however if we have a
non-public node, we assign an A* heuristic of max-u32 fees, which
may result in us de-prioritizing the path in some rare cases around
multi-hop route hints which compete with public nodes.

Fix panic when routing through multiple private last-hops

When we added support for routing through a multi-hop invoice hint
we failed to remove an assertion that we always are able to fill
in features for each hop except the last one. However, when a
multi-hop invoice hint is used, we will not have features for any
of the hinted hops, causing us to panic.

Merge pull request #1327 from TheBlueMatt/2022-02-log-before-panic

Merge pull request #1303 from jkczyz/2022-02-docs-with-features

Generate docs with features for docs.rs

Merge pull request #1335 from TheBlueMatt/2022-02-fix-honggfuzz-regression

Pin rustc in fuzzing to 1.58 due to honggfuzz-rs regression

Merge pull request #1324 from valentinewallace/2022-02-phantom-followup

#1199 Followup

Merge pull request #1332 from TheBlueMatt/2022-02-persister-ignore-tmp

Ignore .tmp files when loading ChannelMonitors in persister

Pin rustc in fuzzing to 1.58 due to honggfuzz-rs regression

Fix bug where we encode flags field into all updates on htlc fail

Failing an HTLC with onion error channel_disabled requires encoding a 'flags' field into the failure
packet. However, we were encoding this 'flags' field for all failures packets that were failing on
update_add_htlc with an update (error 0x1000 UPDATE).

Discovered in the course of adding phantom payment failure tests, which also added testing for this bug

Correctly wrap phantom onion errors

In any place where fail_htlc_backwards_internal was called for a phantom payment
failure, we weren't encoding the onion failure as if the phantom were the one
failing. Instead, we were encoding the failure as if it were coming from the
second-to-last hop. This caused our failures to not be parsed properly on the
payer's side.

Places we were encoding failures incorrectly include:
* on failure of a call to inbound_payment::verify
* on a user call to fail_htlc_backwards

Also drop some unnecessary panics when reading OnionHopData objects. This also
enables one of the phantom failure tests because we can construct OnionHopDatas
with invalid amounts.

Lastly, remove a bogus comment

Fix phantom malformed onion error packet

Ensure we fail back phantom malformed payments with an update_fail_htlc s.t.
the error contains the sha256 of the onion, per LN protocol.

Add phantom shared secret to HTLCPreviousHopData

This also fixes a bug where we were failing back phantom payments with the
wrong scid, causing them to never actually be failed backwards (L3022 in
channelmanager.rs)

This new field will be used in upcoming commit(s) to encrypt phantom payment failure
packets.

Add phantom shared secret to PendingHTLCRouting::Receive

This will be used in upcoming commit(s) to encrypt phantom payment failure packets.

Merge pull request #1318 from jurvis/jurvis/2022-02-log-router-penalty-data-4

Implement custom debug for PathBuildingHop

Ignore .tmp files when loading ChannelMonitors in persister

If we are in the middle of persisting an update to a
`ChannelMonitor` when we shutdown (or crash), we'll start up with
a .tmp file lying around. We should ignore it, as failure to
return from the update call should have prevented the
`ChannelManager` from taking any irrevocable action based on the
update.

We're somewhat protected from any filesystem inconsistency behavior
as the `ChannelManager` will refuse to load if we're outright
missing `ChannelMonitor`s.

Fixes #1330.

Implement custom debug for PathBuildingHop

Add other fields to log for PathBuildingHop

Use DebugStruct to print PathBuildingHop

Fix PathBuildingHop visibility

Add more useful fee print-outs

Remove Features<NodeContext> from hop print-out

Remove logging fields we don’t need

Add fields to log back to PathBuildingHop

Use &mut self in invoice updaters, not take-self-return-Self

The take-self-return-Self idiom in Rust is substantially less
usable than it is in Java, where its more common. Because we have
to take self by move, it prevents using the update methods to
actually update features, something we occasionally want to do.

See, eg, the change in lightning-invoice where we previously had
to copy and re-create an entire vec of fields just to update the
features field, which is nuts.

There are a few places where this makes things a little less clean,
but the tradeoff to enable more effecient and broader uses of the
update methods seems worth it.

Merge pull request #1309 from TheBlueMatt/2022-02-first-hop-log

Specify whether we have first-hop hints when routing

Follow-up nits from #1199 (phantom node support)

Log more during ChannelMonitor updating

Fixes #1323.

Merge pull request #1314 from TheBlueMatt/2022-02-accept_chan_type

Update channel-type implementation to upstream spec as merged

Generate docs with features for docs.rs

Enable generating docs using --all-features or --features="std" where
applicable. Additionally, use doc_auto_cfg to tag items requiring a
feature.

https://doc.rust-lang.org/nightly/rustdoc/unstable-features.html#doc_auto_cfg-automatically-generate-doccfg

This requires building with nightly, which is what is used by docs.rs.

https://docs.rs/about/builds

To test locally, use:

RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc ...

Fix rustdoc error on nightly

Unhide struct docs in scoring module

The docs were hidden since a type alias should be used. However, the
alias docs don't contain much useful information and don't link to the
corresponding struct.

Fix `cargo doc` warning in lightning-block-sync

Specify whether we have first-hop hints when routing

This is incredibly useful when debugging issues with the router,
and is somewhat of an oversight currently.

Merge pull request #1316 from TheBlueMatt/2022-02-no-fuzztarget

Drop `fuzztarget` feature entirely

Add explicit compile errors when cfg=fuzzing is mis-set

Drop `fuzztarget` feature entirely

Some time ago we started transitioning to `cfg(fuzzing)` instead of
exposing a full feature. Here we complete the transition.

Merge pull request #1315 from TheBlueMatt/2022-02-fix-tokio-msrv

Restrict tokio to 1.14 as a dev-dependency

Restrict tokio to 1.14 as a dev-dependency

This maintains our MSRV for simple `cargo test` runs, but doesn't
restrict users to any specific 1.X tokio version.

Merge pull request #1266 from TheBlueMatt/2022-01-fix-double-fail-panic

Fix a debug panic caused by receiving MPP parts after a failure

Fix a debug panic caused by receiving MPP parts after a failure

Prior to cryptographic payment secrets, when we process a received
payment in `process_pending_htlc_fowards` we'd remove its entry
from the `pending_inbound_payments` map and give the user a
`PaymentReceived` event.

Thereafter, if a second HTLC came in with the same payment hash, it
would find no entry in the `pending_inbound_payments` map and be
immediately failed in `process_pending_htlc_forwards`.

Thus, each HTLC will either result in a `PaymentReceived` event or
be failed, with no possibility for both.

As of 846487555556d8465c5b7b811f976e78f265c48f, we no longer
materially have a pending-inbound-payments map, and thus
more-than-happily accept a second payment with the same payment
hash even if we just failed a previous one for having mis-matched
payment data.

This can cause an issue if the two HTLCs are received back-to-back,
with the first being accepted as valid, generating a
`PaymentReceived` event. Then, when the second comes in we'll hit
the "total value {} ran over expected value" condition and fail
*all* pending HTLCs with the same payment hash. At this point,
we'll have a pending failure for both HTLCs, as well as a
`PaymentReceived` event for the user.

Thereafter, if the user attempts to fail the HTLC in response to
the `PaymentReceived`, they'll get a debug panic at channel.rs:1657
'Tried to fail an HTLC that was already failed'.

The solution is to avoid bulk-failing all pending HTLCs for a
payment. This feels like the right thing to do anyway - if a sender
accidentally sends an extra HTLC after a payment has ben fully
paid, we shouldn't fail the entire payment.

Found by the `chanmon_consistency` fuzz test.

Update channel-type implementation to upstream spec as merged

Somehow, our channel type implementation doesn't echo back the
channel type as we believe it was negotiated, as we should. Though
the spec doesn't explicitly require this, some implementations may
require it and it appears to have been in the BOLTs from the start
of the channel type logic.

Drop spurious whitespace in channel.rs

Use "Minimum", not "Minmal" for MSRV.

Merge pull request #1199 from valentinewallace/2021-11-phantom-node

Add support for multi-node receive

Bump MSRV to 1.41.1.

1.41.1 is currently the Firefox ESR MSRV, which means its also the
version several Linux distros ship. Further, rust-bitcoin is likely
to make a similar change soon, see
https://github.com/rust-bitcoin/rust-bitcoin/issues/510.

Don't send channel updates for private chans on error

This commit also adds additional checks for the second-to-last (phantom) hop for phantom payments.

Support phantom payment receive in ChannelManager, with invoice util

See PhantomKeysManager and invoice util's create_phantom_invoice for more info

Add get_phantom_scid and get_phantom_route_hints + scid_utils::fake_scid module

See method and module docs for more details

channelmanager: DRY PendingHTLCInfo creation for receives

Will be used to facilitate decoding multiple onion layers for phantom payment receive

scid_utils: add utils for retrieving txindex and vout

keysinterface: adapt get_node_secret for phantom payments

We want LDK to be able to retrieve the phantom secret key when we see that a payment
is destined for a phantom node.

KeysInterface::sign_invoice: indicate whether invoice is a phantom

keysmanager: support phantom payments with PhantomKeysManager

To support the feature of generating invoices that can be paid to any of
multiple nodes, a key manager need to be able to share an inbound_payment_key
and phantom secret key. This is because a phantom payment may be received by
any node participating in the invoice, so all nodes must be able to decrypt the
phantom payment (and therefore must share decryption key(s)) in the act of
pretending to be the phantom node. Thus we add a new `PhantomKeysManager` that
supports these features.

To be more specific, the inbound payment key must be shared because it is used
to decrypt the payment details for verification (LDK avoids storing inbound
payment data by encrypting payment metadata in the payment hash and/or payment
secret).

The phantom secret must be shared because enables any real node included in the
phantom invoice to decrypt the final layer of the onion packet, since the onion
is encrypted by the sender using the phantom public key provided in the
invoice.

DRY shared hkdf_extract_expand code to new module

Implement serialization for ChannelDetails

Will be used in upcoming commit(s) where it may be desirable to cache ChannelDetails routehints

Refactor out decode_next_hop util from ChannelManager::decode_update_add_htlc

This will be used in upcoming commit(s) to facilitate decoding multiple onion layers for
multi-node payment receive

Merge pull request #1301 from TheBlueMatt/2022-02-router-no-test

Work around rustc bug on nightly and make benchmarks not run test code

Merge pull request #1305 from ConorOkus/update-readme

Update README to include community invite links

Merge pull request #1281 from ViktorTigerstrom/2022-01-accept-or-reject-channels

Add option accept or reject channel requests

Merge pull request #1304 from jkczyz/2021-12-remove-mut-ref

Remove unnecessary mut from reference