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 //! Provides keys to LDK and defines some useful objects describing spendable on-chain outputs.
11 //! The provided output descriptors follow a custom LDK data format and are currently not fully
12 //! compatible with Bitcoin Core output descriptors.
14 use alloc::str::FromStr;
15 use core::ffi::c_void;
16 use core::convert::Infallible;
17 use bitcoin::hashes::Hash;
18 use crate::c_types::*;
19 #[cfg(feature="no-std")]
20 use alloc::{vec::Vec, boxed::Box};
23 use lightning::chain::keysinterface::DelayedPaymentOutputDescriptor as nativeDelayedPaymentOutputDescriptorImport;
24 pub(crate) type nativeDelayedPaymentOutputDescriptor = nativeDelayedPaymentOutputDescriptorImport;
26 /// Information about a spendable output to a P2WSH script.
28 /// See [`SpendableOutputDescriptor::DelayedPaymentOutput`] for more details on how to spend this.
31 pub struct DelayedPaymentOutputDescriptor {
32 /// A pointer to the opaque Rust object.
34 /// Nearly everywhere, inner must be non-null, however in places where
35 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
36 pub inner: *mut nativeDelayedPaymentOutputDescriptor,
37 /// Indicates that this is the only struct which contains the same pointer.
39 /// Rust functions which take ownership of an object provided via an argument require
40 /// this to be true and invalidate the object pointed to by inner.
44 impl Drop for DelayedPaymentOutputDescriptor {
46 if self.is_owned && !<*mut nativeDelayedPaymentOutputDescriptor>::is_null(self.inner) {
47 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
51 /// Frees any resources used by the DelayedPaymentOutputDescriptor, if is_owned is set and inner is non-NULL.
53 pub extern "C" fn DelayedPaymentOutputDescriptor_free(this_obj: DelayedPaymentOutputDescriptor) { }
55 /// Used only if an object of this type is returned as a trait impl by a method
56 pub(crate) extern "C" fn DelayedPaymentOutputDescriptor_free_void(this_ptr: *mut c_void) {
57 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeDelayedPaymentOutputDescriptor) };
60 impl DelayedPaymentOutputDescriptor {
61 pub(crate) fn get_native_ref(&self) -> &'static nativeDelayedPaymentOutputDescriptor {
62 unsafe { &*ObjOps::untweak_ptr(self.inner) }
64 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeDelayedPaymentOutputDescriptor {
65 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
67 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
68 pub(crate) fn take_inner(mut self) -> *mut nativeDelayedPaymentOutputDescriptor {
69 assert!(self.is_owned);
70 let ret = ObjOps::untweak_ptr(self.inner);
71 self.inner = core::ptr::null_mut();
75 /// The outpoint which is spendable.
77 pub extern "C" fn DelayedPaymentOutputDescriptor_get_outpoint(this_ptr: &DelayedPaymentOutputDescriptor) -> crate::lightning::chain::transaction::OutPoint {
78 let mut inner_val = &mut this_ptr.get_native_mut_ref().outpoint;
79 crate::lightning::chain::transaction::OutPoint { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::chain::transaction::OutPoint<>) as *mut _) }, is_owned: false }
81 /// The outpoint which is spendable.
83 pub extern "C" fn DelayedPaymentOutputDescriptor_set_outpoint(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: crate::lightning::chain::transaction::OutPoint) {
84 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.outpoint = *unsafe { Box::from_raw(val.take_inner()) };
86 /// Per commitment point to derive the delayed payment key by key holder.
88 pub extern "C" fn DelayedPaymentOutputDescriptor_get_per_commitment_point(this_ptr: &DelayedPaymentOutputDescriptor) -> crate::c_types::PublicKey {
89 let mut inner_val = &mut this_ptr.get_native_mut_ref().per_commitment_point;
90 crate::c_types::PublicKey::from_rust(&inner_val)
92 /// Per commitment point to derive the delayed payment key by key holder.
94 pub extern "C" fn DelayedPaymentOutputDescriptor_set_per_commitment_point(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: crate::c_types::PublicKey) {
95 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.per_commitment_point = val.into_rust();
97 /// The `nSequence` value which must be set in the spending input to satisfy the `OP_CSV` in
98 /// the witness_script.
100 pub extern "C" fn DelayedPaymentOutputDescriptor_get_to_self_delay(this_ptr: &DelayedPaymentOutputDescriptor) -> u16 {
101 let mut inner_val = &mut this_ptr.get_native_mut_ref().to_self_delay;
104 /// The `nSequence` value which must be set in the spending input to satisfy the `OP_CSV` in
105 /// the witness_script.
107 pub extern "C" fn DelayedPaymentOutputDescriptor_set_to_self_delay(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: u16) {
108 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.to_self_delay = val;
110 /// The output which is referenced by the given outpoint.
112 /// Returns a copy of the field.
114 pub extern "C" fn DelayedPaymentOutputDescriptor_get_output(this_ptr: &DelayedPaymentOutputDescriptor) -> crate::c_types::TxOut {
115 let mut inner_val = this_ptr.get_native_mut_ref().output.clone();
116 crate::c_types::TxOut::from_rust(inner_val)
118 /// The output which is referenced by the given outpoint.
120 pub extern "C" fn DelayedPaymentOutputDescriptor_set_output(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: crate::c_types::TxOut) {
121 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.output = val.into_rust();
123 /// The revocation point specific to the commitment transaction which was broadcast. Used to
124 /// derive the witnessScript for this output.
126 pub extern "C" fn DelayedPaymentOutputDescriptor_get_revocation_pubkey(this_ptr: &DelayedPaymentOutputDescriptor) -> crate::c_types::PublicKey {
127 let mut inner_val = &mut this_ptr.get_native_mut_ref().revocation_pubkey;
128 crate::c_types::PublicKey::from_rust(&inner_val)
130 /// The revocation point specific to the commitment transaction which was broadcast. Used to
131 /// derive the witnessScript for this output.
133 pub extern "C" fn DelayedPaymentOutputDescriptor_set_revocation_pubkey(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: crate::c_types::PublicKey) {
134 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.revocation_pubkey = val.into_rust();
136 /// Arbitrary identification information returned by a call to [`BaseSign::channel_keys_id`].
137 /// This may be useful in re-deriving keys used in the channel to spend the output.
139 pub extern "C" fn DelayedPaymentOutputDescriptor_get_channel_keys_id(this_ptr: &DelayedPaymentOutputDescriptor) -> *const [u8; 32] {
140 let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_keys_id;
143 /// Arbitrary identification information returned by a call to [`BaseSign::channel_keys_id`].
144 /// This may be useful in re-deriving keys used in the channel to spend the output.
146 pub extern "C" fn DelayedPaymentOutputDescriptor_set_channel_keys_id(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: crate::c_types::ThirtyTwoBytes) {
147 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_keys_id = val.data;
149 /// The value of the channel which this output originated from, possibly indirectly.
151 pub extern "C" fn DelayedPaymentOutputDescriptor_get_channel_value_satoshis(this_ptr: &DelayedPaymentOutputDescriptor) -> u64 {
152 let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_value_satoshis;
155 /// The value of the channel which this output originated from, possibly indirectly.
157 pub extern "C" fn DelayedPaymentOutputDescriptor_set_channel_value_satoshis(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: u64) {
158 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_value_satoshis = val;
160 /// Constructs a new DelayedPaymentOutputDescriptor given each field
163 pub extern "C" fn DelayedPaymentOutputDescriptor_new(mut outpoint_arg: crate::lightning::chain::transaction::OutPoint, mut per_commitment_point_arg: crate::c_types::PublicKey, mut to_self_delay_arg: u16, mut output_arg: crate::c_types::TxOut, mut revocation_pubkey_arg: crate::c_types::PublicKey, mut channel_keys_id_arg: crate::c_types::ThirtyTwoBytes, mut channel_value_satoshis_arg: u64) -> DelayedPaymentOutputDescriptor {
164 DelayedPaymentOutputDescriptor { inner: ObjOps::heap_alloc(nativeDelayedPaymentOutputDescriptor {
165 outpoint: *unsafe { Box::from_raw(outpoint_arg.take_inner()) },
166 per_commitment_point: per_commitment_point_arg.into_rust(),
167 to_self_delay: to_self_delay_arg,
168 output: output_arg.into_rust(),
169 revocation_pubkey: revocation_pubkey_arg.into_rust(),
170 channel_keys_id: channel_keys_id_arg.data,
171 channel_value_satoshis: channel_value_satoshis_arg,
174 impl Clone for DelayedPaymentOutputDescriptor {
175 fn clone(&self) -> Self {
177 inner: if <*mut nativeDelayedPaymentOutputDescriptor>::is_null(self.inner) { core::ptr::null_mut() } else {
178 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
184 /// Used only if an object of this type is returned as a trait impl by a method
185 pub(crate) extern "C" fn DelayedPaymentOutputDescriptor_clone_void(this_ptr: *const c_void) -> *mut c_void {
186 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeDelayedPaymentOutputDescriptor)).clone() })) as *mut c_void
189 /// Creates a copy of the DelayedPaymentOutputDescriptor
190 pub extern "C" fn DelayedPaymentOutputDescriptor_clone(orig: &DelayedPaymentOutputDescriptor) -> DelayedPaymentOutputDescriptor {
193 /// Checks if two DelayedPaymentOutputDescriptors contain equal inner contents.
194 /// This ignores pointers and is_owned flags and looks at the values in fields.
195 /// Two objects with NULL inner values will be considered "equal" here.
197 pub extern "C" fn DelayedPaymentOutputDescriptor_eq(a: &DelayedPaymentOutputDescriptor, b: &DelayedPaymentOutputDescriptor) -> bool {
198 if a.inner == b.inner { return true; }
199 if a.inner.is_null() || b.inner.is_null() { return false; }
200 if a.get_native_ref() == b.get_native_ref() { true } else { false }
203 /// Serialize the DelayedPaymentOutputDescriptor object into a byte array which can be read by DelayedPaymentOutputDescriptor_read
204 pub extern "C" fn DelayedPaymentOutputDescriptor_write(obj: &crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor) -> crate::c_types::derived::CVec_u8Z {
205 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
208 pub(crate) extern "C" fn DelayedPaymentOutputDescriptor_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
209 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeDelayedPaymentOutputDescriptor) })
212 /// Read a DelayedPaymentOutputDescriptor from a byte array, created by DelayedPaymentOutputDescriptor_write
213 pub extern "C" fn DelayedPaymentOutputDescriptor_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_DelayedPaymentOutputDescriptorDecodeErrorZ {
214 let res: Result<lightning::chain::keysinterface::DelayedPaymentOutputDescriptor, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
215 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
219 use lightning::chain::keysinterface::StaticPaymentOutputDescriptor as nativeStaticPaymentOutputDescriptorImport;
220 pub(crate) type nativeStaticPaymentOutputDescriptor = nativeStaticPaymentOutputDescriptorImport;
222 /// Information about a spendable output to our \"payment key\".
224 /// See [`SpendableOutputDescriptor::StaticPaymentOutput`] for more details on how to spend this.
227 pub struct StaticPaymentOutputDescriptor {
228 /// A pointer to the opaque Rust object.
230 /// Nearly everywhere, inner must be non-null, however in places where
231 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
232 pub inner: *mut nativeStaticPaymentOutputDescriptor,
233 /// Indicates that this is the only struct which contains the same pointer.
235 /// Rust functions which take ownership of an object provided via an argument require
236 /// this to be true and invalidate the object pointed to by inner.
240 impl Drop for StaticPaymentOutputDescriptor {
242 if self.is_owned && !<*mut nativeStaticPaymentOutputDescriptor>::is_null(self.inner) {
243 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
247 /// Frees any resources used by the StaticPaymentOutputDescriptor, if is_owned is set and inner is non-NULL.
249 pub extern "C" fn StaticPaymentOutputDescriptor_free(this_obj: StaticPaymentOutputDescriptor) { }
251 /// Used only if an object of this type is returned as a trait impl by a method
252 pub(crate) extern "C" fn StaticPaymentOutputDescriptor_free_void(this_ptr: *mut c_void) {
253 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeStaticPaymentOutputDescriptor) };
256 impl StaticPaymentOutputDescriptor {
257 pub(crate) fn get_native_ref(&self) -> &'static nativeStaticPaymentOutputDescriptor {
258 unsafe { &*ObjOps::untweak_ptr(self.inner) }
260 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeStaticPaymentOutputDescriptor {
261 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
263 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
264 pub(crate) fn take_inner(mut self) -> *mut nativeStaticPaymentOutputDescriptor {
265 assert!(self.is_owned);
266 let ret = ObjOps::untweak_ptr(self.inner);
267 self.inner = core::ptr::null_mut();
271 /// The outpoint which is spendable.
273 pub extern "C" fn StaticPaymentOutputDescriptor_get_outpoint(this_ptr: &StaticPaymentOutputDescriptor) -> crate::lightning::chain::transaction::OutPoint {
274 let mut inner_val = &mut this_ptr.get_native_mut_ref().outpoint;
275 crate::lightning::chain::transaction::OutPoint { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::chain::transaction::OutPoint<>) as *mut _) }, is_owned: false }
277 /// The outpoint which is spendable.
279 pub extern "C" fn StaticPaymentOutputDescriptor_set_outpoint(this_ptr: &mut StaticPaymentOutputDescriptor, mut val: crate::lightning::chain::transaction::OutPoint) {
280 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.outpoint = *unsafe { Box::from_raw(val.take_inner()) };
282 /// The output which is referenced by the given outpoint.
284 /// Returns a copy of the field.
286 pub extern "C" fn StaticPaymentOutputDescriptor_get_output(this_ptr: &StaticPaymentOutputDescriptor) -> crate::c_types::TxOut {
287 let mut inner_val = this_ptr.get_native_mut_ref().output.clone();
288 crate::c_types::TxOut::from_rust(inner_val)
290 /// The output which is referenced by the given outpoint.
292 pub extern "C" fn StaticPaymentOutputDescriptor_set_output(this_ptr: &mut StaticPaymentOutputDescriptor, mut val: crate::c_types::TxOut) {
293 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.output = val.into_rust();
295 /// Arbitrary identification information returned by a call to [`BaseSign::channel_keys_id`].
296 /// This may be useful in re-deriving keys used in the channel to spend the output.
298 pub extern "C" fn StaticPaymentOutputDescriptor_get_channel_keys_id(this_ptr: &StaticPaymentOutputDescriptor) -> *const [u8; 32] {
299 let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_keys_id;
302 /// Arbitrary identification information returned by a call to [`BaseSign::channel_keys_id`].
303 /// This may be useful in re-deriving keys used in the channel to spend the output.
305 pub extern "C" fn StaticPaymentOutputDescriptor_set_channel_keys_id(this_ptr: &mut StaticPaymentOutputDescriptor, mut val: crate::c_types::ThirtyTwoBytes) {
306 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_keys_id = val.data;
308 /// The value of the channel which this transactions spends.
310 pub extern "C" fn StaticPaymentOutputDescriptor_get_channel_value_satoshis(this_ptr: &StaticPaymentOutputDescriptor) -> u64 {
311 let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_value_satoshis;
314 /// The value of the channel which this transactions spends.
316 pub extern "C" fn StaticPaymentOutputDescriptor_set_channel_value_satoshis(this_ptr: &mut StaticPaymentOutputDescriptor, mut val: u64) {
317 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_value_satoshis = val;
319 /// Constructs a new StaticPaymentOutputDescriptor given each field
322 pub extern "C" fn StaticPaymentOutputDescriptor_new(mut outpoint_arg: crate::lightning::chain::transaction::OutPoint, mut output_arg: crate::c_types::TxOut, mut channel_keys_id_arg: crate::c_types::ThirtyTwoBytes, mut channel_value_satoshis_arg: u64) -> StaticPaymentOutputDescriptor {
323 StaticPaymentOutputDescriptor { inner: ObjOps::heap_alloc(nativeStaticPaymentOutputDescriptor {
324 outpoint: *unsafe { Box::from_raw(outpoint_arg.take_inner()) },
325 output: output_arg.into_rust(),
326 channel_keys_id: channel_keys_id_arg.data,
327 channel_value_satoshis: channel_value_satoshis_arg,
330 impl Clone for StaticPaymentOutputDescriptor {
331 fn clone(&self) -> Self {
333 inner: if <*mut nativeStaticPaymentOutputDescriptor>::is_null(self.inner) { core::ptr::null_mut() } else {
334 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
340 /// Used only if an object of this type is returned as a trait impl by a method
341 pub(crate) extern "C" fn StaticPaymentOutputDescriptor_clone_void(this_ptr: *const c_void) -> *mut c_void {
342 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeStaticPaymentOutputDescriptor)).clone() })) as *mut c_void
345 /// Creates a copy of the StaticPaymentOutputDescriptor
346 pub extern "C" fn StaticPaymentOutputDescriptor_clone(orig: &StaticPaymentOutputDescriptor) -> StaticPaymentOutputDescriptor {
349 /// Checks if two StaticPaymentOutputDescriptors contain equal inner contents.
350 /// This ignores pointers and is_owned flags and looks at the values in fields.
351 /// Two objects with NULL inner values will be considered "equal" here.
353 pub extern "C" fn StaticPaymentOutputDescriptor_eq(a: &StaticPaymentOutputDescriptor, b: &StaticPaymentOutputDescriptor) -> bool {
354 if a.inner == b.inner { return true; }
355 if a.inner.is_null() || b.inner.is_null() { return false; }
356 if a.get_native_ref() == b.get_native_ref() { true } else { false }
359 /// Serialize the StaticPaymentOutputDescriptor object into a byte array which can be read by StaticPaymentOutputDescriptor_read
360 pub extern "C" fn StaticPaymentOutputDescriptor_write(obj: &crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor) -> crate::c_types::derived::CVec_u8Z {
361 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
364 pub(crate) extern "C" fn StaticPaymentOutputDescriptor_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
365 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeStaticPaymentOutputDescriptor) })
368 /// Read a StaticPaymentOutputDescriptor from a byte array, created by StaticPaymentOutputDescriptor_write
369 pub extern "C" fn StaticPaymentOutputDescriptor_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_StaticPaymentOutputDescriptorDecodeErrorZ {
370 let res: Result<lightning::chain::keysinterface::StaticPaymentOutputDescriptor, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
371 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
374 /// Describes the necessary information to spend a spendable output.
376 /// When on-chain outputs are created by LDK (which our counterparty is not able to claim at any
377 /// point in the future) a [`SpendableOutputs`] event is generated which you must track and be able
378 /// to spend on-chain. The information needed to do this is provided in this enum, including the
379 /// outpoint describing which `txid` and output `index` is available, the full output which exists
380 /// at that `txid`/`index`, and any keys or other information required to sign.
382 /// [`SpendableOutputs`]: crate::util::events::Event::SpendableOutputs
386 pub enum SpendableOutputDescriptor {
387 /// An output to a script which was provided via [`KeysInterface`] directly, either from
388 /// [`get_destination_script`] or [`get_shutdown_scriptpubkey`], thus you should already
389 /// know how to spend it. No secret keys are provided as LDK was never given any key.
390 /// These may include outputs from a transaction punishing our counterparty or claiming an HTLC
391 /// on-chain using the payment preimage or after it has timed out.
393 /// [`get_shutdown_scriptpubkey`]: KeysInterface::get_shutdown_scriptpubkey
394 /// [`get_destination_script`]: KeysInterface::get_shutdown_scriptpubkey
396 /// The outpoint which is spendable.
397 outpoint: crate::lightning::chain::transaction::OutPoint,
398 /// The output which is referenced by the given outpoint.
399 output: crate::c_types::TxOut,
401 /// An output to a P2WSH script which can be spent with a single signature after an `OP_CSV`
404 /// The witness in the spending input should be:
406 /// <BIP 143 signature> <empty vector> (MINIMALIF standard rule) <provided witnessScript>
409 /// Note that the `nSequence` field in the spending input must be set to
410 /// [`DelayedPaymentOutputDescriptor::to_self_delay`] (which means the transaction is not
411 /// broadcastable until at least [`DelayedPaymentOutputDescriptor::to_self_delay`] blocks after
412 /// the outpoint confirms, see [BIP
413 /// 68](https://github.com/bitcoin/bips/blob/master/bip-0068.mediawiki)). Also note that LDK
414 /// won't generate a [`SpendableOutputDescriptor`] until the corresponding block height
417 /// These are generally the result of a \"revocable\" output to us, spendable only by us unless
418 /// it is an output from an old state which we broadcast (which should never happen).
420 /// To derive the delayed payment key which is used to sign this input, you must pass the
421 /// holder [`InMemorySigner::delayed_payment_base_key`] (i.e., the private key which corresponds to the
422 /// [`ChannelPublicKeys::delayed_payment_basepoint`] in [`BaseSign::pubkeys`]) and the provided
423 /// [`DelayedPaymentOutputDescriptor::per_commitment_point`] to [`chan_utils::derive_private_key`]. The public key can be
424 /// generated without the secret key using [`chan_utils::derive_public_key`] and only the
425 /// [`ChannelPublicKeys::delayed_payment_basepoint`] which appears in [`BaseSign::pubkeys`].
427 /// To derive the [`DelayedPaymentOutputDescriptor::revocation_pubkey`] provided here (which is
428 /// used in the witness script generation), you must pass the counterparty
429 /// [`ChannelPublicKeys::revocation_basepoint`] (which appears in the call to
430 /// [`BaseSign::provide_channel_parameters`]) and the provided
431 /// [`DelayedPaymentOutputDescriptor::per_commitment_point`] to
432 /// [`chan_utils::derive_public_revocation_key`].
434 /// The witness script which is hashed and included in the output `script_pubkey` may be
435 /// regenerated by passing the [`DelayedPaymentOutputDescriptor::revocation_pubkey`] (derived
436 /// as explained above), our delayed payment pubkey (derived as explained above), and the
437 /// [`DelayedPaymentOutputDescriptor::to_self_delay`] contained here to
438 /// [`chan_utils::get_revokeable_redeemscript`].
439 DelayedPaymentOutput(
440 crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor),
441 /// An output to a P2WPKH, spendable exclusively by our payment key (i.e., the private key
442 /// which corresponds to the `payment_point` in [`BaseSign::pubkeys`]). The witness
443 /// in the spending input is, thus, simply:
445 /// <BIP 143 signature> <payment key>
448 /// These are generally the result of our counterparty having broadcast the current state,
449 /// allowing us to claim the non-HTLC-encumbered outputs immediately.
451 crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor),
453 use lightning::chain::keysinterface::SpendableOutputDescriptor as SpendableOutputDescriptorImport;
454 pub(crate) type nativeSpendableOutputDescriptor = SpendableOutputDescriptorImport;
456 impl SpendableOutputDescriptor {
458 pub(crate) fn to_native(&self) -> nativeSpendableOutputDescriptor {
460 SpendableOutputDescriptor::StaticOutput {ref outpoint, ref output, } => {
461 let mut outpoint_nonref = Clone::clone(outpoint);
462 let mut output_nonref = Clone::clone(output);
463 nativeSpendableOutputDescriptor::StaticOutput {
464 outpoint: *unsafe { Box::from_raw(outpoint_nonref.take_inner()) },
465 output: output_nonref.into_rust(),
468 SpendableOutputDescriptor::DelayedPaymentOutput (ref a, ) => {
469 let mut a_nonref = Clone::clone(a);
470 nativeSpendableOutputDescriptor::DelayedPaymentOutput (
471 *unsafe { Box::from_raw(a_nonref.take_inner()) },
474 SpendableOutputDescriptor::StaticPaymentOutput (ref a, ) => {
475 let mut a_nonref = Clone::clone(a);
476 nativeSpendableOutputDescriptor::StaticPaymentOutput (
477 *unsafe { Box::from_raw(a_nonref.take_inner()) },
483 pub(crate) fn into_native(self) -> nativeSpendableOutputDescriptor {
485 SpendableOutputDescriptor::StaticOutput {mut outpoint, mut output, } => {
486 nativeSpendableOutputDescriptor::StaticOutput {
487 outpoint: *unsafe { Box::from_raw(outpoint.take_inner()) },
488 output: output.into_rust(),
491 SpendableOutputDescriptor::DelayedPaymentOutput (mut a, ) => {
492 nativeSpendableOutputDescriptor::DelayedPaymentOutput (
493 *unsafe { Box::from_raw(a.take_inner()) },
496 SpendableOutputDescriptor::StaticPaymentOutput (mut a, ) => {
497 nativeSpendableOutputDescriptor::StaticPaymentOutput (
498 *unsafe { Box::from_raw(a.take_inner()) },
504 pub(crate) fn from_native(native: &nativeSpendableOutputDescriptor) -> Self {
506 nativeSpendableOutputDescriptor::StaticOutput {ref outpoint, ref output, } => {
507 let mut outpoint_nonref = Clone::clone(outpoint);
508 let mut output_nonref = Clone::clone(output);
509 SpendableOutputDescriptor::StaticOutput {
510 outpoint: crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(outpoint_nonref), is_owned: true },
511 output: crate::c_types::TxOut::from_rust(output_nonref),
514 nativeSpendableOutputDescriptor::DelayedPaymentOutput (ref a, ) => {
515 let mut a_nonref = Clone::clone(a);
516 SpendableOutputDescriptor::DelayedPaymentOutput (
517 crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor { inner: ObjOps::heap_alloc(a_nonref), is_owned: true },
520 nativeSpendableOutputDescriptor::StaticPaymentOutput (ref a, ) => {
521 let mut a_nonref = Clone::clone(a);
522 SpendableOutputDescriptor::StaticPaymentOutput (
523 crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor { inner: ObjOps::heap_alloc(a_nonref), is_owned: true },
529 pub(crate) fn native_into(native: nativeSpendableOutputDescriptor) -> Self {
531 nativeSpendableOutputDescriptor::StaticOutput {mut outpoint, mut output, } => {
532 SpendableOutputDescriptor::StaticOutput {
533 outpoint: crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(outpoint), is_owned: true },
534 output: crate::c_types::TxOut::from_rust(output),
537 nativeSpendableOutputDescriptor::DelayedPaymentOutput (mut a, ) => {
538 SpendableOutputDescriptor::DelayedPaymentOutput (
539 crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor { inner: ObjOps::heap_alloc(a), is_owned: true },
542 nativeSpendableOutputDescriptor::StaticPaymentOutput (mut a, ) => {
543 SpendableOutputDescriptor::StaticPaymentOutput (
544 crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor { inner: ObjOps::heap_alloc(a), is_owned: true },
550 /// Frees any resources used by the SpendableOutputDescriptor
552 pub extern "C" fn SpendableOutputDescriptor_free(this_ptr: SpendableOutputDescriptor) { }
553 /// Creates a copy of the SpendableOutputDescriptor
555 pub extern "C" fn SpendableOutputDescriptor_clone(orig: &SpendableOutputDescriptor) -> SpendableOutputDescriptor {
559 /// Utility method to constructs a new StaticOutput-variant SpendableOutputDescriptor
560 pub extern "C" fn SpendableOutputDescriptor_static_output(outpoint: crate::lightning::chain::transaction::OutPoint, output: crate::c_types::TxOut) -> SpendableOutputDescriptor {
561 SpendableOutputDescriptor::StaticOutput {
567 /// Utility method to constructs a new DelayedPaymentOutput-variant SpendableOutputDescriptor
568 pub extern "C" fn SpendableOutputDescriptor_delayed_payment_output(a: crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor) -> SpendableOutputDescriptor {
569 SpendableOutputDescriptor::DelayedPaymentOutput(a, )
572 /// Utility method to constructs a new StaticPaymentOutput-variant SpendableOutputDescriptor
573 pub extern "C" fn SpendableOutputDescriptor_static_payment_output(a: crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor) -> SpendableOutputDescriptor {
574 SpendableOutputDescriptor::StaticPaymentOutput(a, )
576 /// Checks if two SpendableOutputDescriptors contain equal inner contents.
577 /// This ignores pointers and is_owned flags and looks at the values in fields.
579 pub extern "C" fn SpendableOutputDescriptor_eq(a: &SpendableOutputDescriptor, b: &SpendableOutputDescriptor) -> bool {
580 if &a.to_native() == &b.to_native() { true } else { false }
583 /// Serialize the SpendableOutputDescriptor object into a byte array which can be read by SpendableOutputDescriptor_read
584 pub extern "C" fn SpendableOutputDescriptor_write(obj: &crate::lightning::chain::keysinterface::SpendableOutputDescriptor) -> crate::c_types::derived::CVec_u8Z {
585 crate::c_types::serialize_obj(&unsafe { &*obj }.to_native())
588 /// Read a SpendableOutputDescriptor from a byte array, created by SpendableOutputDescriptor_write
589 pub extern "C" fn SpendableOutputDescriptor_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_SpendableOutputDescriptorDecodeErrorZ {
590 let res: Result<lightning::chain::keysinterface::SpendableOutputDescriptor, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
591 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::chain::keysinterface::SpendableOutputDescriptor::native_into(o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
594 /// A trait to sign Lightning channel transactions as described in
595 /// [BOLT 3](https://github.com/lightning/bolts/blob/master/03-transactions.md).
597 /// Signing services could be implemented on a hardware wallet and should implement signing
598 /// policies in order to be secure. Please refer to the [VLS Policy
599 /// Controls](https://gitlab.com/lightning-signer/validating-lightning-signer/-/blob/main/docs/policy-controls.md)
600 /// for an example of such policies.
602 pub struct BaseSign {
603 /// An opaque pointer which is passed to your function implementations as an argument.
604 /// This has no meaning in the LDK, and can be NULL or any other value.
605 pub this_arg: *mut c_void,
606 /// Gets the per-commitment point for a specific commitment number
608 /// Note that the commitment number starts at `(1 << 48) - 1` and counts backwards.
610 pub get_per_commitment_point: extern "C" fn (this_arg: *const c_void, idx: u64) -> crate::c_types::PublicKey,
611 /// Gets the commitment secret for a specific commitment number as part of the revocation process
613 /// An external signer implementation should error here if the commitment was already signed
614 /// and should refuse to sign it in the future.
616 /// May be called more than once for the same index.
618 /// Note that the commitment number starts at `(1 << 48) - 1` and counts backwards.
620 pub release_commitment_secret: extern "C" fn (this_arg: *const c_void, idx: u64) -> crate::c_types::ThirtyTwoBytes,
621 /// Validate the counterparty's signatures on the holder commitment transaction and HTLCs.
623 /// This is required in order for the signer to make sure that releasing a commitment
624 /// secret won't leave us without a broadcastable holder transaction.
625 /// Policy checks should be implemented in this function, including checking the amount
626 /// sent to us and checking the HTLCs.
628 /// The preimages of outgoing HTLCs that were fulfilled since the last commitment are provided.
629 /// A validating signer should ensure that an HTLC output is removed only when the matching
630 /// preimage is provided, or when the value to holder is restored.
632 /// Note that all the relevant preimages will be provided, but there may also be additional
633 /// irrelevant or duplicate preimages.
635 pub validate_holder_commitment: extern "C" fn (this_arg: *const c_void, holder_tx: &crate::lightning::ln::chan_utils::HolderCommitmentTransaction, preimages: crate::c_types::derived::CVec_PaymentPreimageZ) -> crate::c_types::derived::CResult_NoneNoneZ,
636 /// Returns the holder's channel public keys and basepoints.
637 pub pubkeys: crate::lightning::ln::chan_utils::ChannelPublicKeys,
638 /// Fill in the pubkeys field as a reference to it will be given to Rust after this returns
639 /// Note that this takes a pointer to this object, not the this_ptr like other methods do
640 /// This function pointer may be NULL if pubkeys is filled in when this object is created and never needs updating.
641 pub set_pubkeys: Option<extern "C" fn(&BaseSign)>,
642 /// Returns an arbitrary identifier describing the set of keys which are provided back to you in
643 /// some [`SpendableOutputDescriptor`] types. This should be sufficient to identify this
644 /// [`BaseSign`] object uniquely and lookup or re-derive its keys.
646 pub channel_keys_id: extern "C" fn (this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes,
647 /// Create a signature for a counterparty's commitment transaction and associated HTLC transactions.
649 /// Note that if signing fails or is rejected, the channel will be force-closed.
651 /// Policy checks should be implemented in this function, including checking the amount
652 /// sent to us and checking the HTLCs.
654 /// The preimages of outgoing HTLCs that were fulfilled since the last commitment are provided.
655 /// A validating signer should ensure that an HTLC output is removed only when the matching
656 /// preimage is provided, or when the value to holder is restored.
658 /// Note that all the relevant preimages will be provided, but there may also be additional
659 /// irrelevant or duplicate preimages.
661 pub sign_counterparty_commitment: extern "C" fn (this_arg: *const c_void, commitment_tx: &crate::lightning::ln::chan_utils::CommitmentTransaction, preimages: crate::c_types::derived::CVec_PaymentPreimageZ) -> crate::c_types::derived::CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ,
662 /// Validate the counterparty's revocation.
664 /// This is required in order for the signer to make sure that the state has moved
665 /// forward and it is safe to sign the next counterparty commitment.
667 pub validate_counterparty_revocation: extern "C" fn (this_arg: *const c_void, idx: u64, secret: *const [u8; 32]) -> crate::c_types::derived::CResult_NoneNoneZ,
668 /// Creates a signature for a holder's commitment transaction and its claiming HTLC transactions.
670 /// This will be called
671 /// - with a non-revoked `commitment_tx`.
672 /// - with the latest `commitment_tx` when we initiate a force-close.
673 /// - with the previous `commitment_tx`, just to get claiming HTLC
674 /// signatures, if we are reacting to a [`ChannelMonitor`]
675 /// [replica](https://github.com/lightningdevkit/rust-lightning/blob/main/GLOSSARY.md#monitor-replicas)
676 /// that decided to broadcast before it had been updated to the latest `commitment_tx`.
678 /// This may be called multiple times for the same transaction.
680 /// An external signer implementation should check that the commitment has not been revoked.
682 /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
684 pub sign_holder_commitment_and_htlcs: extern "C" fn (this_arg: *const c_void, commitment_tx: &crate::lightning::ln::chan_utils::HolderCommitmentTransaction) -> crate::c_types::derived::CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ,
685 /// Create a signature for the given input in a transaction spending an HTLC transaction output
686 /// or a commitment transaction `to_local` output when our counterparty broadcasts an old state.
688 /// A justice transaction may claim multiple outputs at the same time if timelocks are
689 /// similar, but only a signature for the input at index `input` should be signed for here.
690 /// It may be called multiple times for same output(s) if a fee-bump is needed with regards
691 /// to an upcoming timelock expiration.
693 /// Amount is value of the output spent by this input, committed to in the BIP 143 signature.
695 /// `per_commitment_key` is revocation secret which was provided by our counterparty when they
696 /// revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
697 /// not allow the spending of any funds by itself (you need our holder `revocation_secret` to do
700 pub sign_justice_revoked_output: extern "C" fn (this_arg: *const c_void, justice_tx: crate::c_types::Transaction, input: usize, amount: u64, per_commitment_key: *const [u8; 32]) -> crate::c_types::derived::CResult_SignatureNoneZ,
701 /// Create a signature for the given input in a transaction spending a commitment transaction
702 /// HTLC output when our counterparty broadcasts an old state.
704 /// A justice transaction may claim multiple outputs at the same time if timelocks are
705 /// similar, but only a signature for the input at index `input` should be signed for here.
706 /// It may be called multiple times for same output(s) if a fee-bump is needed with regards
707 /// to an upcoming timelock expiration.
709 /// `amount` is the value of the output spent by this input, committed to in the BIP 143
712 /// `per_commitment_key` is revocation secret which was provided by our counterparty when they
713 /// revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
714 /// not allow the spending of any funds by itself (you need our holder revocation_secret to do
717 /// `htlc` holds HTLC elements (hash, timelock), thus changing the format of the witness script
718 /// (which is committed to in the BIP 143 signatures).
720 pub sign_justice_revoked_htlc: extern "C" fn (this_arg: *const c_void, justice_tx: crate::c_types::Transaction, input: usize, amount: u64, per_commitment_key: *const [u8; 32], htlc: &crate::lightning::ln::chan_utils::HTLCOutputInCommitment) -> crate::c_types::derived::CResult_SignatureNoneZ,
721 /// Create a signature for a claiming transaction for a HTLC output on a counterparty's commitment
722 /// transaction, either offered or received.
724 /// Such a transaction may claim multiples offered outputs at same time if we know the
725 /// preimage for each when we create it, but only the input at index `input` should be
726 /// signed for here. It may be called multiple times for same output(s) if a fee-bump is
727 /// needed with regards to an upcoming timelock expiration.
729 /// `witness_script` is either an offered or received script as defined in BOLT3 for HTLC
732 /// `amount` is value of the output spent by this input, committed to in the BIP 143 signature.
734 /// `per_commitment_point` is the dynamic point corresponding to the channel state
735 /// detected onchain. It has been generated by our counterparty and is used to derive
736 /// channel state keys, which are then included in the witness script and committed to in the
737 /// BIP 143 signature.
739 pub sign_counterparty_htlc_transaction: extern "C" fn (this_arg: *const c_void, htlc_tx: crate::c_types::Transaction, input: usize, amount: u64, per_commitment_point: crate::c_types::PublicKey, htlc: &crate::lightning::ln::chan_utils::HTLCOutputInCommitment) -> crate::c_types::derived::CResult_SignatureNoneZ,
740 /// Create a signature for a (proposed) closing transaction.
742 /// Note that, due to rounding, there may be one \"missing\" satoshi, and either party may have
743 /// chosen to forgo their output as dust.
745 pub sign_closing_transaction: extern "C" fn (this_arg: *const c_void, closing_tx: &crate::lightning::ln::chan_utils::ClosingTransaction) -> crate::c_types::derived::CResult_SignatureNoneZ,
746 /// Computes the signature for a commitment transaction's anchor output used as an
747 /// input within `anchor_tx`, which spends the commitment transaction, at index `input`.
749 pub sign_holder_anchor_input: extern "C" fn (this_arg: *const c_void, anchor_tx: crate::c_types::Transaction, input: usize) -> crate::c_types::derived::CResult_SignatureNoneZ,
750 /// Signs a channel announcement message with our funding key and our node secret key (aka
751 /// node_id or network_key), proving it comes from one of the channel participants.
753 /// The first returned signature should be from our node secret key, the second from our
756 /// Note that if this fails or is rejected, the channel will not be publicly announced and
757 /// our counterparty may (though likely will not) close the channel on us for violating the
760 pub sign_channel_announcement: extern "C" fn (this_arg: *const c_void, msg: &crate::lightning::ln::msgs::UnsignedChannelAnnouncement) -> crate::c_types::derived::CResult_C2Tuple_SignatureSignatureZNoneZ,
761 /// Set the counterparty static channel data, including basepoints,
762 /// `counterparty_selected`/`holder_selected_contest_delay` and funding outpoint. Since these
763 /// are static channel data, they MUST NOT be allowed to change to different values once set,
764 /// as LDK may call this method more than once.
766 /// channel_parameters.is_populated() MUST be true.
767 pub provide_channel_parameters: extern "C" fn (this_arg: *mut c_void, channel_parameters: &crate::lightning::ln::chan_utils::ChannelTransactionParameters),
768 /// Frees any resources associated with this object given its this_arg pointer.
769 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
770 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
772 unsafe impl Send for BaseSign {}
773 unsafe impl Sync for BaseSign {}
775 pub(crate) extern "C" fn BaseSign_clone_fields(orig: &BaseSign) -> BaseSign {
777 this_arg: orig.this_arg,
778 get_per_commitment_point: Clone::clone(&orig.get_per_commitment_point),
779 release_commitment_secret: Clone::clone(&orig.release_commitment_secret),
780 validate_holder_commitment: Clone::clone(&orig.validate_holder_commitment),
781 pubkeys: Clone::clone(&orig.pubkeys),
782 set_pubkeys: Clone::clone(&orig.set_pubkeys),
783 channel_keys_id: Clone::clone(&orig.channel_keys_id),
784 sign_counterparty_commitment: Clone::clone(&orig.sign_counterparty_commitment),
785 validate_counterparty_revocation: Clone::clone(&orig.validate_counterparty_revocation),
786 sign_holder_commitment_and_htlcs: Clone::clone(&orig.sign_holder_commitment_and_htlcs),
787 sign_justice_revoked_output: Clone::clone(&orig.sign_justice_revoked_output),
788 sign_justice_revoked_htlc: Clone::clone(&orig.sign_justice_revoked_htlc),
789 sign_counterparty_htlc_transaction: Clone::clone(&orig.sign_counterparty_htlc_transaction),
790 sign_closing_transaction: Clone::clone(&orig.sign_closing_transaction),
791 sign_holder_anchor_input: Clone::clone(&orig.sign_holder_anchor_input),
792 sign_channel_announcement: Clone::clone(&orig.sign_channel_announcement),
793 provide_channel_parameters: Clone::clone(&orig.provide_channel_parameters),
794 free: Clone::clone(&orig.free),
798 use lightning::chain::keysinterface::BaseSign as rustBaseSign;
799 impl rustBaseSign for BaseSign {
800 fn get_per_commitment_point(&self, mut idx: u64, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> bitcoin::secp256k1::PublicKey {
801 let mut ret = (self.get_per_commitment_point)(self.this_arg, idx);
804 fn release_commitment_secret(&self, mut idx: u64) -> [u8; 32] {
805 let mut ret = (self.release_commitment_secret)(self.this_arg, idx);
808 fn validate_holder_commitment(&self, mut holder_tx: &lightning::ln::chan_utils::HolderCommitmentTransaction, mut preimages: Vec<lightning::ln::PaymentPreimage>) -> Result<(), ()> {
809 let mut local_preimages = Vec::new(); for mut item in preimages.drain(..) { local_preimages.push( { crate::c_types::ThirtyTwoBytes { data: item.0 } }); };
810 let mut ret = (self.validate_holder_commitment)(self.this_arg, &crate::lightning::ln::chan_utils::HolderCommitmentTransaction { inner: unsafe { ObjOps::nonnull_ptr_to_inner((holder_tx as *const lightning::ln::chan_utils::HolderCommitmentTransaction<>) as *mut _) }, is_owned: false }, local_preimages.into());
811 let mut local_ret = match ret.result_ok { true => Ok( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) })*/ }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
814 fn pubkeys(&self) -> &lightning::ln::chan_utils::ChannelPublicKeys {
815 if let Some(f) = self.set_pubkeys {
818 self.pubkeys.get_native_ref()
820 fn channel_keys_id(&self) -> [u8; 32] {
821 let mut ret = (self.channel_keys_id)(self.this_arg);
824 fn sign_counterparty_commitment(&self, mut commitment_tx: &lightning::ln::chan_utils::CommitmentTransaction, mut preimages: Vec<lightning::ln::PaymentPreimage>, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<(bitcoin::secp256k1::ecdsa::Signature, Vec<bitcoin::secp256k1::ecdsa::Signature>), ()> {
825 let mut local_preimages = Vec::new(); for mut item in preimages.drain(..) { local_preimages.push( { crate::c_types::ThirtyTwoBytes { data: item.0 } }); };
826 let mut ret = (self.sign_counterparty_commitment)(self.this_arg, &crate::lightning::ln::chan_utils::CommitmentTransaction { inner: unsafe { ObjOps::nonnull_ptr_to_inner((commitment_tx as *const lightning::ln::chan_utils::CommitmentTransaction<>) as *mut _) }, is_owned: false }, local_preimages.into());
827 let mut local_ret = match ret.result_ok { true => Ok( { let (mut orig_ret_0_0, mut orig_ret_0_1) = (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).to_rust(); let mut local_orig_ret_0_1 = Vec::new(); for mut item in orig_ret_0_1.into_rust().drain(..) { local_orig_ret_0_1.push( { item.into_rust() }); }; let mut local_ret_0 = (orig_ret_0_0.into_rust(), local_orig_ret_0_1); local_ret_0 }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
830 fn validate_counterparty_revocation(&self, mut idx: u64, mut secret: &bitcoin::secp256k1::SecretKey) -> Result<(), ()> {
831 let mut ret = (self.validate_counterparty_revocation)(self.this_arg, idx, secret.as_ref());
832 let mut local_ret = match ret.result_ok { true => Ok( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) })*/ }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
835 fn sign_holder_commitment_and_htlcs(&self, mut commitment_tx: &lightning::ln::chan_utils::HolderCommitmentTransaction, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<(bitcoin::secp256k1::ecdsa::Signature, Vec<bitcoin::secp256k1::ecdsa::Signature>), ()> {
836 let mut ret = (self.sign_holder_commitment_and_htlcs)(self.this_arg, &crate::lightning::ln::chan_utils::HolderCommitmentTransaction { inner: unsafe { ObjOps::nonnull_ptr_to_inner((commitment_tx as *const lightning::ln::chan_utils::HolderCommitmentTransaction<>) as *mut _) }, is_owned: false });
837 let mut local_ret = match ret.result_ok { true => Ok( { let (mut orig_ret_0_0, mut orig_ret_0_1) = (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).to_rust(); let mut local_orig_ret_0_1 = Vec::new(); for mut item in orig_ret_0_1.into_rust().drain(..) { local_orig_ret_0_1.push( { item.into_rust() }); }; let mut local_ret_0 = (orig_ret_0_0.into_rust(), local_orig_ret_0_1); local_ret_0 }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
840 fn sign_justice_revoked_output(&self, mut justice_tx: &bitcoin::blockdata::transaction::Transaction, mut input: usize, mut amount: u64, mut per_commitment_key: &bitcoin::secp256k1::SecretKey, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<bitcoin::secp256k1::ecdsa::Signature, ()> {
841 let mut ret = (self.sign_justice_revoked_output)(self.this_arg, crate::c_types::Transaction::from_bitcoin(justice_tx), input, amount, per_commitment_key.as_ref());
842 let mut local_ret = match ret.result_ok { true => Ok( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).into_rust() }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
845 fn sign_justice_revoked_htlc(&self, mut justice_tx: &bitcoin::blockdata::transaction::Transaction, mut input: usize, mut amount: u64, mut per_commitment_key: &bitcoin::secp256k1::SecretKey, mut htlc: &lightning::ln::chan_utils::HTLCOutputInCommitment, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<bitcoin::secp256k1::ecdsa::Signature, ()> {
846 let mut ret = (self.sign_justice_revoked_htlc)(self.this_arg, crate::c_types::Transaction::from_bitcoin(justice_tx), input, amount, per_commitment_key.as_ref(), &crate::lightning::ln::chan_utils::HTLCOutputInCommitment { inner: unsafe { ObjOps::nonnull_ptr_to_inner((htlc as *const lightning::ln::chan_utils::HTLCOutputInCommitment<>) as *mut _) }, is_owned: false });
847 let mut local_ret = match ret.result_ok { true => Ok( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).into_rust() }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
850 fn sign_counterparty_htlc_transaction(&self, mut htlc_tx: &bitcoin::blockdata::transaction::Transaction, mut input: usize, mut amount: u64, mut per_commitment_point: &bitcoin::secp256k1::PublicKey, mut htlc: &lightning::ln::chan_utils::HTLCOutputInCommitment, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<bitcoin::secp256k1::ecdsa::Signature, ()> {
851 let mut ret = (self.sign_counterparty_htlc_transaction)(self.this_arg, crate::c_types::Transaction::from_bitcoin(htlc_tx), input, amount, crate::c_types::PublicKey::from_rust(&per_commitment_point), &crate::lightning::ln::chan_utils::HTLCOutputInCommitment { inner: unsafe { ObjOps::nonnull_ptr_to_inner((htlc as *const lightning::ln::chan_utils::HTLCOutputInCommitment<>) as *mut _) }, is_owned: false });
852 let mut local_ret = match ret.result_ok { true => Ok( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).into_rust() }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
855 fn sign_closing_transaction(&self, mut closing_tx: &lightning::ln::chan_utils::ClosingTransaction, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<bitcoin::secp256k1::ecdsa::Signature, ()> {
856 let mut ret = (self.sign_closing_transaction)(self.this_arg, &crate::lightning::ln::chan_utils::ClosingTransaction { inner: unsafe { ObjOps::nonnull_ptr_to_inner((closing_tx as *const lightning::ln::chan_utils::ClosingTransaction<>) as *mut _) }, is_owned: false });
857 let mut local_ret = match ret.result_ok { true => Ok( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).into_rust() }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
860 fn sign_holder_anchor_input(&self, mut anchor_tx: &bitcoin::blockdata::transaction::Transaction, mut input: usize, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<bitcoin::secp256k1::ecdsa::Signature, ()> {
861 let mut ret = (self.sign_holder_anchor_input)(self.this_arg, crate::c_types::Transaction::from_bitcoin(anchor_tx), input);
862 let mut local_ret = match ret.result_ok { true => Ok( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).into_rust() }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
865 fn sign_channel_announcement(&self, mut msg: &lightning::ln::msgs::UnsignedChannelAnnouncement, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<(bitcoin::secp256k1::ecdsa::Signature, bitcoin::secp256k1::ecdsa::Signature), ()> {
866 let mut ret = (self.sign_channel_announcement)(self.this_arg, &crate::lightning::ln::msgs::UnsignedChannelAnnouncement { inner: unsafe { ObjOps::nonnull_ptr_to_inner((msg as *const lightning::ln::msgs::UnsignedChannelAnnouncement<>) as *mut _) }, is_owned: false });
867 let mut local_ret = match ret.result_ok { true => Ok( { let (mut orig_ret_0_0, mut orig_ret_0_1) = (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).to_rust(); let mut local_ret_0 = (orig_ret_0_0.into_rust(), orig_ret_0_1.into_rust()); local_ret_0 }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
870 fn provide_channel_parameters(&mut self, mut channel_parameters: &lightning::ln::chan_utils::ChannelTransactionParameters) {
871 (self.provide_channel_parameters)(self.this_arg, &crate::lightning::ln::chan_utils::ChannelTransactionParameters { inner: unsafe { ObjOps::nonnull_ptr_to_inner((channel_parameters as *const lightning::ln::chan_utils::ChannelTransactionParameters<>) as *mut _) }, is_owned: false })
875 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
876 // directly as a Deref trait in higher-level structs:
877 impl core::ops::Deref for BaseSign {
879 fn deref(&self) -> &Self {
883 /// Calls the free function if one is set
885 pub extern "C" fn BaseSign_free(this_ptr: BaseSign) { }
886 impl Drop for BaseSign {
888 if let Some(f) = self.free {
893 /// A writeable signer.
895 /// There will always be two instances of a signer per channel, one occupied by the
896 /// [`ChannelManager`] and another by the channel's [`ChannelMonitor`].
898 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
899 /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
902 /// An opaque pointer which is passed to your function implementations as an argument.
903 /// This has no meaning in the LDK, and can be NULL or any other value.
904 pub this_arg: *mut c_void,
905 /// Implementation of BaseSign for this object.
906 pub BaseSign: crate::lightning::chain::keysinterface::BaseSign,
907 /// Serialize the object into a byte array
908 pub write: extern "C" fn (this_arg: *const c_void) -> crate::c_types::derived::CVec_u8Z,
909 /// Frees any resources associated with this object given its this_arg pointer.
910 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
911 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
913 unsafe impl Send for Sign {}
914 unsafe impl Sync for Sign {}
916 pub(crate) extern "C" fn Sign_clone_fields(orig: &Sign) -> Sign {
918 this_arg: orig.this_arg,
919 BaseSign: crate::lightning::chain::keysinterface::BaseSign_clone_fields(&orig.BaseSign),
920 write: Clone::clone(&orig.write),
921 free: Clone::clone(&orig.free),
924 impl lightning::chain::keysinterface::BaseSign for Sign {
925 fn get_per_commitment_point(&self, mut idx: u64, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> bitcoin::secp256k1::PublicKey {
926 let mut ret = (self.BaseSign.get_per_commitment_point)(self.BaseSign.this_arg, idx);
929 fn release_commitment_secret(&self, mut idx: u64) -> [u8; 32] {
930 let mut ret = (self.BaseSign.release_commitment_secret)(self.BaseSign.this_arg, idx);
933 fn validate_holder_commitment(&self, mut holder_tx: &lightning::ln::chan_utils::HolderCommitmentTransaction, mut preimages: Vec<lightning::ln::PaymentPreimage>) -> Result<(), ()> {
934 let mut local_preimages = Vec::new(); for mut item in preimages.drain(..) { local_preimages.push( { crate::c_types::ThirtyTwoBytes { data: item.0 } }); };
935 let mut ret = (self.BaseSign.validate_holder_commitment)(self.BaseSign.this_arg, &crate::lightning::ln::chan_utils::HolderCommitmentTransaction { inner: unsafe { ObjOps::nonnull_ptr_to_inner((holder_tx as *const lightning::ln::chan_utils::HolderCommitmentTransaction<>) as *mut _) }, is_owned: false }, local_preimages.into());
936 let mut local_ret = match ret.result_ok { true => Ok( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) })*/ }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
939 fn pubkeys(&self) -> &lightning::ln::chan_utils::ChannelPublicKeys {
940 if let Some(f) = self.BaseSign.set_pubkeys {
943 self.BaseSign.pubkeys.get_native_ref()
945 fn channel_keys_id(&self) -> [u8; 32] {
946 let mut ret = (self.BaseSign.channel_keys_id)(self.BaseSign.this_arg);
949 fn sign_counterparty_commitment(&self, mut commitment_tx: &lightning::ln::chan_utils::CommitmentTransaction, mut preimages: Vec<lightning::ln::PaymentPreimage>, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<(bitcoin::secp256k1::ecdsa::Signature, Vec<bitcoin::secp256k1::ecdsa::Signature>), ()> {
950 let mut local_preimages = Vec::new(); for mut item in preimages.drain(..) { local_preimages.push( { crate::c_types::ThirtyTwoBytes { data: item.0 } }); };
951 let mut ret = (self.BaseSign.sign_counterparty_commitment)(self.BaseSign.this_arg, &crate::lightning::ln::chan_utils::CommitmentTransaction { inner: unsafe { ObjOps::nonnull_ptr_to_inner((commitment_tx as *const lightning::ln::chan_utils::CommitmentTransaction<>) as *mut _) }, is_owned: false }, local_preimages.into());
952 let mut local_ret = match ret.result_ok { true => Ok( { let (mut orig_ret_0_0, mut orig_ret_0_1) = (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).to_rust(); let mut local_orig_ret_0_1 = Vec::new(); for mut item in orig_ret_0_1.into_rust().drain(..) { local_orig_ret_0_1.push( { item.into_rust() }); }; let mut local_ret_0 = (orig_ret_0_0.into_rust(), local_orig_ret_0_1); local_ret_0 }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
955 fn validate_counterparty_revocation(&self, mut idx: u64, mut secret: &bitcoin::secp256k1::SecretKey) -> Result<(), ()> {
956 let mut ret = (self.BaseSign.validate_counterparty_revocation)(self.BaseSign.this_arg, idx, secret.as_ref());
957 let mut local_ret = match ret.result_ok { true => Ok( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) })*/ }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
960 fn sign_holder_commitment_and_htlcs(&self, mut commitment_tx: &lightning::ln::chan_utils::HolderCommitmentTransaction, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<(bitcoin::secp256k1::ecdsa::Signature, Vec<bitcoin::secp256k1::ecdsa::Signature>), ()> {
961 let mut ret = (self.BaseSign.sign_holder_commitment_and_htlcs)(self.BaseSign.this_arg, &crate::lightning::ln::chan_utils::HolderCommitmentTransaction { inner: unsafe { ObjOps::nonnull_ptr_to_inner((commitment_tx as *const lightning::ln::chan_utils::HolderCommitmentTransaction<>) as *mut _) }, is_owned: false });
962 let mut local_ret = match ret.result_ok { true => Ok( { let (mut orig_ret_0_0, mut orig_ret_0_1) = (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).to_rust(); let mut local_orig_ret_0_1 = Vec::new(); for mut item in orig_ret_0_1.into_rust().drain(..) { local_orig_ret_0_1.push( { item.into_rust() }); }; let mut local_ret_0 = (orig_ret_0_0.into_rust(), local_orig_ret_0_1); local_ret_0 }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
965 fn sign_justice_revoked_output(&self, mut justice_tx: &bitcoin::blockdata::transaction::Transaction, mut input: usize, mut amount: u64, mut per_commitment_key: &bitcoin::secp256k1::SecretKey, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<bitcoin::secp256k1::ecdsa::Signature, ()> {
966 let mut ret = (self.BaseSign.sign_justice_revoked_output)(self.BaseSign.this_arg, crate::c_types::Transaction::from_bitcoin(justice_tx), input, amount, per_commitment_key.as_ref());
967 let mut local_ret = match ret.result_ok { true => Ok( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).into_rust() }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
970 fn sign_justice_revoked_htlc(&self, mut justice_tx: &bitcoin::blockdata::transaction::Transaction, mut input: usize, mut amount: u64, mut per_commitment_key: &bitcoin::secp256k1::SecretKey, mut htlc: &lightning::ln::chan_utils::HTLCOutputInCommitment, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<bitcoin::secp256k1::ecdsa::Signature, ()> {
971 let mut ret = (self.BaseSign.sign_justice_revoked_htlc)(self.BaseSign.this_arg, crate::c_types::Transaction::from_bitcoin(justice_tx), input, amount, per_commitment_key.as_ref(), &crate::lightning::ln::chan_utils::HTLCOutputInCommitment { inner: unsafe { ObjOps::nonnull_ptr_to_inner((htlc as *const lightning::ln::chan_utils::HTLCOutputInCommitment<>) as *mut _) }, is_owned: false });
972 let mut local_ret = match ret.result_ok { true => Ok( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).into_rust() }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
975 fn sign_counterparty_htlc_transaction(&self, mut htlc_tx: &bitcoin::blockdata::transaction::Transaction, mut input: usize, mut amount: u64, mut per_commitment_point: &bitcoin::secp256k1::PublicKey, mut htlc: &lightning::ln::chan_utils::HTLCOutputInCommitment, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<bitcoin::secp256k1::ecdsa::Signature, ()> {
976 let mut ret = (self.BaseSign.sign_counterparty_htlc_transaction)(self.BaseSign.this_arg, crate::c_types::Transaction::from_bitcoin(htlc_tx), input, amount, crate::c_types::PublicKey::from_rust(&per_commitment_point), &crate::lightning::ln::chan_utils::HTLCOutputInCommitment { inner: unsafe { ObjOps::nonnull_ptr_to_inner((htlc as *const lightning::ln::chan_utils::HTLCOutputInCommitment<>) as *mut _) }, is_owned: false });
977 let mut local_ret = match ret.result_ok { true => Ok( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).into_rust() }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
980 fn sign_closing_transaction(&self, mut closing_tx: &lightning::ln::chan_utils::ClosingTransaction, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<bitcoin::secp256k1::ecdsa::Signature, ()> {
981 let mut ret = (self.BaseSign.sign_closing_transaction)(self.BaseSign.this_arg, &crate::lightning::ln::chan_utils::ClosingTransaction { inner: unsafe { ObjOps::nonnull_ptr_to_inner((closing_tx as *const lightning::ln::chan_utils::ClosingTransaction<>) as *mut _) }, is_owned: false });
982 let mut local_ret = match ret.result_ok { true => Ok( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).into_rust() }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
985 fn sign_holder_anchor_input(&self, mut anchor_tx: &bitcoin::blockdata::transaction::Transaction, mut input: usize, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<bitcoin::secp256k1::ecdsa::Signature, ()> {
986 let mut ret = (self.BaseSign.sign_holder_anchor_input)(self.BaseSign.this_arg, crate::c_types::Transaction::from_bitcoin(anchor_tx), input);
987 let mut local_ret = match ret.result_ok { true => Ok( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).into_rust() }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
990 fn sign_channel_announcement(&self, mut msg: &lightning::ln::msgs::UnsignedChannelAnnouncement, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<(bitcoin::secp256k1::ecdsa::Signature, bitcoin::secp256k1::ecdsa::Signature), ()> {
991 let mut ret = (self.BaseSign.sign_channel_announcement)(self.BaseSign.this_arg, &crate::lightning::ln::msgs::UnsignedChannelAnnouncement { inner: unsafe { ObjOps::nonnull_ptr_to_inner((msg as *const lightning::ln::msgs::UnsignedChannelAnnouncement<>) as *mut _) }, is_owned: false });
992 let mut local_ret = match ret.result_ok { true => Ok( { let (mut orig_ret_0_0, mut orig_ret_0_1) = (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).to_rust(); let mut local_ret_0 = (orig_ret_0_0.into_rust(), orig_ret_0_1.into_rust()); local_ret_0 }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
995 fn provide_channel_parameters(&mut self, mut channel_parameters: &lightning::ln::chan_utils::ChannelTransactionParameters) {
996 (self.BaseSign.provide_channel_parameters)(self.BaseSign.this_arg, &crate::lightning::ln::chan_utils::ChannelTransactionParameters { inner: unsafe { ObjOps::nonnull_ptr_to_inner((channel_parameters as *const lightning::ln::chan_utils::ChannelTransactionParameters<>) as *mut _) }, is_owned: false })
999 impl lightning::util::ser::Writeable for Sign {
1000 fn write<W: lightning::util::ser::Writer>(&self, w: &mut W) -> Result<(), crate::c_types::io::Error> {
1001 let vec = (self.write)(self.this_arg);
1002 w.write_all(vec.as_slice())
1006 use lightning::chain::keysinterface::Sign as rustSign;
1007 impl rustSign for Sign {
1010 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
1011 // directly as a Deref trait in higher-level structs:
1012 impl core::ops::Deref for Sign {
1014 fn deref(&self) -> &Self {
1018 /// Calls the free function if one is set
1020 pub extern "C" fn Sign_free(this_ptr: Sign) { }
1021 impl Drop for Sign {
1022 fn drop(&mut self) {
1023 if let Some(f) = self.free {
1028 /// Specifies the recipient of an invoice.
1030 /// This indicates to [`KeysInterface::sign_invoice`] what node secret key should be used to sign
1035 pub enum Recipient {
1036 /// The invoice should be signed with the local node secret key.
1038 /// The invoice should be signed with the phantom node secret key. This secret key must be the
1039 /// same for all nodes participating in the [phantom node payment].
1041 /// [phantom node payment]: PhantomKeysManager
1044 use lightning::chain::keysinterface::Recipient as RecipientImport;
1045 pub(crate) type nativeRecipient = RecipientImport;
1049 pub(crate) fn to_native(&self) -> nativeRecipient {
1051 Recipient::Node => nativeRecipient::Node,
1052 Recipient::PhantomNode => nativeRecipient::PhantomNode,
1056 pub(crate) fn into_native(self) -> nativeRecipient {
1058 Recipient::Node => nativeRecipient::Node,
1059 Recipient::PhantomNode => nativeRecipient::PhantomNode,
1063 pub(crate) fn from_native(native: &nativeRecipient) -> Self {
1065 nativeRecipient::Node => Recipient::Node,
1066 nativeRecipient::PhantomNode => Recipient::PhantomNode,
1070 pub(crate) fn native_into(native: nativeRecipient) -> Self {
1072 nativeRecipient::Node => Recipient::Node,
1073 nativeRecipient::PhantomNode => Recipient::PhantomNode,
1077 /// Creates a copy of the Recipient
1079 pub extern "C" fn Recipient_clone(orig: &Recipient) -> Recipient {
1083 /// Utility method to constructs a new Node-variant Recipient
1084 pub extern "C" fn Recipient_node() -> Recipient {
1087 /// Utility method to constructs a new PhantomNode-variant Recipient
1088 pub extern "C" fn Recipient_phantom_node() -> Recipient {
1089 Recipient::PhantomNode}
1090 /// A trait to describe an object which can get user secrets and key material.
1092 pub struct KeysInterface {
1093 /// An opaque pointer which is passed to your function implementations as an argument.
1094 /// This has no meaning in the LDK, and can be NULL or any other value.
1095 pub this_arg: *mut c_void,
1096 /// Get node secret key based on the provided [`Recipient`].
1098 /// The `node_id`/`network_key` is the public key that corresponds to this secret key.
1100 /// This method must return the same value each time it is called with a given [`Recipient`]
1103 /// Errors if the [`Recipient`] variant is not supported by the implementation.
1105 pub get_node_secret: extern "C" fn (this_arg: *const c_void, recipient: crate::lightning::chain::keysinterface::Recipient) -> crate::c_types::derived::CResult_SecretKeyNoneZ,
1106 /// Get node id based on the provided [`Recipient`]. This public key corresponds to the secret in
1107 /// [`get_node_secret`].
1109 /// This method must return the same value each time it is called with a given [`Recipient`]
1112 /// Errors if the [`Recipient`] variant is not supported by the implementation.
1114 /// [`get_node_secret`]: Self::get_node_secret
1116 pub get_node_id: extern "C" fn (this_arg: *const c_void, recipient: crate::lightning::chain::keysinterface::Recipient) -> crate::c_types::derived::CResult_PublicKeyNoneZ,
1117 /// Gets the ECDH shared secret of our [`node secret`] and `other_key`, multiplying by `tweak` if
1118 /// one is provided. Note that this tweak can be applied to `other_key` instead of our node
1119 /// secret, though this is less efficient.
1121 /// Errors if the [`Recipient`] variant is not supported by the implementation.
1123 /// [`node secret`]: Self::get_node_secret
1125 pub ecdh: extern "C" fn (this_arg: *const c_void, recipient: crate::lightning::chain::keysinterface::Recipient, other_key: crate::c_types::PublicKey, tweak: crate::c_types::derived::COption_ScalarZ) -> crate::c_types::derived::CResult_SharedSecretNoneZ,
1126 /// Get a script pubkey which we send funds to when claiming on-chain contestable outputs.
1128 /// This method should return a different value each time it is called, to avoid linking
1129 /// on-chain funds across channels as controlled to the same user.
1131 pub get_destination_script: extern "C" fn (this_arg: *const c_void) -> crate::c_types::derived::CVec_u8Z,
1132 /// Get a script pubkey which we will send funds to when closing a channel.
1134 /// This method should return a different value each time it is called, to avoid linking
1135 /// on-chain funds across channels as controlled to the same user.
1137 pub get_shutdown_scriptpubkey: extern "C" fn (this_arg: *const c_void) -> crate::lightning::ln::script::ShutdownScript,
1138 /// Get a new set of [`Sign`] for per-channel secrets. These MUST be unique even if you
1139 /// restarted with some stale data!
1141 /// This method must return a different value each time it is called.
1143 pub generate_channel_keys_id: extern "C" fn (this_arg: *const c_void, inbound: bool, channel_value_satoshis: u64, user_channel_id: crate::c_types::U128) -> crate::c_types::ThirtyTwoBytes,
1144 /// Derives the private key material backing a `Signer`.
1146 /// To derive a new `Signer`, a fresh `channel_keys_id` should be obtained through
1147 /// [`KeysInterface::generate_channel_keys_id`]. Otherwise, an existing `Signer` can be
1148 /// re-derived from its `channel_keys_id`, which can be obtained through its trait method
1149 /// [`BaseSign::channel_keys_id`].
1151 pub derive_channel_signer: extern "C" fn (this_arg: *const c_void, channel_value_satoshis: u64, channel_keys_id: crate::c_types::ThirtyTwoBytes) -> crate::lightning::chain::keysinterface::Sign,
1152 /// Gets a unique, cryptographically-secure, random 32 byte value. This is used for encrypting
1153 /// onion packets and for temporary channel IDs. There is no requirement that these be
1154 /// persisted anywhere, though they must be unique across restarts.
1156 /// This method must return a different value each time it is called.
1158 pub get_secure_random_bytes: extern "C" fn (this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes,
1159 /// Reads a [`Signer`] for this [`KeysInterface`] from the given input stream.
1160 /// This is only called during deserialization of other objects which contain
1161 /// [`Sign`]-implementing objects (i.e., [`ChannelMonitor`]s and [`ChannelManager`]s).
1162 /// The bytes are exactly those which `<Self::Signer as Writeable>::write()` writes, and
1163 /// contain no versioning scheme. You may wish to include your own version prefix and ensure
1164 /// you've read all of the provided bytes to ensure no corruption occurred.
1166 /// This method is slowly being phased out -- it will only be called when reading objects
1167 /// written by LDK versions prior to 0.0.113.
1169 /// [`Signer`]: Self::Signer
1170 /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
1171 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
1173 pub read_chan_signer: extern "C" fn (this_arg: *const c_void, reader: crate::c_types::u8slice) -> crate::c_types::derived::CResult_SignDecodeErrorZ,
1174 /// Sign an invoice.
1175 /// By parameterizing by the raw invoice bytes instead of the hash, we allow implementors of
1176 /// this trait to parse the invoice and make sure they're signing what they expect, rather than
1177 /// blindly signing the hash.
1178 /// The `hrp` is ASCII bytes, while the invoice data is base32-encoded.
1180 /// The secret key used to sign the invoice is dependent on the [`Recipient`].
1182 /// Errors if the [`Recipient`] variant is not supported by the implementation.
1184 pub sign_invoice: extern "C" fn (this_arg: *const c_void, hrp_bytes: crate::c_types::u8slice, invoice_data: crate::c_types::derived::CVec_U5Z, receipient: crate::lightning::chain::keysinterface::Recipient) -> crate::c_types::derived::CResult_RecoverableSignatureNoneZ,
1185 /// Get secret key material as bytes for use in encrypting and decrypting inbound payment data.
1187 /// If the implementor of this trait supports [phantom node payments], then every node that is
1188 /// intended to be included in the phantom invoice route hints must return the same value from
1191 /// This method must return the same value each time it is called.
1193 /// [phantom node payments]: PhantomKeysManager
1195 pub get_inbound_payment_key_material: extern "C" fn (this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes,
1196 /// Frees any resources associated with this object given its this_arg pointer.
1197 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
1198 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
1200 unsafe impl Send for KeysInterface {}
1201 unsafe impl Sync for KeysInterface {}
1203 pub(crate) extern "C" fn KeysInterface_clone_fields(orig: &KeysInterface) -> KeysInterface {
1205 this_arg: orig.this_arg,
1206 get_node_secret: Clone::clone(&orig.get_node_secret),
1207 get_node_id: Clone::clone(&orig.get_node_id),
1208 ecdh: Clone::clone(&orig.ecdh),
1209 get_destination_script: Clone::clone(&orig.get_destination_script),
1210 get_shutdown_scriptpubkey: Clone::clone(&orig.get_shutdown_scriptpubkey),
1211 generate_channel_keys_id: Clone::clone(&orig.generate_channel_keys_id),
1212 derive_channel_signer: Clone::clone(&orig.derive_channel_signer),
1213 get_secure_random_bytes: Clone::clone(&orig.get_secure_random_bytes),
1214 read_chan_signer: Clone::clone(&orig.read_chan_signer),
1215 sign_invoice: Clone::clone(&orig.sign_invoice),
1216 get_inbound_payment_key_material: Clone::clone(&orig.get_inbound_payment_key_material),
1217 free: Clone::clone(&orig.free),
1221 use lightning::chain::keysinterface::KeysInterface as rustKeysInterface;
1222 impl rustKeysInterface for KeysInterface {
1223 type Signer = crate::lightning::chain::keysinterface::Sign;
1224 fn get_node_secret(&self, mut recipient: lightning::chain::keysinterface::Recipient) -> Result<bitcoin::secp256k1::SecretKey, ()> {
1225 let mut ret = (self.get_node_secret)(self.this_arg, crate::lightning::chain::keysinterface::Recipient::native_into(recipient));
1226 let mut local_ret = match ret.result_ok { true => Ok( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).into_rust() }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
1229 fn get_node_id(&self, mut recipient: lightning::chain::keysinterface::Recipient) -> Result<bitcoin::secp256k1::PublicKey, ()> {
1230 let mut ret = (self.get_node_id)(self.this_arg, crate::lightning::chain::keysinterface::Recipient::native_into(recipient));
1231 let mut local_ret = match ret.result_ok { true => Ok( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).into_rust() }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
1234 fn ecdh(&self, mut recipient: lightning::chain::keysinterface::Recipient, mut other_key: &bitcoin::secp256k1::PublicKey, mut tweak: Option<&bitcoin::secp256k1::Scalar>) -> Result<bitcoin::secp256k1::ecdh::SharedSecret, ()> {
1235 let mut local_tweak = if tweak.is_none() { crate::c_types::derived::COption_ScalarZ::None } else { crate::c_types::derived::COption_ScalarZ::Some(/* WARNING: CLONING CONVERSION HERE! &Option<Enum> is otherwise un-expressable. */ { crate::c_types::BigEndianScalar::from_rust(tweak.clone().unwrap()) }) };
1236 let mut ret = (self.ecdh)(self.this_arg, crate::lightning::chain::keysinterface::Recipient::native_into(recipient), crate::c_types::PublicKey::from_rust(&other_key), local_tweak);
1237 let mut local_ret = match ret.result_ok { true => Ok( { ::bitcoin::secp256k1::ecdh::SharedSecret::from_bytes((*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).data) }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
1240 fn get_destination_script(&self) -> bitcoin::blockdata::script::Script {
1241 let mut ret = (self.get_destination_script)(self.this_arg);
1242 ::bitcoin::blockdata::script::Script::from(ret.into_rust())
1244 fn get_shutdown_scriptpubkey(&self) -> lightning::ln::script::ShutdownScript {
1245 let mut ret = (self.get_shutdown_scriptpubkey)(self.this_arg);
1246 *unsafe { Box::from_raw(ret.take_inner()) }
1248 fn generate_channel_keys_id(&self, mut inbound: bool, mut channel_value_satoshis: u64, mut user_channel_id: u128) -> [u8; 32] {
1249 let mut ret = (self.generate_channel_keys_id)(self.this_arg, inbound, channel_value_satoshis, user_channel_id.into());
1252 fn derive_channel_signer(&self, mut channel_value_satoshis: u64, mut channel_keys_id: [u8; 32]) -> crate::lightning::chain::keysinterface::Sign {
1253 let mut ret = (self.derive_channel_signer)(self.this_arg, channel_value_satoshis, crate::c_types::ThirtyTwoBytes { data: channel_keys_id });
1256 fn get_secure_random_bytes(&self) -> [u8; 32] {
1257 let mut ret = (self.get_secure_random_bytes)(self.this_arg);
1260 fn read_chan_signer(&self, mut reader: &[u8]) -> Result<crate::lightning::chain::keysinterface::Sign, lightning::ln::msgs::DecodeError> {
1261 let mut local_reader = crate::c_types::u8slice::from_slice(reader);
1262 let mut ret = (self.read_chan_signer)(self.this_arg, local_reader);
1263 let mut local_ret = match ret.result_ok { true => Ok( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }) }), false => Err( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) }).into_native() })};
1266 fn sign_invoice(&self, mut hrp_bytes: &[u8], mut invoice_data: &[bitcoin::bech32::u5], mut receipient: lightning::chain::keysinterface::Recipient) -> Result<bitcoin::secp256k1::ecdsa::RecoverableSignature, ()> {
1267 let mut local_hrp_bytes = crate::c_types::u8slice::from_slice(hrp_bytes);
1268 let mut local_invoice_data_clone = Vec::new(); local_invoice_data_clone.extend_from_slice(invoice_data); let mut invoice_data = local_invoice_data_clone; let mut local_invoice_data = Vec::new(); for mut item in invoice_data.drain(..) { local_invoice_data.push( { item.into() }); };
1269 let mut ret = (self.sign_invoice)(self.this_arg, local_hrp_bytes, local_invoice_data.into(), crate::lightning::chain::keysinterface::Recipient::native_into(receipient));
1270 let mut local_ret = match ret.result_ok { true => Ok( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).into_rust() }), false => Err( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) })*/ })};
1273 fn get_inbound_payment_key_material(&self) -> lightning::chain::keysinterface::KeyMaterial {
1274 let mut ret = (self.get_inbound_payment_key_material)(self.this_arg);
1275 ::lightning::chain::keysinterface::KeyMaterial(ret.data)
1279 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
1280 // directly as a Deref trait in higher-level structs:
1281 impl core::ops::Deref for KeysInterface {
1283 fn deref(&self) -> &Self {
1287 /// Calls the free function if one is set
1289 pub extern "C" fn KeysInterface_free(this_ptr: KeysInterface) { }
1290 impl Drop for KeysInterface {
1291 fn drop(&mut self) {
1292 if let Some(f) = self.free {
1298 use lightning::chain::keysinterface::InMemorySigner as nativeInMemorySignerImport;
1299 pub(crate) type nativeInMemorySigner = nativeInMemorySignerImport;
1301 /// A simple implementation of [`Sign`] that just keeps the private keys in memory.
1303 /// This implementation performs no policy checks and is insufficient by itself as
1304 /// a secure external signer.
1307 pub struct InMemorySigner {
1308 /// A pointer to the opaque Rust object.
1310 /// Nearly everywhere, inner must be non-null, however in places where
1311 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1312 pub inner: *mut nativeInMemorySigner,
1313 /// Indicates that this is the only struct which contains the same pointer.
1315 /// Rust functions which take ownership of an object provided via an argument require
1316 /// this to be true and invalidate the object pointed to by inner.
1320 impl Drop for InMemorySigner {
1321 fn drop(&mut self) {
1322 if self.is_owned && !<*mut nativeInMemorySigner>::is_null(self.inner) {
1323 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1327 /// Frees any resources used by the InMemorySigner, if is_owned is set and inner is non-NULL.
1329 pub extern "C" fn InMemorySigner_free(this_obj: InMemorySigner) { }
1331 /// Used only if an object of this type is returned as a trait impl by a method
1332 pub(crate) extern "C" fn InMemorySigner_free_void(this_ptr: *mut c_void) {
1333 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeInMemorySigner) };
1336 impl InMemorySigner {
1337 pub(crate) fn get_native_ref(&self) -> &'static nativeInMemorySigner {
1338 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1340 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeInMemorySigner {
1341 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1343 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1344 pub(crate) fn take_inner(mut self) -> *mut nativeInMemorySigner {
1345 assert!(self.is_owned);
1346 let ret = ObjOps::untweak_ptr(self.inner);
1347 self.inner = core::ptr::null_mut();
1351 /// Holder secret key in the 2-of-2 multisig script of a channel. This key also backs the
1352 /// holder's anchor output in a commitment transaction, if one is present.
1354 pub extern "C" fn InMemorySigner_get_funding_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1355 let mut inner_val = &mut this_ptr.get_native_mut_ref().funding_key;
1358 /// Holder secret key in the 2-of-2 multisig script of a channel. This key also backs the
1359 /// holder's anchor output in a commitment transaction, if one is present.
1361 pub extern "C" fn InMemorySigner_set_funding_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1362 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.funding_key = val.into_rust();
1364 /// Holder secret key for blinded revocation pubkey.
1366 pub extern "C" fn InMemorySigner_get_revocation_base_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1367 let mut inner_val = &mut this_ptr.get_native_mut_ref().revocation_base_key;
1370 /// Holder secret key for blinded revocation pubkey.
1372 pub extern "C" fn InMemorySigner_set_revocation_base_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1373 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.revocation_base_key = val.into_rust();
1375 /// Holder secret key used for our balance in counterparty-broadcasted commitment transactions.
1377 pub extern "C" fn InMemorySigner_get_payment_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1378 let mut inner_val = &mut this_ptr.get_native_mut_ref().payment_key;
1381 /// Holder secret key used for our balance in counterparty-broadcasted commitment transactions.
1383 pub extern "C" fn InMemorySigner_set_payment_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1384 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.payment_key = val.into_rust();
1386 /// Holder secret key used in an HTLC transaction.
1388 pub extern "C" fn InMemorySigner_get_delayed_payment_base_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1389 let mut inner_val = &mut this_ptr.get_native_mut_ref().delayed_payment_base_key;
1392 /// Holder secret key used in an HTLC transaction.
1394 pub extern "C" fn InMemorySigner_set_delayed_payment_base_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1395 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.delayed_payment_base_key = val.into_rust();
1397 /// Holder HTLC secret key used in commitment transaction HTLC outputs.
1399 pub extern "C" fn InMemorySigner_get_htlc_base_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1400 let mut inner_val = &mut this_ptr.get_native_mut_ref().htlc_base_key;
1403 /// Holder HTLC secret key used in commitment transaction HTLC outputs.
1405 pub extern "C" fn InMemorySigner_set_htlc_base_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1406 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.htlc_base_key = val.into_rust();
1408 /// Commitment seed.
1410 pub extern "C" fn InMemorySigner_get_commitment_seed(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1411 let mut inner_val = &mut this_ptr.get_native_mut_ref().commitment_seed;
1414 /// Commitment seed.
1416 pub extern "C" fn InMemorySigner_set_commitment_seed(this_ptr: &mut InMemorySigner, mut val: crate::c_types::ThirtyTwoBytes) {
1417 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.commitment_seed = val.data;
1419 impl Clone for InMemorySigner {
1420 fn clone(&self) -> Self {
1422 inner: if <*mut nativeInMemorySigner>::is_null(self.inner) { core::ptr::null_mut() } else {
1423 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1429 /// Used only if an object of this type is returned as a trait impl by a method
1430 pub(crate) extern "C" fn InMemorySigner_clone_void(this_ptr: *const c_void) -> *mut c_void {
1431 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeInMemorySigner)).clone() })) as *mut c_void
1434 /// Creates a copy of the InMemorySigner
1435 pub extern "C" fn InMemorySigner_clone(orig: &InMemorySigner) -> InMemorySigner {
1438 /// Creates a new [`InMemorySigner`].
1441 pub extern "C" fn InMemorySigner_new(mut node_secret: crate::c_types::SecretKey, mut funding_key: crate::c_types::SecretKey, mut revocation_base_key: crate::c_types::SecretKey, mut payment_key: crate::c_types::SecretKey, mut delayed_payment_base_key: crate::c_types::SecretKey, mut htlc_base_key: crate::c_types::SecretKey, mut commitment_seed: crate::c_types::ThirtyTwoBytes, mut channel_value_satoshis: u64, mut channel_keys_id: crate::c_types::ThirtyTwoBytes) -> crate::lightning::chain::keysinterface::InMemorySigner {
1442 let mut ret = lightning::chain::keysinterface::InMemorySigner::new(secp256k1::global::SECP256K1, node_secret.into_rust(), funding_key.into_rust(), revocation_base_key.into_rust(), payment_key.into_rust(), delayed_payment_base_key.into_rust(), htlc_base_key.into_rust(), commitment_seed.data, channel_value_satoshis, channel_keys_id.data);
1443 crate::lightning::chain::keysinterface::InMemorySigner { inner: ObjOps::heap_alloc(ret), is_owned: true }
1446 /// Returns the counterparty's pubkeys.
1448 /// Will panic if [`BaseSign::provide_channel_parameters`] has not been called before.
1451 pub extern "C" fn InMemorySigner_counterparty_pubkeys(this_arg: &crate::lightning::chain::keysinterface::InMemorySigner) -> crate::lightning::ln::chan_utils::ChannelPublicKeys {
1452 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.counterparty_pubkeys();
1453 crate::lightning::ln::chan_utils::ChannelPublicKeys { inner: unsafe { ObjOps::nonnull_ptr_to_inner((ret as *const lightning::ln::chan_utils::ChannelPublicKeys<>) as *mut _) }, is_owned: false }
1456 /// Returns the `contest_delay` value specified by our counterparty and applied on holder-broadcastable
1457 /// transactions, i.e., the amount of time that we have to wait to recover our funds if we
1458 /// broadcast a transaction.
1460 /// Will panic if [`BaseSign::provide_channel_parameters`] has not been called before.
1463 pub extern "C" fn InMemorySigner_counterparty_selected_contest_delay(this_arg: &crate::lightning::chain::keysinterface::InMemorySigner) -> u16 {
1464 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.counterparty_selected_contest_delay();
1468 /// Returns the `contest_delay` value specified by us and applied on transactions broadcastable
1469 /// by our counterparty, i.e., the amount of time that they have to wait to recover their funds
1470 /// if they broadcast a transaction.
1472 /// Will panic if [`BaseSign::provide_channel_parameters`] has not been called before.
1475 pub extern "C" fn InMemorySigner_holder_selected_contest_delay(this_arg: &crate::lightning::chain::keysinterface::InMemorySigner) -> u16 {
1476 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.holder_selected_contest_delay();
1480 /// Returns whether the holder is the initiator.
1482 /// Will panic if [`BaseSign::provide_channel_parameters`] has not been called before.
1485 pub extern "C" fn InMemorySigner_is_outbound(this_arg: &crate::lightning::chain::keysinterface::InMemorySigner) -> bool {
1486 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.is_outbound();
1490 /// Funding outpoint
1492 /// Will panic if [`BaseSign::provide_channel_parameters`] has not been called before.
1495 pub extern "C" fn InMemorySigner_funding_outpoint(this_arg: &crate::lightning::chain::keysinterface::InMemorySigner) -> crate::lightning::chain::transaction::OutPoint {
1496 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.funding_outpoint();
1497 crate::lightning::chain::transaction::OutPoint { inner: unsafe { ObjOps::nonnull_ptr_to_inner((ret as *const lightning::chain::transaction::OutPoint<>) as *mut _) }, is_owned: false }
1500 /// Returns a [`ChannelTransactionParameters`] for this channel, to be used when verifying or
1501 /// building transactions.
1503 /// Will panic if [`BaseSign::provide_channel_parameters`] has not been called before.
1506 pub extern "C" fn InMemorySigner_get_channel_parameters(this_arg: &crate::lightning::chain::keysinterface::InMemorySigner) -> crate::lightning::ln::chan_utils::ChannelTransactionParameters {
1507 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_channel_parameters();
1508 crate::lightning::ln::chan_utils::ChannelTransactionParameters { inner: unsafe { ObjOps::nonnull_ptr_to_inner((ret as *const lightning::ln::chan_utils::ChannelTransactionParameters<>) as *mut _) }, is_owned: false }
1511 /// Returns whether anchors should be used.
1513 /// Will panic if [`BaseSign::provide_channel_parameters`] has not been called before.
1516 pub extern "C" fn InMemorySigner_opt_anchors(this_arg: &crate::lightning::chain::keysinterface::InMemorySigner) -> bool {
1517 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.opt_anchors();
1521 /// Sign the single input of `spend_tx` at index `input_idx`, which spends the output described
1522 /// by `descriptor`, returning the witness stack for the input.
1524 /// Returns an error if the input at `input_idx` does not exist, has a non-empty `script_sig`,
1525 /// is not spending the outpoint described by [`descriptor.outpoint`],
1526 /// or if an output descriptor `script_pubkey` does not match the one we can spend.
1528 /// [`descriptor.outpoint`]: StaticPaymentOutputDescriptor::outpoint
1531 pub extern "C" fn InMemorySigner_sign_counterparty_payment_input(this_arg: &crate::lightning::chain::keysinterface::InMemorySigner, mut spend_tx: crate::c_types::Transaction, mut input_idx: usize, descriptor: &crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor) -> crate::c_types::derived::CResult_CVec_CVec_u8ZZNoneZ {
1532 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.sign_counterparty_payment_input(&spend_tx.into_bitcoin(), input_idx, descriptor.get_native_ref(), secp256k1::global::SECP256K1);
1533 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { let mut local_ret_0 = Vec::new(); for mut item in o.drain(..) { local_ret_0.push( { let mut local_ret_0_0 = Vec::new(); for mut item in item.drain(..) { local_ret_0_0.push( { item }); }; local_ret_0_0.into() }); }; local_ret_0.into() }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1537 /// Sign the single input of `spend_tx` at index `input_idx` which spends the output
1538 /// described by `descriptor`, returning the witness stack for the input.
1540 /// Returns an error if the input at `input_idx` does not exist, has a non-empty `script_sig`,
1541 /// is not spending the outpoint described by [`descriptor.outpoint`], does not have a
1542 /// sequence set to [`descriptor.to_self_delay`], or if an output descriptor
1543 /// `script_pubkey` does not match the one we can spend.
1545 /// [`descriptor.outpoint`]: DelayedPaymentOutputDescriptor::outpoint
1546 /// [`descriptor.to_self_delay`]: DelayedPaymentOutputDescriptor::to_self_delay
1549 pub extern "C" fn InMemorySigner_sign_dynamic_p2wsh_input(this_arg: &crate::lightning::chain::keysinterface::InMemorySigner, mut spend_tx: crate::c_types::Transaction, mut input_idx: usize, descriptor: &crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor) -> crate::c_types::derived::CResult_CVec_CVec_u8ZZNoneZ {
1550 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.sign_dynamic_p2wsh_input(&spend_tx.into_bitcoin(), input_idx, descriptor.get_native_ref(), secp256k1::global::SECP256K1);
1551 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { let mut local_ret_0 = Vec::new(); for mut item in o.drain(..) { local_ret_0.push( { let mut local_ret_0_0 = Vec::new(); for mut item in item.drain(..) { local_ret_0_0.push( { item }); }; local_ret_0_0.into() }); }; local_ret_0.into() }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1555 impl From<nativeInMemorySigner> for crate::lightning::chain::keysinterface::BaseSign {
1556 fn from(obj: nativeInMemorySigner) -> Self {
1557 let mut rust_obj = InMemorySigner { inner: ObjOps::heap_alloc(obj), is_owned: true };
1558 let mut ret = InMemorySigner_as_BaseSign(&rust_obj);
1559 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so wipe rust_obj's pointer and set ret's free() fn
1560 rust_obj.inner = core::ptr::null_mut();
1561 ret.free = Some(InMemorySigner_free_void);
1565 /// Constructs a new BaseSign which calls the relevant methods on this_arg.
1566 /// This copies the `inner` pointer in this_arg and thus the returned BaseSign must be freed before this_arg is
1568 pub extern "C" fn InMemorySigner_as_BaseSign(this_arg: &InMemorySigner) -> crate::lightning::chain::keysinterface::BaseSign {
1569 crate::lightning::chain::keysinterface::BaseSign {
1570 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
1572 get_per_commitment_point: InMemorySigner_BaseSign_get_per_commitment_point,
1573 release_commitment_secret: InMemorySigner_BaseSign_release_commitment_secret,
1574 validate_holder_commitment: InMemorySigner_BaseSign_validate_holder_commitment,
1576 pubkeys: crate::lightning::ln::chan_utils::ChannelPublicKeys { inner: core::ptr::null_mut(), is_owned: true },
1577 set_pubkeys: Some(InMemorySigner_BaseSign_set_pubkeys),
1578 channel_keys_id: InMemorySigner_BaseSign_channel_keys_id,
1579 sign_counterparty_commitment: InMemorySigner_BaseSign_sign_counterparty_commitment,
1580 validate_counterparty_revocation: InMemorySigner_BaseSign_validate_counterparty_revocation,
1581 sign_holder_commitment_and_htlcs: InMemorySigner_BaseSign_sign_holder_commitment_and_htlcs,
1582 sign_justice_revoked_output: InMemorySigner_BaseSign_sign_justice_revoked_output,
1583 sign_justice_revoked_htlc: InMemorySigner_BaseSign_sign_justice_revoked_htlc,
1584 sign_counterparty_htlc_transaction: InMemorySigner_BaseSign_sign_counterparty_htlc_transaction,
1585 sign_closing_transaction: InMemorySigner_BaseSign_sign_closing_transaction,
1586 sign_holder_anchor_input: InMemorySigner_BaseSign_sign_holder_anchor_input,
1587 sign_channel_announcement: InMemorySigner_BaseSign_sign_channel_announcement,
1588 provide_channel_parameters: InMemorySigner_BaseSign_provide_channel_parameters,
1593 extern "C" fn InMemorySigner_BaseSign_get_per_commitment_point(this_arg: *const c_void, mut idx: u64) -> crate::c_types::PublicKey {
1594 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::get_per_commitment_point(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, idx, secp256k1::global::SECP256K1);
1595 crate::c_types::PublicKey::from_rust(&ret)
1598 extern "C" fn InMemorySigner_BaseSign_release_commitment_secret(this_arg: *const c_void, mut idx: u64) -> crate::c_types::ThirtyTwoBytes {
1599 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::release_commitment_secret(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, idx);
1600 crate::c_types::ThirtyTwoBytes { data: ret }
1603 extern "C" fn InMemorySigner_BaseSign_validate_holder_commitment(this_arg: *const c_void, holder_tx: &crate::lightning::ln::chan_utils::HolderCommitmentTransaction, mut preimages: crate::c_types::derived::CVec_PaymentPreimageZ) -> crate::c_types::derived::CResult_NoneNoneZ {
1604 let mut local_preimages = Vec::new(); for mut item in preimages.into_rust().drain(..) { local_preimages.push( { ::lightning::ln::PaymentPreimage(item.data) }); };
1605 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::validate_holder_commitment(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, holder_tx.get_native_ref(), local_preimages);
1606 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { () /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1610 extern "C" fn InMemorySigner_BaseSign_pubkeys(this_arg: *const c_void) -> crate::lightning::ln::chan_utils::ChannelPublicKeys {
1611 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::pubkeys(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, );
1612 crate::lightning::ln::chan_utils::ChannelPublicKeys { inner: unsafe { ObjOps::nonnull_ptr_to_inner((ret as *const lightning::ln::chan_utils::ChannelPublicKeys<>) as *mut _) }, is_owned: false }
1614 extern "C" fn InMemorySigner_BaseSign_set_pubkeys(trait_self_arg: &BaseSign) {
1615 // This is a bit race-y in the general case, but for our specific use-cases today, we're safe
1616 // Specifically, we must ensure that the first time we're called it can never be in parallel
1617 if trait_self_arg.pubkeys.inner.is_null() {
1618 unsafe { &mut *(trait_self_arg as *const BaseSign as *mut BaseSign) }.pubkeys = InMemorySigner_BaseSign_pubkeys(trait_self_arg.this_arg);
1622 extern "C" fn InMemorySigner_BaseSign_channel_keys_id(this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes {
1623 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::channel_keys_id(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, );
1624 crate::c_types::ThirtyTwoBytes { data: ret }
1627 extern "C" fn InMemorySigner_BaseSign_sign_counterparty_commitment(this_arg: *const c_void, commitment_tx: &crate::lightning::ln::chan_utils::CommitmentTransaction, mut preimages: crate::c_types::derived::CVec_PaymentPreimageZ) -> crate::c_types::derived::CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ {
1628 let mut local_preimages = Vec::new(); for mut item in preimages.into_rust().drain(..) { local_preimages.push( { ::lightning::ln::PaymentPreimage(item.data) }); };
1629 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::sign_counterparty_commitment(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, commitment_tx.get_native_ref(), local_preimages, secp256k1::global::SECP256K1);
1630 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { let (mut orig_ret_0_0, mut orig_ret_0_1) = o; let mut local_orig_ret_0_1 = Vec::new(); for mut item in orig_ret_0_1.drain(..) { local_orig_ret_0_1.push( { crate::c_types::Signature::from_rust(&item) }); }; let mut local_ret_0 = (crate::c_types::Signature::from_rust(&orig_ret_0_0), local_orig_ret_0_1.into()).into(); local_ret_0 }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1634 extern "C" fn InMemorySigner_BaseSign_validate_counterparty_revocation(this_arg: *const c_void, mut idx: u64, secret: *const [u8; 32]) -> crate::c_types::derived::CResult_NoneNoneZ {
1635 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::validate_counterparty_revocation(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, idx, &::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *secret}[..]).unwrap());
1636 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { () /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1640 extern "C" fn InMemorySigner_BaseSign_sign_holder_commitment_and_htlcs(this_arg: *const c_void, commitment_tx: &crate::lightning::ln::chan_utils::HolderCommitmentTransaction) -> crate::c_types::derived::CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ {
1641 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::sign_holder_commitment_and_htlcs(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, commitment_tx.get_native_ref(), secp256k1::global::SECP256K1);
1642 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { let (mut orig_ret_0_0, mut orig_ret_0_1) = o; let mut local_orig_ret_0_1 = Vec::new(); for mut item in orig_ret_0_1.drain(..) { local_orig_ret_0_1.push( { crate::c_types::Signature::from_rust(&item) }); }; let mut local_ret_0 = (crate::c_types::Signature::from_rust(&orig_ret_0_0), local_orig_ret_0_1.into()).into(); local_ret_0 }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1646 extern "C" fn InMemorySigner_BaseSign_sign_justice_revoked_output(this_arg: *const c_void, mut justice_tx: crate::c_types::Transaction, mut input: usize, mut amount: u64, per_commitment_key: *const [u8; 32]) -> crate::c_types::derived::CResult_SignatureNoneZ {
1647 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::sign_justice_revoked_output(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, &justice_tx.into_bitcoin(), input, amount, &::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *per_commitment_key}[..]).unwrap(), secp256k1::global::SECP256K1);
1648 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::Signature::from_rust(&o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1652 extern "C" fn InMemorySigner_BaseSign_sign_justice_revoked_htlc(this_arg: *const c_void, mut justice_tx: crate::c_types::Transaction, mut input: usize, mut amount: u64, per_commitment_key: *const [u8; 32], htlc: &crate::lightning::ln::chan_utils::HTLCOutputInCommitment) -> crate::c_types::derived::CResult_SignatureNoneZ {
1653 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::sign_justice_revoked_htlc(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, &justice_tx.into_bitcoin(), input, amount, &::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *per_commitment_key}[..]).unwrap(), htlc.get_native_ref(), secp256k1::global::SECP256K1);
1654 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::Signature::from_rust(&o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1658 extern "C" fn InMemorySigner_BaseSign_sign_counterparty_htlc_transaction(this_arg: *const c_void, mut htlc_tx: crate::c_types::Transaction, mut input: usize, mut amount: u64, mut per_commitment_point: crate::c_types::PublicKey, htlc: &crate::lightning::ln::chan_utils::HTLCOutputInCommitment) -> crate::c_types::derived::CResult_SignatureNoneZ {
1659 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::sign_counterparty_htlc_transaction(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, &htlc_tx.into_bitcoin(), input, amount, &per_commitment_point.into_rust(), htlc.get_native_ref(), secp256k1::global::SECP256K1);
1660 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::Signature::from_rust(&o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1664 extern "C" fn InMemorySigner_BaseSign_sign_closing_transaction(this_arg: *const c_void, closing_tx: &crate::lightning::ln::chan_utils::ClosingTransaction) -> crate::c_types::derived::CResult_SignatureNoneZ {
1665 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::sign_closing_transaction(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, closing_tx.get_native_ref(), secp256k1::global::SECP256K1);
1666 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::Signature::from_rust(&o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1670 extern "C" fn InMemorySigner_BaseSign_sign_holder_anchor_input(this_arg: *const c_void, mut anchor_tx: crate::c_types::Transaction, mut input: usize) -> crate::c_types::derived::CResult_SignatureNoneZ {
1671 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::sign_holder_anchor_input(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, &anchor_tx.into_bitcoin(), input, secp256k1::global::SECP256K1);
1672 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::Signature::from_rust(&o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1676 extern "C" fn InMemorySigner_BaseSign_sign_channel_announcement(this_arg: *const c_void, msg: &crate::lightning::ln::msgs::UnsignedChannelAnnouncement) -> crate::c_types::derived::CResult_C2Tuple_SignatureSignatureZNoneZ {
1677 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::sign_channel_announcement(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, msg.get_native_ref(), secp256k1::global::SECP256K1);
1678 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { let (mut orig_ret_0_0, mut orig_ret_0_1) = o; let mut local_ret_0 = (crate::c_types::Signature::from_rust(&orig_ret_0_0), crate::c_types::Signature::from_rust(&orig_ret_0_1)).into(); local_ret_0 }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1681 extern "C" fn InMemorySigner_BaseSign_provide_channel_parameters(this_arg: *mut c_void, channel_parameters: &crate::lightning::ln::chan_utils::ChannelTransactionParameters) {
1682 <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::provide_channel_parameters(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, channel_parameters.get_native_ref())
1685 impl From<nativeInMemorySigner> for crate::lightning::chain::keysinterface::Sign {
1686 fn from(obj: nativeInMemorySigner) -> Self {
1687 let mut rust_obj = InMemorySigner { inner: ObjOps::heap_alloc(obj), is_owned: true };
1688 let mut ret = InMemorySigner_as_Sign(&rust_obj);
1689 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so wipe rust_obj's pointer and set ret's free() fn
1690 rust_obj.inner = core::ptr::null_mut();
1691 ret.free = Some(InMemorySigner_free_void);
1695 /// Constructs a new Sign which calls the relevant methods on this_arg.
1696 /// This copies the `inner` pointer in this_arg and thus the returned Sign must be freed before this_arg is
1698 pub extern "C" fn InMemorySigner_as_Sign(this_arg: &InMemorySigner) -> crate::lightning::chain::keysinterface::Sign {
1699 crate::lightning::chain::keysinterface::Sign {
1700 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
1702 BaseSign: crate::lightning::chain::keysinterface::BaseSign {
1703 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
1705 get_per_commitment_point: InMemorySigner_BaseSign_get_per_commitment_point,
1706 release_commitment_secret: InMemorySigner_BaseSign_release_commitment_secret,
1707 validate_holder_commitment: InMemorySigner_BaseSign_validate_holder_commitment,
1709 pubkeys: crate::lightning::ln::chan_utils::ChannelPublicKeys { inner: core::ptr::null_mut(), is_owned: true },
1710 set_pubkeys: Some(InMemorySigner_BaseSign_set_pubkeys),
1711 channel_keys_id: InMemorySigner_BaseSign_channel_keys_id,
1712 sign_counterparty_commitment: InMemorySigner_BaseSign_sign_counterparty_commitment,
1713 validate_counterparty_revocation: InMemorySigner_BaseSign_validate_counterparty_revocation,
1714 sign_holder_commitment_and_htlcs: InMemorySigner_BaseSign_sign_holder_commitment_and_htlcs,
1715 sign_justice_revoked_output: InMemorySigner_BaseSign_sign_justice_revoked_output,
1716 sign_justice_revoked_htlc: InMemorySigner_BaseSign_sign_justice_revoked_htlc,
1717 sign_counterparty_htlc_transaction: InMemorySigner_BaseSign_sign_counterparty_htlc_transaction,
1718 sign_closing_transaction: InMemorySigner_BaseSign_sign_closing_transaction,
1719 sign_holder_anchor_input: InMemorySigner_BaseSign_sign_holder_anchor_input,
1720 sign_channel_announcement: InMemorySigner_BaseSign_sign_channel_announcement,
1721 provide_channel_parameters: InMemorySigner_BaseSign_provide_channel_parameters,
1723 write: InMemorySigner_write_void,
1729 /// Serialize the InMemorySigner object into a byte array which can be read by InMemorySigner_read
1730 pub extern "C" fn InMemorySigner_write(obj: &crate::lightning::chain::keysinterface::InMemorySigner) -> crate::c_types::derived::CVec_u8Z {
1731 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
1734 pub(crate) extern "C" fn InMemorySigner_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1735 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeInMemorySigner) })
1738 /// Read a InMemorySigner from a byte array, created by InMemorySigner_write
1739 pub extern "C" fn InMemorySigner_read(ser: crate::c_types::u8slice, arg: crate::c_types::SecretKey) -> crate::c_types::derived::CResult_InMemorySignerDecodeErrorZ {
1740 let arg_conv = arg.into_rust();
1741 let res: Result<lightning::chain::keysinterface::InMemorySigner, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj_arg(ser, arg_conv);
1742 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::chain::keysinterface::InMemorySigner { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
1746 use lightning::chain::keysinterface::KeysManager as nativeKeysManagerImport;
1747 pub(crate) type nativeKeysManager = nativeKeysManagerImport;
1749 /// Simple [`KeysInterface`] implementation that takes a 32-byte seed for use as a BIP 32 extended
1750 /// key and derives keys from that.
1752 /// Your `node_id` is seed/0'.
1753 /// Unilateral closes may use seed/1'.
1754 /// Cooperative closes may use seed/2'.
1755 /// The two close keys may be needed to claim on-chain funds!
1757 /// This struct cannot be used for nodes that wish to support receiving phantom payments;
1758 /// [`PhantomKeysManager`] must be used instead.
1760 /// Note that switching between this struct and [`PhantomKeysManager`] will invalidate any
1761 /// previously issued invoices and attempts to pay previous invoices will fail.
1764 pub struct KeysManager {
1765 /// A pointer to the opaque Rust object.
1767 /// Nearly everywhere, inner must be non-null, however in places where
1768 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1769 pub inner: *mut nativeKeysManager,
1770 /// Indicates that this is the only struct which contains the same pointer.
1772 /// Rust functions which take ownership of an object provided via an argument require
1773 /// this to be true and invalidate the object pointed to by inner.
1777 impl Drop for KeysManager {
1778 fn drop(&mut self) {
1779 if self.is_owned && !<*mut nativeKeysManager>::is_null(self.inner) {
1780 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1784 /// Frees any resources used by the KeysManager, if is_owned is set and inner is non-NULL.
1786 pub extern "C" fn KeysManager_free(this_obj: KeysManager) { }
1788 /// Used only if an object of this type is returned as a trait impl by a method
1789 pub(crate) extern "C" fn KeysManager_free_void(this_ptr: *mut c_void) {
1790 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeKeysManager) };
1794 pub(crate) fn get_native_ref(&self) -> &'static nativeKeysManager {
1795 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1797 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeKeysManager {
1798 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1800 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1801 pub(crate) fn take_inner(mut self) -> *mut nativeKeysManager {
1802 assert!(self.is_owned);
1803 let ret = ObjOps::untweak_ptr(self.inner);
1804 self.inner = core::ptr::null_mut();
1808 /// Constructs a [`KeysManager`] from a 32-byte seed. If the seed is in some way biased (e.g.,
1809 /// your CSRNG is busted) this may panic (but more importantly, you will possibly lose funds).
1810 /// `starting_time` isn't strictly required to actually be a time, but it must absolutely,
1811 /// without a doubt, be unique to this instance. ie if you start multiple times with the same
1812 /// `seed`, `starting_time` must be unique to each run. Thus, the easiest way to achieve this
1813 /// is to simply use the current time (with very high precision).
1815 /// The `seed` MUST be backed up safely prior to use so that the keys can be re-created, however,
1816 /// obviously, `starting_time` should be unique every time you reload the library - it is only
1817 /// used to generate new ephemeral key data (which will be stored by the individual channel if
1820 /// Note that the seed is required to recover certain on-chain funds independent of
1821 /// [`ChannelMonitor`] data, though a current copy of [`ChannelMonitor`] data is also required
1822 /// for any channel, and some on-chain during-closing funds.
1824 /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
1827 pub extern "C" fn KeysManager_new(seed: *const [u8; 32], mut starting_time_secs: u64, mut starting_time_nanos: u32) -> crate::lightning::chain::keysinterface::KeysManager {
1828 let mut ret = lightning::chain::keysinterface::KeysManager::new(unsafe { &*seed}, starting_time_secs, starting_time_nanos);
1829 crate::lightning::chain::keysinterface::KeysManager { inner: ObjOps::heap_alloc(ret), is_owned: true }
1832 /// Derive an old [`Sign`] containing per-channel secrets based on a key derivation parameters.
1835 pub extern "C" fn KeysManager_derive_channel_keys(this_arg: &crate::lightning::chain::keysinterface::KeysManager, mut channel_value_satoshis: u64, params: *const [u8; 32]) -> crate::lightning::chain::keysinterface::InMemorySigner {
1836 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.derive_channel_keys(channel_value_satoshis, unsafe { &*params});
1837 crate::lightning::chain::keysinterface::InMemorySigner { inner: ObjOps::heap_alloc(ret), is_owned: true }
1840 /// Creates a [`Transaction`] which spends the given descriptors to the given outputs, plus an
1841 /// output to the given change destination (if sufficient change value remains). The
1842 /// transaction will have a feerate, at least, of the given value.
1844 /// Returns `Err(())` if the output value is greater than the input value minus required fee,
1845 /// if a descriptor was duplicated, or if an output descriptor `script_pubkey`
1846 /// does not match the one we can spend.
1848 /// We do not enforce that outputs meet the dust limit or that any output scripts are standard.
1850 /// May panic if the [`SpendableOutputDescriptor`]s were not generated by channels which used
1851 /// this [`KeysManager`] or one of the [`InMemorySigner`] created by this [`KeysManager`].
1854 pub extern "C" fn KeysManager_spend_spendable_outputs(this_arg: &crate::lightning::chain::keysinterface::KeysManager, mut descriptors: crate::c_types::derived::CVec_SpendableOutputDescriptorZ, mut outputs: crate::c_types::derived::CVec_TxOutZ, mut change_destination_script: crate::c_types::derived::CVec_u8Z, mut feerate_sat_per_1000_weight: u32) -> crate::c_types::derived::CResult_TransactionNoneZ {
1855 let mut local_descriptors = Vec::new(); for mut item in descriptors.into_rust().drain(..) { local_descriptors.push( { item.into_native() }); };
1856 let mut local_outputs = Vec::new(); for mut item in outputs.into_rust().drain(..) { local_outputs.push( { item.into_rust() }); };
1857 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.spend_spendable_outputs(&local_descriptors.iter().collect::<Vec<_>>()[..], local_outputs, ::bitcoin::blockdata::script::Script::from(change_destination_script.into_rust()), feerate_sat_per_1000_weight, secp256k1::global::SECP256K1);
1858 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::Transaction::from_bitcoin(&o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1862 impl From<nativeKeysManager> for crate::lightning::chain::keysinterface::KeysInterface {
1863 fn from(obj: nativeKeysManager) -> Self {
1864 let mut rust_obj = KeysManager { inner: ObjOps::heap_alloc(obj), is_owned: true };
1865 let mut ret = KeysManager_as_KeysInterface(&rust_obj);
1866 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so wipe rust_obj's pointer and set ret's free() fn
1867 rust_obj.inner = core::ptr::null_mut();
1868 ret.free = Some(KeysManager_free_void);
1872 /// Constructs a new KeysInterface which calls the relevant methods on this_arg.
1873 /// This copies the `inner` pointer in this_arg and thus the returned KeysInterface must be freed before this_arg is
1875 pub extern "C" fn KeysManager_as_KeysInterface(this_arg: &KeysManager) -> crate::lightning::chain::keysinterface::KeysInterface {
1876 crate::lightning::chain::keysinterface::KeysInterface {
1877 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
1879 get_node_secret: KeysManager_KeysInterface_get_node_secret,
1880 get_node_id: KeysManager_KeysInterface_get_node_id,
1881 ecdh: KeysManager_KeysInterface_ecdh,
1882 get_destination_script: KeysManager_KeysInterface_get_destination_script,
1883 get_shutdown_scriptpubkey: KeysManager_KeysInterface_get_shutdown_scriptpubkey,
1884 generate_channel_keys_id: KeysManager_KeysInterface_generate_channel_keys_id,
1885 derive_channel_signer: KeysManager_KeysInterface_derive_channel_signer,
1886 get_secure_random_bytes: KeysManager_KeysInterface_get_secure_random_bytes,
1887 read_chan_signer: KeysManager_KeysInterface_read_chan_signer,
1888 sign_invoice: KeysManager_KeysInterface_sign_invoice,
1889 get_inbound_payment_key_material: KeysManager_KeysInterface_get_inbound_payment_key_material,
1894 extern "C" fn KeysManager_KeysInterface_get_node_secret(this_arg: *const c_void, mut recipient: crate::lightning::chain::keysinterface::Recipient) -> crate::c_types::derived::CResult_SecretKeyNoneZ {
1895 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_node_secret(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, recipient.into_native());
1896 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::SecretKey::from_rust(o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1900 extern "C" fn KeysManager_KeysInterface_get_node_id(this_arg: *const c_void, mut recipient: crate::lightning::chain::keysinterface::Recipient) -> crate::c_types::derived::CResult_PublicKeyNoneZ {
1901 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_node_id(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, recipient.into_native());
1902 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::PublicKey::from_rust(&o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1906 extern "C" fn KeysManager_KeysInterface_ecdh(this_arg: *const c_void, mut recipient: crate::lightning::chain::keysinterface::Recipient, mut other_key: crate::c_types::PublicKey, mut tweak: crate::c_types::derived::COption_ScalarZ) -> crate::c_types::derived::CResult_SharedSecretNoneZ {
1907 let mut local_tweak_base = { /* tweak*/ let tweak_opt = tweak; { } if tweak_opt.is_none() { None } else { Some({ tweak_opt.take().into_rust() }) } }; let mut local_tweak = local_tweak_base.as_ref();
1908 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::ecdh(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, recipient.into_native(), &other_key.into_rust(), local_tweak);
1909 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::ThirtyTwoBytes { data: o.secret_bytes() } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1913 extern "C" fn KeysManager_KeysInterface_get_destination_script(this_arg: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1914 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_destination_script(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, );
1915 ret.into_bytes().into()
1918 extern "C" fn KeysManager_KeysInterface_get_shutdown_scriptpubkey(this_arg: *const c_void) -> crate::lightning::ln::script::ShutdownScript {
1919 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_shutdown_scriptpubkey(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, );
1920 crate::lightning::ln::script::ShutdownScript { inner: ObjOps::heap_alloc(ret), is_owned: true }
1923 extern "C" fn KeysManager_KeysInterface_generate_channel_keys_id(this_arg: *const c_void, mut inbound: bool, mut channel_value_satoshis: u64, mut user_channel_id: crate::c_types::U128) -> crate::c_types::ThirtyTwoBytes {
1924 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::generate_channel_keys_id(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, inbound, channel_value_satoshis, user_channel_id.into());
1925 crate::c_types::ThirtyTwoBytes { data: ret }
1928 extern "C" fn KeysManager_KeysInterface_derive_channel_signer(this_arg: *const c_void, mut channel_value_satoshis: u64, mut channel_keys_id: crate::c_types::ThirtyTwoBytes) -> crate::lightning::chain::keysinterface::Sign {
1929 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::derive_channel_signer(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, channel_value_satoshis, channel_keys_id.data);
1933 extern "C" fn KeysManager_KeysInterface_get_secure_random_bytes(this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes {
1934 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_secure_random_bytes(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, );
1935 crate::c_types::ThirtyTwoBytes { data: ret }
1938 extern "C" fn KeysManager_KeysInterface_read_chan_signer(this_arg: *const c_void, mut reader: crate::c_types::u8slice) -> crate::c_types::derived::CResult_SignDecodeErrorZ {
1939 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::read_chan_signer(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, reader.to_slice());
1940 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { Into::into(o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
1944 extern "C" fn KeysManager_KeysInterface_sign_invoice(this_arg: *const c_void, mut hrp_bytes: crate::c_types::u8slice, mut invoice_data: crate::c_types::derived::CVec_U5Z, mut receipient: crate::lightning::chain::keysinterface::Recipient) -> crate::c_types::derived::CResult_RecoverableSignatureNoneZ {
1945 let mut local_invoice_data = Vec::new(); for mut item in invoice_data.into_rust().drain(..) { local_invoice_data.push( { item.into() }); };
1946 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::sign_invoice(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, hrp_bytes.to_slice(), &local_invoice_data[..], receipient.into_native());
1947 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::RecoverableSignature::from_rust(&o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1951 extern "C" fn KeysManager_KeysInterface_get_inbound_payment_key_material(this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes {
1952 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_inbound_payment_key_material(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, );
1953 crate::c_types::ThirtyTwoBytes { data: ret.0 }
1957 use lightning::chain::keysinterface::PhantomKeysManager as nativePhantomKeysManagerImport;
1958 pub(crate) type nativePhantomKeysManager = nativePhantomKeysManagerImport;
1960 /// Similar to [`KeysManager`], but allows the node using this struct to receive phantom node
1963 /// A phantom node payment is a payment made to a phantom invoice, which is an invoice that can be
1964 /// paid to one of multiple nodes. This works because we encode the invoice route hints such that
1965 /// LDK will recognize an incoming payment as destined for a phantom node, and collect the payment
1966 /// itself without ever needing to forward to this fake node.
1968 /// Phantom node payments are useful for load balancing between multiple LDK nodes. They also
1969 /// provide some fault tolerance, because payers will automatically retry paying other provided
1970 /// nodes in the case that one node goes down.
1972 /// Note that multi-path payments are not supported in phantom invoices for security reasons.
1973 /// Switching between this struct and [`KeysManager`] will invalidate any previously issued
1974 /// invoices and attempts to pay previous invoices will fail.
1977 pub struct PhantomKeysManager {
1978 /// A pointer to the opaque Rust object.
1980 /// Nearly everywhere, inner must be non-null, however in places where
1981 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1982 pub inner: *mut nativePhantomKeysManager,
1983 /// Indicates that this is the only struct which contains the same pointer.
1985 /// Rust functions which take ownership of an object provided via an argument require
1986 /// this to be true and invalidate the object pointed to by inner.
1990 impl Drop for PhantomKeysManager {
1991 fn drop(&mut self) {
1992 if self.is_owned && !<*mut nativePhantomKeysManager>::is_null(self.inner) {
1993 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1997 /// Frees any resources used by the PhantomKeysManager, if is_owned is set and inner is non-NULL.
1999 pub extern "C" fn PhantomKeysManager_free(this_obj: PhantomKeysManager) { }
2001 /// Used only if an object of this type is returned as a trait impl by a method
2002 pub(crate) extern "C" fn PhantomKeysManager_free_void(this_ptr: *mut c_void) {
2003 let _ = unsafe { Box::from_raw(this_ptr as *mut nativePhantomKeysManager) };
2006 impl PhantomKeysManager {
2007 pub(crate) fn get_native_ref(&self) -> &'static nativePhantomKeysManager {
2008 unsafe { &*ObjOps::untweak_ptr(self.inner) }
2010 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativePhantomKeysManager {
2011 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
2013 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
2014 pub(crate) fn take_inner(mut self) -> *mut nativePhantomKeysManager {
2015 assert!(self.is_owned);
2016 let ret = ObjOps::untweak_ptr(self.inner);
2017 self.inner = core::ptr::null_mut();
2021 impl From<nativePhantomKeysManager> for crate::lightning::chain::keysinterface::KeysInterface {
2022 fn from(obj: nativePhantomKeysManager) -> Self {
2023 let mut rust_obj = PhantomKeysManager { inner: ObjOps::heap_alloc(obj), is_owned: true };
2024 let mut ret = PhantomKeysManager_as_KeysInterface(&rust_obj);
2025 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so wipe rust_obj's pointer and set ret's free() fn
2026 rust_obj.inner = core::ptr::null_mut();
2027 ret.free = Some(PhantomKeysManager_free_void);
2031 /// Constructs a new KeysInterface which calls the relevant methods on this_arg.
2032 /// This copies the `inner` pointer in this_arg and thus the returned KeysInterface must be freed before this_arg is
2034 pub extern "C" fn PhantomKeysManager_as_KeysInterface(this_arg: &PhantomKeysManager) -> crate::lightning::chain::keysinterface::KeysInterface {
2035 crate::lightning::chain::keysinterface::KeysInterface {
2036 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
2038 get_node_secret: PhantomKeysManager_KeysInterface_get_node_secret,
2039 get_node_id: PhantomKeysManager_KeysInterface_get_node_id,
2040 ecdh: PhantomKeysManager_KeysInterface_ecdh,
2041 get_destination_script: PhantomKeysManager_KeysInterface_get_destination_script,
2042 get_shutdown_scriptpubkey: PhantomKeysManager_KeysInterface_get_shutdown_scriptpubkey,
2043 generate_channel_keys_id: PhantomKeysManager_KeysInterface_generate_channel_keys_id,
2044 derive_channel_signer: PhantomKeysManager_KeysInterface_derive_channel_signer,
2045 get_secure_random_bytes: PhantomKeysManager_KeysInterface_get_secure_random_bytes,
2046 read_chan_signer: PhantomKeysManager_KeysInterface_read_chan_signer,
2047 sign_invoice: PhantomKeysManager_KeysInterface_sign_invoice,
2048 get_inbound_payment_key_material: PhantomKeysManager_KeysInterface_get_inbound_payment_key_material,
2053 extern "C" fn PhantomKeysManager_KeysInterface_get_node_secret(this_arg: *const c_void, mut recipient: crate::lightning::chain::keysinterface::Recipient) -> crate::c_types::derived::CResult_SecretKeyNoneZ {
2054 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_node_secret(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, recipient.into_native());
2055 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::SecretKey::from_rust(o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
2059 extern "C" fn PhantomKeysManager_KeysInterface_get_node_id(this_arg: *const c_void, mut recipient: crate::lightning::chain::keysinterface::Recipient) -> crate::c_types::derived::CResult_PublicKeyNoneZ {
2060 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_node_id(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, recipient.into_native());
2061 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::PublicKey::from_rust(&o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
2065 extern "C" fn PhantomKeysManager_KeysInterface_ecdh(this_arg: *const c_void, mut recipient: crate::lightning::chain::keysinterface::Recipient, mut other_key: crate::c_types::PublicKey, mut tweak: crate::c_types::derived::COption_ScalarZ) -> crate::c_types::derived::CResult_SharedSecretNoneZ {
2066 let mut local_tweak_base = { /* tweak*/ let tweak_opt = tweak; { } if tweak_opt.is_none() { None } else { Some({ tweak_opt.take().into_rust() }) } }; let mut local_tweak = local_tweak_base.as_ref();
2067 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::ecdh(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, recipient.into_native(), &other_key.into_rust(), local_tweak);
2068 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::ThirtyTwoBytes { data: o.secret_bytes() } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
2072 extern "C" fn PhantomKeysManager_KeysInterface_get_destination_script(this_arg: *const c_void) -> crate::c_types::derived::CVec_u8Z {
2073 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_destination_script(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, );
2074 ret.into_bytes().into()
2077 extern "C" fn PhantomKeysManager_KeysInterface_get_shutdown_scriptpubkey(this_arg: *const c_void) -> crate::lightning::ln::script::ShutdownScript {
2078 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_shutdown_scriptpubkey(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, );
2079 crate::lightning::ln::script::ShutdownScript { inner: ObjOps::heap_alloc(ret), is_owned: true }
2082 extern "C" fn PhantomKeysManager_KeysInterface_generate_channel_keys_id(this_arg: *const c_void, mut inbound: bool, mut channel_value_satoshis: u64, mut user_channel_id: crate::c_types::U128) -> crate::c_types::ThirtyTwoBytes {
2083 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::generate_channel_keys_id(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, inbound, channel_value_satoshis, user_channel_id.into());
2084 crate::c_types::ThirtyTwoBytes { data: ret }
2087 extern "C" fn PhantomKeysManager_KeysInterface_derive_channel_signer(this_arg: *const c_void, mut channel_value_satoshis: u64, mut channel_keys_id: crate::c_types::ThirtyTwoBytes) -> crate::lightning::chain::keysinterface::Sign {
2088 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::derive_channel_signer(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, channel_value_satoshis, channel_keys_id.data);
2092 extern "C" fn PhantomKeysManager_KeysInterface_get_secure_random_bytes(this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes {
2093 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_secure_random_bytes(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, );
2094 crate::c_types::ThirtyTwoBytes { data: ret }
2097 extern "C" fn PhantomKeysManager_KeysInterface_read_chan_signer(this_arg: *const c_void, mut reader: crate::c_types::u8slice) -> crate::c_types::derived::CResult_SignDecodeErrorZ {
2098 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::read_chan_signer(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, reader.to_slice());
2099 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { Into::into(o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
2103 extern "C" fn PhantomKeysManager_KeysInterface_sign_invoice(this_arg: *const c_void, mut hrp_bytes: crate::c_types::u8slice, mut invoice_data: crate::c_types::derived::CVec_U5Z, mut receipient: crate::lightning::chain::keysinterface::Recipient) -> crate::c_types::derived::CResult_RecoverableSignatureNoneZ {
2104 let mut local_invoice_data = Vec::new(); for mut item in invoice_data.into_rust().drain(..) { local_invoice_data.push( { item.into() }); };
2105 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::sign_invoice(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, hrp_bytes.to_slice(), &local_invoice_data[..], receipient.into_native());
2106 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::RecoverableSignature::from_rust(&o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
2110 extern "C" fn PhantomKeysManager_KeysInterface_get_inbound_payment_key_material(this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes {
2111 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_inbound_payment_key_material(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, );
2112 crate::c_types::ThirtyTwoBytes { data: ret.0 }
2115 /// Constructs a [`PhantomKeysManager`] given a 32-byte seed and an additional `cross_node_seed`
2116 /// that is shared across all nodes that intend to participate in [phantom node payments]
2119 /// See [`KeysManager::new`] for more information on `seed`, `starting_time_secs`, and
2120 /// `starting_time_nanos`.
2122 /// `cross_node_seed` must be the same across all phantom payment-receiving nodes and also the
2123 /// same across restarts, or else inbound payments may fail.
2125 /// [phantom node payments]: PhantomKeysManager
2128 pub extern "C" fn PhantomKeysManager_new(seed: *const [u8; 32], mut starting_time_secs: u64, mut starting_time_nanos: u32, cross_node_seed: *const [u8; 32]) -> crate::lightning::chain::keysinterface::PhantomKeysManager {
2129 let mut ret = lightning::chain::keysinterface::PhantomKeysManager::new(unsafe { &*seed}, starting_time_secs, starting_time_nanos, unsafe { &*cross_node_seed});
2130 crate::lightning::chain::keysinterface::PhantomKeysManager { inner: ObjOps::heap_alloc(ret), is_owned: true }
2133 /// See [`KeysManager::spend_spendable_outputs`] for documentation on this method.
2136 pub extern "C" fn PhantomKeysManager_spend_spendable_outputs(this_arg: &crate::lightning::chain::keysinterface::PhantomKeysManager, mut descriptors: crate::c_types::derived::CVec_SpendableOutputDescriptorZ, mut outputs: crate::c_types::derived::CVec_TxOutZ, mut change_destination_script: crate::c_types::derived::CVec_u8Z, mut feerate_sat_per_1000_weight: u32) -> crate::c_types::derived::CResult_TransactionNoneZ {
2137 let mut local_descriptors = Vec::new(); for mut item in descriptors.into_rust().drain(..) { local_descriptors.push( { item.into_native() }); };
2138 let mut local_outputs = Vec::new(); for mut item in outputs.into_rust().drain(..) { local_outputs.push( { item.into_rust() }); };
2139 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.spend_spendable_outputs(&local_descriptors.iter().collect::<Vec<_>>()[..], local_outputs, ::bitcoin::blockdata::script::Script::from(change_destination_script.into_rust()), feerate_sat_per_1000_weight, secp256k1::global::SECP256K1);
2140 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::Transaction::from_bitcoin(&o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
2144 /// See [`KeysManager::derive_channel_keys`] for documentation on this method.
2147 pub extern "C" fn PhantomKeysManager_derive_channel_keys(this_arg: &crate::lightning::chain::keysinterface::PhantomKeysManager, mut channel_value_satoshis: u64, params: *const [u8; 32]) -> crate::lightning::chain::keysinterface::InMemorySigner {
2148 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.derive_channel_keys(channel_value_satoshis, unsafe { &*params});
2149 crate::lightning::chain::keysinterface::InMemorySigner { inner: ObjOps::heap_alloc(ret), is_owned: true }