]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/chain/mod.rs
Include OfferId in VerifiedInvoiceRequest
[rust-lightning] / lightning / src / chain / mod.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
8 // licenses.
9
10 //! Structs and traits which allow other parts of rust-lightning to interact with the blockchain.
11
12 use bitcoin::blockdata::block::{Block, Header};
13 use bitcoin::blockdata::constants::genesis_block;
14 use bitcoin::blockdata::script::{Script, ScriptBuf};
15 use bitcoin::hash_types::{BlockHash, Txid};
16 use bitcoin::network::constants::Network;
17 use bitcoin::secp256k1::PublicKey;
18
19 use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, MonitorEvent};
20 use crate::ln::ChannelId;
21 use crate::sign::ecdsa::WriteableEcdsaChannelSigner;
22 use crate::chain::transaction::{OutPoint, TransactionData};
23
24 #[allow(unused_imports)]
25 use crate::prelude::*;
26
27 pub mod chaininterface;
28 pub mod chainmonitor;
29 pub mod channelmonitor;
30 pub mod transaction;
31 pub(crate) mod onchaintx;
32 pub(crate) mod package;
33
34 /// The best known block as identified by its hash and height.
35 #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
36 pub struct BestBlock {
37         /// The block's hash
38         pub block_hash: BlockHash,
39         /// The height at which the block was confirmed.
40         pub height: u32,
41 }
42
43 impl BestBlock {
44         /// Constructs a `BestBlock` that represents the genesis block at height 0 of the given
45         /// network.
46         pub fn from_network(network: Network) -> Self {
47                 BestBlock {
48                         block_hash: genesis_block(network).header.block_hash(),
49                         height: 0,
50                 }
51         }
52
53         /// Returns a `BestBlock` as identified by the given block hash and height.
54         pub fn new(block_hash: BlockHash, height: u32) -> Self {
55                 BestBlock { block_hash, height }
56         }
57 }
58
59
60 /// The `Listen` trait is used to notify when blocks have been connected or disconnected from the
61 /// chain.
62 ///
63 /// Useful when needing to replay chain data upon startup or as new chain events occur. Clients
64 /// sourcing chain data using a block-oriented API should prefer this interface over [`Confirm`].
65 /// Such clients fetch the entire header chain whereas clients using [`Confirm`] only fetch headers
66 /// when needed.
67 ///
68 /// By using [`Listen::filtered_block_connected`] this interface supports clients fetching the
69 /// entire header chain and only blocks with matching transaction data using BIP 157 filters or
70 /// other similar filtering.
71 pub trait Listen {
72         /// Notifies the listener that a block was added at the given height, with the transaction data
73         /// possibly filtered.
74         fn filtered_block_connected(&self, header: &Header, txdata: &TransactionData, height: u32);
75
76         /// Notifies the listener that a block was added at the given height.
77         fn block_connected(&self, block: &Block, height: u32) {
78                 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
79                 self.filtered_block_connected(&block.header, &txdata, height);
80         }
81
82         /// Notifies the listener that a block was removed at the given height.
83         fn block_disconnected(&self, header: &Header, height: u32);
84 }
85
86 /// The `Confirm` trait is used to notify LDK when relevant transactions have been confirmed on
87 /// chain or unconfirmed during a chain reorganization.
88 ///
89 /// Clients sourcing chain data using a transaction-oriented API should prefer this interface over
90 /// [`Listen`]. For instance, an Electrum-based transaction sync implementation may implement
91 /// [`Filter`] to subscribe to relevant transactions and unspent outputs it should monitor for
92 /// on-chain activity. Then, it needs to notify LDK via this interface upon observing any changes
93 /// with reference to the confirmation status of the monitored objects.
94 ///
95 /// # Use
96 /// The intended use is as follows:
97 /// - Call [`transactions_confirmed`] to notify LDK whenever any of the registered transactions or
98 ///   outputs are, respectively, confirmed or spent on chain.
99 /// - Call [`transaction_unconfirmed`] to notify LDK whenever any transaction returned by
100 ///   [`get_relevant_txids`] is no longer confirmed in the block with the given block hash.
101 /// - Call [`best_block_updated`] to notify LDK whenever a new chain tip becomes available.
102 ///
103 /// # Order
104 ///
105 /// Clients must call these methods in chain order. Specifically:
106 /// - Transactions which are confirmed in a particular block must be given before transactions
107 ///   confirmed in a later block.
108 /// - Dependent transactions within the same block must be given in topological order, possibly in
109 ///   separate calls.
110 /// - All unconfirmed transactions must be given after the original confirmations and before *any*
111 ///   reconfirmations, i.e., [`transactions_confirmed`] and [`transaction_unconfirmed`] calls should
112 ///   never be interleaved, but always conduced *en bloc*.
113 /// - Any reconfirmed transactions need to be explicitly unconfirmed before they are reconfirmed
114 ///   in regard to the new block.
115 ///
116 /// See individual method documentation for further details.
117 ///
118 /// [`transactions_confirmed`]: Self::transactions_confirmed
119 /// [`transaction_unconfirmed`]: Self::transaction_unconfirmed
120 /// [`best_block_updated`]: Self::best_block_updated
121 /// [`get_relevant_txids`]: Self::get_relevant_txids
122 pub trait Confirm {
123         /// Notifies LDK of transactions confirmed in a block with a given header and height.
124         ///
125         /// Must be called for any transactions registered by [`Filter::register_tx`] or any
126         /// transactions spending an output registered by [`Filter::register_output`]. Such transactions
127         /// appearing in the same block do not need to be included in the same call; instead, multiple
128         /// calls with additional transactions may be made so long as they are made in [chain order].
129         ///
130         /// May be called before or after [`best_block_updated`] for the corresponding block. However,
131         /// in the event of a chain reorganization, it must not be called with a `header` that is no
132         /// longer in the chain as of the last call to [`best_block_updated`].
133         ///
134         /// [chain order]: Confirm#order
135         /// [`best_block_updated`]: Self::best_block_updated
136         fn transactions_confirmed(&self, header: &Header, txdata: &TransactionData, height: u32);
137         /// Notifies LDK of a transaction that is no longer confirmed as result of a chain reorganization.
138         ///
139         /// Must be called for any transaction returned by [`get_relevant_txids`] if it has been
140         /// reorganized out of the best chain or if it is no longer confirmed in the block with the
141         /// given block hash. Once called, the given transaction will not be returned
142         /// by [`get_relevant_txids`], unless it has been reconfirmed via [`transactions_confirmed`].
143         ///
144         /// [`get_relevant_txids`]: Self::get_relevant_txids
145         /// [`transactions_confirmed`]: Self::transactions_confirmed
146         fn transaction_unconfirmed(&self, txid: &Txid);
147         /// Notifies LDK of an update to the best header connected at the given height.
148         ///
149         /// Must be called whenever a new chain tip becomes available. May be skipped for intermediary
150         /// blocks.
151         fn best_block_updated(&self, header: &Header, height: u32);
152         /// Returns transactions that must be monitored for reorganization out of the chain along
153         /// with the height and the hash of the block as part of which it had been previously confirmed.
154         ///
155         /// Note that the returned `Option<BlockHash>` might be `None` for channels created with LDK
156         /// 0.0.112 and prior, in which case you need to manually track previous confirmations.
157         ///
158         /// Will include any transactions passed to [`transactions_confirmed`] that have insufficient
159         /// confirmations to be safe from a chain reorganization. Will not include any transactions
160         /// passed to [`transaction_unconfirmed`], unless later reconfirmed.
161         ///
162         /// Must be called to determine the subset of transactions that must be monitored for
163         /// reorganization. Will be idempotent between calls but may change as a result of calls to the
164         /// other interface methods. Thus, this is useful to determine which transactions must be
165         /// given to [`transaction_unconfirmed`].
166         ///
167         /// If any of the returned transactions are confirmed in a block other than the one with the
168         /// given hash at the given height, they need to be unconfirmed and reconfirmed via
169         /// [`transaction_unconfirmed`] and [`transactions_confirmed`], respectively.
170         ///
171         /// [`transactions_confirmed`]: Self::transactions_confirmed
172         /// [`transaction_unconfirmed`]: Self::transaction_unconfirmed
173         fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<BlockHash>)>;
174 }
175
176 /// An enum representing the status of a channel monitor update persistence.
177 ///
178 /// These are generally used as the return value for an implementation of [`Persist`] which is used
179 /// as the storage layer for a [`ChainMonitor`]. See the docs on [`Persist`] for a high-level
180 /// explanation of how to handle different cases.
181 ///
182 /// While `UnrecoverableError` is provided as a failure variant, it is not truly "handled" on the
183 /// calling side, and generally results in an immediate panic. For those who prefer to avoid
184 /// panics, `InProgress` can be used and you can retry the update operation in the background or
185 /// shut down cleanly.
186 ///
187 /// Note that channels should generally *not* be force-closed after a persistence failure.
188 /// Force-closing with the latest [`ChannelMonitorUpdate`] applied may result in a transaction
189 /// being broadcast which can only be spent by the latest [`ChannelMonitor`]! Thus, if the
190 /// latest [`ChannelMonitor`] is not durably persisted anywhere and exists only in memory, naively
191 /// calling [`ChannelManager::force_close_broadcasting_latest_txn`] *may result in loss of funds*!
192 ///
193 /// [`Persist`]: chainmonitor::Persist
194 /// [`ChainMonitor`]: chainmonitor::ChainMonitor
195 /// [`ChannelManager::force_close_broadcasting_latest_txn`]: crate::ln::channelmanager::ChannelManager::force_close_broadcasting_latest_txn
196 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
197 pub enum ChannelMonitorUpdateStatus {
198         /// The update has been durably persisted and all copies of the relevant [`ChannelMonitor`]
199         /// have been updated.
200         ///
201         /// This includes performing any `fsync()` calls required to ensure the update is guaranteed to
202         /// be available on restart even if the application crashes.
203         Completed,
204         /// Indicates that the update will happen asynchronously in the background or that a transient
205         /// failure occurred which is being retried in the background and will eventually complete.
206         ///
207         /// This will "freeze" a channel, preventing us from revoking old states or submitting a new
208         /// commitment transaction to the counterparty. Once the update(s) which are `InProgress` have
209         /// been completed, a [`MonitorEvent::Completed`] can be used to restore the channel to an
210         /// operational state.
211         ///
212         /// Even when a channel has been "frozen", updates to the [`ChannelMonitor`] can continue to
213         /// occur (e.g. if an inbound HTLC which we forwarded was claimed upstream, resulting in us
214         /// attempting to claim it on this channel) and those updates must still be persisted.
215         ///
216         /// No updates to the channel will be made which could invalidate other [`ChannelMonitor`]s
217         /// until a [`MonitorEvent::Completed`] is provided, even if you return no error on a later
218         /// monitor update for the same channel.
219         ///
220         /// For deployments where a copy of [`ChannelMonitor`]s and other local state are backed up in
221         /// a remote location (with local copies persisted immediately), it is anticipated that all
222         /// updates will return [`InProgress`] until the remote copies could be updated.
223         ///
224         /// Note that while fully asynchronous persistence of [`ChannelMonitor`] data is generally
225         /// reliable, this feature is considered beta, and a handful of edge-cases remain. Until the
226         /// remaining cases are fixed, in rare cases, *using this feature may lead to funds loss*.
227         ///
228         /// [`InProgress`]: ChannelMonitorUpdateStatus::InProgress
229         InProgress,
230         /// Indicates that an update has failed and will not complete at any point in the future.
231         ///
232         /// Currently returning this variant will cause LDK to immediately panic to encourage immediate
233         /// shutdown. In the future this may be updated to disconnect peers and refuse to continue
234         /// normal operation without a panic.
235         ///
236         /// Applications which wish to perform an orderly shutdown after failure should consider
237         /// returning [`InProgress`] instead and simply shut down without ever marking the update
238         /// complete.
239         ///
240         /// [`InProgress`]: ChannelMonitorUpdateStatus::InProgress
241         UnrecoverableError,
242 }
243
244 /// The `Watch` trait defines behavior for watching on-chain activity pertaining to channels as
245 /// blocks are connected and disconnected.
246 ///
247 /// Each channel is associated with a [`ChannelMonitor`]. Implementations of this trait are
248 /// responsible for maintaining a set of monitors such that they can be updated as channel state
249 /// changes. On each update, *all copies* of a [`ChannelMonitor`] must be updated and the update
250 /// persisted to disk to ensure that the latest [`ChannelMonitor`] state can be reloaded if the
251 /// application crashes.
252 ///
253 /// See method documentation and [`ChannelMonitorUpdateStatus`] for specific requirements.
254 pub trait Watch<ChannelSigner: WriteableEcdsaChannelSigner> {
255         /// Watches a channel identified by `funding_txo` using `monitor`.
256         ///
257         /// Implementations are responsible for watching the chain for the funding transaction along
258         /// with any spends of outputs returned by [`get_outputs_to_watch`]. In practice, this means
259         /// calling [`block_connected`] and [`block_disconnected`] on the monitor.
260         ///
261         /// A return of `Err(())` indicates that the channel should immediately be force-closed without
262         /// broadcasting the funding transaction.
263         ///
264         /// If the given `funding_txo` has previously been registered via `watch_channel`, `Err(())`
265         /// must be returned.
266         ///
267         /// [`get_outputs_to_watch`]: channelmonitor::ChannelMonitor::get_outputs_to_watch
268         /// [`block_connected`]: channelmonitor::ChannelMonitor::block_connected
269         /// [`block_disconnected`]: channelmonitor::ChannelMonitor::block_disconnected
270         fn watch_channel(&self, funding_txo: OutPoint, monitor: ChannelMonitor<ChannelSigner>) -> Result<ChannelMonitorUpdateStatus, ()>;
271
272         /// Updates a channel identified by `funding_txo` by applying `update` to its monitor.
273         ///
274         /// Implementations must call [`ChannelMonitor::update_monitor`] with the given update. This
275         /// may fail (returning an `Err(())`), in which case this should return
276         /// [`ChannelMonitorUpdateStatus::InProgress`] (and the update should never complete). This
277         /// generally implies the channel has been closed (either by the funding outpoint being spent
278         /// on-chain or the [`ChannelMonitor`] having decided to do so and broadcasted a transaction),
279         /// and the [`ChannelManager`] state will be updated once it sees the funding spend on-chain.
280         ///
281         /// In general, persistence failures should be retried after returning
282         /// [`ChannelMonitorUpdateStatus::InProgress`] and eventually complete. If a failure truly
283         /// cannot be retried, the node should shut down immediately after returning
284         /// [`ChannelMonitorUpdateStatus::UnrecoverableError`], see its documentation for more info.
285         ///
286         /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
287         fn update_channel(&self, funding_txo: OutPoint, update: &ChannelMonitorUpdate) -> ChannelMonitorUpdateStatus;
288
289         /// Returns any monitor events since the last call. Subsequent calls must only return new
290         /// events.
291         ///
292         /// Note that after any block- or transaction-connection calls to a [`ChannelMonitor`], no
293         /// further events may be returned here until the [`ChannelMonitor`] has been fully persisted
294         /// to disk.
295         ///
296         /// For details on asynchronous [`ChannelMonitor`] updating and returning
297         /// [`MonitorEvent::Completed`] here, see [`ChannelMonitorUpdateStatus::InProgress`].
298         fn release_pending_monitor_events(&self) -> Vec<(OutPoint, ChannelId, Vec<MonitorEvent>, Option<PublicKey>)>;
299 }
300
301 /// The `Filter` trait defines behavior for indicating chain activity of interest pertaining to
302 /// channels.
303 ///
304 /// This is useful in order to have a [`Watch`] implementation convey to a chain source which
305 /// transactions to be notified of. Notification may take the form of pre-filtering blocks or, in
306 /// the case of [BIP 157]/[BIP 158], only fetching a block if the compact filter matches. If
307 /// receiving full blocks from a chain source, any further filtering is unnecessary.
308 ///
309 /// After an output has been registered, subsequent block retrievals from the chain source must not
310 /// exclude any transactions matching the new criteria nor any in-block descendants of such
311 /// transactions.
312 ///
313 /// Note that use as part of a [`Watch`] implementation involves reentrancy. Therefore, the `Filter`
314 /// should not block on I/O. Implementations should instead queue the newly monitored data to be
315 /// processed later. Then, in order to block until the data has been processed, any [`Watch`]
316 /// invocation that has called the `Filter` must return [`InProgress`].
317 ///
318 /// [`InProgress`]: ChannelMonitorUpdateStatus::InProgress
319 /// [BIP 157]: https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki
320 /// [BIP 158]: https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki
321 pub trait Filter {
322         /// Registers interest in a transaction with `txid` and having an output with `script_pubkey` as
323         /// a spending condition.
324         fn register_tx(&self, txid: &Txid, script_pubkey: &Script);
325
326         /// Registers interest in spends of a transaction output.
327         ///
328         /// Note that this method might be called during processing of a new block. You therefore need
329         /// to ensure that also dependent output spents within an already connected block are correctly
330         /// handled, e.g., by re-scanning the block in question whenever new outputs have been
331         /// registered mid-processing.
332         fn register_output(&self, output: WatchedOutput);
333 }
334
335 /// A transaction output watched by a [`ChannelMonitor`] for spends on-chain.
336 ///
337 /// Used to convey to a [`Filter`] such an output with a given spending condition. Any transaction
338 /// spending the output must be given to [`ChannelMonitor::block_connected`] either directly or via
339 /// [`Confirm::transactions_confirmed`].
340 ///
341 /// If `block_hash` is `Some`, this indicates the output was created in the corresponding block and
342 /// may have been spent there. See [`Filter::register_output`] for details.
343 ///
344 /// [`ChannelMonitor`]: channelmonitor::ChannelMonitor
345 /// [`ChannelMonitor::block_connected`]: channelmonitor::ChannelMonitor::block_connected
346 #[derive(Clone, PartialEq, Eq, Hash)]
347 pub struct WatchedOutput {
348         /// First block where the transaction output may have been spent.
349         pub block_hash: Option<BlockHash>,
350
351         /// Outpoint identifying the transaction output.
352         pub outpoint: OutPoint,
353
354         /// Spending condition of the transaction output.
355         pub script_pubkey: ScriptBuf,
356 }
357
358 impl<T: Listen> Listen for dyn core::ops::Deref<Target = T> {
359         fn filtered_block_connected(&self, header: &Header, txdata: &TransactionData, height: u32) {
360                 (**self).filtered_block_connected(header, txdata, height);
361         }
362
363         fn block_disconnected(&self, header: &Header, height: u32) {
364                 (**self).block_disconnected(header, height);
365         }
366 }
367
368 impl<T: core::ops::Deref, U: core::ops::Deref> Listen for (T, U)
369 where
370         T::Target: Listen,
371         U::Target: Listen,
372 {
373         fn filtered_block_connected(&self, header: &Header, txdata: &TransactionData, height: u32) {
374                 self.0.filtered_block_connected(header, txdata, height);
375                 self.1.filtered_block_connected(header, txdata, height);
376         }
377
378         fn block_disconnected(&self, header: &Header, height: u32) {
379                 self.0.block_disconnected(header, height);
380                 self.1.block_disconnected(header, height);
381         }
382 }
383
384 /// A unique identifier to track each pending output claim within a [`ChannelMonitor`].
385 ///
386 /// This is not exported to bindings users as we just use [u8; 32] directly.
387 #[derive(Copy, Clone, Debug, Hash, PartialEq, Eq)]
388 pub struct ClaimId(pub [u8; 32]);