_ Git - rust-lightning/blob - 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::script::Script;
  13 use bitcoin::blockdata::transaction::TxOut;
  14 use bitcoin::hash_types::{BlockHash, Txid};
  15
  16 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateErr, MonitorEvent};
  17 use chain::keysinterface::ChannelKeys;
  18 use chain::transaction::OutPoint;
  19
  20 pub mod chaininterface;
  21 pub mod chainmonitor;
  22 pub mod channelmonitor;
  23 pub mod transaction;
  24 pub mod keysinterface;
  25
  26 /// An error when accessing the chain via [`Access`].
  27 ///
  28 /// [`Access`]: trait.Access.html
  29 #[derive(Clone)]
  30 pub enum AccessError {
  31         /// The requested chain is unknown.
  32         UnknownChain,
  33
  34         /// The requested transaction doesn't exist or hasn't confirmed.
  35         UnknownTx,
  36 }
  37
  38 /// The `Access` trait defines behavior for accessing chain data and state, such as blocks and
  39 /// UTXOs.
  40 pub trait Access: Send + Sync {
  41         /// Returns the transaction output of a funding transaction encoded by [`short_channel_id`].
  42         /// Returns an error if `genesis_hash` is for a different chain or if such a transaction output
  43         /// is unknown.
  44         ///
  45         /// [`short_channel_id`]: https://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md#definition-of-short_channel_id
  46         fn get_utxo(&self, genesis_hash: &BlockHash, short_channel_id: u64) -> Result<TxOut, AccessError>;
  47 }
  48
  49 /// The `Watch` trait defines behavior for watching on-chain activity pertaining to channels as
  50 /// blocks are connected and disconnected.
  51 ///
  52 /// Each channel is associated with a [`ChannelMonitor`]. Implementations of this trait are
  53 /// responsible for maintaining a set of monitors such that they can be updated accordingly as
  54 /// channel state changes and HTLCs are resolved. See method documentation for specific
  55 /// requirements.
  56 ///
  57 /// Implementations **must** ensure that updates are successfully applied and persisted upon method
  58 /// completion. If an update fails with a [`PermanentFailure`], then it must immediately shut down
  59 /// without taking any further action such as persisting the current state.
  60 ///
  61 /// If an implementation maintains multiple instances of a channel's monitor (e.g., by storing
  62 /// backup copies), then it must ensure that updates are applied across all instances. Otherwise, it
  63 /// could result in a revoked transaction being broadcast, allowing the counterparty to claim all
  64 /// funds in the channel. See [`ChannelMonitorUpdateErr`] for more details about how to handle
  65 /// multiple instances.
  66 ///
  67 /// [`ChannelMonitor`]: channelmonitor/struct.ChannelMonitor.html
  68 /// [`ChannelMonitorUpdateErr`]: channelmonitor/enum.ChannelMonitorUpdateErr.html
  69 /// [`PermanentFailure`]: channelmonitor/enum.ChannelMonitorUpdateErr.html#variant.PermanentFailure
  70 pub trait Watch: Send + Sync {
  71         /// Keys needed by monitors for creating and signing transactions.
  72         type Keys: ChannelKeys;
  73
  74         /// Watches a channel identified by `funding_txo` using `monitor`.
  75         ///
  76         /// Implementations are responsible for watching the chain for the funding transaction along
  77         /// with any spends of outputs returned by [`get_outputs_to_watch`]. In practice, this means
  78         /// calling [`block_connected`] and [`block_disconnected`] on the monitor.
  79         ///
  80         /// [`get_outputs_to_watch`]: channelmonitor/struct.ChannelMonitor.html#method.get_outputs_to_watch
  81         /// [`block_connected`]: channelmonitor/struct.ChannelMonitor.html#method.block_connected
  82         /// [`block_disconnected`]: channelmonitor/struct.ChannelMonitor.html#method.block_disconnected
  83         fn watch_channel(&self, funding_txo: OutPoint, monitor: ChannelMonitor<Self::Keys>) -> Result<(), ChannelMonitorUpdateErr>;
  84
  85         /// Updates a channel identified by `funding_txo` by applying `update` to its monitor.
  86         ///
  87         /// Implementations must call [`update_monitor`] with the given update. See
  88         /// [`ChannelMonitorUpdateErr`] for invariants around returning an error.
  89         ///
  90         /// [`update_monitor`]: channelmonitor/struct.ChannelMonitor.html#method.update_monitor
  91         /// [`ChannelMonitorUpdateErr`]: channelmonitor/enum.ChannelMonitorUpdateErr.html
  92         fn update_channel(&self, funding_txo: OutPoint, update: ChannelMonitorUpdate) -> Result<(), ChannelMonitorUpdateErr>;
  93
  94         /// Returns any monitor events since the last call. Subsequent calls must only return new
  95         /// events.
  96         fn release_pending_monitor_events(&self) -> Vec<MonitorEvent>;
  97 }
  98
  99 /// The `Filter` trait defines behavior for indicating chain activity of interest pertaining to
 100 /// channels.
 101 ///
 102 /// This is useful in order to have a [`Watch`] implementation convey to a chain source which
 103 /// transactions to be notified of. Notification may take the form of pre-filtering blocks or, in
 104 /// the case of [BIP 157]/[BIP 158], only fetching a block if the compact filter matches. If
 105 /// receiving full blocks from a chain source, any further filtering is unnecessary.
 106 ///
 107 /// After an output has been registered, subsequent block retrievals from the chain source must not
 108 /// exclude any transactions matching the new criteria nor any in-block descendants of such
 109 /// transactions.
 110 ///
 111 /// Note that use as part of a [`Watch`] implementation involves reentrancy. Therefore, the `Filter`
 112 /// should not block on I/O. Implementations should instead queue the newly monitored data to be
 113 /// processed later. Then, in order to block until the data has been processed, any `Watch`
 114 /// invocation that has called the `Filter` must return [`TemporaryFailure`].
 115 ///
 116 /// [`Watch`]: trait.Watch.html
 117 /// [`TemporaryFailure`]: channelmonitor/enum.ChannelMonitorUpdateErr.html#variant.TemporaryFailure
 118 /// [BIP 157]: https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki
 119 /// [BIP 158]: https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki
 120 pub trait Filter: Send + Sync {
 121         /// Registers interest in a transaction with `txid` and having an output with `script_pubkey` as
 122         /// a spending condition.
 123         fn register_tx(&self, txid: &Txid, script_pubkey: &Script);
 124
 125         /// Registers interest in spends of a transaction output identified by `outpoint` having
 126         /// `script_pubkey` as the spending condition.
 127         fn register_output(&self, outpoint: &OutPoint, script_pubkey: &Script);
 128 }