1 // This file is Copyright its original authors, visible in version control
2 // history and in the source files from which this was generated.
4 // This file is licensed under the license available in the LICENSE or LICENSE.md
5 // file in the root of this repository or, if no such file exists, the same
6 // license as that which applies to the original source files from which this
7 // source was automatically generated.
9 //! Traits and utility impls which allow other parts of rust-lightning to interact with the
12 //! Includes traits for monitoring and receiving notifications of new blocks and block
13 //! disconnections, transaction broadcasting, and feerate information requests.
15 use std::str::FromStr;
17 use bitcoin::hashes::Hash;
18 use crate::c_types::*;
20 /// An interface to send a transaction to the Bitcoin network.
22 pub struct BroadcasterInterface {
23 /// An opaque pointer which is passed to your function implementations as an argument.
24 /// This has no meaning in the LDK, and can be NULL or any other value.
25 pub this_arg: *mut c_void,
26 /// Sends a transaction out to (hopefully) be mined.
27 pub broadcast_transaction: extern "C" fn (this_arg: *const c_void, tx: crate::c_types::Transaction),
28 /// Frees any resources associated with this object given its this_arg pointer.
29 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
30 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
33 use lightning::chain::chaininterface::BroadcasterInterface as rustBroadcasterInterface;
34 impl rustBroadcasterInterface for BroadcasterInterface {
35 fn broadcast_transaction(&self, mut tx: &bitcoin::blockdata::transaction::Transaction) {
36 (self.broadcast_transaction)(self.this_arg, crate::c_types::Transaction::from_bitcoin(tx))
40 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
41 // directly as a Deref trait in higher-level structs:
42 impl std::ops::Deref for BroadcasterInterface {
44 fn deref(&self) -> &Self {
48 /// Calls the free function if one is set
50 pub extern "C" fn BroadcasterInterface_free(this_ptr: BroadcasterInterface) { }
51 impl Drop for BroadcasterInterface {
53 if let Some(f) = self.free {
58 /// An enum that represents the speed at which we want a transaction to confirm used for feerate
63 pub enum ConfirmationTarget {
64 /// We are happy with this transaction confirming slowly when feerate drops some.
66 /// We'd like this transaction to confirm without major delay, but 12-18 blocks is fine.
68 /// We'd like this transaction to confirm in the next few blocks.
71 use lightning::chain::chaininterface::ConfirmationTarget as nativeConfirmationTarget;
72 impl ConfirmationTarget {
74 pub(crate) fn to_native(&self) -> nativeConfirmationTarget {
76 ConfirmationTarget::Background => nativeConfirmationTarget::Background,
77 ConfirmationTarget::Normal => nativeConfirmationTarget::Normal,
78 ConfirmationTarget::HighPriority => nativeConfirmationTarget::HighPriority,
82 pub(crate) fn into_native(self) -> nativeConfirmationTarget {
84 ConfirmationTarget::Background => nativeConfirmationTarget::Background,
85 ConfirmationTarget::Normal => nativeConfirmationTarget::Normal,
86 ConfirmationTarget::HighPriority => nativeConfirmationTarget::HighPriority,
90 pub(crate) fn from_native(native: &nativeConfirmationTarget) -> Self {
92 nativeConfirmationTarget::Background => ConfirmationTarget::Background,
93 nativeConfirmationTarget::Normal => ConfirmationTarget::Normal,
94 nativeConfirmationTarget::HighPriority => ConfirmationTarget::HighPriority,
98 pub(crate) fn native_into(native: nativeConfirmationTarget) -> Self {
100 nativeConfirmationTarget::Background => ConfirmationTarget::Background,
101 nativeConfirmationTarget::Normal => ConfirmationTarget::Normal,
102 nativeConfirmationTarget::HighPriority => ConfirmationTarget::HighPriority,
106 /// Creates a copy of the ConfirmationTarget
108 pub extern "C" fn ConfirmationTarget_clone(orig: &ConfirmationTarget) -> ConfirmationTarget {
111 /// A trait which should be implemented to provide feerate information on a number of time
114 /// Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're
115 /// called from inside the library in response to chain events, P2P events, or timer events).
117 pub struct FeeEstimator {
118 /// An opaque pointer which is passed to your function implementations as an argument.
119 /// This has no meaning in the LDK, and can be NULL or any other value.
120 pub this_arg: *mut c_void,
121 /// Gets estimated satoshis of fee required per 1000 Weight-Units.
123 /// Must be no smaller than 253 (ie 1 satoshi-per-byte rounded up to ensure later round-downs
124 /// don't put us below 1 satoshi-per-byte).
126 /// This translates to:
127 /// * satoshis-per-byte * 250
128 /// * ceil(satoshis-per-kbyte / 4)
130 pub get_est_sat_per_1000_weight: extern "C" fn (this_arg: *const c_void, confirmation_target: crate::lightning::chain::chaininterface::ConfirmationTarget) -> u32,
131 /// Frees any resources associated with this object given its this_arg pointer.
132 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
133 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
136 use lightning::chain::chaininterface::FeeEstimator as rustFeeEstimator;
137 impl rustFeeEstimator for FeeEstimator {
138 fn get_est_sat_per_1000_weight(&self, mut confirmation_target: lightning::chain::chaininterface::ConfirmationTarget) -> u32 {
139 let mut ret = (self.get_est_sat_per_1000_weight)(self.this_arg, crate::lightning::chain::chaininterface::ConfirmationTarget::native_into(confirmation_target));
144 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
145 // directly as a Deref trait in higher-level structs:
146 impl std::ops::Deref for FeeEstimator {
148 fn deref(&self) -> &Self {
152 /// Calls the free function if one is set
154 pub extern "C" fn FeeEstimator_free(this_ptr: FeeEstimator) { }
155 impl Drop for FeeEstimator {
157 if let Some(f) = self.free {
162 /// Minimum relay fee as required by bitcoin network mempool policy.
165 pub static MIN_RELAY_FEE_SAT_PER_1000_WEIGHT: u64 = lightning::chain::chaininterface::MIN_RELAY_FEE_SAT_PER_1000_WEIGHT;