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)>,
32 unsafe impl Send for BroadcasterInterface {}
33 unsafe impl Sync for BroadcasterInterface {}
35 pub(crate) extern "C" fn BroadcasterInterface_clone_fields(orig: &BroadcasterInterface) -> BroadcasterInterface {
36 BroadcasterInterface {
37 this_arg: orig.this_arg,
38 broadcast_transaction: Clone::clone(&orig.broadcast_transaction),
39 free: Clone::clone(&orig.free),
43 use lightning::chain::chaininterface::BroadcasterInterface as rustBroadcasterInterface;
44 impl rustBroadcasterInterface for BroadcasterInterface {
45 fn broadcast_transaction(&self, mut tx: &bitcoin::blockdata::transaction::Transaction) {
46 (self.broadcast_transaction)(self.this_arg, crate::c_types::Transaction::from_bitcoin(tx))
50 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
51 // directly as a Deref trait in higher-level structs:
52 impl std::ops::Deref for BroadcasterInterface {
54 fn deref(&self) -> &Self {
58 /// Calls the free function if one is set
60 pub extern "C" fn BroadcasterInterface_free(this_ptr: BroadcasterInterface) { }
61 impl Drop for BroadcasterInterface {
63 if let Some(f) = self.free {
68 /// An enum that represents the speed at which we want a transaction to confirm used for feerate
73 pub enum ConfirmationTarget {
74 /// We are happy with this transaction confirming slowly when feerate drops some.
76 /// We'd like this transaction to confirm without major delay, but 12-18 blocks is fine.
78 /// We'd like this transaction to confirm in the next few blocks.
81 use lightning::chain::chaininterface::ConfirmationTarget as nativeConfirmationTarget;
82 impl ConfirmationTarget {
84 pub(crate) fn to_native(&self) -> nativeConfirmationTarget {
86 ConfirmationTarget::Background => nativeConfirmationTarget::Background,
87 ConfirmationTarget::Normal => nativeConfirmationTarget::Normal,
88 ConfirmationTarget::HighPriority => nativeConfirmationTarget::HighPriority,
92 pub(crate) fn into_native(self) -> nativeConfirmationTarget {
94 ConfirmationTarget::Background => nativeConfirmationTarget::Background,
95 ConfirmationTarget::Normal => nativeConfirmationTarget::Normal,
96 ConfirmationTarget::HighPriority => nativeConfirmationTarget::HighPriority,
100 pub(crate) fn from_native(native: &nativeConfirmationTarget) -> Self {
102 nativeConfirmationTarget::Background => ConfirmationTarget::Background,
103 nativeConfirmationTarget::Normal => ConfirmationTarget::Normal,
104 nativeConfirmationTarget::HighPriority => ConfirmationTarget::HighPriority,
108 pub(crate) fn native_into(native: nativeConfirmationTarget) -> Self {
110 nativeConfirmationTarget::Background => ConfirmationTarget::Background,
111 nativeConfirmationTarget::Normal => ConfirmationTarget::Normal,
112 nativeConfirmationTarget::HighPriority => ConfirmationTarget::HighPriority,
116 /// Creates a copy of the ConfirmationTarget
118 pub extern "C" fn ConfirmationTarget_clone(orig: &ConfirmationTarget) -> ConfirmationTarget {
122 /// Utility method to constructs a new Background-variant ConfirmationTarget
123 pub extern "C" fn ConfirmationTarget_background() -> ConfirmationTarget {
124 ConfirmationTarget::Background}
126 /// Utility method to constructs a new Normal-variant ConfirmationTarget
127 pub extern "C" fn ConfirmationTarget_normal() -> ConfirmationTarget {
128 ConfirmationTarget::Normal}
130 /// Utility method to constructs a new HighPriority-variant ConfirmationTarget
131 pub extern "C" fn ConfirmationTarget_high_priority() -> ConfirmationTarget {
132 ConfirmationTarget::HighPriority}
133 /// Checks if two ConfirmationTargets contain equal inner contents.
134 /// This ignores pointers and is_owned flags and looks at the values in fields.
136 pub extern "C" fn ConfirmationTarget_eq(a: &ConfirmationTarget, b: &ConfirmationTarget) -> bool {
137 if &a.to_native() == &b.to_native() { true } else { false }
139 /// A trait which should be implemented to provide feerate information on a number of time
142 /// Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're
143 /// called from inside the library in response to chain events, P2P events, or timer events).
145 pub struct FeeEstimator {
146 /// An opaque pointer which is passed to your function implementations as an argument.
147 /// This has no meaning in the LDK, and can be NULL or any other value.
148 pub this_arg: *mut c_void,
149 /// Gets estimated satoshis of fee required per 1000 Weight-Units.
151 /// Must be no smaller than 253 (ie 1 satoshi-per-byte rounded up to ensure later round-downs
152 /// don't put us below 1 satoshi-per-byte).
154 /// This translates to:
155 /// * satoshis-per-byte * 250
156 /// * ceil(satoshis-per-kbyte / 4)
158 pub get_est_sat_per_1000_weight: extern "C" fn (this_arg: *const c_void, confirmation_target: crate::lightning::chain::chaininterface::ConfirmationTarget) -> u32,
159 /// Frees any resources associated with this object given its this_arg pointer.
160 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
161 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
163 unsafe impl Send for FeeEstimator {}
164 unsafe impl Sync for FeeEstimator {}
166 pub(crate) extern "C" fn FeeEstimator_clone_fields(orig: &FeeEstimator) -> FeeEstimator {
168 this_arg: orig.this_arg,
169 get_est_sat_per_1000_weight: Clone::clone(&orig.get_est_sat_per_1000_weight),
170 free: Clone::clone(&orig.free),
174 use lightning::chain::chaininterface::FeeEstimator as rustFeeEstimator;
175 impl rustFeeEstimator for FeeEstimator {
176 fn get_est_sat_per_1000_weight(&self, mut confirmation_target: lightning::chain::chaininterface::ConfirmationTarget) -> u32 {
177 let mut ret = (self.get_est_sat_per_1000_weight)(self.this_arg, crate::lightning::chain::chaininterface::ConfirmationTarget::native_into(confirmation_target));
182 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
183 // directly as a Deref trait in higher-level structs:
184 impl std::ops::Deref for FeeEstimator {
186 fn deref(&self) -> &Self {
190 /// Calls the free function if one is set
192 pub extern "C" fn FeeEstimator_free(this_ptr: FeeEstimator) { }
193 impl Drop for FeeEstimator {
195 if let Some(f) = self.free {
200 /// Minimum relay fee as required by bitcoin network mempool policy.
203 pub static MIN_RELAY_FEE_SAT_PER_1000_WEIGHT: u64 = lightning::chain::chaininterface::MIN_RELAY_FEE_SAT_PER_1000_WEIGHT;