]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/chain/mod.rs
Merge pull request #1628 from tnull/2022-07-readme-remove-slack
[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, BlockHeader};
13 use bitcoin::blockdata::constants::genesis_block;
14 use bitcoin::blockdata::script::Script;
15 use bitcoin::blockdata::transaction::{Transaction, TxOut};
16 use bitcoin::hash_types::{BlockHash, Txid};
17 use bitcoin::network::constants::Network;
18 use bitcoin::secp256k1::PublicKey;
19
20 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, MonitorEvent};
21 use chain::keysinterface::Sign;
22 use chain::transaction::{OutPoint, TransactionData};
23
24 use prelude::*;
25
26 pub mod chaininterface;
27 pub mod chainmonitor;
28 pub mod channelmonitor;
29 pub mod transaction;
30 pub mod keysinterface;
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, PartialEq)]
36 pub struct BestBlock {
37         block_hash: BlockHash,
38         height: u32,
39 }
40
41 impl BestBlock {
42         /// Constructs a `BestBlock` that represents the genesis block at height 0 of the given
43         /// network.
44         pub fn from_genesis(network: Network) -> Self {
45                 BestBlock {
46                         block_hash: genesis_block(network).header.block_hash(),
47                         height: 0,
48                 }
49         }
50
51         /// Returns a `BestBlock` as identified by the given block hash and height.
52         pub fn new(block_hash: BlockHash, height: u32) -> Self {
53                 BestBlock { block_hash, height }
54         }
55
56         /// Returns the best block hash.
57         pub fn block_hash(&self) -> BlockHash { self.block_hash }
58
59         /// Returns the best block height.
60         pub fn height(&self) -> u32 { self.height }
61 }
62
63 /// An error when accessing the chain via [`Access`].
64 #[derive(Clone)]
65 pub enum AccessError {
66         /// The requested chain is unknown.
67         UnknownChain,
68
69         /// The requested transaction doesn't exist or hasn't confirmed.
70         UnknownTx,
71 }
72
73 /// The `Access` trait defines behavior for accessing chain data and state, such as blocks and
74 /// UTXOs.
75 pub trait Access {
76         /// Returns the transaction output of a funding transaction encoded by [`short_channel_id`].
77         /// Returns an error if `genesis_hash` is for a different chain or if such a transaction output
78         /// is unknown.
79         ///
80         /// [`short_channel_id`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#definition-of-short_channel_id
81         fn get_utxo(&self, genesis_hash: &BlockHash, short_channel_id: u64) -> Result<TxOut, AccessError>;
82 }
83
84 /// The `Listen` trait is used to notify when blocks have been connected or disconnected from the
85 /// chain.
86 ///
87 /// Useful when needing to replay chain data upon startup or as new chain events occur. Clients
88 /// sourcing chain data using a block-oriented API should prefer this interface over [`Confirm`].
89 /// Such clients fetch the entire header chain whereas clients using [`Confirm`] only fetch headers
90 /// when needed.
91 ///
92 /// By using [`Listen::filtered_block_connected`] this interface supports clients fetching the
93 /// entire header chain and only blocks with matching transaction data using BIP 157 filters or
94 /// other similar filtering.
95 pub trait Listen {
96         /// Notifies the listener that a block was added at the given height, with the transaction data
97         /// possibly filtered.
98         fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32);
99
100         /// Notifies the listener that a block was added at the given height.
101         fn block_connected(&self, block: &Block, height: u32) {
102                 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
103                 self.filtered_block_connected(&block.header, &txdata, height);
104         }
105
106         /// Notifies the listener that a block was removed at the given height.
107         fn block_disconnected(&self, header: &BlockHeader, height: u32);
108 }
109
110 /// The `Confirm` trait is used to notify when transactions have been confirmed on chain or
111 /// unconfirmed during a chain reorganization.
112 ///
113 /// Clients sourcing chain data using a transaction-oriented API should prefer this interface over
114 /// [`Listen`]. For instance, an Electrum client may implement [`Filter`] by subscribing to activity
115 /// related to registered transactions and outputs. Upon notification, it would pass along the
116 /// matching transactions using this interface.
117 ///
118 /// # Use
119 ///
120 /// The intended use is as follows:
121 /// - Call [`transactions_confirmed`] to process any on-chain activity of interest.
122 /// - Call [`transaction_unconfirmed`] to process any transaction returned by [`get_relevant_txids`]
123 ///   that has been reorganized out of the chain.
124 /// - Call [`best_block_updated`] whenever a new chain tip becomes available.
125 ///
126 /// # Order
127 ///
128 /// Clients must call these methods in chain order. Specifically:
129 /// - Transactions confirmed in a block must be given before transactions confirmed in a later
130 ///   block.
131 /// - Dependent transactions within the same block must be given in topological order, possibly in
132 ///   separate calls.
133 /// - Unconfirmed transactions must be given after the original confirmations and before any
134 ///   reconfirmation.
135 ///
136 /// See individual method documentation for further details.
137 ///
138 /// [`transactions_confirmed`]: Self::transactions_confirmed
139 /// [`transaction_unconfirmed`]: Self::transaction_unconfirmed
140 /// [`best_block_updated`]: Self::best_block_updated
141 /// [`get_relevant_txids`]: Self::get_relevant_txids
142 pub trait Confirm {
143         /// Processes transactions confirmed in a block with a given header and height.
144         ///
145         /// Should be called for any transactions registered by [`Filter::register_tx`] or any
146         /// transactions spending an output registered by [`Filter::register_output`]. Such transactions
147         /// appearing in the same block do not need to be included in the same call; instead, multiple
148         /// calls with additional transactions may be made so long as they are made in [chain order].
149         ///
150         /// May be called before or after [`best_block_updated`] for the corresponding block. However,
151         /// in the event of a chain reorganization, it must not be called with a `header` that is no
152         /// longer in the chain as of the last call to [`best_block_updated`].
153         ///
154         /// [chain order]: Confirm#Order
155         /// [`best_block_updated`]: Self::best_block_updated
156         fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32);
157
158         /// Processes a transaction that is no longer confirmed as result of a chain reorganization.
159         ///
160         /// Should be called for any transaction returned by [`get_relevant_txids`] if it has been
161         /// reorganized out of the best chain. Once called, the given transaction should not be returned
162         /// by [`get_relevant_txids`] unless it has been reconfirmed via [`transactions_confirmed`].
163         ///
164         /// [`get_relevant_txids`]: Self::get_relevant_txids
165         /// [`transactions_confirmed`]: Self::transactions_confirmed
166         fn transaction_unconfirmed(&self, txid: &Txid);
167
168         /// Processes an update to the best header connected at the given height.
169         ///
170         /// Should be called when a new header is available but may be skipped for intermediary blocks
171         /// if they become available at the same time.
172         fn best_block_updated(&self, header: &BlockHeader, height: u32);
173
174         /// Returns transactions that should be monitored for reorganization out of the chain.
175         ///
176         /// Should include any transactions passed to [`transactions_confirmed`] that have insufficient
177         /// confirmations to be safe from a chain reorganization. Should not include any transactions
178         /// passed to [`transaction_unconfirmed`] unless later reconfirmed.
179         ///
180         /// May be called to determine the subset of transactions that must still be monitored for
181         /// reorganization. Will be idempotent between calls but may change as a result of calls to the
182         /// other interface methods. Thus, this is useful to determine which transactions may need to be
183         /// given to [`transaction_unconfirmed`].
184         ///
185         /// [`transactions_confirmed`]: Self::transactions_confirmed
186         /// [`transaction_unconfirmed`]: Self::transaction_unconfirmed
187         fn get_relevant_txids(&self) -> Vec<Txid>;
188 }
189
190 /// An error enum representing a failure to persist a channel monitor update.
191 #[derive(Clone, Copy, Debug, PartialEq)]
192 pub enum ChannelMonitorUpdateErr {
193         /// Used to indicate a temporary failure (eg connection to a watchtower or remote backup of
194         /// our state failed, but is expected to succeed at some point in the future).
195         ///
196         /// Such a failure will "freeze" a channel, preventing us from revoking old states or
197         /// submitting new commitment transactions to the counterparty. Once the update(s) that failed
198         /// have been successfully applied, a [`MonitorEvent::UpdateCompleted`] event should be returned
199         /// via [`Watch::release_pending_monitor_events`] which will then restore the channel to an
200         /// operational state.
201         ///
202         /// Note that a given ChannelManager will *never* re-generate a given ChannelMonitorUpdate. If
203         /// you return a TemporaryFailure you must ensure that it is written to disk safely before
204         /// writing out the latest ChannelManager state.
205         ///
206         /// Even when a channel has been "frozen" updates to the ChannelMonitor can continue to occur
207         /// (eg if an inbound HTLC which we forwarded was claimed upstream resulting in us attempting
208         /// to claim it on this channel) and those updates must be applied wherever they can be. At
209         /// least one such updated ChannelMonitor must be persisted otherwise PermanentFailure should
210         /// be returned to get things on-chain ASAP using only the in-memory copy. Obviously updates to
211         /// the channel which would invalidate previous ChannelMonitors are not made when a channel has
212         /// been "frozen".
213         ///
214         /// Note that even if updates made after TemporaryFailure succeed you must still provide a
215         /// [`MonitorEvent::UpdateCompleted`] to ensure you have the latest monitor and re-enable
216         /// normal channel operation. Note that this is normally generated through a call to
217         /// [`ChainMonitor::channel_monitor_updated`].
218         ///
219         /// Note that the update being processed here will not be replayed for you when you return a
220         /// [`MonitorEvent::UpdateCompleted`] event via [`Watch::release_pending_monitor_events`], so
221         /// you must store the update itself on your own local disk prior to returning a
222         /// TemporaryFailure. You may, of course, employ a journaling approach, storing only the
223         /// ChannelMonitorUpdate on disk without updating the monitor itself, replaying the journal at
224         /// reload-time.
225         ///
226         /// For deployments where a copy of ChannelMonitors and other local state are backed up in a
227         /// remote location (with local copies persisted immediately), it is anticipated that all
228         /// updates will return TemporaryFailure until the remote copies could be updated.
229         ///
230         /// [`ChainMonitor::channel_monitor_updated`]: chainmonitor::ChainMonitor::channel_monitor_updated
231         TemporaryFailure,
232         /// Used to indicate no further channel monitor updates will be allowed (eg we've moved on to a
233         /// different watchtower and cannot update with all watchtowers that were previously informed
234         /// of this channel).
235         ///
236         /// At reception of this error, ChannelManager will force-close the channel and return at
237         /// least a final ChannelMonitorUpdate::ChannelForceClosed which must be delivered to at
238         /// least one ChannelMonitor copy. Revocation secret MUST NOT be released and offchain channel
239         /// update must be rejected.
240         ///
241         /// This failure may also signal a failure to update the local persisted copy of one of
242         /// the channel monitor instance.
243         ///
244         /// Note that even when you fail a holder commitment transaction update, you must store the
245         /// update to ensure you can claim from it in case of a duplicate copy of this ChannelMonitor
246         /// broadcasts it (e.g distributed channel-monitor deployment)
247         ///
248         /// In case of distributed watchtowers deployment, the new version must be written to disk, as
249         /// state may have been stored but rejected due to a block forcing a commitment broadcast. This
250         /// storage is used to claim outputs of rejected state confirmed onchain by another watchtower,
251         /// lagging behind on block processing.
252         PermanentFailure,
253 }
254
255 /// The `Watch` trait defines behavior for watching on-chain activity pertaining to channels as
256 /// blocks are connected and disconnected.
257 ///
258 /// Each channel is associated with a [`ChannelMonitor`]. Implementations of this trait are
259 /// responsible for maintaining a set of monitors such that they can be updated accordingly as
260 /// channel state changes and HTLCs are resolved. See method documentation for specific
261 /// requirements.
262 ///
263 /// Implementations **must** ensure that updates are successfully applied and persisted upon method
264 /// completion. If an update fails with a [`PermanentFailure`], then it must immediately shut down
265 /// without taking any further action such as persisting the current state.
266 ///
267 /// If an implementation maintains multiple instances of a channel's monitor (e.g., by storing
268 /// backup copies), then it must ensure that updates are applied across all instances. Otherwise, it
269 /// could result in a revoked transaction being broadcast, allowing the counterparty to claim all
270 /// funds in the channel. See [`ChannelMonitorUpdateErr`] for more details about how to handle
271 /// multiple instances.
272 ///
273 /// [`PermanentFailure`]: ChannelMonitorUpdateErr::PermanentFailure
274 pub trait Watch<ChannelSigner: Sign> {
275         /// Watches a channel identified by `funding_txo` using `monitor`.
276         ///
277         /// Implementations are responsible for watching the chain for the funding transaction along
278         /// with any spends of outputs returned by [`get_outputs_to_watch`]. In practice, this means
279         /// calling [`block_connected`] and [`block_disconnected`] on the monitor.
280         ///
281         /// Note: this interface MUST error with `ChannelMonitorUpdateErr::PermanentFailure` if
282         /// the given `funding_txo` has previously been registered via `watch_channel`.
283         ///
284         /// [`get_outputs_to_watch`]: channelmonitor::ChannelMonitor::get_outputs_to_watch
285         /// [`block_connected`]: channelmonitor::ChannelMonitor::block_connected
286         /// [`block_disconnected`]: channelmonitor::ChannelMonitor::block_disconnected
287         fn watch_channel(&self, funding_txo: OutPoint, monitor: ChannelMonitor<ChannelSigner>) -> Result<(), ChannelMonitorUpdateErr>;
288
289         /// Updates a channel identified by `funding_txo` by applying `update` to its monitor.
290         ///
291         /// Implementations must call [`update_monitor`] with the given update. See
292         /// [`ChannelMonitorUpdateErr`] for invariants around returning an error.
293         ///
294         /// [`update_monitor`]: channelmonitor::ChannelMonitor::update_monitor
295         fn update_channel(&self, funding_txo: OutPoint, update: ChannelMonitorUpdate) -> Result<(), ChannelMonitorUpdateErr>;
296
297         /// Returns any monitor events since the last call. Subsequent calls must only return new
298         /// events.
299         ///
300         /// Note that after any block- or transaction-connection calls to a [`ChannelMonitor`], no
301         /// further events may be returned here until the [`ChannelMonitor`] has been fully persisted
302         /// to disk.
303         ///
304         /// For details on asynchronous [`ChannelMonitor`] updating and returning
305         /// [`MonitorEvent::UpdateCompleted`] here, see [`ChannelMonitorUpdateErr::TemporaryFailure`].
306         fn release_pending_monitor_events(&self) -> Vec<(OutPoint, Vec<MonitorEvent>, Option<PublicKey>)>;
307 }
308
309 /// The `Filter` trait defines behavior for indicating chain activity of interest pertaining to
310 /// channels.
311 ///
312 /// This is useful in order to have a [`Watch`] implementation convey to a chain source which
313 /// transactions to be notified of. Notification may take the form of pre-filtering blocks or, in
314 /// the case of [BIP 157]/[BIP 158], only fetching a block if the compact filter matches. If
315 /// receiving full blocks from a chain source, any further filtering is unnecessary.
316 ///
317 /// After an output has been registered, subsequent block retrievals from the chain source must not
318 /// exclude any transactions matching the new criteria nor any in-block descendants of such
319 /// transactions.
320 ///
321 /// Note that use as part of a [`Watch`] implementation involves reentrancy. Therefore, the `Filter`
322 /// should not block on I/O. Implementations should instead queue the newly monitored data to be
323 /// processed later. Then, in order to block until the data has been processed, any [`Watch`]
324 /// invocation that has called the `Filter` must return [`TemporaryFailure`].
325 ///
326 /// [`TemporaryFailure`]: ChannelMonitorUpdateErr::TemporaryFailure
327 /// [BIP 157]: https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki
328 /// [BIP 158]: https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki
329 pub trait Filter {
330         /// Registers interest in a transaction with `txid` and having an output with `script_pubkey` as
331         /// a spending condition.
332         fn register_tx(&self, txid: &Txid, script_pubkey: &Script);
333
334         /// Registers interest in spends of a transaction output.
335         ///
336         /// Optionally, when `output.block_hash` is set, should return any transaction spending the
337         /// output that is found in the corresponding block along with its index.
338         ///
339         /// This return value is useful for Electrum clients in order to supply in-block descendant
340         /// transactions which otherwise were not included. This is not necessary for other clients if
341         /// such descendant transactions were already included (e.g., when a BIP 157 client provides the
342         /// full block).
343         fn register_output(&self, output: WatchedOutput) -> Option<(usize, Transaction)>;
344 }
345
346 /// A transaction output watched by a [`ChannelMonitor`] for spends on-chain.
347 ///
348 /// Used to convey to a [`Filter`] such an output with a given spending condition. Any transaction
349 /// spending the output must be given to [`ChannelMonitor::block_connected`] either directly or via
350 /// the return value of [`Filter::register_output`].
351 ///
352 /// If `block_hash` is `Some`, this indicates the output was created in the corresponding block and
353 /// may have been spent there. See [`Filter::register_output`] for details.
354 ///
355 /// [`ChannelMonitor`]: channelmonitor::ChannelMonitor
356 /// [`ChannelMonitor::block_connected`]: channelmonitor::ChannelMonitor::block_connected
357 #[derive(Clone, PartialEq, Hash)]
358 pub struct WatchedOutput {
359         /// First block where the transaction output may have been spent.
360         pub block_hash: Option<BlockHash>,
361
362         /// Outpoint identifying the transaction output.
363         pub outpoint: OutPoint,
364
365         /// Spending condition of the transaction output.
366         pub script_pubkey: Script,
367 }
368
369 impl<T: Listen> Listen for core::ops::Deref<Target = T> {
370         fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
371                 (**self).filtered_block_connected(header, txdata, height);
372         }
373
374         fn block_disconnected(&self, header: &BlockHeader, height: u32) {
375                 (**self).block_disconnected(header, height);
376         }
377 }
378
379 impl<T: core::ops::Deref, U: core::ops::Deref> Listen for (T, U)
380 where
381         T::Target: Listen,
382         U::Target: Listen,
383 {
384         fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
385                 self.0.filtered_block_connected(header, txdata, height);
386                 self.1.filtered_block_connected(header, txdata, height);
387         }
388
389         fn block_disconnected(&self, header: &BlockHeader, height: u32) {
390                 self.0.block_disconnected(header, height);
391                 self.1.block_disconnected(header, height);
392         }
393 }