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 //! This module contains traits for LDK to access UTXOs to check gossip data is correct.
11 //! When lightning nodes gossip channel information, they resist DoS attacks by checking that each
12 //! channel matches a UTXO on-chain, requiring at least some marginal on-chain transacting in
13 //! order to announce a channel. This module handles that checking.
15 use alloc::str::FromStr;
16 use alloc::string::String;
17 use core::ffi::c_void;
18 use core::convert::Infallible;
19 use bitcoin::hashes::Hash;
20 use crate::c_types::*;
21 #[cfg(feature="no-std")]
22 use alloc::{vec::Vec, boxed::Box};
24 /// An error when accessing the chain via [`UtxoLookup`].
28 pub enum UtxoLookupError {
29 /// The requested chain is unknown.
31 /// The requested transaction doesn't exist or hasn't confirmed.
34 use lightning::routing::utxo::UtxoLookupError as UtxoLookupErrorImport;
35 pub(crate) type nativeUtxoLookupError = UtxoLookupErrorImport;
37 impl UtxoLookupError {
39 pub(crate) fn to_native(&self) -> nativeUtxoLookupError {
41 UtxoLookupError::UnknownChain => nativeUtxoLookupError::UnknownChain,
42 UtxoLookupError::UnknownTx => nativeUtxoLookupError::UnknownTx,
46 pub(crate) fn into_native(self) -> nativeUtxoLookupError {
48 UtxoLookupError::UnknownChain => nativeUtxoLookupError::UnknownChain,
49 UtxoLookupError::UnknownTx => nativeUtxoLookupError::UnknownTx,
53 pub(crate) fn from_native(native: &nativeUtxoLookupError) -> Self {
55 nativeUtxoLookupError::UnknownChain => UtxoLookupError::UnknownChain,
56 nativeUtxoLookupError::UnknownTx => UtxoLookupError::UnknownTx,
60 pub(crate) fn native_into(native: nativeUtxoLookupError) -> Self {
62 nativeUtxoLookupError::UnknownChain => UtxoLookupError::UnknownChain,
63 nativeUtxoLookupError::UnknownTx => UtxoLookupError::UnknownTx,
67 /// Creates a copy of the UtxoLookupError
69 pub extern "C" fn UtxoLookupError_clone(orig: &UtxoLookupError) -> UtxoLookupError {
73 /// Utility method to constructs a new UnknownChain-variant UtxoLookupError
74 pub extern "C" fn UtxoLookupError_unknown_chain() -> UtxoLookupError {
75 UtxoLookupError::UnknownChain}
77 /// Utility method to constructs a new UnknownTx-variant UtxoLookupError
78 pub extern "C" fn UtxoLookupError_unknown_tx() -> UtxoLookupError {
79 UtxoLookupError::UnknownTx}
80 /// The result of a [`UtxoLookup::get_utxo`] call. A call may resolve either synchronously,
81 /// returning the `Sync` variant, or asynchronously, returning an [`UtxoFuture`] in the `Async`
87 /// A result which was resolved synchronously. It either includes a [`TxOut`] for the output
88 /// requested or a [`UtxoLookupError`].
90 crate::c_types::derived::CResult_TxOutUtxoLookupErrorZ),
91 /// A result which will be resolved asynchronously. It includes a [`UtxoFuture`], a `clone` of
92 /// which you must keep locally and call [`UtxoFuture::resolve`] on once the lookup completes.
94 /// Note that in order to avoid runaway memory usage, the number of parallel checks is limited,
95 /// but only fairly loosely. Because a pending checks block all message processing, leaving
96 /// checks pending for an extended time may cause DoS of other functions. It is recommended you
97 /// keep a tight timeout on lookups, on the order of a few seconds.
99 crate::lightning::routing::utxo::UtxoFuture),
101 use lightning::routing::utxo::UtxoResult as UtxoResultImport;
102 pub(crate) type nativeUtxoResult = UtxoResultImport;
106 pub(crate) fn to_native(&self) -> nativeUtxoResult {
108 UtxoResult::Sync (ref a, ) => {
109 let mut a_nonref = Clone::clone(a);
110 let mut local_a_nonref = match a_nonref.result_ok { true => Ok( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut a_nonref.contents.result)) }).into_rust() }), false => Err( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut a_nonref.contents.err)) }).into_native() })};
111 nativeUtxoResult::Sync (
115 UtxoResult::Async (ref a, ) => {
116 let mut a_nonref = Clone::clone(a);
117 nativeUtxoResult::Async (
118 *unsafe { Box::from_raw(a_nonref.take_inner()) },
124 pub(crate) fn into_native(self) -> nativeUtxoResult {
126 UtxoResult::Sync (mut a, ) => {
127 let mut local_a = match a.result_ok { true => Ok( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut a.contents.result)) }).into_rust() }), false => Err( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut a.contents.err)) }).into_native() })};
128 nativeUtxoResult::Sync (
132 UtxoResult::Async (mut a, ) => {
133 nativeUtxoResult::Async (
134 *unsafe { Box::from_raw(a.take_inner()) },
140 pub(crate) fn from_native(native: &nativeUtxoResult) -> Self {
142 nativeUtxoResult::Sync (ref a, ) => {
143 let mut a_nonref = Clone::clone(a);
144 let mut local_a_nonref = match a_nonref { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::TxOut::from_rust(&o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::routing::utxo::UtxoLookupError::native_into(e) }).into() };
149 nativeUtxoResult::Async (ref a, ) => {
150 let mut a_nonref = Clone::clone(a);
152 crate::lightning::routing::utxo::UtxoFuture { inner: ObjOps::heap_alloc(a_nonref), is_owned: true },
158 pub(crate) fn native_into(native: nativeUtxoResult) -> Self {
160 nativeUtxoResult::Sync (mut a, ) => {
161 let mut local_a = match a { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::TxOut::from_rust(&o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::routing::utxo::UtxoLookupError::native_into(e) }).into() };
166 nativeUtxoResult::Async (mut a, ) => {
168 crate::lightning::routing::utxo::UtxoFuture { inner: ObjOps::heap_alloc(a), is_owned: true },
174 /// Frees any resources used by the UtxoResult
176 pub extern "C" fn UtxoResult_free(this_ptr: UtxoResult) { }
177 /// Creates a copy of the UtxoResult
179 pub extern "C" fn UtxoResult_clone(orig: &UtxoResult) -> UtxoResult {
183 /// Utility method to constructs a new Sync-variant UtxoResult
184 pub extern "C" fn UtxoResult_sync(a: crate::c_types::derived::CResult_TxOutUtxoLookupErrorZ) -> UtxoResult {
185 UtxoResult::Sync(a, )
188 /// Utility method to constructs a new Async-variant UtxoResult
189 pub extern "C" fn UtxoResult_async(a: crate::lightning::routing::utxo::UtxoFuture) -> UtxoResult {
190 UtxoResult::Async(a, )
192 /// The `UtxoLookup` trait defines behavior for accessing on-chain UTXOs.
194 pub struct UtxoLookup {
195 /// An opaque pointer which is passed to your function implementations as an argument.
196 /// This has no meaning in the LDK, and can be NULL or any other value.
197 pub this_arg: *mut c_void,
198 /// Returns the transaction output of a funding transaction encoded by [`short_channel_id`].
199 /// Returns an error if `genesis_hash` is for a different chain or if such a transaction output
202 /// [`short_channel_id`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#definition-of-short_channel_id
203 pub get_utxo: extern "C" fn (this_arg: *const c_void, genesis_hash: *const [u8; 32], short_channel_id: u64) -> crate::lightning::routing::utxo::UtxoResult,
204 /// Frees any resources associated with this object given its this_arg pointer.
205 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
206 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
208 unsafe impl Send for UtxoLookup {}
209 unsafe impl Sync for UtxoLookup {}
210 pub(crate) fn UtxoLookup_clone_fields(orig: &UtxoLookup) -> UtxoLookup {
212 this_arg: orig.this_arg,
213 get_utxo: Clone::clone(&orig.get_utxo),
214 free: Clone::clone(&orig.free),
218 use lightning::routing::utxo::UtxoLookup as rustUtxoLookup;
219 impl rustUtxoLookup for UtxoLookup {
220 fn get_utxo(&self, mut genesis_hash: &bitcoin::BlockHash, mut short_channel_id: u64) -> lightning::routing::utxo::UtxoResult {
221 let mut ret = (self.get_utxo)(self.this_arg, genesis_hash.as_inner(), short_channel_id);
226 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
227 // directly as a Deref trait in higher-level structs:
228 impl core::ops::Deref for UtxoLookup {
230 fn deref(&self) -> &Self {
234 impl core::ops::DerefMut for UtxoLookup {
235 fn deref_mut(&mut self) -> &mut Self {
239 /// Calls the free function if one is set
241 pub extern "C" fn UtxoLookup_free(this_ptr: UtxoLookup) { }
242 impl Drop for UtxoLookup {
244 if let Some(f) = self.free {
250 use lightning::routing::utxo::UtxoFuture as nativeUtxoFutureImport;
251 pub(crate) type nativeUtxoFuture = nativeUtxoFutureImport;
253 /// Represents a future resolution of a [`UtxoLookup::get_utxo`] query resolving async.
255 /// See [`UtxoResult::Async`] and [`UtxoFuture::resolve`] for more info.
258 pub struct UtxoFuture {
259 /// A pointer to the opaque Rust object.
261 /// Nearly everywhere, inner must be non-null, however in places where
262 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
263 pub inner: *mut nativeUtxoFuture,
264 /// Indicates that this is the only struct which contains the same pointer.
266 /// Rust functions which take ownership of an object provided via an argument require
267 /// this to be true and invalidate the object pointed to by inner.
271 impl Drop for UtxoFuture {
273 if self.is_owned && !<*mut nativeUtxoFuture>::is_null(self.inner) {
274 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
278 /// Frees any resources used by the UtxoFuture, if is_owned is set and inner is non-NULL.
280 pub extern "C" fn UtxoFuture_free(this_obj: UtxoFuture) { }
282 /// Used only if an object of this type is returned as a trait impl by a method
283 pub(crate) extern "C" fn UtxoFuture_free_void(this_ptr: *mut c_void) {
284 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeUtxoFuture) };
288 pub(crate) fn get_native_ref(&self) -> &'static nativeUtxoFuture {
289 unsafe { &*ObjOps::untweak_ptr(self.inner) }
291 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeUtxoFuture {
292 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
294 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
295 pub(crate) fn take_inner(mut self) -> *mut nativeUtxoFuture {
296 assert!(self.is_owned);
297 let ret = ObjOps::untweak_ptr(self.inner);
298 self.inner = core::ptr::null_mut();
302 impl Clone for UtxoFuture {
303 fn clone(&self) -> Self {
305 inner: if <*mut nativeUtxoFuture>::is_null(self.inner) { core::ptr::null_mut() } else {
306 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
312 /// Used only if an object of this type is returned as a trait impl by a method
313 pub(crate) extern "C" fn UtxoFuture_clone_void(this_ptr: *const c_void) -> *mut c_void {
314 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeUtxoFuture)).clone() })) as *mut c_void
317 /// Creates a copy of the UtxoFuture
318 pub extern "C" fn UtxoFuture_clone(orig: &UtxoFuture) -> UtxoFuture {
321 /// Builds a new future for later resolution.
324 pub extern "C" fn UtxoFuture_new() -> crate::lightning::routing::utxo::UtxoFuture {
325 let mut ret = lightning::routing::utxo::UtxoFuture::new();
326 crate::lightning::routing::utxo::UtxoFuture { inner: ObjOps::heap_alloc(ret), is_owned: true }
329 /// Resolves this future against the given `graph` and with the given `result`.
331 /// This is identical to calling [`UtxoFuture::resolve`] with a dummy `gossip`, disabling
332 /// forwarding the validated gossip message onwards to peers.
334 /// Because this may cause the [`NetworkGraph`]'s [`processing_queue_high`] to flip, in order
335 /// to allow us to interact with peers again, you should call [`PeerManager::process_events`]
338 /// [`processing_queue_high`]: crate::ln::msgs::RoutingMessageHandler::processing_queue_high
339 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
341 pub extern "C" fn UtxoFuture_resolve_without_forwarding(this_arg: &crate::lightning::routing::utxo::UtxoFuture, graph: &crate::lightning::routing::gossip::NetworkGraph, mut result: crate::c_types::derived::CResult_TxOutUtxoLookupErrorZ) {
342 let mut local_result = match result.result_ok { true => Ok( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut result.contents.result)) }).into_rust() }), false => Err( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut result.contents.err)) }).into_native() })};
343 unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.resolve_without_forwarding(graph.get_native_ref(), local_result)
346 /// Resolves this future against the given `graph` and with the given `result`.
348 /// The given `gossip` is used to broadcast any validated messages onwards to all peers which
349 /// have available buffer space.
351 /// Because this may cause the [`NetworkGraph`]'s [`processing_queue_high`] to flip, in order
352 /// to allow us to interact with peers again, you should call [`PeerManager::process_events`]
355 /// [`processing_queue_high`]: crate::ln::msgs::RoutingMessageHandler::processing_queue_high
356 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
358 pub extern "C" fn UtxoFuture_resolve(this_arg: &crate::lightning::routing::utxo::UtxoFuture, graph: &crate::lightning::routing::gossip::NetworkGraph, gossip: &crate::lightning::routing::gossip::P2PGossipSync, mut result: crate::c_types::derived::CResult_TxOutUtxoLookupErrorZ) {
359 let mut local_result = match result.result_ok { true => Ok( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut result.contents.result)) }).into_rust() }), false => Err( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut result.contents.err)) }).into_native() })};
360 unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.resolve(graph.get_native_ref(), gossip.get_native_ref(), local_result)