Commit graph

3339 commits

Author SHA1 Message Date
Valentine Wallace
9c5acf19f3
Move pending forward htlc construction into method
In upcoming blinded paths work, this method will grow to handle blinded
forwards.
2023-07-13 15:23:49 -04:00
Matt Corallo
df237ba3b4
Merge pull request #2391 from TheBlueMatt/2023-07-all-compl-actions
Handle pre-startup and closed-channel monitor update completion actions
2023-07-12 22:37:40 +00:00
Matt Corallo
550cf91439 Add comment describing when a completion action can be discarded
In an older PR a reviewer had asked why the discarding of a channel
being blocked on another monitor update is okay if the blocked
channel has since closed. At the time, this was not actually okay -
the monitor updates in the channel weren't moved to the
`ChannelManager` on close so the whole pipeline was busted, but
with the changes in 4041f0899f the
handling of channel closes with pending monitor updates is now
correct, and so is the existing code block.
2023-07-12 20:53:10 +00:00
Matt Corallo
f9521a4bda Run monitor update completion actions for pre-startup completion
If a `ChannelMonitorUpdate` completes being persisted, but the
`ChannelManager` isn't informed thereof (or isn't persisted) before
shutdown, on startup we may still have it listed as in-flight. When
we compare the available `ChannelMonitor` with the in-flight set,
we'll notice it completed and remove it, however this may leave
some post-update actions dangling which need to complete.

Here we handle this with a new `BackgroundEvent` indicating we need
to handle any post-update action(s) for a given channel.
2023-07-12 20:53:10 +00:00
Elias Rohrer
07606c1841
Merge pull request #2393 from wpaulino/bump-transaction-event-handler-fixups
Bump transaction event handler fixups
2023-07-12 21:17:56 +02:00
Wilmer Paulino
4c7883c831
Expose previous UTXO for anchor and HTLC inputs
This may be required by some wallets that rely on PSBTs internally to
create/sign transactions.
2023-07-11 16:53:25 -07:00
Wilmer Paulino
0dbfe245a9
Add transaction-related helpers to AnchorDescriptor
This provides a similar interface as `HTLCDescriptor` for users which
choose to implement their own bump transaction event handler.
2023-07-11 16:53:24 -07:00
Wilmer Paulino
690ad18b22
Provide missing post-derivation signer parameters
Users may expect these to be provided manually after derivation in the
event they need to perform any enforcement prior to signing.
2023-07-11 16:53:24 -07:00
Wilmer Paulino
72c42ee786
Cache HTLC per_commitment_point in descriptor
This allows us to obtain the HTLC input and output from its descriptor
without needing to derive the `per_commitment_point` through the signer.
2023-07-11 16:53:22 -07:00
Wilmer Paulino
ae701a0d20
Expose CoinSelection struct members
These are meant to be provided by the user, so they need to be exposed
in the API.
2023-07-11 13:34:42 -07:00
Wilmer Paulino
a100ed0098
Accept BumpTransactionEvent in handle_event
There's no reason to accept the general `Event` enum.
2023-07-11 13:34:35 -07:00
Matt Corallo
e404c129a5
Merge pull request #2400 from TheBlueMatt/2023-07-kill-vec_type
Fix backwards compat for blocked_monitor_updates and finally kill `vec_type`
2023-07-11 19:58:34 +00:00
Matt Corallo
d83390c63b Document some TLV write/read formats
While we don't want to publicly document these and support them for
downstream crates, documenting them internally is useful.
2023-07-11 16:20:03 +00:00
Matt Corallo
907ea200f0 Drop vec_type TLV handling entirely
Historically, we used `vec_type` for all TLV Vec reads/writes, but
it is asymmetric and thus somewhat confusing - on the write side it
always writes a TLV entry, even if there are zero elements. On the
read side, it happily accepts a missing TLV, providing a
zero-length vector.

In 85b573ddad a new `optional_vec`
TLV format was added which was symmetric, but only supports
optional vecs.

Now that we've migrated entirely to the new `required_vec` TLV
type, we can entirely remove the awkward `vec_type`.
2023-07-11 16:20:03 +00:00
Matt Corallo
4b7631ce16 Convert channelmonitor vec_type TLV writes to required/optional
* `HolderSignedTx::htlc_outputs` has always been written since it
   was converted to TLVs in 86641ea680.
 * `ChanelMonitorUpdateStep::*::htlc_outputs` have been written
   since the enum was converted to TLVs in 86641ea680.
2023-07-11 16:20:03 +00:00
Elias Rohrer
31a0456c0e
Merge pull request #2395 from wpaulino/phantom-deduped-forward-event
Force enqueue second forward event for phantom receives
2023-07-11 09:31:37 +02:00
Matt Corallo
d450e0fb2c Handle monitor completion actions for closed channels
If a channel has been closed, there may still be some
`ChannelMonitorUpdate`(s) which are pending completion. These
in-flight updates may also be blocking another channel from letting
an update fly, e.g. for forwarded payments where the payment
preimage will be removed from the downstream channel after the
upstream channel has closed.

Luckily all the infrastructure to handle this case is already in
place - we just need to process the
`monitor_update_blocked_actions` for closed channels.
2023-07-10 21:32:44 +00:00
Wilmer Paulino
4c342bd6b6
Merge pull request #2369 from TheBlueMatt/2023-06-mon-event-less-race
Don't drop ChannelMonitor Events until they're processed
2023-07-10 13:01:50 -07:00
Matt Corallo
4206e7119b Don't drop ChannelMonitor Events until they're processed
We currently assume the owner of `ChannelMonitor`s won't persist
the `ChannelMonitor` while `Event`s are being processed. This is
fine, except (a) its generally hard to do so and (b) the
`ChainMonitor` doesn't even do this.

Thus, in rare cases, a user could begin processing events which
are, generated by connecting a transaction or a new best-block,
take some time to do so, and while doing so process a further chain
event, causing persistece. This could lose the event being
processed alltogether, which could lose the user funds.

This should be very rare, but may have been made slightly more
reachable with (a) the async event processing making it more
common to do networking in event handling, (b) the new future
generation in the `ChainMonitor`, which now wakes the
`background-processor` directly when chain actions happen on the
`ChainMonitor`.
2023-07-10 16:52:04 +00:00
Wilmer Paulino
81722ca833
Handle new event processing logic when enqueuing forward event
This was a regression resulting from f2453b7 since we now process events
in a loop until there aren't any left. Processing events is done in
batches and they are not removed until we're done processing each batch.
Since handling a `PendingHTLCsForwardable` event will call back into the
`ChannelManager`, we'll still see the original forwarding event not
removed. Phantom payments will need an additional forwarding event
before being claimed to make them look real by taking more time.
2023-07-10 09:49:31 -07:00
Wilmer Paulino
dba3e8f2d9
Merge pull request #2364 from TheBlueMatt/2023-06-htlc-preimage-replay
Re-claim forwarded HTLCs on startup
2023-07-10 09:27:57 -07:00
Matt Corallo
a358ba2e68
Merge pull request #2307 from benthecarman/verify-funcs
Add helper functions to verify node and channel annoucements
2023-07-08 22:04:06 +00:00
Matt Corallo
0d3adb8fa0
Merge pull request #2042 from ffaex/add_fn
added fn_add_htlc
2023-07-08 21:47:48 +00:00
benthecarman
5cc400c37f Add helper functions to verify node and channel annoucements
Right now the only real way to verify the node and channel
announcements is to call `update_node_from_announcement`/
`update_channel_from_announcement`. If you want to do some
processing before you add to your network graph then you need to
manually verify the signature. This adds some nice helper functions
to make it easier.

I tried to do the same for channel update but it did not seem as
easy so figured that is fine to punt on since I don't see many
people doing manual things with channel updates.
2023-07-08 20:23:15 +00:00
Matt Corallo
9ce7e8e650 Rename ClosingMonitorUpdateRegeneratedOnStartup to Closed...
Now that we also use the "Closing" `BackgroundEvent` for
already-closed channels we need to rename it and tweak the docs.
2023-07-08 02:16:33 +00:00
Matt Corallo
345f8df28f Re-claim forwarded HTLCs on startup
Because `ChannelMonitorUpdate`s can complete asynchronously and
out-of-order now, a `commitment_signed` `ChannelMonitorUpdate` from
a downstream channel could complete prior to the preimage
`ChannelMonitorUpdate` on the upstream channel. In that case, we may
not get a `update_fulfill_htlc` replay on startup. Thus, we have to
ensure any payment preimages contained in that downstream update are
re-claimed on startup.

Here we do this during the existing walk of the `ChannelMonitor`
preimages for closed channels.
2023-07-08 02:16:33 +00:00
Matt Corallo
6ebb6d182e
Merge pull request #2354 from alecchendev/2023-06-bump-default-dust-exp
Bump dust exposure threshold
2023-07-08 02:15:10 +00:00
Matt Corallo
3236be1d8a
Merge pull request #2347 from henghonglee/issue-2304
Expose whether a channel is closing in ChannelDetails
2023-07-07 21:21:09 +00:00
Matt Corallo
e6eb654cd1 Replace vec_type TLVs in channel/manager with required/optional
* `PhantomRouteHints::channels` has been written since the struct
  was added in 410eb05365.
* `HTLCSource::path_hops` has been written since the struct was
  converted to TLVs in 66784e32fe.
2023-07-07 21:07:25 +00:00
Matt Corallo
6fbeea02ed Convert routing vec_type TLV writes to other TLV types
* `BlindedTail::hops` has always been written since it was
   introduced in 64c26c8a79.
 * `PaymentParameters::clear_hints` has always been written since
   it was introduced as `Payee::route_hitns` in 46b68c517d.
2023-07-07 21:07:25 +00:00
Matt Corallo
739ffe18ba Migrate chan_utils vec_type TLVs to required/optional
* `CommitmentTransaction::htlcs` has always been written since the
  struct was converted to TLVs in 66784e32fe.
* `HolderCommitmentTransaction::counterparty_htlc_sigs` have always
  been written since the struct was converted to TLVs in
  c8bc1b6d3d.
2023-07-07 21:07:06 +00:00
Matt Corallo
884160c5c1 Convert Event vec storage away from vec_type
* `PaymentPathFailed::path` was added without an optional compat
   wrapper in e5310dd5f0.
 * `PaymentPathSuccessful::path` has always been written since the
   event was added in 2c4f16d5e3.
 * `Probe{Failed,Successful}::path` have always been written since
   the events were added in eb8bce0d16.
2023-07-07 21:07:06 +00:00
Matt Corallo
a04bf844d4 Convert some vec_type TLVs to required_vec
This converts some required TLVs to `required_vec` which are, in
fact, required (and have been written forever).

* `HTLCFailReason` hasn't changed since many structs were converted
  to TLVs in 66784e32fe.
* `NodeInfo::channels` has been written since `NetworkGraph`
  structs were converted to TLVs in 321b19c4d9.
* Several test-only TLV writes were converted.
2023-07-07 21:07:06 +00:00
Matt Corallo
32846d33db Add a required_vec TLV deserialization type
Historically, we used `vec_type` for all TLV Vec reads/writes, but
it is asymmetric and thus somewhat confusing - on the write side it
always writes a TLV entry, even if there are zero elements. On the
read side, it happily accepts a missing TLV, providing a
zero-length vector.

In 85b573ddad a new `optional_vec`
TLV format was added which was symmetric, but only supports
optional vecs. This adds the corresponding required form, always
writing a TLV and ensuring it is present.
2023-07-07 21:06:52 +00:00
Alec Chen
b040335712
Use multiplier in dust exposure threshold calculation
This commit makes use of the added enum to calculate the dust
exposure threshold based on the current fee rate. This also updates
tests to ensure it works as intended.
2023-07-07 14:30:51 -05:00
Alec Chen
c2992fd94b
Send fee estimator through to get_max_htlc_dust_exposure_threshold 2023-07-07 14:30:50 -05:00
Alec Chen
cfc7ec66f0
Add max dust exposure multiplier config knob
With fee rates rising dramatically in mid-April 2023, thresholds for
what is considered dust have risen, often exceeding our previous dust
exposure threshold of 5k sats. This causes all payments and HTLC
forwards between 5k sats and new dust thresholds to fail.

This commit changes our max dust exposure config knob from a fixed
upper limit to a `MaxDustHTLCExposure` enum with an additional variant
to allow setting our max dust exposure to a multiplier on the current
high priority feerate.

To remain backwards compatible we'll always write the fixed limit if
it's set, or its default value in its currently reserved TLV.

We also now write an odd TLV for the new enum, so that previous
versions can safely ignore it upon downgrading, while allowing us to
make use of the new type when it's written.
2023-07-07 14:30:42 -05:00
Matt Corallo
46913daa38 Fix backwards compat for blocked_monitor_updates
In 1ce2beb774,
`Channel::blocked_monitor_updates` was moved to an even TLV to
ensure downgrades with vec entries are forbidden. However, the
serialized type remained `vec_type`, which is always written.

Instead, `optional_vec` must be used.
2023-07-07 18:28:25 +00:00
valentinewallace
e40b6ae8b7
Merge pull request #2392 from TheBlueMatt/2023-07-async-mon-even-tlv
Move Channel's blocked monitor updates vec to an even TLV
2023-07-07 11:45:55 -04:00
Elias Rohrer
73ba28d8e4
Expose DefaultMessageRouter 2023-07-07 15:47:02 +02:00
henghonglee
47cb45ed32 Add ChannelShutdownState to ChannelDetails
This commit adds the state of channel shutdown to channeldetails
2023-07-06 10:51:35 +08:00
Matt Corallo
1ce2beb774 Move Channel's blocked monitor updates vec to an even TLV
In 9dfe42cf86,
`ChannelMonitorUpdate`s were stored in `Channel` while they were
being processed. Because it was possible (though highly unlikely,
due to various locking likely blocking persistence) an update was
in-flight (even synchronously) when a `ChannelManager` was
persisted, the new updates were persisted via an odd TLV.

However, in 4041f0899f these pending
monitor updates were moved to `ChannelManager`, with appropriate
handling there. Now the only `ChannelMonitorUpdate`s which are
stored in `Channel` are those which are explicitly blocked, which
requires the async pipeline.

Because we don't support async monitor update users downgrading to
0.0.115 or lower, we move to persisting them via an even TLV. As
the odd TLV storage has not yet been released, we can do so
trivially.

Fixes #2317.
2023-07-05 17:26:37 +00:00
henghonglee
54bcb6eb02 Fix DefaultRouter type restrained to only MutexGuard
Type of DerefMut for DefaultRouter was specialized to only MutexGuard.
It should be generic around RefMut and MutexGuard. This commit fixes that
2023-07-04 22:30:07 +08:00
Matt Corallo
86fd9e7fbc
Merge pull request #2384 from jkczyz/2023-06-message-router
Define a default `MessageRouter` implementation
2023-07-02 20:11:18 +00:00
Matt Corallo
63c77a960b
Merge pull request #2375 from TonyGiorgio/remove-doc-future-anchor-support
Remove doc specifying future anchor support
2023-07-02 20:10:10 +00:00
Jeffrey Czyz
129dd30c45
Define a default MessageRouter implementation
Otherwise, users need to define one when using "Simple" type aliases.
2023-06-30 10:29:37 -04:00
Tony Giorgio
5cc625e8f7
Clarify event doc specifying anchor support 2023-06-29 22:10:02 -05:00
Matt Corallo
bd12067777
Merge pull request #2372 from wpaulino/channelmanager-new-highest-seen-timestamp
Require best block timestamp within ChannelManager::new
2023-06-29 04:15:46 +00:00
Andrei
189b070f62 Use MonotonicTime as Instant shifted by 10 years forward
Such implementation allows `MonotonicTime` to go backward up to 10
years on all platforms. On some platforms (e.g. iOS) `Instant` is
represented as `u64` of nanoseconds since the boot of the system.
Obviously such implementation does not allow to go backward before the
time of the boot.

Co-authored-by: Andrei <andrei.i@posteo.de>
Co-authored-by: Jeffrey Czyz <jkczyz@gmail.com>
2023-06-29 00:00:00 +00:00
Wilmer Paulino
82e0df5e4d
Require best block timestamp within ChannelManager::new
This ensures freshly initialized nodes can proceed to create unexpired
invoices without a call to `best_block_updated`, since an invoice's
expiration delta is applied to `highest_seen_timestamp`.
2023-06-27 13:43:14 -07:00