Expose payment metadata in the sending path via `send_payment`.

Pipe payment metadata through the HTLC send pipeline

...without exposing it to the public `send_payment` API yet.

Provide users the payment metadata via `Event::PaymentReceived`

Deserialize payment metadata fields in the onion final hop data

Avoid storing a full FinalOnionHopData in OnionPayload::Invoice

We only use it to check the amount when processing MPP parts, but
store the full object (including new payment metadata) in it.
Because we now store the amount in the parent structure, there is
no need for it at all in the `OnionPayload`. Sadly, for
serialization compatibility, we need it to continue to exist, at
least temporarily, but we can avoid populating the new fields in
that case.

Store total payment amount in ClaimableHTLC explicitly

...instead of accessing it via the `OnionPayload::Invoice` form.
This may be useful if we add MPP keysend support, but is directly
useful to allow us to drop `FinalOnionHopData` from `OnionPayload`.

Pass FinalOnionHopData to payment verify by reference, not clone

Support setting the new payment metadata field in invoices

Support reading the new `payment_metadata` field in invoices

Unset the optional bit for a feature when setting the required bit

There is no reason to set both, and this currently makes testing
the new BOLT invoice tests slightly harder, so we just unset it.

Define the `PaymentMetadata` feature to be used in invoices

Merge pull request #1283 from TheBlueMatt/2022-01-correct-req-feature-handling

Correct handling of `UnknownRequiredFeature` deserialization

Merge pull request #1273 from jkczyz/2022-01-invoice-expiry

Support invoice expiry over a year

Correct handling of `UnknownRequiredFeature` deserialization

Quite some time ago, `UnknownRequiredFeature` was only used when a
gossip message has a missing required feature. These days, its also
used for any required TLV which we do not understand in any
message. However, the handling of it was never updated in
`PeerManager`, leaving it printing a warning about gossip and
ignoring the message entirely.

Instead, we send a warning message and disconnect.

Closes #1236, as caught by @jkczyz.

Support invoice expiry over a year

The lightning-invoice crate represents timestamps as Duration since the
UNIX epoch rather than a SystemTime. Therefore, internal calculations
are in terms of u64-based Durations. This allows for relaxing the one
year maximum expiry.

Merge pull request #1275 from jkczyz/2022-01-benchmark-improvements

Router benchmark improvements

Merge pull request #1251 from lightning-signer/2022-01-signer-preimages

Provide payment preimages to signer on HTLC success

Benchmark zero-penalty scorer

Benchmark router using a scorer seeded with data

Scorers may have different performance characteristics after seeing
failed and successful paths. Seed the scorer with some random data
before executing the benchmark in order to exercise such behavior.

Add first_hops to generate_routes benchmarks

Passing first_hops to get_route increases the coverage of the benchmark
test. For scorers needing the sending node, it allows for using a single
scorer in the benchmark rather than re-initializing on each iteration.
As a consequence, the scorer can be seeded with success and failure
data.

Remove duplicate generate_routes benchmark code

Refactor generate_routes and generate_mpp_routes into a single utility
for benchmarking. The utility is parameterized with features in order to
test both single path and multi-path routing. Additionally, it is
parameterized with a Score to be used with other scorers.

Provide preimages to signer

Keep track of preimage in OutboundHTLCState on success

Merge pull request #1272 from lightning-signer/2022-01-sign-invoice-api

Improve KeysInterface::sign_invoice API

Merge pull request #1271 from tnull/rename_payee_struct

Rename `Payee` to `PaymentParameters`

Merge pull request #1253 from TheBlueMatt/2022-01-background-persist-exit

Persist `ChannelManager` before `BackgroundProcessor` exits

Improve KeysInterface::sign_invoice API

split hrp from invoice data, to allow parsing, since there is no delimiter between the two parts

Merge pull request #1250 from vss96/sanity_check

Sanity check for ChannelManager and KeysInterface

Sanity check for ChannelManager and KeysInterface

Fix build errors

Create script using p2wsh for comparison

Using p2wpkh for generating the payment script

spendable_outputs sanity check

Return err in spendable_outputs

Doc updates in keysinterface

Merge pull request #1269 from TheBlueMatt/022-01-no-disconnect-on-slow-persist

Avoid disconnecting all peers if user code is slow

Rename `Payee` to `PaymentParameters`

Increase our PING_TIMER to ten seconds, from five.

Because many lightning nodes can take quite some time to respond to
pings, the five second ping timer can sometimes cause spurious
disconnects even though a peer is online. However, in part as a
response to mobile users where a connection may be lost as result
of only a short time with the app in a "paused" state, we had a
rather aggressive ping time to ensure we would disconnect quickly.

However, since we now just used a fixed time for the "went to
sleep" detection, we can somewhat increase the ping timer. We still
want to be fairly aggressive to avoid sending HTLCs to a peer that
is offline, but the tradeoff between spurious disconnections and
stuck payments is likely doesn't need to be quite as aggressive.

Avoid disconnecting all peers if user code is slow

In the sample client (and likely other downstream users), event
processing may block on slow operations (e.g. Bitcoin Core RPCs)
and ChannelManager persistence may take some time. This should be
fine, except that we consider this a case of possible backgrounding
and disconnect all of our peers when it happens.

Instead, we here avoid considering event processing time in the
time between PeerManager events.

Merge pull request #1234 from tnull/limit_max_cltv_delta

Limit maximum CLTV delta during routing

Merge pull request #1248 from naveensrinivasan/naveen/feat/update-readme

Docs: Updated README to include crates information

Limit maximum total CLTV expiry delta during routing.

Docs: Updated README to include crates information

Included crates information into README.

Merge pull request #1258 from lightningdevkit/dependabot/cargo/hex-0.4

Update hex requirement from 0.3 to 0.4

Fixed some typos

Persist `ChannelManager` before `BackgroundProcessor` exits

Fixes #1237.

Update hex requirement from 0.3 to 0.4

Updates the requirements on [hex](https://github.com/KokaKiwi/rust-hex) to permit the latest version.
- [Release notes](https://github.com/KokaKiwi/rust-hex/releases)
- [Commits](https://github.com/KokaKiwi/rust-hex/compare/v0.3...v0.4.3)

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

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

Merge pull request #1243 from naveensrinivasan/naveensrinivasan/dependabot

Enable Dependabot

Create dependabot.yml

Signed-off-by: naveen <172697+naveensrinivasan@users.noreply.github.com>

Merge pull request #1249 from tnull/fix_compile_warnings

Fix compiler warning during building/testing.

Fix unused return warning for 'transmute_copy'.

Merge pull request #1238 from TheBlueMatt/2022-01-lockorder-checks

Fix and test lockorder

Check lockorders in tests with a trivial lockorder tracker

Merge pull request #1229 from lightning-signer/2021-12-htlc-anchor-sighashtype

anchors: Fix SigHashType and weight calculations for anchors

Fixed comment on weight_received_htlc

Set opt_anchors for calls to CommitmentTransaction::new_with_auxiliary_htlc_data

Add anchor tests to outbound_commitment_test

Debit funder's output to cover anchors

Convert HTLC_{SUCCESS,TIMEOUT}_TX_WEIGHT to anchor-aware functions

Convert COMMITMENT_TX_BASE_WEIGHT to anchor-aware function

Add unit test coverage for package::weight_{offered,received}_htlc

make WEIGHT{_REVOKED,}_{OFFERED,RECEIVED}_HTLC functions with opt_anchors parameter

Isolated channelmonitor weight unit tests and added anchor loops

Set the SigHashType of remote htlc signatures w/ anchors to SinglePlusAnyoneCanPay

Fix some (non-bug) lock-order-inversions in tests

Make lockorder consistent in channelmanager

This resolves a lockorder inversion in
`ChannelManager::finalize_claims` where `pending_outbound_payments`
is locked after `pending_events`, opposite of, for example, the
lockorder in `ChannelManager::fail_htlc_backwards_internal` where
`pending_outbound_payments` is locked at the top of the
`HTLCSource::OutboundRoute` handling and then `pending_events` is
locked at the end.

Merge pull request #1013 from TheBlueMatt/2021-07-warning-msgs

Rely on Error/Warning message data lengths being correct

In https://github.com/lightning/bolts/pull/950, the (somewhat
strange) requirement that error messages be handled even if the
length field is set larger than the size of the package was
removed. Here we change the code to drop the special handling for
this, opting to just fail to read the message if the length is
incorrect.

Send `warning` instead of `error` when we incounter bogus gossip

Convert `shutdown` invalid script checks to warning messages

As required by the warning messages PR, we should simply warn our
counterparty in this case and let them try again, continuing to try
to use the channel until they tell us otherwise.

Send warning messages when appropriate in gossip handling pipeline

Handle sending and receiving warning messages

Add a new `WarningMessage` message to send and receive warnings

Merge pull request #1230 from lightning-signer/2021-01-invoice-bech32-dep

Do not turn on bech32/std by default for lightning-invoice

Do not turn on bech32/std by default for lightning-invoice

Merge pull request #1223 from lightning-signer/2021-12-invoice-nostd

Adapt lightning-invoice to no_std

Adapt lightning-invoice to no_std

Merge pull request #1226 from TheBlueMatt/2022-01-bindings-no-std

Support building `cfg=c_bindings` with `no-std`

Support building `cfg=c_bindings` with `no-std`

This will be needed for JavaScript bindings eventually.

Merge pull request #1220 from TheBlueMatt/2021-12-stale-update-gossip-log

Log gossip rejections due to stale channel_updates at GOSSIP level

Merge pull request #1225 from hackerrdave/update-repo-lightningdevkit

update repo name to use lightningdevkit

update repo name to use lightningdevkit

Merge pull request #1218 from TheBlueMatt/2021-12-minor-bindings-tweaks

Minor Bindings Tweaks

Log gossip rejections due to stale channel_updates at GOSSIP level

This further reduces noise at the TRACE level during initial gossip
sync.

Swap around generic argument ordering in InvoicePayer for bindings

The bindings generation really should support generic bounds other
than Deref::Target in where clauses, but currently does not. To
avoid needing to add support during the current release process,
we simply swap around the arguments to move them to the first <>
instead of the where.

Add a C-not exported tag to `NetGraphMsgHandler.network_graph`

Add a constructor to MultiThreadedLockableScore

...as otherwise the struct is rather useless.

Merge pull request #1217 from TheBlueMatt/2021-12-0.0.104

Cut 0.0.104

Swap around generic argument ordering in DefaultRouter for bindings

The bindings generation really should support default generic types
in where clauses, but currently does not. To avoid needing to add
support during the current release process, we simply swap around
the arguments to move them to the first <> instead of the where.

Bump versions to 0.0.104/invoice 0.12

Update CHANGELOG for 0.0.104

Merge pull request #1216 from valentinewallace/2021-12-preimage-getter

Add utility for retrieving an LDK payment preimage

Remove trailing whitespace in the FeeEstimator interface

inbound_payment: Add utility to get payment preimage given hash/secret

User-requested feature

inbound_payment: DRY verify method for use in getting preimage

in the next commit(s)

create_inbound_payment: warn about dup hashes

Leftover feedback from #1177

Salt inbound payment ExpandedKey

Leftover feedback from #1177

Merge pull request #1177 from valentinewallace/2021-11-derivable-payment-secret

Stop storing pending inbound payment data; instead make it derivable on receive

Add new invoice CreationError::InvalidAmount for use in checking `create_inbound_payment`

in an invoice creation utility. Note that if the error type of `create_inbound_payment` ever
changed, we'd be forced to update the invoice utility's callsite to handle the new error

Drop need to store pending inbound payments

and replace payment_secret with encrypted metadata

See docs on `inbound_payment::verify` for details

Also add min_value checks to all create_inbound_payment* methods

Add get_single_block to chacha20 module

In the next commit, we'll want to get a single block from a chacha stream that
takes a 16-byte nonce.

Macro-ize checking that the total value of an MPP's parts is sane

This DRY-ed code will be used in upcoming commits when we stop storing inbound
payment data

Add get_inbound_payment_key_material to KeysInterface

This will allow us to retrieve key material for encrypting/decrypting inbound
payment info, in upcoming commits

Merge pull request #1212 from TheBlueMatt/2021-12-timeout-graph

Add a method to prune stale channels from NetworkGraph

Automatically prune NetworkGraph of stale channels hourly in BP

Reject channel_update messages with timestamps too old or new

Because we time out channel info that is older than two weeks now,
we should also reject new channel info that is older than two
weeks, in addition to rejecting future channel info.