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 //! keysinterface provides keys into rust-lightning and defines some useful enums which describe
10 //! spendable on-chain outputs which the user owns and is responsible for using just as any other
11 //! on-chain output which is theirs.
13 use alloc::str::FromStr;
14 use core::ffi::c_void;
15 use core::convert::Infallible;
16 use bitcoin::hashes::Hash;
17 use crate::c_types::*;
18 #[cfg(feature="no-std")]
19 use alloc::{vec::Vec, boxed::Box};
22 use lightning::chain::keysinterface::DelayedPaymentOutputDescriptor as nativeDelayedPaymentOutputDescriptorImport;
23 pub(crate) type nativeDelayedPaymentOutputDescriptor = nativeDelayedPaymentOutputDescriptorImport;
25 /// Information about a spendable output to a P2WSH script. See
26 /// SpendableOutputDescriptor::DelayedPaymentOutput for more details on how to spend this.
29 pub struct DelayedPaymentOutputDescriptor {
30 /// A pointer to the opaque Rust object.
32 /// Nearly everywhere, inner must be non-null, however in places where
33 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
34 pub inner: *mut nativeDelayedPaymentOutputDescriptor,
35 /// Indicates that this is the only struct which contains the same pointer.
37 /// Rust functions which take ownership of an object provided via an argument require
38 /// this to be true and invalidate the object pointed to by inner.
42 impl Drop for DelayedPaymentOutputDescriptor {
44 if self.is_owned && !<*mut nativeDelayedPaymentOutputDescriptor>::is_null(self.inner) {
45 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
49 /// Frees any resources used by the DelayedPaymentOutputDescriptor, if is_owned is set and inner is non-NULL.
51 pub extern "C" fn DelayedPaymentOutputDescriptor_free(this_obj: DelayedPaymentOutputDescriptor) { }
53 /// Used only if an object of this type is returned as a trait impl by a method
54 pub(crate) extern "C" fn DelayedPaymentOutputDescriptor_free_void(this_ptr: *mut c_void) {
55 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeDelayedPaymentOutputDescriptor); }
58 impl DelayedPaymentOutputDescriptor {
59 pub(crate) fn get_native_ref(&self) -> &'static nativeDelayedPaymentOutputDescriptor {
60 unsafe { &*ObjOps::untweak_ptr(self.inner) }
62 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeDelayedPaymentOutputDescriptor {
63 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
65 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
66 pub(crate) fn take_inner(mut self) -> *mut nativeDelayedPaymentOutputDescriptor {
67 assert!(self.is_owned);
68 let ret = ObjOps::untweak_ptr(self.inner);
69 self.inner = core::ptr::null_mut();
73 /// The outpoint which is spendable
75 pub extern "C" fn DelayedPaymentOutputDescriptor_get_outpoint(this_ptr: &DelayedPaymentOutputDescriptor) -> crate::lightning::chain::transaction::OutPoint {
76 let mut inner_val = &mut this_ptr.get_native_mut_ref().outpoint;
77 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 }
79 /// The outpoint which is spendable
81 pub extern "C" fn DelayedPaymentOutputDescriptor_set_outpoint(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: crate::lightning::chain::transaction::OutPoint) {
82 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.outpoint = *unsafe { Box::from_raw(val.take_inner()) };
84 /// Per commitment point to derive delayed_payment_key by key holder
86 pub extern "C" fn DelayedPaymentOutputDescriptor_get_per_commitment_point(this_ptr: &DelayedPaymentOutputDescriptor) -> crate::c_types::PublicKey {
87 let mut inner_val = &mut this_ptr.get_native_mut_ref().per_commitment_point;
88 crate::c_types::PublicKey::from_rust(&inner_val)
90 /// Per commitment point to derive delayed_payment_key by key holder
92 pub extern "C" fn DelayedPaymentOutputDescriptor_set_per_commitment_point(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: crate::c_types::PublicKey) {
93 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.per_commitment_point = val.into_rust();
95 /// The nSequence value which must be set in the spending input to satisfy the OP_CSV in
96 /// the witness_script.
98 pub extern "C" fn DelayedPaymentOutputDescriptor_get_to_self_delay(this_ptr: &DelayedPaymentOutputDescriptor) -> u16 {
99 let mut inner_val = &mut this_ptr.get_native_mut_ref().to_self_delay;
102 /// The nSequence value which must be set in the spending input to satisfy the OP_CSV in
103 /// the witness_script.
105 pub extern "C" fn DelayedPaymentOutputDescriptor_set_to_self_delay(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: u16) {
106 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.to_self_delay = val;
108 /// The output which is referenced by the given outpoint
110 pub extern "C" fn DelayedPaymentOutputDescriptor_set_output(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: crate::c_types::TxOut) {
111 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.output = val.into_rust();
113 /// The revocation point specific to the commitment transaction which was broadcast. Used to
114 /// derive the witnessScript for this output.
116 pub extern "C" fn DelayedPaymentOutputDescriptor_get_revocation_pubkey(this_ptr: &DelayedPaymentOutputDescriptor) -> crate::c_types::PublicKey {
117 let mut inner_val = &mut this_ptr.get_native_mut_ref().revocation_pubkey;
118 crate::c_types::PublicKey::from_rust(&inner_val)
120 /// The revocation point specific to the commitment transaction which was broadcast. Used to
121 /// derive the witnessScript for this output.
123 pub extern "C" fn DelayedPaymentOutputDescriptor_set_revocation_pubkey(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: crate::c_types::PublicKey) {
124 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.revocation_pubkey = val.into_rust();
126 /// Arbitrary identification information returned by a call to
127 /// `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
128 /// the channel to spend the output.
130 pub extern "C" fn DelayedPaymentOutputDescriptor_get_channel_keys_id(this_ptr: &DelayedPaymentOutputDescriptor) -> *const [u8; 32] {
131 let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_keys_id;
134 /// Arbitrary identification information returned by a call to
135 /// `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
136 /// the channel to spend the output.
138 pub extern "C" fn DelayedPaymentOutputDescriptor_set_channel_keys_id(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: crate::c_types::ThirtyTwoBytes) {
139 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_keys_id = val.data;
141 /// The value of the channel which this output originated from, possibly indirectly.
143 pub extern "C" fn DelayedPaymentOutputDescriptor_get_channel_value_satoshis(this_ptr: &DelayedPaymentOutputDescriptor) -> u64 {
144 let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_value_satoshis;
147 /// The value of the channel which this output originated from, possibly indirectly.
149 pub extern "C" fn DelayedPaymentOutputDescriptor_set_channel_value_satoshis(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: u64) {
150 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_value_satoshis = val;
152 /// Constructs a new DelayedPaymentOutputDescriptor given each field
155 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 {
156 DelayedPaymentOutputDescriptor { inner: ObjOps::heap_alloc(nativeDelayedPaymentOutputDescriptor {
157 outpoint: *unsafe { Box::from_raw(outpoint_arg.take_inner()) },
158 per_commitment_point: per_commitment_point_arg.into_rust(),
159 to_self_delay: to_self_delay_arg,
160 output: output_arg.into_rust(),
161 revocation_pubkey: revocation_pubkey_arg.into_rust(),
162 channel_keys_id: channel_keys_id_arg.data,
163 channel_value_satoshis: channel_value_satoshis_arg,
166 impl Clone for DelayedPaymentOutputDescriptor {
167 fn clone(&self) -> Self {
169 inner: if <*mut nativeDelayedPaymentOutputDescriptor>::is_null(self.inner) { core::ptr::null_mut() } else {
170 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
176 /// Used only if an object of this type is returned as a trait impl by a method
177 pub(crate) extern "C" fn DelayedPaymentOutputDescriptor_clone_void(this_ptr: *const c_void) -> *mut c_void {
178 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeDelayedPaymentOutputDescriptor)).clone() })) as *mut c_void
181 /// Creates a copy of the DelayedPaymentOutputDescriptor
182 pub extern "C" fn DelayedPaymentOutputDescriptor_clone(orig: &DelayedPaymentOutputDescriptor) -> DelayedPaymentOutputDescriptor {
186 /// Serialize the DelayedPaymentOutputDescriptor object into a byte array which can be read by DelayedPaymentOutputDescriptor_read
187 pub extern "C" fn DelayedPaymentOutputDescriptor_write(obj: &crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor) -> crate::c_types::derived::CVec_u8Z {
188 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
191 pub(crate) extern "C" fn DelayedPaymentOutputDescriptor_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
192 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeDelayedPaymentOutputDescriptor) })
195 /// Read a DelayedPaymentOutputDescriptor from a byte array, created by DelayedPaymentOutputDescriptor_write
196 pub extern "C" fn DelayedPaymentOutputDescriptor_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_DelayedPaymentOutputDescriptorDecodeErrorZ {
197 let res: Result<lightning::chain::keysinterface::DelayedPaymentOutputDescriptor, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
198 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 { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
202 use lightning::chain::keysinterface::StaticPaymentOutputDescriptor as nativeStaticPaymentOutputDescriptorImport;
203 pub(crate) type nativeStaticPaymentOutputDescriptor = nativeStaticPaymentOutputDescriptorImport;
205 /// Information about a spendable output to our \"payment key\". See
206 /// SpendableOutputDescriptor::StaticPaymentOutput for more details on how to spend this.
209 pub struct StaticPaymentOutputDescriptor {
210 /// A pointer to the opaque Rust object.
212 /// Nearly everywhere, inner must be non-null, however in places where
213 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
214 pub inner: *mut nativeStaticPaymentOutputDescriptor,
215 /// Indicates that this is the only struct which contains the same pointer.
217 /// Rust functions which take ownership of an object provided via an argument require
218 /// this to be true and invalidate the object pointed to by inner.
222 impl Drop for StaticPaymentOutputDescriptor {
224 if self.is_owned && !<*mut nativeStaticPaymentOutputDescriptor>::is_null(self.inner) {
225 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
229 /// Frees any resources used by the StaticPaymentOutputDescriptor, if is_owned is set and inner is non-NULL.
231 pub extern "C" fn StaticPaymentOutputDescriptor_free(this_obj: StaticPaymentOutputDescriptor) { }
233 /// Used only if an object of this type is returned as a trait impl by a method
234 pub(crate) extern "C" fn StaticPaymentOutputDescriptor_free_void(this_ptr: *mut c_void) {
235 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeStaticPaymentOutputDescriptor); }
238 impl StaticPaymentOutputDescriptor {
239 pub(crate) fn get_native_ref(&self) -> &'static nativeStaticPaymentOutputDescriptor {
240 unsafe { &*ObjOps::untweak_ptr(self.inner) }
242 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeStaticPaymentOutputDescriptor {
243 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
245 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
246 pub(crate) fn take_inner(mut self) -> *mut nativeStaticPaymentOutputDescriptor {
247 assert!(self.is_owned);
248 let ret = ObjOps::untweak_ptr(self.inner);
249 self.inner = core::ptr::null_mut();
253 /// The outpoint which is spendable
255 pub extern "C" fn StaticPaymentOutputDescriptor_get_outpoint(this_ptr: &StaticPaymentOutputDescriptor) -> crate::lightning::chain::transaction::OutPoint {
256 let mut inner_val = &mut this_ptr.get_native_mut_ref().outpoint;
257 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 }
259 /// The outpoint which is spendable
261 pub extern "C" fn StaticPaymentOutputDescriptor_set_outpoint(this_ptr: &mut StaticPaymentOutputDescriptor, mut val: crate::lightning::chain::transaction::OutPoint) {
262 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.outpoint = *unsafe { Box::from_raw(val.take_inner()) };
264 /// The output which is referenced by the given outpoint
266 pub extern "C" fn StaticPaymentOutputDescriptor_set_output(this_ptr: &mut StaticPaymentOutputDescriptor, mut val: crate::c_types::TxOut) {
267 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.output = val.into_rust();
269 /// Arbitrary identification information returned by a call to
270 /// `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
271 /// the channel to spend the output.
273 pub extern "C" fn StaticPaymentOutputDescriptor_get_channel_keys_id(this_ptr: &StaticPaymentOutputDescriptor) -> *const [u8; 32] {
274 let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_keys_id;
277 /// Arbitrary identification information returned by a call to
278 /// `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
279 /// the channel to spend the output.
281 pub extern "C" fn StaticPaymentOutputDescriptor_set_channel_keys_id(this_ptr: &mut StaticPaymentOutputDescriptor, mut val: crate::c_types::ThirtyTwoBytes) {
282 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_keys_id = val.data;
284 /// The value of the channel which this transactions spends.
286 pub extern "C" fn StaticPaymentOutputDescriptor_get_channel_value_satoshis(this_ptr: &StaticPaymentOutputDescriptor) -> u64 {
287 let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_value_satoshis;
290 /// The value of the channel which this transactions spends.
292 pub extern "C" fn StaticPaymentOutputDescriptor_set_channel_value_satoshis(this_ptr: &mut StaticPaymentOutputDescriptor, mut val: u64) {
293 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_value_satoshis = val;
295 /// Constructs a new StaticPaymentOutputDescriptor given each field
298 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 {
299 StaticPaymentOutputDescriptor { inner: ObjOps::heap_alloc(nativeStaticPaymentOutputDescriptor {
300 outpoint: *unsafe { Box::from_raw(outpoint_arg.take_inner()) },
301 output: output_arg.into_rust(),
302 channel_keys_id: channel_keys_id_arg.data,
303 channel_value_satoshis: channel_value_satoshis_arg,
306 impl Clone for StaticPaymentOutputDescriptor {
307 fn clone(&self) -> Self {
309 inner: if <*mut nativeStaticPaymentOutputDescriptor>::is_null(self.inner) { core::ptr::null_mut() } else {
310 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
316 /// Used only if an object of this type is returned as a trait impl by a method
317 pub(crate) extern "C" fn StaticPaymentOutputDescriptor_clone_void(this_ptr: *const c_void) -> *mut c_void {
318 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeStaticPaymentOutputDescriptor)).clone() })) as *mut c_void
321 /// Creates a copy of the StaticPaymentOutputDescriptor
322 pub extern "C" fn StaticPaymentOutputDescriptor_clone(orig: &StaticPaymentOutputDescriptor) -> StaticPaymentOutputDescriptor {
326 /// Serialize the StaticPaymentOutputDescriptor object into a byte array which can be read by StaticPaymentOutputDescriptor_read
327 pub extern "C" fn StaticPaymentOutputDescriptor_write(obj: &crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor) -> crate::c_types::derived::CVec_u8Z {
328 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
331 pub(crate) extern "C" fn StaticPaymentOutputDescriptor_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
332 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeStaticPaymentOutputDescriptor) })
335 /// Read a StaticPaymentOutputDescriptor from a byte array, created by StaticPaymentOutputDescriptor_write
336 pub extern "C" fn StaticPaymentOutputDescriptor_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_StaticPaymentOutputDescriptorDecodeErrorZ {
337 let res: Result<lightning::chain::keysinterface::StaticPaymentOutputDescriptor, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
338 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 { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
341 /// When on-chain outputs are created by rust-lightning (which our counterparty is not able to
342 /// claim at any point in the future) an event is generated which you must track and be able to
343 /// spend on-chain. The information needed to do this is provided in this enum, including the
344 /// outpoint describing which txid and output index is available, the full output which exists at
345 /// that txid/index, and any keys or other information required to sign.
349 pub enum SpendableOutputDescriptor {
350 /// An output to a script which was provided via KeysInterface directly, either from
351 /// `get_destination_script()` or `get_shutdown_scriptpubkey()`, thus you should already know
352 /// how to spend it. No secret keys are provided as rust-lightning was never given any key.
353 /// These may include outputs from a transaction punishing our counterparty or claiming an HTLC
354 /// on-chain using the payment preimage or after it has timed out.
356 /// The outpoint which is spendable
357 outpoint: crate::lightning::chain::transaction::OutPoint,
358 /// The output which is referenced by the given outpoint.
359 output: crate::c_types::TxOut,
361 /// An output to a P2WSH script which can be spent with a single signature after a CSV delay.
363 /// The witness in the spending input should be:
364 /// <BIP 143 signature> <empty vector> (MINIMALIF standard rule) <provided witnessScript>
366 /// Note that the nSequence field in the spending input must be set to to_self_delay
367 /// (which means the transaction is not broadcastable until at least to_self_delay
368 /// blocks after the outpoint confirms).
370 /// These are generally the result of a \"revocable\" output to us, spendable only by us unless
371 /// it is an output from an old state which we broadcast (which should never happen).
373 /// To derive the delayed_payment key which is used to sign for this input, you must pass the
374 /// holder delayed_payment_base_key (ie the private key which corresponds to the pubkey in
375 /// Sign::pubkeys().delayed_payment_basepoint) and the provided per_commitment_point to
376 /// chan_utils::derive_private_key. The public key can be generated without the secret key
377 /// using chan_utils::derive_public_key and only the delayed_payment_basepoint which appears in
380 /// To derive the revocation_pubkey provided here (which is used in the witness
381 /// script generation), you must pass the counterparty revocation_basepoint (which appears in the
382 /// call to Sign::ready_channel) and the provided per_commitment point
383 /// to chan_utils::derive_public_revocation_key.
385 /// The witness script which is hashed and included in the output script_pubkey may be
386 /// regenerated by passing the revocation_pubkey (derived as above), our delayed_payment pubkey
387 /// (derived as above), and the to_self_delay contained here to
388 /// chan_utils::get_revokeable_redeemscript.
389 DelayedPaymentOutput(
390 crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor),
391 /// An output to a P2WPKH, spendable exclusively by our payment key (ie the private key which
392 /// corresponds to the public key in Sign::pubkeys().payment_point).
393 /// The witness in the spending input, is, thus, simply:
394 /// <BIP 143 signature> <payment key>
396 /// These are generally the result of our counterparty having broadcast the current state,
397 /// allowing us to claim the non-HTLC-encumbered outputs immediately.
399 crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor),
401 use lightning::chain::keysinterface::SpendableOutputDescriptor as SpendableOutputDescriptorImport;
402 pub(crate) type nativeSpendableOutputDescriptor = SpendableOutputDescriptorImport;
404 impl SpendableOutputDescriptor {
406 pub(crate) fn to_native(&self) -> nativeSpendableOutputDescriptor {
408 SpendableOutputDescriptor::StaticOutput {ref outpoint, ref output, } => {
409 let mut outpoint_nonref = (*outpoint).clone();
410 let mut output_nonref = (*output).clone();
411 nativeSpendableOutputDescriptor::StaticOutput {
412 outpoint: *unsafe { Box::from_raw(outpoint_nonref.take_inner()) },
413 output: output_nonref.into_rust(),
416 SpendableOutputDescriptor::DelayedPaymentOutput (ref a, ) => {
417 let mut a_nonref = (*a).clone();
418 nativeSpendableOutputDescriptor::DelayedPaymentOutput (
419 *unsafe { Box::from_raw(a_nonref.take_inner()) },
422 SpendableOutputDescriptor::StaticPaymentOutput (ref a, ) => {
423 let mut a_nonref = (*a).clone();
424 nativeSpendableOutputDescriptor::StaticPaymentOutput (
425 *unsafe { Box::from_raw(a_nonref.take_inner()) },
431 pub(crate) fn into_native(self) -> nativeSpendableOutputDescriptor {
433 SpendableOutputDescriptor::StaticOutput {mut outpoint, mut output, } => {
434 nativeSpendableOutputDescriptor::StaticOutput {
435 outpoint: *unsafe { Box::from_raw(outpoint.take_inner()) },
436 output: output.into_rust(),
439 SpendableOutputDescriptor::DelayedPaymentOutput (mut a, ) => {
440 nativeSpendableOutputDescriptor::DelayedPaymentOutput (
441 *unsafe { Box::from_raw(a.take_inner()) },
444 SpendableOutputDescriptor::StaticPaymentOutput (mut a, ) => {
445 nativeSpendableOutputDescriptor::StaticPaymentOutput (
446 *unsafe { Box::from_raw(a.take_inner()) },
452 pub(crate) fn from_native(native: &nativeSpendableOutputDescriptor) -> Self {
454 nativeSpendableOutputDescriptor::StaticOutput {ref outpoint, ref output, } => {
455 let mut outpoint_nonref = (*outpoint).clone();
456 let mut output_nonref = (*output).clone();
457 SpendableOutputDescriptor::StaticOutput {
458 outpoint: crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(outpoint_nonref), is_owned: true },
459 output: crate::c_types::TxOut::from_rust(output_nonref),
462 nativeSpendableOutputDescriptor::DelayedPaymentOutput (ref a, ) => {
463 let mut a_nonref = (*a).clone();
464 SpendableOutputDescriptor::DelayedPaymentOutput (
465 crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor { inner: ObjOps::heap_alloc(a_nonref), is_owned: true },
468 nativeSpendableOutputDescriptor::StaticPaymentOutput (ref a, ) => {
469 let mut a_nonref = (*a).clone();
470 SpendableOutputDescriptor::StaticPaymentOutput (
471 crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor { inner: ObjOps::heap_alloc(a_nonref), is_owned: true },
477 pub(crate) fn native_into(native: nativeSpendableOutputDescriptor) -> Self {
479 nativeSpendableOutputDescriptor::StaticOutput {mut outpoint, mut output, } => {
480 SpendableOutputDescriptor::StaticOutput {
481 outpoint: crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(outpoint), is_owned: true },
482 output: crate::c_types::TxOut::from_rust(output),
485 nativeSpendableOutputDescriptor::DelayedPaymentOutput (mut a, ) => {
486 SpendableOutputDescriptor::DelayedPaymentOutput (
487 crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor { inner: ObjOps::heap_alloc(a), is_owned: true },
490 nativeSpendableOutputDescriptor::StaticPaymentOutput (mut a, ) => {
491 SpendableOutputDescriptor::StaticPaymentOutput (
492 crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor { inner: ObjOps::heap_alloc(a), is_owned: true },
498 /// Frees any resources used by the SpendableOutputDescriptor
500 pub extern "C" fn SpendableOutputDescriptor_free(this_ptr: SpendableOutputDescriptor) { }
501 /// Creates a copy of the SpendableOutputDescriptor
503 pub extern "C" fn SpendableOutputDescriptor_clone(orig: &SpendableOutputDescriptor) -> SpendableOutputDescriptor {
507 /// Utility method to constructs a new StaticOutput-variant SpendableOutputDescriptor
508 pub extern "C" fn SpendableOutputDescriptor_static_output(outpoint: crate::lightning::chain::transaction::OutPoint, output: crate::c_types::TxOut) -> SpendableOutputDescriptor {
509 SpendableOutputDescriptor::StaticOutput {
515 /// Utility method to constructs a new DelayedPaymentOutput-variant SpendableOutputDescriptor
516 pub extern "C" fn SpendableOutputDescriptor_delayed_payment_output(a: crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor) -> SpendableOutputDescriptor {
517 SpendableOutputDescriptor::DelayedPaymentOutput(a, )
520 /// Utility method to constructs a new StaticPaymentOutput-variant SpendableOutputDescriptor
521 pub extern "C" fn SpendableOutputDescriptor_static_payment_output(a: crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor) -> SpendableOutputDescriptor {
522 SpendableOutputDescriptor::StaticPaymentOutput(a, )
525 /// Serialize the SpendableOutputDescriptor object into a byte array which can be read by SpendableOutputDescriptor_read
526 pub extern "C" fn SpendableOutputDescriptor_write(obj: &crate::lightning::chain::keysinterface::SpendableOutputDescriptor) -> crate::c_types::derived::CVec_u8Z {
527 crate::c_types::serialize_obj(&unsafe { &*obj }.to_native())
530 /// Read a SpendableOutputDescriptor from a byte array, created by SpendableOutputDescriptor_write
531 pub extern "C" fn SpendableOutputDescriptor_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_SpendableOutputDescriptorDecodeErrorZ {
532 let res: Result<lightning::chain::keysinterface::SpendableOutputDescriptor, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
533 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 { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
536 /// A trait to sign lightning channel transactions as described in BOLT 3.
538 /// Signing services could be implemented on a hardware wallet. In this case,
539 /// the current Sign would be a front-end on top of a communication
540 /// channel connected to your secure device and lightning key material wouldn't
541 /// reside on a hot server. Nevertheless, a this deployment would still need
542 /// to trust the ChannelManager to avoid loss of funds as this latest component
543 /// could ask to sign commitment transaction with HTLCs paying to attacker pubkeys.
545 /// A more secure iteration would be to use hashlock (or payment points) to pair
546 /// invoice/incoming HTLCs with outgoing HTLCs to implement a no-trust-ChannelManager
547 /// at the price of more state and computation on the hardware wallet side. In the future,
548 /// we are looking forward to design such interface.
550 /// In any case, ChannelMonitor or fallback watchtowers are always going to be trusted
551 /// to act, as liveness and breach reply correctness are always going to be hard requirements
552 /// of LN security model, orthogonal of key management issues.
554 pub struct BaseSign {
555 /// An opaque pointer which is passed to your function implementations as an argument.
556 /// This has no meaning in the LDK, and can be NULL or any other value.
557 pub this_arg: *mut c_void,
558 /// Gets the per-commitment point for a specific commitment number
560 /// Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
562 pub get_per_commitment_point: extern "C" fn (this_arg: *const c_void, idx: u64) -> crate::c_types::PublicKey,
563 /// Gets the commitment secret for a specific commitment number as part of the revocation process
565 /// An external signer implementation should error here if the commitment was already signed
566 /// and should refuse to sign it in the future.
568 /// May be called more than once for the same index.
570 /// Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
572 pub release_commitment_secret: extern "C" fn (this_arg: *const c_void, idx: u64) -> crate::c_types::ThirtyTwoBytes,
573 /// Validate the counterparty's signatures on the holder commitment transaction and HTLCs.
575 /// This is required in order for the signer to make sure that releasing a commitment
576 /// secret won't leave us without a broadcastable holder transaction.
577 /// Policy checks should be implemented in this function, including checking the amount
578 /// sent to us and checking the HTLCs.
580 /// The preimages of outgoing HTLCs that were fulfilled since the last commitment are provided.
581 /// A validating signer should ensure that an HTLC output is removed only when the matching
582 /// preimage is provided, or when the value to holder is restored.
584 /// NOTE: all the relevant preimages will be provided, but there may also be additional
585 /// irrelevant or duplicate preimages.
587 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,
588 /// Gets the holder's channel public keys and basepoints
589 pub pubkeys: crate::lightning::ln::chan_utils::ChannelPublicKeys,
590 /// Fill in the pubkeys field as a reference to it will be given to Rust after this returns
591 /// Note that this takes a pointer to this object, not the this_ptr like other methods do
592 /// This function pointer may be NULL if pubkeys is filled in when this object is created and never needs updating.
593 pub set_pubkeys: Option<extern "C" fn(&BaseSign)>,
594 /// Gets an arbitrary identifier describing the set of keys which are provided back to you in
595 /// some SpendableOutputDescriptor types. This should be sufficient to identify this
596 /// Sign object uniquely and lookup or re-derive its keys.
598 pub channel_keys_id: extern "C" fn (this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes,
599 /// Create a signature for a counterparty's commitment transaction and associated HTLC transactions.
601 /// Note that if signing fails or is rejected, the channel will be force-closed.
603 /// Policy checks should be implemented in this function, including checking the amount
604 /// sent to us and checking the HTLCs.
606 /// The preimages of outgoing HTLCs that were fulfilled since the last commitment are provided.
607 /// A validating signer should ensure that an HTLC output is removed only when the matching
608 /// preimage is provided, or when the value to holder is restored.
610 /// NOTE: all the relevant preimages will be provided, but there may also be additional
611 /// irrelevant or duplicate preimages.
613 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,
614 /// Validate the counterparty's revocation.
616 /// This is required in order for the signer to make sure that the state has moved
617 /// forward and it is safe to sign the next counterparty commitment.
619 pub validate_counterparty_revocation: extern "C" fn (this_arg: *const c_void, idx: u64, secret: *const [u8; 32]) -> crate::c_types::derived::CResult_NoneNoneZ,
620 /// Create a signatures for a holder's commitment transaction and its claiming HTLC transactions.
621 /// This will only ever be called with a non-revoked commitment_tx. This will be called with the
622 /// latest commitment_tx when we initiate a force-close.
623 /// This will be called with the previous latest, just to get claiming HTLC signatures, if we are
624 /// reacting to a ChannelMonitor replica that decided to broadcast before it had been updated to
626 /// This may be called multiple times for the same transaction.
628 /// An external signer implementation should check that the commitment has not been revoked.
630 /// May return Err if key derivation fails. Callers, such as ChannelMonitor, will panic in such a case.
632 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,
633 /// Create a signature for the given input in a transaction spending an HTLC transaction output
634 /// or a commitment transaction `to_local` output when our counterparty broadcasts an old state.
636 /// A justice transaction may claim multiple outputs at the same time if timelocks are
637 /// similar, but only a signature for the input at index `input` should be signed for here.
638 /// It may be called multiple times for same output(s) if a fee-bump is needed with regards
639 /// to an upcoming timelock expiration.
641 /// Amount is value of the output spent by this input, committed to in the BIP 143 signature.
643 /// per_commitment_key is revocation secret which was provided by our counterparty when they
644 /// revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
645 /// not allow the spending of any funds by itself (you need our holder revocation_secret to do
648 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,
649 /// Create a signature for the given input in a transaction spending a commitment transaction
650 /// HTLC output when our counterparty broadcasts an old state.
652 /// A justice transaction may claim multiple outputs at the same time if timelocks are
653 /// similar, but only a signature for the input at index `input` should be signed for here.
654 /// It may be called multiple times for same output(s) if a fee-bump is needed with regards
655 /// to an upcoming timelock expiration.
657 /// Amount is value of the output spent by this input, committed to in the BIP 143 signature.
659 /// per_commitment_key is revocation secret which was provided by our counterparty when they
660 /// revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
661 /// not allow the spending of any funds by itself (you need our holder revocation_secret to do
664 /// htlc holds HTLC elements (hash, timelock), thus changing the format of the witness script
665 /// (which is committed to in the BIP 143 signatures).
667 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,
668 /// Create a signature for a claiming transaction for a HTLC output on a counterparty's commitment
669 /// transaction, either offered or received.
671 /// Such a transaction may claim multiples offered outputs at same time if we know the
672 /// preimage for each when we create it, but only the input at index `input` should be
673 /// signed for here. It may be called multiple times for same output(s) if a fee-bump is
674 /// needed with regards to an upcoming timelock expiration.
676 /// Witness_script is either a offered or received script as defined in BOLT3 for HTLC
679 /// Amount is value of the output spent by this input, committed to in the BIP 143 signature.
681 /// Per_commitment_point is the dynamic point corresponding to the channel state
682 /// detected onchain. It has been generated by our counterparty and is used to derive
683 /// channel state keys, which are then included in the witness script and committed to in the
684 /// BIP 143 signature.
686 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,
687 /// Create a signature for a (proposed) closing transaction.
689 /// Note that, due to rounding, there may be one \"missing\" satoshi, and either party may have
690 /// chosen to forgo their output as dust.
692 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,
693 /// Signs a channel announcement message with our funding key and our node secret key (aka
694 /// node_id or network_key), proving it comes from one of the channel participants.
696 /// The first returned signature should be from our node secret key, the second from our
699 /// Note that if this fails or is rejected, the channel will not be publicly announced and
700 /// our counterparty may (though likely will not) close the channel on us for violating the
703 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,
704 /// Set the counterparty static channel data, including basepoints,
705 /// counterparty_selected/holder_selected_contest_delay and funding outpoint.
706 /// This is done as soon as the funding outpoint is known. Since these are static channel data,
707 /// they MUST NOT be allowed to change to different values once set.
709 /// channel_parameters.is_populated() MUST be true.
711 /// We bind holder_selected_contest_delay late here for API convenience.
713 /// Will be called before any signatures are applied.
714 pub ready_channel: extern "C" fn (this_arg: *mut c_void, channel_parameters: &crate::lightning::ln::chan_utils::ChannelTransactionParameters),
715 /// Frees any resources associated with this object given its this_arg pointer.
716 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
717 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
719 unsafe impl Send for BaseSign {}
720 unsafe impl Sync for BaseSign {}
722 pub(crate) extern "C" fn BaseSign_clone_fields(orig: &BaseSign) -> BaseSign {
724 this_arg: orig.this_arg,
725 get_per_commitment_point: Clone::clone(&orig.get_per_commitment_point),
726 release_commitment_secret: Clone::clone(&orig.release_commitment_secret),
727 validate_holder_commitment: Clone::clone(&orig.validate_holder_commitment),
728 pubkeys: Clone::clone(&orig.pubkeys),
729 set_pubkeys: Clone::clone(&orig.set_pubkeys),
730 channel_keys_id: Clone::clone(&orig.channel_keys_id),
731 sign_counterparty_commitment: Clone::clone(&orig.sign_counterparty_commitment),
732 validate_counterparty_revocation: Clone::clone(&orig.validate_counterparty_revocation),
733 sign_holder_commitment_and_htlcs: Clone::clone(&orig.sign_holder_commitment_and_htlcs),
734 sign_justice_revoked_output: Clone::clone(&orig.sign_justice_revoked_output),
735 sign_justice_revoked_htlc: Clone::clone(&orig.sign_justice_revoked_htlc),
736 sign_counterparty_htlc_transaction: Clone::clone(&orig.sign_counterparty_htlc_transaction),
737 sign_closing_transaction: Clone::clone(&orig.sign_closing_transaction),
738 sign_channel_announcement: Clone::clone(&orig.sign_channel_announcement),
739 ready_channel: Clone::clone(&orig.ready_channel),
740 free: Clone::clone(&orig.free),
744 use lightning::chain::keysinterface::BaseSign as rustBaseSign;
745 impl rustBaseSign for BaseSign {
746 fn get_per_commitment_point(&self, mut idx: u64, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> bitcoin::secp256k1::PublicKey {
747 let mut ret = (self.get_per_commitment_point)(self.this_arg, idx);
750 fn release_commitment_secret(&self, mut idx: u64) -> [u8; 32] {
751 let mut ret = (self.release_commitment_secret)(self.this_arg, idx);
754 fn validate_holder_commitment(&self, mut holder_tx: &lightning::ln::chan_utils::HolderCommitmentTransaction, mut preimages: Vec<lightning::ln::PaymentPreimage>) -> Result<(), ()> {
755 let mut local_preimages = Vec::new(); for mut item in preimages.drain(..) { local_preimages.push( { crate::c_types::ThirtyTwoBytes { data: item.0 } }); };
756 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());
757 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)) })*/ })};
760 fn pubkeys(&self) -> &lightning::ln::chan_utils::ChannelPublicKeys {
761 if let Some(f) = self.set_pubkeys {
764 self.pubkeys.get_native_ref()
766 fn channel_keys_id(&self) -> [u8; 32] {
767 let mut ret = (self.channel_keys_id)(self.this_arg);
770 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>), ()> {
771 let mut local_preimages = Vec::new(); for mut item in preimages.drain(..) { local_preimages.push( { crate::c_types::ThirtyTwoBytes { data: item.0 } }); };
772 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());
773 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)) })*/ })};
776 fn validate_counterparty_revocation(&self, mut idx: u64, mut secret: &bitcoin::secp256k1::SecretKey) -> Result<(), ()> {
777 let mut ret = (self.validate_counterparty_revocation)(self.this_arg, idx, secret.as_ref());
778 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)) })*/ })};
781 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>), ()> {
782 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 });
783 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)) })*/ })};
786 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, ()> {
787 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());
788 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)) })*/ })};
791 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, ()> {
792 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 });
793 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)) })*/ })};
796 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, ()> {
797 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 });
798 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)) })*/ })};
801 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, ()> {
802 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 });
803 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)) })*/ })};
806 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), ()> {
807 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 });
808 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)) })*/ })};
811 fn ready_channel(&mut self, mut channel_parameters: &lightning::ln::chan_utils::ChannelTransactionParameters) {
812 (self.ready_channel)(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 })
816 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
817 // directly as a Deref trait in higher-level structs:
818 impl core::ops::Deref for BaseSign {
820 fn deref(&self) -> &Self {
824 /// Calls the free function if one is set
826 pub extern "C" fn BaseSign_free(this_ptr: BaseSign) { }
827 impl Drop for BaseSign {
829 if let Some(f) = self.free {
834 /// A cloneable signer.
836 /// Although we require signers to be cloneable, it may be useful for developers to be able to use
837 /// signers in an un-sized way, for example as `dyn BaseSign`. Therefore we separate the Clone trait,
838 /// which implies Sized, into this derived trait.
841 /// An opaque pointer which is passed to your function implementations as an argument.
842 /// This has no meaning in the LDK, and can be NULL or any other value.
843 pub this_arg: *mut c_void,
844 /// Implementation of BaseSign for this object.
845 pub BaseSign: crate::lightning::chain::keysinterface::BaseSign,
846 /// Serialize the object into a byte array
847 pub write: extern "C" fn (this_arg: *const c_void) -> crate::c_types::derived::CVec_u8Z,
848 /// Called, if set, after this Sign has been cloned into a duplicate object.
849 /// The new Sign is provided, and should be mutated as needed to perform a
850 /// deep copy of the object pointed to by this_arg or avoid any double-freeing.
851 pub cloned: Option<extern "C" fn (new_Sign: &mut Sign)>,
852 /// Frees any resources associated with this object given its this_arg pointer.
853 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
854 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
856 unsafe impl Send for Sign {}
857 unsafe impl Sync for Sign {}
859 pub(crate) extern "C" fn Sign_clone_fields(orig: &Sign) -> Sign {
861 this_arg: orig.this_arg,
862 BaseSign: crate::lightning::chain::keysinterface::BaseSign_clone_fields(&orig.BaseSign),
863 write: Clone::clone(&orig.write),
864 cloned: Clone::clone(&orig.cloned),
865 free: Clone::clone(&orig.free),
868 impl lightning::chain::keysinterface::BaseSign for Sign {
869 fn get_per_commitment_point(&self, mut idx: u64, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> bitcoin::secp256k1::PublicKey {
870 let mut ret = (self.BaseSign.get_per_commitment_point)(self.BaseSign.this_arg, idx);
873 fn release_commitment_secret(&self, mut idx: u64) -> [u8; 32] {
874 let mut ret = (self.BaseSign.release_commitment_secret)(self.BaseSign.this_arg, idx);
877 fn validate_holder_commitment(&self, mut holder_tx: &lightning::ln::chan_utils::HolderCommitmentTransaction, mut preimages: Vec<lightning::ln::PaymentPreimage>) -> Result<(), ()> {
878 let mut local_preimages = Vec::new(); for mut item in preimages.drain(..) { local_preimages.push( { crate::c_types::ThirtyTwoBytes { data: item.0 } }); };
879 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());
880 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)) })*/ })};
883 fn pubkeys(&self) -> &lightning::ln::chan_utils::ChannelPublicKeys {
884 if let Some(f) = self.BaseSign.set_pubkeys {
887 self.BaseSign.pubkeys.get_native_ref()
889 fn channel_keys_id(&self) -> [u8; 32] {
890 let mut ret = (self.BaseSign.channel_keys_id)(self.BaseSign.this_arg);
893 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>), ()> {
894 let mut local_preimages = Vec::new(); for mut item in preimages.drain(..) { local_preimages.push( { crate::c_types::ThirtyTwoBytes { data: item.0 } }); };
895 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());
896 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)) })*/ })};
899 fn validate_counterparty_revocation(&self, mut idx: u64, mut secret: &bitcoin::secp256k1::SecretKey) -> Result<(), ()> {
900 let mut ret = (self.BaseSign.validate_counterparty_revocation)(self.BaseSign.this_arg, idx, secret.as_ref());
901 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)) })*/ })};
904 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>), ()> {
905 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 });
906 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)) })*/ })};
909 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, ()> {
910 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());
911 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)) })*/ })};
914 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, ()> {
915 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 });
916 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)) })*/ })};
919 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, ()> {
920 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 });
921 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)) })*/ })};
924 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, ()> {
925 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 });
926 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)) })*/ })};
929 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), ()> {
930 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 });
931 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)) })*/ })};
934 fn ready_channel(&mut self, mut channel_parameters: &lightning::ln::chan_utils::ChannelTransactionParameters) {
935 (self.BaseSign.ready_channel)(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 })
938 impl lightning::util::ser::Writeable for Sign {
939 fn write<W: lightning::util::ser::Writer>(&self, w: &mut W) -> Result<(), crate::c_types::io::Error> {
940 let vec = (self.write)(self.this_arg);
941 w.write_all(vec.as_slice())
945 /// Creates a copy of a Sign
946 pub extern "C" fn Sign_clone(orig: &Sign) -> Sign {
947 let mut res = Sign_clone_fields(orig);
948 if let Some(f) = orig.cloned { (f)(&mut res) };
951 impl Clone for Sign {
952 fn clone(&self) -> Self {
957 use lightning::chain::keysinterface::Sign as rustSign;
958 impl rustSign for Sign {
961 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
962 // directly as a Deref trait in higher-level structs:
963 impl core::ops::Deref for Sign {
965 fn deref(&self) -> &Self {
969 /// Calls the free function if one is set
971 pub extern "C" fn Sign_free(this_ptr: Sign) { }
974 if let Some(f) = self.free {
979 /// Specifies the recipient of an invoice, to indicate to [`KeysInterface::sign_invoice`] what node
980 /// secret key should be used to sign the invoice.
985 /// The invoice should be signed with the local node secret key.
987 /// The invoice should be signed with the phantom node secret key. This secret key must be the
988 /// same for all nodes participating in the [phantom node payment].
990 /// [phantom node payment]: PhantomKeysManager
993 use lightning::chain::keysinterface::Recipient as RecipientImport;
994 pub(crate) type nativeRecipient = RecipientImport;
998 pub(crate) fn to_native(&self) -> nativeRecipient {
1000 Recipient::Node => nativeRecipient::Node,
1001 Recipient::PhantomNode => nativeRecipient::PhantomNode,
1005 pub(crate) fn into_native(self) -> nativeRecipient {
1007 Recipient::Node => nativeRecipient::Node,
1008 Recipient::PhantomNode => nativeRecipient::PhantomNode,
1012 pub(crate) fn from_native(native: &nativeRecipient) -> Self {
1014 nativeRecipient::Node => Recipient::Node,
1015 nativeRecipient::PhantomNode => Recipient::PhantomNode,
1019 pub(crate) fn native_into(native: nativeRecipient) -> Self {
1021 nativeRecipient::Node => Recipient::Node,
1022 nativeRecipient::PhantomNode => Recipient::PhantomNode,
1026 /// Creates a copy of the Recipient
1028 pub extern "C" fn Recipient_clone(orig: &Recipient) -> Recipient {
1032 /// Utility method to constructs a new Node-variant Recipient
1033 pub extern "C" fn Recipient_node() -> Recipient {
1036 /// Utility method to constructs a new PhantomNode-variant Recipient
1037 pub extern "C" fn Recipient_phantom_node() -> Recipient {
1038 Recipient::PhantomNode}
1039 /// A trait to describe an object which can get user secrets and key material.
1041 pub struct KeysInterface {
1042 /// An opaque pointer which is passed to your function implementations as an argument.
1043 /// This has no meaning in the LDK, and can be NULL or any other value.
1044 pub this_arg: *mut c_void,
1045 /// Get node secret key (aka node_id or network_key) based on the provided [`Recipient`].
1047 /// This method must return the same value each time it is called with a given `Recipient`
1050 pub get_node_secret: extern "C" fn (this_arg: *const c_void, recipient: crate::lightning::chain::keysinterface::Recipient) -> crate::c_types::derived::CResult_SecretKeyNoneZ,
1051 /// Get a script pubkey which we send funds to when claiming on-chain contestable outputs.
1053 /// This method should return a different value each time it is called, to avoid linking
1054 /// on-chain funds across channels as controlled to the same user.
1056 pub get_destination_script: extern "C" fn (this_arg: *const c_void) -> crate::c_types::derived::CVec_u8Z,
1057 /// Get a script pubkey which we will send funds to when closing a channel.
1059 /// This method should return a different value each time it is called, to avoid linking
1060 /// on-chain funds across channels as controlled to the same user.
1062 pub get_shutdown_scriptpubkey: extern "C" fn (this_arg: *const c_void) -> crate::lightning::ln::script::ShutdownScript,
1063 /// Get a new set of Sign for per-channel secrets. These MUST be unique even if you
1064 /// restarted with some stale data!
1066 /// This method must return a different value each time it is called.
1068 pub get_channel_signer: extern "C" fn (this_arg: *const c_void, inbound: bool, channel_value_satoshis: u64) -> crate::lightning::chain::keysinterface::Sign,
1069 /// Gets a unique, cryptographically-secure, random 32 byte value. This is used for encrypting
1070 /// onion packets and for temporary channel IDs. There is no requirement that these be
1071 /// persisted anywhere, though they must be unique across restarts.
1073 /// This method must return a different value each time it is called.
1075 pub get_secure_random_bytes: extern "C" fn (this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes,
1076 /// Reads a `Signer` for this `KeysInterface` from the given input stream.
1077 /// This is only called during deserialization of other objects which contain
1078 /// `Sign`-implementing objects (ie `ChannelMonitor`s and `ChannelManager`s).
1079 /// The bytes are exactly those which `<Self::Signer as Writeable>::write()` writes, and
1080 /// contain no versioning scheme. You may wish to include your own version prefix and ensure
1081 /// you've read all of the provided bytes to ensure no corruption occurred.
1083 pub read_chan_signer: extern "C" fn (this_arg: *const c_void, reader: crate::c_types::u8slice) -> crate::c_types::derived::CResult_SignDecodeErrorZ,
1084 /// Sign an invoice.
1085 /// By parameterizing by the raw invoice bytes instead of the hash, we allow implementors of
1086 /// this trait to parse the invoice and make sure they're signing what they expect, rather than
1087 /// blindly signing the hash.
1088 /// The hrp is ascii bytes, while the invoice data is base32.
1090 /// The secret key used to sign the invoice is dependent on the [`Recipient`].
1092 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,
1093 /// Get secret key material as bytes for use in encrypting and decrypting inbound payment data.
1095 /// If the implementor of this trait supports [phantom node payments], then every node that is
1096 /// intended to be included in the phantom invoice route hints must return the same value from
1099 /// This method must return the same value each time it is called.
1101 /// [phantom node payments]: PhantomKeysManager
1103 pub get_inbound_payment_key_material: extern "C" fn (this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes,
1104 /// Frees any resources associated with this object given its this_arg pointer.
1105 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
1106 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
1108 unsafe impl Send for KeysInterface {}
1109 unsafe impl Sync for KeysInterface {}
1111 pub(crate) extern "C" fn KeysInterface_clone_fields(orig: &KeysInterface) -> KeysInterface {
1113 this_arg: orig.this_arg,
1114 get_node_secret: Clone::clone(&orig.get_node_secret),
1115 get_destination_script: Clone::clone(&orig.get_destination_script),
1116 get_shutdown_scriptpubkey: Clone::clone(&orig.get_shutdown_scriptpubkey),
1117 get_channel_signer: Clone::clone(&orig.get_channel_signer),
1118 get_secure_random_bytes: Clone::clone(&orig.get_secure_random_bytes),
1119 read_chan_signer: Clone::clone(&orig.read_chan_signer),
1120 sign_invoice: Clone::clone(&orig.sign_invoice),
1121 get_inbound_payment_key_material: Clone::clone(&orig.get_inbound_payment_key_material),
1122 free: Clone::clone(&orig.free),
1126 use lightning::chain::keysinterface::KeysInterface as rustKeysInterface;
1127 impl rustKeysInterface for KeysInterface {
1128 type Signer = crate::lightning::chain::keysinterface::Sign;
1129 fn get_node_secret(&self, mut recipient: lightning::chain::keysinterface::Recipient) -> Result<bitcoin::secp256k1::SecretKey, ()> {
1130 let mut ret = (self.get_node_secret)(self.this_arg, crate::lightning::chain::keysinterface::Recipient::native_into(recipient));
1131 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)) })*/ })};
1134 fn get_destination_script(&self) -> bitcoin::blockdata::script::Script {
1135 let mut ret = (self.get_destination_script)(self.this_arg);
1136 ::bitcoin::blockdata::script::Script::from(ret.into_rust())
1138 fn get_shutdown_scriptpubkey(&self) -> lightning::ln::script::ShutdownScript {
1139 let mut ret = (self.get_shutdown_scriptpubkey)(self.this_arg);
1140 *unsafe { Box::from_raw(ret.take_inner()) }
1142 fn get_channel_signer(&self, mut inbound: bool, mut channel_value_satoshis: u64) -> crate::lightning::chain::keysinterface::Sign {
1143 let mut ret = (self.get_channel_signer)(self.this_arg, inbound, channel_value_satoshis);
1146 fn get_secure_random_bytes(&self) -> [u8; 32] {
1147 let mut ret = (self.get_secure_random_bytes)(self.this_arg);
1150 fn read_chan_signer(&self, mut reader: &[u8]) -> Result<crate::lightning::chain::keysinterface::Sign, lightning::ln::msgs::DecodeError> {
1151 let mut local_reader = crate::c_types::u8slice::from_slice(reader);
1152 let mut ret = (self.read_chan_signer)(self.this_arg, local_reader);
1153 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((*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) }).take_inner()) } })};
1156 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, ()> {
1157 let mut local_hrp_bytes = crate::c_types::u8slice::from_slice(hrp_bytes);
1158 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() }); };
1159 let mut ret = (self.sign_invoice)(self.this_arg, local_hrp_bytes, local_invoice_data.into(), crate::lightning::chain::keysinterface::Recipient::native_into(receipient));
1160 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)) })*/ })};
1163 fn get_inbound_payment_key_material(&self) -> lightning::chain::keysinterface::KeyMaterial {
1164 let mut ret = (self.get_inbound_payment_key_material)(self.this_arg);
1165 ::lightning::chain::keysinterface::KeyMaterial(ret.data)
1169 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
1170 // directly as a Deref trait in higher-level structs:
1171 impl core::ops::Deref for KeysInterface {
1173 fn deref(&self) -> &Self {
1177 /// Calls the free function if one is set
1179 pub extern "C" fn KeysInterface_free(this_ptr: KeysInterface) { }
1180 impl Drop for KeysInterface {
1181 fn drop(&mut self) {
1182 if let Some(f) = self.free {
1188 use lightning::chain::keysinterface::InMemorySigner as nativeInMemorySignerImport;
1189 pub(crate) type nativeInMemorySigner = nativeInMemorySignerImport;
1191 /// A simple implementation of Sign that just keeps the private keys in memory.
1193 /// This implementation performs no policy checks and is insufficient by itself as
1194 /// a secure external signer.
1197 pub struct InMemorySigner {
1198 /// A pointer to the opaque Rust object.
1200 /// Nearly everywhere, inner must be non-null, however in places where
1201 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1202 pub inner: *mut nativeInMemorySigner,
1203 /// Indicates that this is the only struct which contains the same pointer.
1205 /// Rust functions which take ownership of an object provided via an argument require
1206 /// this to be true and invalidate the object pointed to by inner.
1210 impl Drop for InMemorySigner {
1211 fn drop(&mut self) {
1212 if self.is_owned && !<*mut nativeInMemorySigner>::is_null(self.inner) {
1213 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1217 /// Frees any resources used by the InMemorySigner, if is_owned is set and inner is non-NULL.
1219 pub extern "C" fn InMemorySigner_free(this_obj: InMemorySigner) { }
1221 /// Used only if an object of this type is returned as a trait impl by a method
1222 pub(crate) extern "C" fn InMemorySigner_free_void(this_ptr: *mut c_void) {
1223 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeInMemorySigner); }
1226 impl InMemorySigner {
1227 pub(crate) fn get_native_ref(&self) -> &'static nativeInMemorySigner {
1228 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1230 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeInMemorySigner {
1231 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1233 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1234 pub(crate) fn take_inner(mut self) -> *mut nativeInMemorySigner {
1235 assert!(self.is_owned);
1236 let ret = ObjOps::untweak_ptr(self.inner);
1237 self.inner = core::ptr::null_mut();
1241 /// Private key of anchor tx
1243 pub extern "C" fn InMemorySigner_get_funding_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1244 let mut inner_val = &mut this_ptr.get_native_mut_ref().funding_key;
1247 /// Private key of anchor tx
1249 pub extern "C" fn InMemorySigner_set_funding_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1250 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.funding_key = val.into_rust();
1252 /// Holder secret key for blinded revocation pubkey
1254 pub extern "C" fn InMemorySigner_get_revocation_base_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1255 let mut inner_val = &mut this_ptr.get_native_mut_ref().revocation_base_key;
1258 /// Holder secret key for blinded revocation pubkey
1260 pub extern "C" fn InMemorySigner_set_revocation_base_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1261 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.revocation_base_key = val.into_rust();
1263 /// Holder secret key used for our balance in counterparty-broadcasted commitment transactions
1265 pub extern "C" fn InMemorySigner_get_payment_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1266 let mut inner_val = &mut this_ptr.get_native_mut_ref().payment_key;
1269 /// Holder secret key used for our balance in counterparty-broadcasted commitment transactions
1271 pub extern "C" fn InMemorySigner_set_payment_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1272 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.payment_key = val.into_rust();
1274 /// Holder secret key used in HTLC tx
1276 pub extern "C" fn InMemorySigner_get_delayed_payment_base_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1277 let mut inner_val = &mut this_ptr.get_native_mut_ref().delayed_payment_base_key;
1280 /// Holder secret key used in HTLC tx
1282 pub extern "C" fn InMemorySigner_set_delayed_payment_base_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1283 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.delayed_payment_base_key = val.into_rust();
1285 /// Holder htlc secret key used in commitment tx htlc outputs
1287 pub extern "C" fn InMemorySigner_get_htlc_base_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1288 let mut inner_val = &mut this_ptr.get_native_mut_ref().htlc_base_key;
1291 /// Holder htlc secret key used in commitment tx htlc outputs
1293 pub extern "C" fn InMemorySigner_set_htlc_base_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1294 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.htlc_base_key = val.into_rust();
1298 pub extern "C" fn InMemorySigner_get_commitment_seed(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1299 let mut inner_val = &mut this_ptr.get_native_mut_ref().commitment_seed;
1304 pub extern "C" fn InMemorySigner_set_commitment_seed(this_ptr: &mut InMemorySigner, mut val: crate::c_types::ThirtyTwoBytes) {
1305 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.commitment_seed = val.data;
1307 impl Clone for InMemorySigner {
1308 fn clone(&self) -> Self {
1310 inner: if <*mut nativeInMemorySigner>::is_null(self.inner) { core::ptr::null_mut() } else {
1311 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1317 /// Used only if an object of this type is returned as a trait impl by a method
1318 pub(crate) extern "C" fn InMemorySigner_clone_void(this_ptr: *const c_void) -> *mut c_void {
1319 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeInMemorySigner)).clone() })) as *mut c_void
1322 /// Creates a copy of the InMemorySigner
1323 pub extern "C" fn InMemorySigner_clone(orig: &InMemorySigner) -> InMemorySigner {
1326 /// Create a new InMemorySigner
1329 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 {
1330 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);
1331 crate::lightning::chain::keysinterface::InMemorySigner { inner: ObjOps::heap_alloc(ret), is_owned: true }
1334 /// Counterparty pubkeys.
1335 /// Will panic if ready_channel wasn't called.
1338 pub extern "C" fn InMemorySigner_counterparty_pubkeys(this_arg: &crate::lightning::chain::keysinterface::InMemorySigner) -> crate::lightning::ln::chan_utils::ChannelPublicKeys {
1339 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.counterparty_pubkeys();
1340 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 }
1343 /// The contest_delay value specified by our counterparty and applied on holder-broadcastable
1344 /// transactions, ie the amount of time that we have to wait to recover our funds if we
1345 /// broadcast a transaction.
1346 /// Will panic if ready_channel wasn't called.
1349 pub extern "C" fn InMemorySigner_counterparty_selected_contest_delay(this_arg: &crate::lightning::chain::keysinterface::InMemorySigner) -> u16 {
1350 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.counterparty_selected_contest_delay();
1354 /// The contest_delay value specified by us and applied on transactions broadcastable
1355 /// by our counterparty, ie the amount of time that they have to wait to recover their funds
1356 /// if they broadcast a transaction.
1357 /// Will panic if ready_channel wasn't called.
1360 pub extern "C" fn InMemorySigner_holder_selected_contest_delay(this_arg: &crate::lightning::chain::keysinterface::InMemorySigner) -> u16 {
1361 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.holder_selected_contest_delay();
1365 /// Whether the holder is the initiator
1366 /// Will panic if ready_channel wasn't called.
1369 pub extern "C" fn InMemorySigner_is_outbound(this_arg: &crate::lightning::chain::keysinterface::InMemorySigner) -> bool {
1370 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.is_outbound();
1374 /// Funding outpoint
1375 /// Will panic if ready_channel wasn't called.
1378 pub extern "C" fn InMemorySigner_funding_outpoint(this_arg: &crate::lightning::chain::keysinterface::InMemorySigner) -> crate::lightning::chain::transaction::OutPoint {
1379 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.funding_outpoint();
1380 crate::lightning::chain::transaction::OutPoint { inner: unsafe { ObjOps::nonnull_ptr_to_inner((ret as *const lightning::chain::transaction::OutPoint<>) as *mut _) }, is_owned: false }
1383 /// Obtain a ChannelTransactionParameters for this channel, to be used when verifying or
1384 /// building transactions.
1386 /// Will panic if ready_channel wasn't called.
1389 pub extern "C" fn InMemorySigner_get_channel_parameters(this_arg: &crate::lightning::chain::keysinterface::InMemorySigner) -> crate::lightning::ln::chan_utils::ChannelTransactionParameters {
1390 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_channel_parameters();
1391 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 }
1394 /// Whether anchors should be used.
1395 /// Will panic if ready_channel wasn't called.
1398 pub extern "C" fn InMemorySigner_opt_anchors(this_arg: &crate::lightning::chain::keysinterface::InMemorySigner) -> bool {
1399 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.opt_anchors();
1403 /// Sign the single input of spend_tx at index `input_idx` which spends the output
1404 /// described by descriptor, returning the witness stack for the input.
1406 /// Returns an Err if the input at input_idx does not exist, has a non-empty script_sig,
1407 /// is not spending the outpoint described by `descriptor.outpoint`,
1408 /// or if an output descriptor script_pubkey does not match the one we can spend.
1411 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 {
1412 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);
1413 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() };
1417 /// Sign the single input of spend_tx at index `input_idx` which spends the output
1418 /// described by descriptor, returning the witness stack for the input.
1420 /// Returns an Err if the input at input_idx does not exist, has a non-empty script_sig,
1421 /// is not spending the outpoint described by `descriptor.outpoint`, does not have a
1422 /// sequence set to `descriptor.to_self_delay`, or if an output descriptor
1423 /// script_pubkey does not match the one we can spend.
1426 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 {
1427 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);
1428 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() };
1432 impl From<nativeInMemorySigner> for crate::lightning::chain::keysinterface::BaseSign {
1433 fn from(obj: nativeInMemorySigner) -> Self {
1434 let mut rust_obj = InMemorySigner { inner: ObjOps::heap_alloc(obj), is_owned: true };
1435 let mut ret = InMemorySigner_as_BaseSign(&rust_obj);
1436 // 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
1437 rust_obj.inner = core::ptr::null_mut();
1438 ret.free = Some(InMemorySigner_free_void);
1442 /// Constructs a new BaseSign which calls the relevant methods on this_arg.
1443 /// This copies the `inner` pointer in this_arg and thus the returned BaseSign must be freed before this_arg is
1445 pub extern "C" fn InMemorySigner_as_BaseSign(this_arg: &InMemorySigner) -> crate::lightning::chain::keysinterface::BaseSign {
1446 crate::lightning::chain::keysinterface::BaseSign {
1447 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
1449 get_per_commitment_point: InMemorySigner_BaseSign_get_per_commitment_point,
1450 release_commitment_secret: InMemorySigner_BaseSign_release_commitment_secret,
1451 validate_holder_commitment: InMemorySigner_BaseSign_validate_holder_commitment,
1453 pubkeys: crate::lightning::ln::chan_utils::ChannelPublicKeys { inner: core::ptr::null_mut(), is_owned: true },
1454 set_pubkeys: Some(InMemorySigner_BaseSign_set_pubkeys),
1455 channel_keys_id: InMemorySigner_BaseSign_channel_keys_id,
1456 sign_counterparty_commitment: InMemorySigner_BaseSign_sign_counterparty_commitment,
1457 validate_counterparty_revocation: InMemorySigner_BaseSign_validate_counterparty_revocation,
1458 sign_holder_commitment_and_htlcs: InMemorySigner_BaseSign_sign_holder_commitment_and_htlcs,
1459 sign_justice_revoked_output: InMemorySigner_BaseSign_sign_justice_revoked_output,
1460 sign_justice_revoked_htlc: InMemorySigner_BaseSign_sign_justice_revoked_htlc,
1461 sign_counterparty_htlc_transaction: InMemorySigner_BaseSign_sign_counterparty_htlc_transaction,
1462 sign_closing_transaction: InMemorySigner_BaseSign_sign_closing_transaction,
1463 sign_channel_announcement: InMemorySigner_BaseSign_sign_channel_announcement,
1464 ready_channel: InMemorySigner_BaseSign_ready_channel,
1469 extern "C" fn InMemorySigner_BaseSign_get_per_commitment_point(this_arg: *const c_void, mut idx: u64) -> crate::c_types::PublicKey {
1470 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::get_per_commitment_point(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, idx, secp256k1::global::SECP256K1);
1471 crate::c_types::PublicKey::from_rust(&ret)
1474 extern "C" fn InMemorySigner_BaseSign_release_commitment_secret(this_arg: *const c_void, mut idx: u64) -> crate::c_types::ThirtyTwoBytes {
1475 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::release_commitment_secret(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, idx);
1476 crate::c_types::ThirtyTwoBytes { data: ret }
1479 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 {
1480 let mut local__preimages = Vec::new(); for mut item in _preimages.into_rust().drain(..) { local__preimages.push( { ::lightning::ln::PaymentPreimage(item.data) }); };
1481 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);
1482 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() };
1486 extern "C" fn InMemorySigner_BaseSign_pubkeys(this_arg: *const c_void) -> crate::lightning::ln::chan_utils::ChannelPublicKeys {
1487 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::pubkeys(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, );
1488 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 }
1490 extern "C" fn InMemorySigner_BaseSign_set_pubkeys(trait_self_arg: &BaseSign) {
1491 // This is a bit race-y in the general case, but for our specific use-cases today, we're safe
1492 // Specifically, we must ensure that the first time we're called it can never be in parallel
1493 if trait_self_arg.pubkeys.inner.is_null() {
1494 unsafe { &mut *(trait_self_arg as *const BaseSign as *mut BaseSign) }.pubkeys = InMemorySigner_BaseSign_pubkeys(trait_self_arg.this_arg);
1498 extern "C" fn InMemorySigner_BaseSign_channel_keys_id(this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes {
1499 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::channel_keys_id(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, );
1500 crate::c_types::ThirtyTwoBytes { data: ret }
1503 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 {
1504 let mut local__preimages = Vec::new(); for mut item in _preimages.into_rust().drain(..) { local__preimages.push( { ::lightning::ln::PaymentPreimage(item.data) }); };
1505 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);
1506 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() };
1510 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 {
1511 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());
1512 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() };
1516 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 {
1517 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);
1518 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() };
1522 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 {
1523 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);
1524 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() };
1528 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 {
1529 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);
1530 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() };
1534 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 {
1535 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);
1536 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() };
1540 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 {
1541 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);
1542 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() };
1546 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 {
1547 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);
1548 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() };
1551 extern "C" fn InMemorySigner_BaseSign_ready_channel(this_arg: *mut c_void, channel_parameters: &crate::lightning::ln::chan_utils::ChannelTransactionParameters) {
1552 <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::ready_channel(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, channel_parameters.get_native_ref())
1555 impl From<nativeInMemorySigner> for crate::lightning::chain::keysinterface::Sign {
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_Sign(&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 Sign which calls the relevant methods on this_arg.
1566 /// This copies the `inner` pointer in this_arg and thus the returned Sign must be freed before this_arg is
1568 pub extern "C" fn InMemorySigner_as_Sign(this_arg: &InMemorySigner) -> crate::lightning::chain::keysinterface::Sign {
1569 crate::lightning::chain::keysinterface::Sign {
1570 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
1572 BaseSign: crate::lightning::chain::keysinterface::BaseSign {
1573 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
1575 get_per_commitment_point: InMemorySigner_BaseSign_get_per_commitment_point,
1576 release_commitment_secret: InMemorySigner_BaseSign_release_commitment_secret,
1577 validate_holder_commitment: InMemorySigner_BaseSign_validate_holder_commitment,
1579 pubkeys: crate::lightning::ln::chan_utils::ChannelPublicKeys { inner: core::ptr::null_mut(), is_owned: true },
1580 set_pubkeys: Some(InMemorySigner_BaseSign_set_pubkeys),
1581 channel_keys_id: InMemorySigner_BaseSign_channel_keys_id,
1582 sign_counterparty_commitment: InMemorySigner_BaseSign_sign_counterparty_commitment,
1583 validate_counterparty_revocation: InMemorySigner_BaseSign_validate_counterparty_revocation,
1584 sign_holder_commitment_and_htlcs: InMemorySigner_BaseSign_sign_holder_commitment_and_htlcs,
1585 sign_justice_revoked_output: InMemorySigner_BaseSign_sign_justice_revoked_output,
1586 sign_justice_revoked_htlc: InMemorySigner_BaseSign_sign_justice_revoked_htlc,
1587 sign_counterparty_htlc_transaction: InMemorySigner_BaseSign_sign_counterparty_htlc_transaction,
1588 sign_closing_transaction: InMemorySigner_BaseSign_sign_closing_transaction,
1589 sign_channel_announcement: InMemorySigner_BaseSign_sign_channel_announcement,
1590 ready_channel: InMemorySigner_BaseSign_ready_channel,
1592 write: InMemorySigner_write_void,
1593 cloned: Some(Sign_InMemorySigner_cloned),
1597 extern "C" fn Sign_InMemorySigner_cloned(new_obj: &mut crate::lightning::chain::keysinterface::Sign) {
1598 new_obj.this_arg = InMemorySigner_clone_void(new_obj.this_arg);
1599 new_obj.free = Some(InMemorySigner_free_void);
1600 new_obj.BaseSign.this_arg = new_obj.this_arg;
1601 new_obj.BaseSign.free = None;
1605 /// Serialize the InMemorySigner object into a byte array which can be read by InMemorySigner_read
1606 pub extern "C" fn InMemorySigner_write(obj: &crate::lightning::chain::keysinterface::InMemorySigner) -> crate::c_types::derived::CVec_u8Z {
1607 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
1610 pub(crate) extern "C" fn InMemorySigner_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1611 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeInMemorySigner) })
1614 /// Read a InMemorySigner from a byte array, created by InMemorySigner_write
1615 pub extern "C" fn InMemorySigner_read(ser: crate::c_types::u8slice, arg: crate::c_types::SecretKey) -> crate::c_types::derived::CResult_InMemorySignerDecodeErrorZ {
1616 let arg_conv = arg.into_rust();
1617 let res: Result<lightning::chain::keysinterface::InMemorySigner, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj_arg(ser, arg_conv);
1618 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 { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
1622 use lightning::chain::keysinterface::KeysManager as nativeKeysManagerImport;
1623 pub(crate) type nativeKeysManager = nativeKeysManagerImport;
1625 /// Simple KeysInterface implementor that takes a 32-byte seed for use as a BIP 32 extended key
1626 /// and derives keys from that.
1628 /// Your node_id is seed/0'
1629 /// ChannelMonitor closes may use seed/1'
1630 /// Cooperative closes may use seed/2'
1631 /// The two close keys may be needed to claim on-chain funds!
1633 /// This struct cannot be used for nodes that wish to support receiving phantom payments;
1634 /// [`PhantomKeysManager`] must be used instead.
1636 /// Note that switching between this struct and [`PhantomKeysManager`] will invalidate any
1637 /// previously issued invoices and attempts to pay previous invoices will fail.
1640 pub struct KeysManager {
1641 /// A pointer to the opaque Rust object.
1643 /// Nearly everywhere, inner must be non-null, however in places where
1644 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1645 pub inner: *mut nativeKeysManager,
1646 /// Indicates that this is the only struct which contains the same pointer.
1648 /// Rust functions which take ownership of an object provided via an argument require
1649 /// this to be true and invalidate the object pointed to by inner.
1653 impl Drop for KeysManager {
1654 fn drop(&mut self) {
1655 if self.is_owned && !<*mut nativeKeysManager>::is_null(self.inner) {
1656 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1660 /// Frees any resources used by the KeysManager, if is_owned is set and inner is non-NULL.
1662 pub extern "C" fn KeysManager_free(this_obj: KeysManager) { }
1664 /// Used only if an object of this type is returned as a trait impl by a method
1665 pub(crate) extern "C" fn KeysManager_free_void(this_ptr: *mut c_void) {
1666 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeKeysManager); }
1670 pub(crate) fn get_native_ref(&self) -> &'static nativeKeysManager {
1671 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1673 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeKeysManager {
1674 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1676 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1677 pub(crate) fn take_inner(mut self) -> *mut nativeKeysManager {
1678 assert!(self.is_owned);
1679 let ret = ObjOps::untweak_ptr(self.inner);
1680 self.inner = core::ptr::null_mut();
1684 /// Constructs a KeysManager from a 32-byte seed. If the seed is in some way biased (eg your
1685 /// CSRNG is busted) this may panic (but more importantly, you will possibly lose funds).
1686 /// starting_time isn't strictly required to actually be a time, but it must absolutely,
1687 /// without a doubt, be unique to this instance. ie if you start multiple times with the same
1688 /// seed, starting_time must be unique to each run. Thus, the easiest way to achieve this is to
1689 /// simply use the current time (with very high precision).
1691 /// The seed MUST be backed up safely prior to use so that the keys can be re-created, however,
1692 /// obviously, starting_time should be unique every time you reload the library - it is only
1693 /// used to generate new ephemeral key data (which will be stored by the individual channel if
1696 /// Note that the seed is required to recover certain on-chain funds independent of
1697 /// ChannelMonitor data, though a current copy of ChannelMonitor data is also required for any
1698 /// channel, and some on-chain during-closing funds.
1700 /// Note that until the 0.1 release there is no guarantee of backward compatibility between
1701 /// versions. Once the library is more fully supported, the docs will be updated to include a
1702 /// detailed description of the guarantee.
1705 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 {
1706 let mut ret = lightning::chain::keysinterface::KeysManager::new(unsafe { &*seed}, starting_time_secs, starting_time_nanos);
1707 crate::lightning::chain::keysinterface::KeysManager { inner: ObjOps::heap_alloc(ret), is_owned: true }
1710 /// Derive an old Sign containing per-channel secrets based on a key derivation parameters.
1712 /// Key derivation parameters are accessible through a per-channel secrets
1713 /// Sign::channel_keys_id and is provided inside DynamicOuputP2WSH in case of
1714 /// onchain output detection for which a corresponding delayed_payment_key must be derived.
1717 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 {
1718 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.derive_channel_keys(channel_value_satoshis, unsafe { &*params});
1719 crate::lightning::chain::keysinterface::InMemorySigner { inner: ObjOps::heap_alloc(ret), is_owned: true }
1722 /// Creates a Transaction which spends the given descriptors to the given outputs, plus an
1723 /// output to the given change destination (if sufficient change value remains). The
1724 /// transaction will have a feerate, at least, of the given value.
1726 /// Returns `Err(())` if the output value is greater than the input value minus required fee,
1727 /// if a descriptor was duplicated, or if an output descriptor `script_pubkey`
1728 /// does not match the one we can spend.
1730 /// We do not enforce that outputs meet the dust limit or that any output scripts are standard.
1732 /// May panic if the `SpendableOutputDescriptor`s were not generated by Channels which used
1733 /// this KeysManager or one of the `InMemorySigner` created by this KeysManager.
1736 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 {
1737 let mut local_descriptors = Vec::new(); for mut item in descriptors.into_rust().drain(..) { local_descriptors.push( { item.into_native() }); };
1738 let mut local_outputs = Vec::new(); for mut item in outputs.into_rust().drain(..) { local_outputs.push( { item.into_rust() }); };
1739 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);
1740 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() };
1744 impl From<nativeKeysManager> for crate::lightning::chain::keysinterface::KeysInterface {
1745 fn from(obj: nativeKeysManager) -> Self {
1746 let mut rust_obj = KeysManager { inner: ObjOps::heap_alloc(obj), is_owned: true };
1747 let mut ret = KeysManager_as_KeysInterface(&rust_obj);
1748 // 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
1749 rust_obj.inner = core::ptr::null_mut();
1750 ret.free = Some(KeysManager_free_void);
1754 /// Constructs a new KeysInterface which calls the relevant methods on this_arg.
1755 /// This copies the `inner` pointer in this_arg and thus the returned KeysInterface must be freed before this_arg is
1757 pub extern "C" fn KeysManager_as_KeysInterface(this_arg: &KeysManager) -> crate::lightning::chain::keysinterface::KeysInterface {
1758 crate::lightning::chain::keysinterface::KeysInterface {
1759 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
1761 get_node_secret: KeysManager_KeysInterface_get_node_secret,
1762 get_destination_script: KeysManager_KeysInterface_get_destination_script,
1763 get_shutdown_scriptpubkey: KeysManager_KeysInterface_get_shutdown_scriptpubkey,
1764 get_channel_signer: KeysManager_KeysInterface_get_channel_signer,
1765 get_secure_random_bytes: KeysManager_KeysInterface_get_secure_random_bytes,
1766 read_chan_signer: KeysManager_KeysInterface_read_chan_signer,
1767 sign_invoice: KeysManager_KeysInterface_sign_invoice,
1768 get_inbound_payment_key_material: KeysManager_KeysInterface_get_inbound_payment_key_material,
1773 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 {
1774 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_node_secret(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, recipient.into_native());
1775 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() };
1779 extern "C" fn KeysManager_KeysInterface_get_destination_script(this_arg: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1780 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_destination_script(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, );
1781 ret.into_bytes().into()
1784 extern "C" fn KeysManager_KeysInterface_get_shutdown_scriptpubkey(this_arg: *const c_void) -> crate::lightning::ln::script::ShutdownScript {
1785 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_shutdown_scriptpubkey(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, );
1786 crate::lightning::ln::script::ShutdownScript { inner: ObjOps::heap_alloc(ret), is_owned: true }
1789 extern "C" fn KeysManager_KeysInterface_get_channel_signer(this_arg: *const c_void, mut _inbound: bool, mut channel_value_satoshis: u64) -> crate::lightning::chain::keysinterface::Sign {
1790 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_channel_signer(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, _inbound, channel_value_satoshis);
1794 extern "C" fn KeysManager_KeysInterface_get_secure_random_bytes(this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes {
1795 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_secure_random_bytes(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, );
1796 crate::c_types::ThirtyTwoBytes { data: ret }
1799 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 {
1800 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::read_chan_signer(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, reader.to_slice());
1801 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 { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
1805 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 recipient: crate::lightning::chain::keysinterface::Recipient) -> crate::c_types::derived::CResult_RecoverableSignatureNoneZ {
1806 let mut local_invoice_data = Vec::new(); for mut item in invoice_data.into_rust().drain(..) { local_invoice_data.push( { item.into() }); };
1807 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[..], recipient.into_native());
1808 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() };
1812 extern "C" fn KeysManager_KeysInterface_get_inbound_payment_key_material(this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes {
1813 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_inbound_payment_key_material(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, );
1814 crate::c_types::ThirtyTwoBytes { data: ret.0 }
1818 use lightning::chain::keysinterface::PhantomKeysManager as nativePhantomKeysManagerImport;
1819 pub(crate) type nativePhantomKeysManager = nativePhantomKeysManagerImport;
1821 /// Similar to [`KeysManager`], but allows the node using this struct to receive phantom node
1824 /// A phantom node payment is a payment made to a phantom invoice, which is an invoice that can be
1825 /// paid to one of multiple nodes. This works because we encode the invoice route hints such that
1826 /// LDK will recognize an incoming payment as destined for a phantom node, and collect the payment
1827 /// itself without ever needing to forward to this fake node.
1829 /// Phantom node payments are useful for load balancing between multiple LDK nodes. They also
1830 /// provide some fault tolerance, because payers will automatically retry paying other provided
1831 /// nodes in the case that one node goes down.
1833 /// Note that multi-path payments are not supported in phantom invoices for security reasons.
1834 /// Switching between this struct and [`KeysManager`] will invalidate any previously issued
1835 /// invoices and attempts to pay previous invoices will fail.
1838 pub struct PhantomKeysManager {
1839 /// A pointer to the opaque Rust object.
1841 /// Nearly everywhere, inner must be non-null, however in places where
1842 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1843 pub inner: *mut nativePhantomKeysManager,
1844 /// Indicates that this is the only struct which contains the same pointer.
1846 /// Rust functions which take ownership of an object provided via an argument require
1847 /// this to be true and invalidate the object pointed to by inner.
1851 impl Drop for PhantomKeysManager {
1852 fn drop(&mut self) {
1853 if self.is_owned && !<*mut nativePhantomKeysManager>::is_null(self.inner) {
1854 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1858 /// Frees any resources used by the PhantomKeysManager, if is_owned is set and inner is non-NULL.
1860 pub extern "C" fn PhantomKeysManager_free(this_obj: PhantomKeysManager) { }
1862 /// Used only if an object of this type is returned as a trait impl by a method
1863 pub(crate) extern "C" fn PhantomKeysManager_free_void(this_ptr: *mut c_void) {
1864 unsafe { let _ = Box::from_raw(this_ptr as *mut nativePhantomKeysManager); }
1867 impl PhantomKeysManager {
1868 pub(crate) fn get_native_ref(&self) -> &'static nativePhantomKeysManager {
1869 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1871 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativePhantomKeysManager {
1872 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1874 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1875 pub(crate) fn take_inner(mut self) -> *mut nativePhantomKeysManager {
1876 assert!(self.is_owned);
1877 let ret = ObjOps::untweak_ptr(self.inner);
1878 self.inner = core::ptr::null_mut();
1882 impl From<nativePhantomKeysManager> for crate::lightning::chain::keysinterface::KeysInterface {
1883 fn from(obj: nativePhantomKeysManager) -> Self {
1884 let mut rust_obj = PhantomKeysManager { inner: ObjOps::heap_alloc(obj), is_owned: true };
1885 let mut ret = PhantomKeysManager_as_KeysInterface(&rust_obj);
1886 // 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
1887 rust_obj.inner = core::ptr::null_mut();
1888 ret.free = Some(PhantomKeysManager_free_void);
1892 /// Constructs a new KeysInterface which calls the relevant methods on this_arg.
1893 /// This copies the `inner` pointer in this_arg and thus the returned KeysInterface must be freed before this_arg is
1895 pub extern "C" fn PhantomKeysManager_as_KeysInterface(this_arg: &PhantomKeysManager) -> crate::lightning::chain::keysinterface::KeysInterface {
1896 crate::lightning::chain::keysinterface::KeysInterface {
1897 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
1899 get_node_secret: PhantomKeysManager_KeysInterface_get_node_secret,
1900 get_destination_script: PhantomKeysManager_KeysInterface_get_destination_script,
1901 get_shutdown_scriptpubkey: PhantomKeysManager_KeysInterface_get_shutdown_scriptpubkey,
1902 get_channel_signer: PhantomKeysManager_KeysInterface_get_channel_signer,
1903 get_secure_random_bytes: PhantomKeysManager_KeysInterface_get_secure_random_bytes,
1904 read_chan_signer: PhantomKeysManager_KeysInterface_read_chan_signer,
1905 sign_invoice: PhantomKeysManager_KeysInterface_sign_invoice,
1906 get_inbound_payment_key_material: PhantomKeysManager_KeysInterface_get_inbound_payment_key_material,
1911 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 {
1912 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_node_secret(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, recipient.into_native());
1913 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() };
1917 extern "C" fn PhantomKeysManager_KeysInterface_get_destination_script(this_arg: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1918 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_destination_script(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, );
1919 ret.into_bytes().into()
1922 extern "C" fn PhantomKeysManager_KeysInterface_get_shutdown_scriptpubkey(this_arg: *const c_void) -> crate::lightning::ln::script::ShutdownScript {
1923 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_shutdown_scriptpubkey(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, );
1924 crate::lightning::ln::script::ShutdownScript { inner: ObjOps::heap_alloc(ret), is_owned: true }
1927 extern "C" fn PhantomKeysManager_KeysInterface_get_channel_signer(this_arg: *const c_void, mut inbound: bool, mut channel_value_satoshis: u64) -> crate::lightning::chain::keysinterface::Sign {
1928 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_channel_signer(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, inbound, channel_value_satoshis);
1932 extern "C" fn PhantomKeysManager_KeysInterface_get_secure_random_bytes(this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes {
1933 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_secure_random_bytes(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, );
1934 crate::c_types::ThirtyTwoBytes { data: ret }
1937 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 {
1938 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::read_chan_signer(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, reader.to_slice());
1939 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 { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
1943 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 recipient: crate::lightning::chain::keysinterface::Recipient) -> crate::c_types::derived::CResult_RecoverableSignatureNoneZ {
1944 let mut local_invoice_data = Vec::new(); for mut item in invoice_data.into_rust().drain(..) { local_invoice_data.push( { item.into() }); };
1945 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[..], recipient.into_native());
1946 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() };
1950 extern "C" fn PhantomKeysManager_KeysInterface_get_inbound_payment_key_material(this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes {
1951 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_inbound_payment_key_material(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, );
1952 crate::c_types::ThirtyTwoBytes { data: ret.0 }
1955 /// Constructs a `PhantomKeysManager` given a 32-byte seed and an additional `cross_node_seed`
1956 /// that is shared across all nodes that intend to participate in [phantom node payments] together.
1958 /// See [`KeysManager::new`] for more information on `seed`, `starting_time_secs`, and
1959 /// `starting_time_nanos`.
1961 /// `cross_node_seed` must be the same across all phantom payment-receiving nodes and also the
1962 /// same across restarts, or else inbound payments may fail.
1964 /// [phantom node payments]: PhantomKeysManager
1967 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 {
1968 let mut ret = lightning::chain::keysinterface::PhantomKeysManager::new(unsafe { &*seed}, starting_time_secs, starting_time_nanos, unsafe { &*cross_node_seed});
1969 crate::lightning::chain::keysinterface::PhantomKeysManager { inner: ObjOps::heap_alloc(ret), is_owned: true }
1972 /// See [`KeysManager::spend_spendable_outputs`] for documentation on this method.
1975 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 {
1976 let mut local_descriptors = Vec::new(); for mut item in descriptors.into_rust().drain(..) { local_descriptors.push( { item.into_native() }); };
1977 let mut local_outputs = Vec::new(); for mut item in outputs.into_rust().drain(..) { local_outputs.push( { item.into_rust() }); };
1978 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);
1979 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() };
1983 /// See [`KeysManager::derive_channel_keys`] for documentation on this method.
1986 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 {
1987 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.derive_channel_keys(channel_value_satoshis, unsafe { &*params});
1988 crate::lightning::chain::keysinterface::InMemorySigner { inner: ObjOps::heap_alloc(ret), is_owned: true }