bark-bitcoin-ext 0.1.2

Extension library to the rust-bitcoin ecosystem crates used in bark
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

use bitcoin::{Amount, FeeRate, Txid};

/// Returned by the bark API when creating a P2A CPFP transaction fails.
#[derive(Debug, thiserror::Error)]
pub enum CpfpError {
	#[error("Unable to create CPFP transaction: {0}")]
	CreateError(String),
	#[error("Unable to finalize CPFP transaction: {0}")]
	FinalizeError(String),
	#[error("You need more confirmations on your on-chain funds, {available} is available but {needed} is needed.")]
	InsufficientConfirmedFunds { needed: Amount, available: Amount },
	#[error("An internal error occurred while creating CPFP: {0}")]
	InternalError(String),
	#[error("Transaction has no fee anchor: {0}")]
	NoFeeAnchor(Txid),
	#[error("Unable to sign CPFP transaction: {0}")]
	SigningError(String),
	#[error("Unable to store CPFP transaction: {0}")]
	StoreError(String),
}

/// Indicates how fees should be handled by when creating a CPFP [bitcoin::Transaction].
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum MakeCpfpFees {
	/// Create a normal transaction with the given effective fee rate. If the new transaction spends
	/// a P2A (Pay-to-Anchor) output, then this represents the effective fee rate of the package as
	/// a whole, not just the child transaction.
	Effective(FeeRate),
	/// The intent is to replace a transaction already in the mempool so certain fee standards must
	/// be met.
	///
	/// See [BIP125](https://github.com/bitcoin/bips/blob/master/bip-0125.mediawiki#implementation-details)
	/// for more details.
	Rbf {
		/// This represents the effective fee rate of the current transaction/package in the
		/// mempool. This must be exceeded by a new transaction. This also does not include bumping
		/// fees.
		min_effective_fee_rate: FeeRate,
		/// The current fee paid by the transaction/package to be replaced in the mempool. This must
		/// be exceeded by the new transaction.
		current_package_fee: Amount,
	},
}

impl MakeCpfpFees {
	pub fn effective(&self) -> FeeRate {
		match self {
			MakeCpfpFees::Effective(fr) => *fr,
			MakeCpfpFees::Rbf { min_effective_fee_rate, .. } => *min_effective_fee_rate,
		}
	}
}