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 core::convert::Infallible;
18 use bitcoin::hashes::Hash;
19 use crate::c_types::*;
21 /// An interface to send a transaction to the Bitcoin network.
23 pub struct BroadcasterInterface {
24 /// An opaque pointer which is passed to your function implementations as an argument.
25 /// This has no meaning in the LDK, and can be NULL or any other value.
26 pub this_arg: *mut c_void,
27 /// Sends a transaction out to (hopefully) be mined.
28 pub broadcast_transaction: extern "C" fn (this_arg: *const c_void, tx: crate::c_types::Transaction),
29 /// Frees any resources associated with this object given its this_arg pointer.
30 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
31 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
33 unsafe impl Send for BroadcasterInterface {}
34 unsafe impl Sync for BroadcasterInterface {}
36 pub(crate) extern "C" fn BroadcasterInterface_clone_fields(orig: &BroadcasterInterface) -> BroadcasterInterface {
37 BroadcasterInterface {
38 this_arg: orig.this_arg,
39 broadcast_transaction: Clone::clone(&orig.broadcast_transaction),
40 free: Clone::clone(&orig.free),
44 use lightning::chain::chaininterface::BroadcasterInterface as rustBroadcasterInterface;
45 impl rustBroadcasterInterface for BroadcasterInterface {
46 fn broadcast_transaction(&self, mut tx: &bitcoin::blockdata::transaction::Transaction) {
47 (self.broadcast_transaction)(self.this_arg, crate::c_types::Transaction::from_bitcoin(tx))
51 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
52 // directly as a Deref trait in higher-level structs:
53 impl std::ops::Deref for BroadcasterInterface {
55 fn deref(&self) -> &Self {
59 /// Calls the free function if one is set
61 pub extern "C" fn BroadcasterInterface_free(this_ptr: BroadcasterInterface) { }
62 impl Drop for BroadcasterInterface {
64 if let Some(f) = self.free {
69 /// An enum that represents the speed at which we want a transaction to confirm used for feerate
74 pub enum ConfirmationTarget {
75 /// We are happy with this transaction confirming slowly when feerate drops some.
77 /// We'd like this transaction to confirm without major delay, but 12-18 blocks is fine.
79 /// We'd like this transaction to confirm in the next few blocks.
82 use lightning::chain::chaininterface::ConfirmationTarget as nativeConfirmationTarget;
83 impl ConfirmationTarget {
85 pub(crate) fn to_native(&self) -> nativeConfirmationTarget {
87 ConfirmationTarget::Background => nativeConfirmationTarget::Background,
88 ConfirmationTarget::Normal => nativeConfirmationTarget::Normal,
89 ConfirmationTarget::HighPriority => nativeConfirmationTarget::HighPriority,
93 pub(crate) fn into_native(self) -> nativeConfirmationTarget {
95 ConfirmationTarget::Background => nativeConfirmationTarget::Background,
96 ConfirmationTarget::Normal => nativeConfirmationTarget::Normal,
97 ConfirmationTarget::HighPriority => nativeConfirmationTarget::HighPriority,
101 pub(crate) fn from_native(native: &nativeConfirmationTarget) -> Self {
103 nativeConfirmationTarget::Background => ConfirmationTarget::Background,
104 nativeConfirmationTarget::Normal => ConfirmationTarget::Normal,
105 nativeConfirmationTarget::HighPriority => ConfirmationTarget::HighPriority,
109 pub(crate) fn native_into(native: nativeConfirmationTarget) -> Self {
111 nativeConfirmationTarget::Background => ConfirmationTarget::Background,
112 nativeConfirmationTarget::Normal => ConfirmationTarget::Normal,
113 nativeConfirmationTarget::HighPriority => ConfirmationTarget::HighPriority,
117 /// Creates a copy of the ConfirmationTarget
119 pub extern "C" fn ConfirmationTarget_clone(orig: &ConfirmationTarget) -> ConfirmationTarget {
123 /// Utility method to constructs a new Background-variant ConfirmationTarget
124 pub extern "C" fn ConfirmationTarget_background() -> ConfirmationTarget {
125 ConfirmationTarget::Background}
127 /// Utility method to constructs a new Normal-variant ConfirmationTarget
128 pub extern "C" fn ConfirmationTarget_normal() -> ConfirmationTarget {
129 ConfirmationTarget::Normal}
131 /// Utility method to constructs a new HighPriority-variant ConfirmationTarget
132 pub extern "C" fn ConfirmationTarget_high_priority() -> ConfirmationTarget {
133 ConfirmationTarget::HighPriority}
134 /// Checks if two ConfirmationTargets contain equal inner contents.
135 /// This ignores pointers and is_owned flags and looks at the values in fields.
137 pub extern "C" fn ConfirmationTarget_eq(a: &ConfirmationTarget, b: &ConfirmationTarget) -> bool {
138 if &a.to_native() == &b.to_native() { true } else { false }
140 /// A trait which should be implemented to provide feerate information on a number of time
143 /// Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're
144 /// called from inside the library in response to chain events, P2P events, or timer events).
146 pub struct FeeEstimator {
147 /// An opaque pointer which is passed to your function implementations as an argument.
148 /// This has no meaning in the LDK, and can be NULL or any other value.
149 pub this_arg: *mut c_void,
150 /// Gets estimated satoshis of fee required per 1000 Weight-Units.
152 /// Must be no smaller than 253 (ie 1 satoshi-per-byte rounded up to ensure later round-downs
153 /// don't put us below 1 satoshi-per-byte).
155 /// This translates to:
156 /// * satoshis-per-byte * 250
157 /// * ceil(satoshis-per-kbyte / 4)
159 pub get_est_sat_per_1000_weight: extern "C" fn (this_arg: *const c_void, confirmation_target: crate::lightning::chain::chaininterface::ConfirmationTarget) -> u32,
160 /// Frees any resources associated with this object given its this_arg pointer.
161 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
162 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
164 unsafe impl Send for FeeEstimator {}
165 unsafe impl Sync for FeeEstimator {}
167 pub(crate) extern "C" fn FeeEstimator_clone_fields(orig: &FeeEstimator) -> FeeEstimator {
169 this_arg: orig.this_arg,
170 get_est_sat_per_1000_weight: Clone::clone(&orig.get_est_sat_per_1000_weight),
171 free: Clone::clone(&orig.free),
175 use lightning::chain::chaininterface::FeeEstimator as rustFeeEstimator;
176 impl rustFeeEstimator for FeeEstimator {
177 fn get_est_sat_per_1000_weight(&self, mut confirmation_target: lightning::chain::chaininterface::ConfirmationTarget) -> u32 {
178 let mut ret = (self.get_est_sat_per_1000_weight)(self.this_arg, crate::lightning::chain::chaininterface::ConfirmationTarget::native_into(confirmation_target));
183 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
184 // directly as a Deref trait in higher-level structs:
185 impl std::ops::Deref for FeeEstimator {
187 fn deref(&self) -> &Self {
191 /// Calls the free function if one is set
193 pub extern "C" fn FeeEstimator_free(this_ptr: FeeEstimator) { }
194 impl Drop for FeeEstimator {
196 if let Some(f) = self.free {
201 /// Minimum relay fee as required by bitcoin network mempool policy.
204 pub static MIN_RELAY_FEE_SAT_PER_1000_WEIGHT: u64 = lightning::chain::chaininterface::MIN_RELAY_FEE_SAT_PER_1000_WEIGHT;