X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fchain%2Fchaininterface.rs;h=913fa007d378e91ba5666e3d34ae11c15010ce13;hb=620244dc2ec3153a61e009b80a8c59cf41514482;hp=2da2ae8c7eb618a49308e664e4a8edd50266bd58;hpb=b9707da1382bcebe066c0c26b15a975991bf81e2;p=rust-lightning diff --git a/lightning/src/chain/chaininterface.rs b/lightning/src/chain/chaininterface.rs index 2da2ae8c..913fa007 100644 --- a/lightning/src/chain/chaininterface.rs +++ b/lightning/src/chain/chaininterface.rs @@ -13,476 +13,137 @@ //! Includes traits for monitoring and receiving notifications of new blocks and block //! disconnections, transaction broadcasting, and feerate information requests. -use bitcoin::blockdata::block::{Block, BlockHeader}; -use bitcoin::blockdata::transaction::Transaction; -use bitcoin::blockdata::script::Script; -use bitcoin::blockdata::constants::genesis_block; -use bitcoin::network::constants::Network; -use bitcoin::hash_types::{Txid, BlockHash}; +use core::{cmp, ops::Deref}; +use core::convert::TryInto; -use std::sync::{Mutex, MutexGuard, Arc}; -use std::sync::atomic::{AtomicUsize, Ordering}; -use std::collections::HashSet; -use std::ops::Deref; -use std::marker::PhantomData; -use std::ptr; +use bitcoin::blockdata::transaction::Transaction; -/// Used to give chain error details upstream -#[derive(Clone)] -pub enum ChainError { - /// Client doesn't support UTXO lookup (but the chain hash matches our genesis block hash) - NotSupported, - /// Chain isn't the one watched - NotWatched, - /// Tx doesn't exist or is unconfirmed - UnknownTx, +// TODO: Define typed abstraction over feerates to handle their conversions. +pub(crate) fn compute_feerate_sat_per_1000_weight(fee_sat: u64, weight: u64) -> u32 { + (fee_sat * 1000 / weight).try_into().unwrap_or(u32::max_value()) } - -/// An interface to request notification of certain scripts as they appear the -/// chain. -/// -/// Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're -/// called from inside the library in response to ChainListener events, P2P events, or timer -/// events). -pub trait ChainWatchInterface: Sync + Send { - /// Provides a txid/random-scriptPubKey-in-the-tx which much be watched for. - fn install_watch_tx(&self, txid: &Txid, script_pub_key: &Script); - - /// Provides an outpoint which must be watched for, providing any transactions which spend the - /// given outpoint. - fn install_watch_outpoint(&self, outpoint: (Txid, u32), out_script: &Script); - - /// Indicates that a listener needs to see all transactions. - fn watch_all_txn(&self); - - /// Gets the script and value in satoshis for a given unspent transaction output given a - /// short_channel_id (aka unspent_tx_output_identier). For BTC/tBTC channels the top three - /// bytes are the block height, the next 3 the transaction index within the block, and the - /// final two the output within the transaction. - fn get_chain_utxo(&self, genesis_hash: BlockHash, unspent_tx_output_identifier: u64) -> Result<(Script, u64), ChainError>; - - /// Gets the list of transaction indices within a given block that the ChainWatchInterface is - /// watching for. - fn filter_block(&self, block: &Block) -> Vec; - - /// Returns a usize that changes when the ChainWatchInterface's watched data is modified. - /// Users of `filter_block` should pre-save a copy of `reentered`'s return value and use it to - /// determine whether they need to re-filter a given block. - fn reentered(&self) -> usize; +pub(crate) const fn fee_for_weight(feerate_sat_per_1000_weight: u32, weight: u64) -> u64 { + ((feerate_sat_per_1000_weight as u64 * weight) + 1000 - 1) / 1000 } /// An interface to send a transaction to the Bitcoin network. -pub trait BroadcasterInterface: Sync + Send { - /// Sends a transaction out to (hopefully) be mined. - fn broadcast_transaction(&self, tx: &Transaction); -} - -/// A trait indicating a desire to listen for events from the chain -pub trait ChainListener: Sync + Send { - /// Notifies a listener that a block was connected. - /// - /// The txn_matched array should be set to references to transactions which matched the - /// relevant installed watch outpoints/txn, or the full set of transactions in the block. +pub trait BroadcasterInterface { + /// Sends a list of transactions out to (hopefully) be mined. + /// This only needs to handle the actual broadcasting of transactions, LDK will automatically + /// rebroadcast transactions that haven't made it into a block. /// - /// Note that if txn_matched includes only matched transactions, and a new - /// transaction/outpoint is watched during a block_connected call, the block *must* be - /// re-scanned with the new transaction/outpoints and block_connected should be called - /// again with the same header and (at least) the new transactions. + /// In some cases LDK may attempt to broadcast a transaction which double-spends another + /// and this isn't a bug and can be safely ignored. /// - /// Note that if non-new transaction/outpoints are be registered during a call, a second call - /// *must not* happen. + /// If more than one transaction is given, these transactions should be considered to be a + /// package and broadcast together. Some of the transactions may or may not depend on each other, + /// be sure to manage both cases correctly. /// - /// This also means those counting confirmations using block_connected callbacks should watch - /// for duplicate headers and not count them towards confirmations! - fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[usize]); - /// Notifies a listener that a block was disconnected. - /// Unlike block_connected, this *must* never be called twice for the same disconnect event. - /// Height must be the one of the block which was disconnected (not new height of the best chain) - fn block_disconnected(&self, header: &BlockHeader, disconnected_height: u32); + /// Bitcoin transaction packages are defined in BIP 331 and here: + /// https://github.com/bitcoin/bitcoin/blob/master/doc/policy/packages.md + fn broadcast_transactions(&self, txs: &[&Transaction]); } -/// An enum that represents the speed at which we want a transaction to confirm used for feerate +/// An enum that represents the priority at which we want a transaction to confirm used for feerate /// estimation. +#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)] pub enum ConfirmationTarget { - /// We are happy with this transaction confirming slowly when feerate drops some. + /// We'd like a transaction to confirm in the future, but don't want to commit most of the fees + /// required to do so yet. The remaining fees will come via a Child-Pays-For-Parent (CPFP) fee + /// bump of the transaction. + /// + /// The feerate returned should be the absolute minimum feerate required to enter most node + /// mempools across the network. Note that if you are not able to obtain this feerate estimate, + /// you should likely use the furthest-out estimate allowed by your fee estimator. + MempoolMinimum, + /// We are happy with a transaction confirming slowly, at least within a day or so worth of + /// blocks. Background, - /// We'd like this transaction to confirm without major delay, but 12-18 blocks is fine. + /// We'd like a transaction to confirm without major delayed, i.e., within the next 12-24 blocks. Normal, - /// We'd like this transaction to confirm in the next few blocks. + /// We'd like a transaction to confirm in the next few blocks. HighPriority, } /// A trait which should be implemented to provide feerate information on a number of time /// horizons. /// +/// If access to a local mempool is not feasible, feerate estimates should be fetched from a set of +/// third-parties hosting them. Note that this enables them to affect the propagation of your +/// pre-signed transactions at any time and therefore endangers the safety of channels funds. It +/// should be considered carefully as a deployment. +/// /// Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're -/// called from inside the library in response to ChainListener events, P2P events, or timer -/// events). -pub trait FeeEstimator: Sync + Send { +/// called from inside the library in response to chain events, P2P events, or timer events). +pub trait FeeEstimator { /// Gets estimated satoshis of fee required per 1000 Weight-Units. /// - /// Must be no smaller than 253 (ie 1 satoshi-per-byte rounded up to ensure later round-downs - /// don't put us below 1 satoshi-per-byte). + /// LDK will wrap this method and ensure that the value returned is no smaller than 253 + /// (ie 1 satoshi-per-byte rounded up to ensure later round-downs don't put us below 1 satoshi-per-byte). /// - /// This translates to: + /// The following unit conversions can be used to convert to sats/KW: /// * satoshis-per-byte * 250 - /// * ceil(satoshis-per-kbyte / 4) + /// * satoshis-per-kbyte / 4 fn get_est_sat_per_1000_weight(&self, confirmation_target: ConfirmationTarget) -> u32; } /// Minimum relay fee as required by bitcoin network mempool policy. pub const MIN_RELAY_FEE_SAT_PER_1000_WEIGHT: u64 = 4000; +/// Minimum feerate that takes a sane approach to bitcoind weight-to-vbytes rounding. +/// See the following Core Lightning commit for an explanation: +/// +pub const FEERATE_FLOOR_SATS_PER_KW: u32 = 253; -/// Utility for tracking registered txn/outpoints and checking for matches -#[cfg_attr(test, derive(PartialEq))] -pub struct ChainWatchedUtil { - watch_all: bool, - - // We are more conservative in matching during testing to ensure everything matches *exactly*, - // even though during normal runtime we take more optimized match approaches... - #[cfg(test)] - watched_txn: HashSet<(Txid, Script)>, - #[cfg(not(test))] - watched_txn: HashSet