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: &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: &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(crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor),
390 /// An output to a P2WPKH, spendable exclusively by our payment key (ie the private key which
391 /// corresponds to the public key in Sign::pubkeys().payment_point).
392 /// The witness in the spending input, is, thus, simply:
393 /// <BIP 143 signature> <payment key>
395 /// These are generally the result of our counterparty having broadcast the current state,
396 /// allowing us to claim the non-HTLC-encumbered outputs immediately.
397 StaticPaymentOutput(crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor),
399 use lightning::chain::keysinterface::SpendableOutputDescriptor as nativeSpendableOutputDescriptor;
400 impl SpendableOutputDescriptor {
402 pub(crate) fn to_native(&self) -> nativeSpendableOutputDescriptor {
404 SpendableOutputDescriptor::StaticOutput {ref outpoint, ref output, } => {
405 let mut outpoint_nonref = (*outpoint).clone();
406 let mut output_nonref = (*output).clone();
407 nativeSpendableOutputDescriptor::StaticOutput {
408 outpoint: *unsafe { Box::from_raw(outpoint_nonref.take_inner()) },
409 output: output_nonref.into_rust(),
412 SpendableOutputDescriptor::DelayedPaymentOutput (ref a, ) => {
413 let mut a_nonref = (*a).clone();
414 nativeSpendableOutputDescriptor::DelayedPaymentOutput (
415 *unsafe { Box::from_raw(a_nonref.take_inner()) },
418 SpendableOutputDescriptor::StaticPaymentOutput (ref a, ) => {
419 let mut a_nonref = (*a).clone();
420 nativeSpendableOutputDescriptor::StaticPaymentOutput (
421 *unsafe { Box::from_raw(a_nonref.take_inner()) },
427 pub(crate) fn into_native(self) -> nativeSpendableOutputDescriptor {
429 SpendableOutputDescriptor::StaticOutput {mut outpoint, mut output, } => {
430 nativeSpendableOutputDescriptor::StaticOutput {
431 outpoint: *unsafe { Box::from_raw(outpoint.take_inner()) },
432 output: output.into_rust(),
435 SpendableOutputDescriptor::DelayedPaymentOutput (mut a, ) => {
436 nativeSpendableOutputDescriptor::DelayedPaymentOutput (
437 *unsafe { Box::from_raw(a.take_inner()) },
440 SpendableOutputDescriptor::StaticPaymentOutput (mut a, ) => {
441 nativeSpendableOutputDescriptor::StaticPaymentOutput (
442 *unsafe { Box::from_raw(a.take_inner()) },
448 pub(crate) fn from_native(native: &nativeSpendableOutputDescriptor) -> Self {
450 nativeSpendableOutputDescriptor::StaticOutput {ref outpoint, ref output, } => {
451 let mut outpoint_nonref = (*outpoint).clone();
452 let mut output_nonref = (*output).clone();
453 SpendableOutputDescriptor::StaticOutput {
454 outpoint: crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(outpoint_nonref), is_owned: true },
455 output: crate::c_types::TxOut::from_rust(output_nonref),
458 nativeSpendableOutputDescriptor::DelayedPaymentOutput (ref a, ) => {
459 let mut a_nonref = (*a).clone();
460 SpendableOutputDescriptor::DelayedPaymentOutput (
461 crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor { inner: ObjOps::heap_alloc(a_nonref), is_owned: true },
464 nativeSpendableOutputDescriptor::StaticPaymentOutput (ref a, ) => {
465 let mut a_nonref = (*a).clone();
466 SpendableOutputDescriptor::StaticPaymentOutput (
467 crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor { inner: ObjOps::heap_alloc(a_nonref), is_owned: true },
473 pub(crate) fn native_into(native: nativeSpendableOutputDescriptor) -> Self {
475 nativeSpendableOutputDescriptor::StaticOutput {mut outpoint, mut output, } => {
476 SpendableOutputDescriptor::StaticOutput {
477 outpoint: crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(outpoint), is_owned: true },
478 output: crate::c_types::TxOut::from_rust(output),
481 nativeSpendableOutputDescriptor::DelayedPaymentOutput (mut a, ) => {
482 SpendableOutputDescriptor::DelayedPaymentOutput (
483 crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor { inner: ObjOps::heap_alloc(a), is_owned: true },
486 nativeSpendableOutputDescriptor::StaticPaymentOutput (mut a, ) => {
487 SpendableOutputDescriptor::StaticPaymentOutput (
488 crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor { inner: ObjOps::heap_alloc(a), is_owned: true },
494 /// Frees any resources used by the SpendableOutputDescriptor
496 pub extern "C" fn SpendableOutputDescriptor_free(this_ptr: SpendableOutputDescriptor) { }
497 /// Creates a copy of the SpendableOutputDescriptor
499 pub extern "C" fn SpendableOutputDescriptor_clone(orig: &SpendableOutputDescriptor) -> SpendableOutputDescriptor {
503 /// Utility method to constructs a new StaticOutput-variant SpendableOutputDescriptor
504 pub extern "C" fn SpendableOutputDescriptor_static_output(outpoint: crate::lightning::chain::transaction::OutPoint, output: crate::c_types::TxOut) -> SpendableOutputDescriptor {
505 SpendableOutputDescriptor::StaticOutput {
511 /// Utility method to constructs a new DelayedPaymentOutput-variant SpendableOutputDescriptor
512 pub extern "C" fn SpendableOutputDescriptor_delayed_payment_output(a: crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor) -> SpendableOutputDescriptor {
513 SpendableOutputDescriptor::DelayedPaymentOutput(a, )
516 /// Utility method to constructs a new StaticPaymentOutput-variant SpendableOutputDescriptor
517 pub extern "C" fn SpendableOutputDescriptor_static_payment_output(a: crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor) -> SpendableOutputDescriptor {
518 SpendableOutputDescriptor::StaticPaymentOutput(a, )
521 /// Serialize the SpendableOutputDescriptor object into a byte array which can be read by SpendableOutputDescriptor_read
522 pub extern "C" fn SpendableOutputDescriptor_write(obj: &SpendableOutputDescriptor) -> crate::c_types::derived::CVec_u8Z {
523 crate::c_types::serialize_obj(&unsafe { &*obj }.to_native())
526 /// Read a SpendableOutputDescriptor from a byte array, created by SpendableOutputDescriptor_write
527 pub extern "C" fn SpendableOutputDescriptor_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_SpendableOutputDescriptorDecodeErrorZ {
528 let res: Result<lightning::chain::keysinterface::SpendableOutputDescriptor, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
529 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() };
532 /// A trait to sign lightning channel transactions as described in BOLT 3.
534 /// Signing services could be implemented on a hardware wallet. In this case,
535 /// the current Sign would be a front-end on top of a communication
536 /// channel connected to your secure device and lightning key material wouldn't
537 /// reside on a hot server. Nevertheless, a this deployment would still need
538 /// to trust the ChannelManager to avoid loss of funds as this latest component
539 /// could ask to sign commitment transaction with HTLCs paying to attacker pubkeys.
541 /// A more secure iteration would be to use hashlock (or payment points) to pair
542 /// invoice/incoming HTLCs with outgoing HTLCs to implement a no-trust-ChannelManager
543 /// at the price of more state and computation on the hardware wallet side. In the future,
544 /// we are looking forward to design such interface.
546 /// In any case, ChannelMonitor or fallback watchtowers are always going to be trusted
547 /// to act, as liveness and breach reply correctness are always going to be hard requirements
548 /// of LN security model, orthogonal of key management issues.
550 pub struct BaseSign {
551 /// An opaque pointer which is passed to your function implementations as an argument.
552 /// This has no meaning in the LDK, and can be NULL or any other value.
553 pub this_arg: *mut c_void,
554 /// Gets the per-commitment point for a specific commitment number
556 /// Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
558 pub get_per_commitment_point: extern "C" fn (this_arg: *const c_void, idx: u64) -> crate::c_types::PublicKey,
559 /// Gets the commitment secret for a specific commitment number as part of the revocation process
561 /// An external signer implementation should error here if the commitment was already signed
562 /// and should refuse to sign it in the future.
564 /// May be called more than once for the same index.
566 /// Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
568 pub release_commitment_secret: extern "C" fn (this_arg: *const c_void, idx: u64) -> crate::c_types::ThirtyTwoBytes,
569 /// Validate the counterparty's signatures on the holder commitment transaction and HTLCs.
571 /// This is required in order for the signer to make sure that releasing a commitment
572 /// secret won't leave us without a broadcastable holder transaction.
573 /// Policy checks should be implemented in this function, including checking the amount
574 /// sent to us and checking the HTLCs.
576 /// The preimages of outgoing HTLCs that were fulfilled since the last commitment are provided.
577 /// A validating signer should ensure that an HTLC output is removed only when the matching
578 /// preimage is provided, or when the value to holder is restored.
580 /// NOTE: all the relevant preimages will be provided, but there may also be additional
581 /// irrelevant or duplicate preimages.
583 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,
584 /// Gets the holder's channel public keys and basepoints
585 pub pubkeys: crate::lightning::ln::chan_utils::ChannelPublicKeys,
586 /// Fill in the pubkeys field as a reference to it will be given to Rust after this returns
587 /// Note that this takes a pointer to this object, not the this_ptr like other methods do
588 /// This function pointer may be NULL if pubkeys is filled in when this object is created and never needs updating.
589 pub set_pubkeys: Option<extern "C" fn(&BaseSign)>,
590 /// Gets an arbitrary identifier describing the set of keys which are provided back to you in
591 /// some SpendableOutputDescriptor types. This should be sufficient to identify this
592 /// Sign object uniquely and lookup or re-derive its keys.
594 pub channel_keys_id: extern "C" fn (this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes,
595 /// Create a signature for a counterparty's commitment transaction and associated HTLC transactions.
597 /// Note that if signing fails or is rejected, the channel will be force-closed.
599 /// Policy checks should be implemented in this function, including checking the amount
600 /// sent to us and checking the HTLCs.
602 /// The preimages of outgoing HTLCs that were fulfilled since the last commitment are provided.
603 /// A validating signer should ensure that an HTLC output is removed only when the matching
604 /// preimage is provided, or when the value to holder is restored.
606 /// NOTE: all the relevant preimages will be provided, but there may also be additional
607 /// irrelevant or duplicate preimages.
609 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,
610 /// Validate the counterparty's revocation.
612 /// This is required in order for the signer to make sure that the state has moved
613 /// forward and it is safe to sign the next counterparty commitment.
615 pub validate_counterparty_revocation: extern "C" fn (this_arg: *const c_void, idx: u64, secret: *const [u8; 32]) -> crate::c_types::derived::CResult_NoneNoneZ,
616 /// Create a signatures for a holder's commitment transaction and its claiming HTLC transactions.
617 /// This will only ever be called with a non-revoked commitment_tx. This will be called with the
618 /// latest commitment_tx when we initiate a force-close.
619 /// This will be called with the previous latest, just to get claiming HTLC signatures, if we are
620 /// reacting to a ChannelMonitor replica that decided to broadcast before it had been updated to
622 /// This may be called multiple times for the same transaction.
624 /// An external signer implementation should check that the commitment has not been revoked.
626 /// May return Err if key derivation fails. Callers, such as ChannelMonitor, will panic in such a case.
628 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,
629 /// Create a signature for the given input in a transaction spending an HTLC transaction output
630 /// or a commitment transaction `to_local` output when our counterparty broadcasts an old state.
632 /// A justice transaction may claim multiple outputs at the same time if timelocks are
633 /// similar, but only a signature for the input at index `input` should be signed for here.
634 /// It may be called multiple times for same output(s) if a fee-bump is needed with regards
635 /// to an upcoming timelock expiration.
637 /// Amount is value of the output spent by this input, committed to in the BIP 143 signature.
639 /// per_commitment_key is revocation secret which was provided by our counterparty when they
640 /// revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
641 /// not allow the spending of any funds by itself (you need our holder revocation_secret to do
644 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,
645 /// Create a signature for the given input in a transaction spending a commitment transaction
646 /// HTLC output when our counterparty broadcasts an old state.
648 /// A justice transaction may claim multiple outputs at the same time if timelocks are
649 /// similar, but only a signature for the input at index `input` should be signed for here.
650 /// It may be called multiple times for same output(s) if a fee-bump is needed with regards
651 /// to an upcoming timelock expiration.
653 /// Amount is value of the output spent by this input, committed to in the BIP 143 signature.
655 /// per_commitment_key is revocation secret which was provided by our counterparty when they
656 /// revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
657 /// not allow the spending of any funds by itself (you need our holder revocation_secret to do
660 /// htlc holds HTLC elements (hash, timelock), thus changing the format of the witness script
661 /// (which is committed to in the BIP 143 signatures).
663 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,
664 /// Create a signature for a claiming transaction for a HTLC output on a counterparty's commitment
665 /// transaction, either offered or received.
667 /// Such a transaction may claim multiples offered outputs at same time if we know the
668 /// preimage for each when we create it, but only the input at index `input` should be
669 /// signed for here. It may be called multiple times for same output(s) if a fee-bump is
670 /// needed with regards to an upcoming timelock expiration.
672 /// Witness_script is either a offered or received script as defined in BOLT3 for HTLC
675 /// Amount is value of the output spent by this input, committed to in the BIP 143 signature.
677 /// Per_commitment_point is the dynamic point corresponding to the channel state
678 /// detected onchain. It has been generated by our counterparty and is used to derive
679 /// channel state keys, which are then included in the witness script and committed to in the
680 /// BIP 143 signature.
682 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,
683 /// Create a signature for a (proposed) closing transaction.
685 /// Note that, due to rounding, there may be one \"missing\" satoshi, and either party may have
686 /// chosen to forgo their output as dust.
688 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,
689 /// Signs a channel announcement message with our funding key and our node secret key (aka
690 /// node_id or network_key), proving it comes from one of the channel participants.
692 /// The first returned signature should be from our node secret key, the second from our
695 /// Note that if this fails or is rejected, the channel will not be publicly announced and
696 /// our counterparty may (though likely will not) close the channel on us for violating the
699 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,
700 /// Set the counterparty static channel data, including basepoints,
701 /// counterparty_selected/holder_selected_contest_delay and funding outpoint.
702 /// This is done as soon as the funding outpoint is known. Since these are static channel data,
703 /// they MUST NOT be allowed to change to different values once set.
705 /// channel_parameters.is_populated() MUST be true.
707 /// We bind holder_selected_contest_delay late here for API convenience.
709 /// Will be called before any signatures are applied.
710 pub ready_channel: extern "C" fn (this_arg: *mut c_void, channel_parameters: &crate::lightning::ln::chan_utils::ChannelTransactionParameters),
711 /// Frees any resources associated with this object given its this_arg pointer.
712 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
713 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
715 unsafe impl Send for BaseSign {}
716 unsafe impl Sync for BaseSign {}
718 pub(crate) extern "C" fn BaseSign_clone_fields(orig: &BaseSign) -> BaseSign {
720 this_arg: orig.this_arg,
721 get_per_commitment_point: Clone::clone(&orig.get_per_commitment_point),
722 release_commitment_secret: Clone::clone(&orig.release_commitment_secret),
723 validate_holder_commitment: Clone::clone(&orig.validate_holder_commitment),
724 pubkeys: Clone::clone(&orig.pubkeys),
725 set_pubkeys: Clone::clone(&orig.set_pubkeys),
726 channel_keys_id: Clone::clone(&orig.channel_keys_id),
727 sign_counterparty_commitment: Clone::clone(&orig.sign_counterparty_commitment),
728 validate_counterparty_revocation: Clone::clone(&orig.validate_counterparty_revocation),
729 sign_holder_commitment_and_htlcs: Clone::clone(&orig.sign_holder_commitment_and_htlcs),
730 sign_justice_revoked_output: Clone::clone(&orig.sign_justice_revoked_output),
731 sign_justice_revoked_htlc: Clone::clone(&orig.sign_justice_revoked_htlc),
732 sign_counterparty_htlc_transaction: Clone::clone(&orig.sign_counterparty_htlc_transaction),
733 sign_closing_transaction: Clone::clone(&orig.sign_closing_transaction),
734 sign_channel_announcement: Clone::clone(&orig.sign_channel_announcement),
735 ready_channel: Clone::clone(&orig.ready_channel),
736 free: Clone::clone(&orig.free),
740 use lightning::chain::keysinterface::BaseSign as rustBaseSign;
741 impl rustBaseSign for BaseSign {
742 fn get_per_commitment_point(&self, mut idx: u64, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> bitcoin::secp256k1::key::PublicKey {
743 let mut ret = (self.get_per_commitment_point)(self.this_arg, idx);
746 fn release_commitment_secret(&self, mut idx: u64) -> [u8; 32] {
747 let mut ret = (self.release_commitment_secret)(self.this_arg, idx);
750 fn validate_holder_commitment(&self, mut holder_tx: &lightning::ln::chan_utils::HolderCommitmentTransaction, mut preimages: Vec<lightning::ln::PaymentPreimage>) -> Result<(), ()> {
751 let mut local_preimages = Vec::new(); for mut item in preimages.drain(..) { local_preimages.push( { crate::c_types::ThirtyTwoBytes { data: item.0 } }); };
752 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());
753 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)) })*/ })};
756 fn pubkeys(&self) -> &lightning::ln::chan_utils::ChannelPublicKeys {
757 if let Some(f) = self.set_pubkeys {
760 self.pubkeys.get_native_ref()
762 fn channel_keys_id(&self) -> [u8; 32] {
763 let mut ret = (self.channel_keys_id)(self.this_arg);
766 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::Signature, Vec<bitcoin::secp256k1::Signature>), ()> {
767 let mut local_preimages = Vec::new(); for mut item in preimages.drain(..) { local_preimages.push( { crate::c_types::ThirtyTwoBytes { data: item.0 } }); };
768 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());
769 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)) })*/ })};
772 fn validate_counterparty_revocation(&self, mut idx: u64, mut secret: &bitcoin::secp256k1::key::SecretKey) -> Result<(), ()> {
773 let mut ret = (self.validate_counterparty_revocation)(self.this_arg, idx, secret.as_ref());
774 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)) })*/ })};
777 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::Signature, Vec<bitcoin::secp256k1::Signature>), ()> {
778 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 });
779 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)) })*/ })};
782 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::key::SecretKey, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<bitcoin::secp256k1::Signature, ()> {
783 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());
784 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)) })*/ })};
787 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::key::SecretKey, mut htlc: &lightning::ln::chan_utils::HTLCOutputInCommitment, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<bitcoin::secp256k1::Signature, ()> {
788 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 });
789 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)) })*/ })};
792 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::key::PublicKey, mut htlc: &lightning::ln::chan_utils::HTLCOutputInCommitment, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<bitcoin::secp256k1::Signature, ()> {
793 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 });
794 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)) })*/ })};
797 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::Signature, ()> {
798 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 });
799 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)) })*/ })};
802 fn sign_channel_announcement(&self, mut msg: &lightning::ln::msgs::UnsignedChannelAnnouncement, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<(bitcoin::secp256k1::Signature, bitcoin::secp256k1::Signature), ()> {
803 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 });
804 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)) })*/ })};
807 fn ready_channel(&mut self, mut channel_parameters: &lightning::ln::chan_utils::ChannelTransactionParameters) {
808 (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 })
812 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
813 // directly as a Deref trait in higher-level structs:
814 impl core::ops::Deref for BaseSign {
816 fn deref(&self) -> &Self {
820 /// Calls the free function if one is set
822 pub extern "C" fn BaseSign_free(this_ptr: BaseSign) { }
823 impl Drop for BaseSign {
825 if let Some(f) = self.free {
830 /// A cloneable signer.
832 /// Although we require signers to be cloneable, it may be useful for developers to be able to use
833 /// signers in an un-sized way, for example as `dyn BaseSign`. Therefore we separate the Clone trait,
834 /// which implies Sized, into this derived trait.
837 /// An opaque pointer which is passed to your function implementations as an argument.
838 /// This has no meaning in the LDK, and can be NULL or any other value.
839 pub this_arg: *mut c_void,
840 /// Implementation of BaseSign for this object.
841 pub BaseSign: crate::lightning::chain::keysinterface::BaseSign,
842 /// Serialize the object into a byte array
843 pub write: extern "C" fn (this_arg: *const c_void) -> crate::c_types::derived::CVec_u8Z,
844 /// Called, if set, after this Sign has been cloned into a duplicate object.
845 /// The new Sign is provided, and should be mutated as needed to perform a
846 /// deep copy of the object pointed to by this_arg or avoid any double-freeing.
847 pub cloned: Option<extern "C" fn (new_Sign: &mut Sign)>,
848 /// Frees any resources associated with this object given its this_arg pointer.
849 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
850 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
852 unsafe impl Send for Sign {}
853 unsafe impl Sync for Sign {}
855 pub(crate) extern "C" fn Sign_clone_fields(orig: &Sign) -> Sign {
857 this_arg: orig.this_arg,
858 BaseSign: crate::lightning::chain::keysinterface::BaseSign_clone_fields(&orig.BaseSign),
859 write: Clone::clone(&orig.write),
860 cloned: Clone::clone(&orig.cloned),
861 free: Clone::clone(&orig.free),
864 impl lightning::chain::keysinterface::BaseSign for Sign {
865 fn get_per_commitment_point(&self, mut idx: u64, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> bitcoin::secp256k1::key::PublicKey {
866 let mut ret = (self.BaseSign.get_per_commitment_point)(self.BaseSign.this_arg, idx);
869 fn release_commitment_secret(&self, mut idx: u64) -> [u8; 32] {
870 let mut ret = (self.BaseSign.release_commitment_secret)(self.BaseSign.this_arg, idx);
873 fn validate_holder_commitment(&self, mut holder_tx: &lightning::ln::chan_utils::HolderCommitmentTransaction, mut preimages: Vec<lightning::ln::PaymentPreimage>) -> Result<(), ()> {
874 let mut local_preimages = Vec::new(); for mut item in preimages.drain(..) { local_preimages.push( { crate::c_types::ThirtyTwoBytes { data: item.0 } }); };
875 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());
876 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)) })*/ })};
879 fn pubkeys(&self) -> &lightning::ln::chan_utils::ChannelPublicKeys {
880 if let Some(f) = self.BaseSign.set_pubkeys {
883 self.BaseSign.pubkeys.get_native_ref()
885 fn channel_keys_id(&self) -> [u8; 32] {
886 let mut ret = (self.BaseSign.channel_keys_id)(self.BaseSign.this_arg);
889 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::Signature, Vec<bitcoin::secp256k1::Signature>), ()> {
890 let mut local_preimages = Vec::new(); for mut item in preimages.drain(..) { local_preimages.push( { crate::c_types::ThirtyTwoBytes { data: item.0 } }); };
891 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());
892 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)) })*/ })};
895 fn validate_counterparty_revocation(&self, mut idx: u64, mut secret: &bitcoin::secp256k1::key::SecretKey) -> Result<(), ()> {
896 let mut ret = (self.BaseSign.validate_counterparty_revocation)(self.BaseSign.this_arg, idx, secret.as_ref());
897 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)) })*/ })};
900 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::Signature, Vec<bitcoin::secp256k1::Signature>), ()> {
901 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 });
902 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)) })*/ })};
905 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::key::SecretKey, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<bitcoin::secp256k1::Signature, ()> {
906 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());
907 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)) })*/ })};
910 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::key::SecretKey, mut htlc: &lightning::ln::chan_utils::HTLCOutputInCommitment, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<bitcoin::secp256k1::Signature, ()> {
911 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 });
912 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)) })*/ })};
915 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::key::PublicKey, mut htlc: &lightning::ln::chan_utils::HTLCOutputInCommitment, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<bitcoin::secp256k1::Signature, ()> {
916 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 });
917 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)) })*/ })};
920 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::Signature, ()> {
921 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 });
922 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)) })*/ })};
925 fn sign_channel_announcement(&self, mut msg: &lightning::ln::msgs::UnsignedChannelAnnouncement, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<(bitcoin::secp256k1::Signature, bitcoin::secp256k1::Signature), ()> {
926 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 });
927 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)) })*/ })};
930 fn ready_channel(&mut self, mut channel_parameters: &lightning::ln::chan_utils::ChannelTransactionParameters) {
931 (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 })
934 impl lightning::util::ser::Writeable for Sign {
935 fn write<W: lightning::util::ser::Writer>(&self, w: &mut W) -> Result<(), crate::c_types::io::Error> {
936 let vec = (self.write)(self.this_arg);
937 w.write_all(vec.as_slice())
941 /// Creates a copy of a Sign
942 pub extern "C" fn Sign_clone(orig: &Sign) -> Sign {
943 let mut res = Sign_clone_fields(orig);
944 if let Some(f) = orig.cloned { (f)(&mut res) };
947 impl Clone for Sign {
948 fn clone(&self) -> Self {
953 use lightning::chain::keysinterface::Sign as rustSign;
954 impl rustSign for Sign {
957 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
958 // directly as a Deref trait in higher-level structs:
959 impl core::ops::Deref for Sign {
961 fn deref(&self) -> &Self {
965 /// Calls the free function if one is set
967 pub extern "C" fn Sign_free(this_ptr: Sign) { }
970 if let Some(f) = self.free {
975 /// Specifies the recipient of an invoice, to indicate to [`KeysInterface::sign_invoice`] what node
976 /// secret key should be used to sign the invoice.
981 /// The invoice should be signed with the local node secret key.
983 /// The invoice should be signed with the phantom node secret key. This secret key must be the
984 /// same for all nodes participating in the [phantom node payment].
986 /// [phantom node payment]: PhantomKeysManager
989 use lightning::chain::keysinterface::Recipient as nativeRecipient;
992 pub(crate) fn to_native(&self) -> nativeRecipient {
994 Recipient::Node => nativeRecipient::Node,
995 Recipient::PhantomNode => nativeRecipient::PhantomNode,
999 pub(crate) fn into_native(self) -> nativeRecipient {
1001 Recipient::Node => nativeRecipient::Node,
1002 Recipient::PhantomNode => nativeRecipient::PhantomNode,
1006 pub(crate) fn from_native(native: &nativeRecipient) -> Self {
1008 nativeRecipient::Node => Recipient::Node,
1009 nativeRecipient::PhantomNode => Recipient::PhantomNode,
1013 pub(crate) fn native_into(native: nativeRecipient) -> Self {
1015 nativeRecipient::Node => Recipient::Node,
1016 nativeRecipient::PhantomNode => Recipient::PhantomNode,
1020 /// Creates a copy of the Recipient
1022 pub extern "C" fn Recipient_clone(orig: &Recipient) -> Recipient {
1026 /// Utility method to constructs a new Node-variant Recipient
1027 pub extern "C" fn Recipient_node() -> Recipient {
1030 /// Utility method to constructs a new PhantomNode-variant Recipient
1031 pub extern "C" fn Recipient_phantom_node() -> Recipient {
1032 Recipient::PhantomNode}
1033 /// A trait to describe an object which can get user secrets and key material.
1035 pub struct KeysInterface {
1036 /// An opaque pointer which is passed to your function implementations as an argument.
1037 /// This has no meaning in the LDK, and can be NULL or any other value.
1038 pub this_arg: *mut c_void,
1039 /// Get node secret key (aka node_id or network_key) based on the provided [`Recipient`].
1041 /// This method must return the same value each time it is called with a given `Recipient`
1044 pub get_node_secret: extern "C" fn (this_arg: *const c_void, recipient: crate::lightning::chain::keysinterface::Recipient) -> crate::c_types::derived::CResult_SecretKeyNoneZ,
1045 /// Get a script pubkey which we send funds to when claiming on-chain contestable outputs.
1047 /// This method should return a different value each time it is called, to avoid linking
1048 /// on-chain funds across channels as controlled to the same user.
1050 pub get_destination_script: extern "C" fn (this_arg: *const c_void) -> crate::c_types::derived::CVec_u8Z,
1051 /// Get a script pubkey which we will send funds to when closing a channel.
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_shutdown_scriptpubkey: extern "C" fn (this_arg: *const c_void) -> crate::lightning::ln::script::ShutdownScript,
1057 /// Get a new set of Sign for per-channel secrets. These MUST be unique even if you
1058 /// restarted with some stale data!
1060 /// This method must return a different value each time it is called.
1062 pub get_channel_signer: extern "C" fn (this_arg: *const c_void, inbound: bool, channel_value_satoshis: u64) -> crate::lightning::chain::keysinterface::Sign,
1063 /// Gets a unique, cryptographically-secure, random 32 byte value. This is used for encrypting
1064 /// onion packets and for temporary channel IDs. There is no requirement that these be
1065 /// persisted anywhere, though they must be unique across restarts.
1067 /// This method must return a different value each time it is called.
1069 pub get_secure_random_bytes: extern "C" fn (this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes,
1070 /// Reads a `Signer` for this `KeysInterface` from the given input stream.
1071 /// This is only called during deserialization of other objects which contain
1072 /// `Sign`-implementing objects (ie `ChannelMonitor`s and `ChannelManager`s).
1073 /// The bytes are exactly those which `<Self::Signer as Writeable>::write()` writes, and
1074 /// contain no versioning scheme. You may wish to include your own version prefix and ensure
1075 /// you've read all of the provided bytes to ensure no corruption occurred.
1077 pub read_chan_signer: extern "C" fn (this_arg: *const c_void, reader: crate::c_types::u8slice) -> crate::c_types::derived::CResult_SignDecodeErrorZ,
1078 /// Sign an invoice.
1079 /// By parameterizing by the raw invoice bytes instead of the hash, we allow implementors of
1080 /// this trait to parse the invoice and make sure they're signing what they expect, rather than
1081 /// blindly signing the hash.
1082 /// The hrp is ascii bytes, while the invoice data is base32.
1084 /// The secret key used to sign the invoice is dependent on the [`Recipient`].
1086 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,
1087 /// Get secret key material as bytes for use in encrypting and decrypting inbound payment data.
1089 /// If the implementor of this trait supports [phantom node payments], then every node that is
1090 /// intended to be included in the phantom invoice route hints must return the same value from
1093 /// This method must return the same value each time it is called.
1095 /// [phantom node payments]: PhantomKeysManager
1097 pub get_inbound_payment_key_material: extern "C" fn (this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes,
1098 /// Frees any resources associated with this object given its this_arg pointer.
1099 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
1100 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
1102 unsafe impl Send for KeysInterface {}
1103 unsafe impl Sync for KeysInterface {}
1105 pub(crate) extern "C" fn KeysInterface_clone_fields(orig: &KeysInterface) -> KeysInterface {
1107 this_arg: orig.this_arg,
1108 get_node_secret: Clone::clone(&orig.get_node_secret),
1109 get_destination_script: Clone::clone(&orig.get_destination_script),
1110 get_shutdown_scriptpubkey: Clone::clone(&orig.get_shutdown_scriptpubkey),
1111 get_channel_signer: Clone::clone(&orig.get_channel_signer),
1112 get_secure_random_bytes: Clone::clone(&orig.get_secure_random_bytes),
1113 read_chan_signer: Clone::clone(&orig.read_chan_signer),
1114 sign_invoice: Clone::clone(&orig.sign_invoice),
1115 get_inbound_payment_key_material: Clone::clone(&orig.get_inbound_payment_key_material),
1116 free: Clone::clone(&orig.free),
1120 use lightning::chain::keysinterface::KeysInterface as rustKeysInterface;
1121 impl rustKeysInterface for KeysInterface {
1122 type Signer = crate::lightning::chain::keysinterface::Sign;
1123 fn get_node_secret(&self, mut recipient: lightning::chain::keysinterface::Recipient) -> Result<bitcoin::secp256k1::key::SecretKey, ()> {
1124 let mut ret = (self.get_node_secret)(self.this_arg, crate::lightning::chain::keysinterface::Recipient::native_into(recipient));
1125 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)) })*/ })};
1128 fn get_destination_script(&self) -> bitcoin::blockdata::script::Script {
1129 let mut ret = (self.get_destination_script)(self.this_arg);
1130 ::bitcoin::blockdata::script::Script::from(ret.into_rust())
1132 fn get_shutdown_scriptpubkey(&self) -> lightning::ln::script::ShutdownScript {
1133 let mut ret = (self.get_shutdown_scriptpubkey)(self.this_arg);
1134 *unsafe { Box::from_raw(ret.take_inner()) }
1136 fn get_channel_signer(&self, mut inbound: bool, mut channel_value_satoshis: u64) -> crate::lightning::chain::keysinterface::Sign {
1137 let mut ret = (self.get_channel_signer)(self.this_arg, inbound, channel_value_satoshis);
1140 fn get_secure_random_bytes(&self) -> [u8; 32] {
1141 let mut ret = (self.get_secure_random_bytes)(self.this_arg);
1144 fn read_chan_signer(&self, mut reader: &[u8]) -> Result<crate::lightning::chain::keysinterface::Sign, lightning::ln::msgs::DecodeError> {
1145 let mut local_reader = crate::c_types::u8slice::from_slice(reader);
1146 let mut ret = (self.read_chan_signer)(self.this_arg, local_reader);
1147 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()) } })};
1150 fn sign_invoice(&self, mut hrp_bytes: &[u8], mut invoice_data: &[bitcoin::bech32::u5], mut receipient: lightning::chain::keysinterface::Recipient) -> Result<bitcoin::secp256k1::recovery::RecoverableSignature, ()> {
1151 let mut local_hrp_bytes = crate::c_types::u8slice::from_slice(hrp_bytes);
1152 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() }); };
1153 let mut ret = (self.sign_invoice)(self.this_arg, local_hrp_bytes, local_invoice_data.into(), crate::lightning::chain::keysinterface::Recipient::native_into(receipient));
1154 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)) })*/ })};
1157 fn get_inbound_payment_key_material(&self) -> lightning::chain::keysinterface::KeyMaterial {
1158 let mut ret = (self.get_inbound_payment_key_material)(self.this_arg);
1159 ::lightning::chain::keysinterface::KeyMaterial(ret.data)
1163 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
1164 // directly as a Deref trait in higher-level structs:
1165 impl core::ops::Deref for KeysInterface {
1167 fn deref(&self) -> &Self {
1171 /// Calls the free function if one is set
1173 pub extern "C" fn KeysInterface_free(this_ptr: KeysInterface) { }
1174 impl Drop for KeysInterface {
1175 fn drop(&mut self) {
1176 if let Some(f) = self.free {
1182 use lightning::chain::keysinterface::InMemorySigner as nativeInMemorySignerImport;
1183 pub(crate) type nativeInMemorySigner = nativeInMemorySignerImport;
1185 /// A simple implementation of Sign that just keeps the private keys in memory.
1187 /// This implementation performs no policy checks and is insufficient by itself as
1188 /// a secure external signer.
1191 pub struct InMemorySigner {
1192 /// A pointer to the opaque Rust object.
1194 /// Nearly everywhere, inner must be non-null, however in places where
1195 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1196 pub inner: *mut nativeInMemorySigner,
1197 /// Indicates that this is the only struct which contains the same pointer.
1199 /// Rust functions which take ownership of an object provided via an argument require
1200 /// this to be true and invalidate the object pointed to by inner.
1204 impl Drop for InMemorySigner {
1205 fn drop(&mut self) {
1206 if self.is_owned && !<*mut nativeInMemorySigner>::is_null(self.inner) {
1207 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1211 /// Frees any resources used by the InMemorySigner, if is_owned is set and inner is non-NULL.
1213 pub extern "C" fn InMemorySigner_free(this_obj: InMemorySigner) { }
1215 /// Used only if an object of this type is returned as a trait impl by a method
1216 pub(crate) extern "C" fn InMemorySigner_free_void(this_ptr: *mut c_void) {
1217 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeInMemorySigner); }
1220 impl InMemorySigner {
1221 pub(crate) fn get_native_ref(&self) -> &'static nativeInMemorySigner {
1222 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1224 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeInMemorySigner {
1225 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1227 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1228 pub(crate) fn take_inner(mut self) -> *mut nativeInMemorySigner {
1229 assert!(self.is_owned);
1230 let ret = ObjOps::untweak_ptr(self.inner);
1231 self.inner = core::ptr::null_mut();
1235 /// Private key of anchor tx
1237 pub extern "C" fn InMemorySigner_get_funding_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1238 let mut inner_val = &mut this_ptr.get_native_mut_ref().funding_key;
1241 /// Private key of anchor tx
1243 pub extern "C" fn InMemorySigner_set_funding_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1244 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.funding_key = val.into_rust();
1246 /// Holder secret key for blinded revocation pubkey
1248 pub extern "C" fn InMemorySigner_get_revocation_base_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1249 let mut inner_val = &mut this_ptr.get_native_mut_ref().revocation_base_key;
1252 /// Holder secret key for blinded revocation pubkey
1254 pub extern "C" fn InMemorySigner_set_revocation_base_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1255 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.revocation_base_key = val.into_rust();
1257 /// Holder secret key used for our balance in counterparty-broadcasted commitment transactions
1259 pub extern "C" fn InMemorySigner_get_payment_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1260 let mut inner_val = &mut this_ptr.get_native_mut_ref().payment_key;
1263 /// Holder secret key used for our balance in counterparty-broadcasted commitment transactions
1265 pub extern "C" fn InMemorySigner_set_payment_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1266 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.payment_key = val.into_rust();
1268 /// Holder secret key used in HTLC tx
1270 pub extern "C" fn InMemorySigner_get_delayed_payment_base_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1271 let mut inner_val = &mut this_ptr.get_native_mut_ref().delayed_payment_base_key;
1274 /// Holder secret key used in HTLC tx
1276 pub extern "C" fn InMemorySigner_set_delayed_payment_base_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1277 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.delayed_payment_base_key = val.into_rust();
1279 /// Holder htlc secret key used in commitment tx htlc outputs
1281 pub extern "C" fn InMemorySigner_get_htlc_base_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1282 let mut inner_val = &mut this_ptr.get_native_mut_ref().htlc_base_key;
1285 /// Holder htlc secret key used in commitment tx htlc outputs
1287 pub extern "C" fn InMemorySigner_set_htlc_base_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1288 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.htlc_base_key = val.into_rust();
1292 pub extern "C" fn InMemorySigner_get_commitment_seed(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1293 let mut inner_val = &mut this_ptr.get_native_mut_ref().commitment_seed;
1298 pub extern "C" fn InMemorySigner_set_commitment_seed(this_ptr: &mut InMemorySigner, mut val: crate::c_types::ThirtyTwoBytes) {
1299 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.commitment_seed = val.data;
1301 impl Clone for InMemorySigner {
1302 fn clone(&self) -> Self {
1304 inner: if <*mut nativeInMemorySigner>::is_null(self.inner) { core::ptr::null_mut() } else {
1305 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1311 /// Used only if an object of this type is returned as a trait impl by a method
1312 pub(crate) extern "C" fn InMemorySigner_clone_void(this_ptr: *const c_void) -> *mut c_void {
1313 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeInMemorySigner)).clone() })) as *mut c_void
1316 /// Creates a copy of the InMemorySigner
1317 pub extern "C" fn InMemorySigner_clone(orig: &InMemorySigner) -> InMemorySigner {
1320 /// Create a new InMemorySigner
1323 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 {
1324 let mut ret = lightning::chain::keysinterface::InMemorySigner::new(secp256k1::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);
1325 crate::lightning::chain::keysinterface::InMemorySigner { inner: ObjOps::heap_alloc(ret), is_owned: true }
1328 /// Counterparty pubkeys.
1329 /// Will panic if ready_channel wasn't called.
1332 pub extern "C" fn InMemorySigner_counterparty_pubkeys(this_arg: &InMemorySigner) -> crate::lightning::ln::chan_utils::ChannelPublicKeys {
1333 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.counterparty_pubkeys();
1334 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 }
1337 /// The contest_delay value specified by our counterparty and applied on holder-broadcastable
1338 /// transactions, ie the amount of time that we have to wait to recover our funds if we
1339 /// broadcast a transaction.
1340 /// Will panic if ready_channel wasn't called.
1343 pub extern "C" fn InMemorySigner_counterparty_selected_contest_delay(this_arg: &InMemorySigner) -> u16 {
1344 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.counterparty_selected_contest_delay();
1348 /// The contest_delay value specified by us and applied on transactions broadcastable
1349 /// by our counterparty, ie the amount of time that they have to wait to recover their funds
1350 /// if they broadcast a transaction.
1351 /// Will panic if ready_channel wasn't called.
1354 pub extern "C" fn InMemorySigner_holder_selected_contest_delay(this_arg: &InMemorySigner) -> u16 {
1355 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.holder_selected_contest_delay();
1359 /// Whether the holder is the initiator
1360 /// Will panic if ready_channel wasn't called.
1363 pub extern "C" fn InMemorySigner_is_outbound(this_arg: &InMemorySigner) -> bool {
1364 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.is_outbound();
1368 /// Funding outpoint
1369 /// Will panic if ready_channel wasn't called.
1372 pub extern "C" fn InMemorySigner_funding_outpoint(this_arg: &InMemorySigner) -> crate::lightning::chain::transaction::OutPoint {
1373 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.funding_outpoint();
1374 crate::lightning::chain::transaction::OutPoint { inner: unsafe { ObjOps::nonnull_ptr_to_inner((ret as *const lightning::chain::transaction::OutPoint<>) as *mut _) }, is_owned: false }
1377 /// Obtain a ChannelTransactionParameters for this channel, to be used when verifying or
1378 /// building transactions.
1380 /// Will panic if ready_channel wasn't called.
1383 pub extern "C" fn InMemorySigner_get_channel_parameters(this_arg: &InMemorySigner) -> crate::lightning::ln::chan_utils::ChannelTransactionParameters {
1384 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_channel_parameters();
1385 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 }
1388 /// Whether anchors should be used.
1389 /// Will panic if ready_channel wasn't called.
1392 pub extern "C" fn InMemorySigner_opt_anchors(this_arg: &InMemorySigner) -> bool {
1393 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.opt_anchors();
1397 /// Sign the single input of spend_tx at index `input_idx` which spends the output
1398 /// described by descriptor, returning the witness stack for the input.
1400 /// Returns an Err if the input at input_idx does not exist, has a non-empty script_sig,
1401 /// is not spending the outpoint described by `descriptor.outpoint`,
1402 /// or if an output descriptor script_pubkey does not match the one we can spend.
1405 pub extern "C" fn InMemorySigner_sign_counterparty_payment_input(this_arg: &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 {
1406 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::SECP256K1);
1407 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() };
1411 /// Sign the single input of spend_tx at index `input_idx` which spends the output
1412 /// described by descriptor, returning the witness stack for the input.
1414 /// Returns an Err if the input at input_idx does not exist, has a non-empty script_sig,
1415 /// is not spending the outpoint described by `descriptor.outpoint`, does not have a
1416 /// sequence set to `descriptor.to_self_delay`, or if an output descriptor
1417 /// script_pubkey does not match the one we can spend.
1420 pub extern "C" fn InMemorySigner_sign_dynamic_p2wsh_input(this_arg: &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 {
1421 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::SECP256K1);
1422 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() };
1426 impl From<nativeInMemorySigner> for crate::lightning::chain::keysinterface::BaseSign {
1427 fn from(obj: nativeInMemorySigner) -> Self {
1428 let mut rust_obj = InMemorySigner { inner: ObjOps::heap_alloc(obj), is_owned: true };
1429 let mut ret = InMemorySigner_as_BaseSign(&rust_obj);
1430 // 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
1431 rust_obj.inner = core::ptr::null_mut();
1432 ret.free = Some(InMemorySigner_free_void);
1436 /// Constructs a new BaseSign which calls the relevant methods on this_arg.
1437 /// This copies the `inner` pointer in this_arg and thus the returned BaseSign must be freed before this_arg is
1439 pub extern "C" fn InMemorySigner_as_BaseSign(this_arg: &InMemorySigner) -> crate::lightning::chain::keysinterface::BaseSign {
1440 crate::lightning::chain::keysinterface::BaseSign {
1441 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
1443 get_per_commitment_point: InMemorySigner_BaseSign_get_per_commitment_point,
1444 release_commitment_secret: InMemorySigner_BaseSign_release_commitment_secret,
1445 validate_holder_commitment: InMemorySigner_BaseSign_validate_holder_commitment,
1447 pubkeys: crate::lightning::ln::chan_utils::ChannelPublicKeys { inner: core::ptr::null_mut(), is_owned: true },
1448 set_pubkeys: Some(InMemorySigner_BaseSign_set_pubkeys),
1449 channel_keys_id: InMemorySigner_BaseSign_channel_keys_id,
1450 sign_counterparty_commitment: InMemorySigner_BaseSign_sign_counterparty_commitment,
1451 validate_counterparty_revocation: InMemorySigner_BaseSign_validate_counterparty_revocation,
1452 sign_holder_commitment_and_htlcs: InMemorySigner_BaseSign_sign_holder_commitment_and_htlcs,
1453 sign_justice_revoked_output: InMemorySigner_BaseSign_sign_justice_revoked_output,
1454 sign_justice_revoked_htlc: InMemorySigner_BaseSign_sign_justice_revoked_htlc,
1455 sign_counterparty_htlc_transaction: InMemorySigner_BaseSign_sign_counterparty_htlc_transaction,
1456 sign_closing_transaction: InMemorySigner_BaseSign_sign_closing_transaction,
1457 sign_channel_announcement: InMemorySigner_BaseSign_sign_channel_announcement,
1458 ready_channel: InMemorySigner_BaseSign_ready_channel,
1463 extern "C" fn InMemorySigner_BaseSign_get_per_commitment_point(this_arg: *const c_void, mut idx: u64) -> crate::c_types::PublicKey {
1464 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::get_per_commitment_point(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, idx, secp256k1::SECP256K1);
1465 crate::c_types::PublicKey::from_rust(&ret)
1468 extern "C" fn InMemorySigner_BaseSign_release_commitment_secret(this_arg: *const c_void, mut idx: u64) -> crate::c_types::ThirtyTwoBytes {
1469 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::release_commitment_secret(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, idx);
1470 crate::c_types::ThirtyTwoBytes { data: ret }
1473 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 {
1474 let mut local__preimages = Vec::new(); for mut item in _preimages.into_rust().drain(..) { local__preimages.push( { ::lightning::ln::PaymentPreimage(item.data) }); };
1475 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);
1476 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() };
1480 extern "C" fn InMemorySigner_BaseSign_pubkeys(this_arg: *const c_void) -> crate::lightning::ln::chan_utils::ChannelPublicKeys {
1481 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::pubkeys(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, );
1482 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 }
1484 extern "C" fn InMemorySigner_BaseSign_set_pubkeys(trait_self_arg: &BaseSign) {
1485 // This is a bit race-y in the general case, but for our specific use-cases today, we're safe
1486 // Specifically, we must ensure that the first time we're called it can never be in parallel
1487 if trait_self_arg.pubkeys.inner.is_null() {
1488 unsafe { &mut *(trait_self_arg as *const BaseSign as *mut BaseSign) }.pubkeys = InMemorySigner_BaseSign_pubkeys(trait_self_arg.this_arg);
1492 extern "C" fn InMemorySigner_BaseSign_channel_keys_id(this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes {
1493 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::channel_keys_id(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, );
1494 crate::c_types::ThirtyTwoBytes { data: ret }
1497 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 {
1498 let mut local__preimages = Vec::new(); for mut item in _preimages.into_rust().drain(..) { local__preimages.push( { ::lightning::ln::PaymentPreimage(item.data) }); };
1499 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::SECP256K1);
1500 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() };
1504 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 {
1505 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::validate_counterparty_revocation(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, _idx, &::bitcoin::secp256k1::key::SecretKey::from_slice(&unsafe { *_secret}[..]).unwrap());
1506 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() };
1510 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 {
1511 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::SECP256K1);
1512 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() };
1516 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 {
1517 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::key::SecretKey::from_slice(&unsafe { *per_commitment_key}[..]).unwrap(), secp256k1::SECP256K1);
1518 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() };
1522 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 {
1523 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::key::SecretKey::from_slice(&unsafe { *per_commitment_key}[..]).unwrap(), htlc.get_native_ref(), secp256k1::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_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 {
1529 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::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_closing_transaction(this_arg: *const c_void, closing_tx: &crate::lightning::ln::chan_utils::ClosingTransaction) -> crate::c_types::derived::CResult_SignatureNoneZ {
1535 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::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_channel_announcement(this_arg: *const c_void, msg: &crate::lightning::ln::msgs::UnsignedChannelAnnouncement) -> crate::c_types::derived::CResult_C2Tuple_SignatureSignatureZNoneZ {
1541 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::sign_channel_announcement(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, msg.get_native_ref(), secp256k1::SECP256K1);
1542 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() };
1545 extern "C" fn InMemorySigner_BaseSign_ready_channel(this_arg: *mut c_void, channel_parameters: &crate::lightning::ln::chan_utils::ChannelTransactionParameters) {
1546 <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::ready_channel(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, channel_parameters.get_native_ref())
1549 impl From<nativeInMemorySigner> for crate::lightning::chain::keysinterface::Sign {
1550 fn from(obj: nativeInMemorySigner) -> Self {
1551 let mut rust_obj = InMemorySigner { inner: ObjOps::heap_alloc(obj), is_owned: true };
1552 let mut ret = InMemorySigner_as_Sign(&rust_obj);
1553 // 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
1554 rust_obj.inner = core::ptr::null_mut();
1555 ret.free = Some(InMemorySigner_free_void);
1559 /// Constructs a new Sign which calls the relevant methods on this_arg.
1560 /// This copies the `inner` pointer in this_arg and thus the returned Sign must be freed before this_arg is
1562 pub extern "C" fn InMemorySigner_as_Sign(this_arg: &InMemorySigner) -> crate::lightning::chain::keysinterface::Sign {
1563 crate::lightning::chain::keysinterface::Sign {
1564 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
1566 BaseSign: crate::lightning::chain::keysinterface::BaseSign {
1567 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
1569 get_per_commitment_point: InMemorySigner_BaseSign_get_per_commitment_point,
1570 release_commitment_secret: InMemorySigner_BaseSign_release_commitment_secret,
1571 validate_holder_commitment: InMemorySigner_BaseSign_validate_holder_commitment,
1573 pubkeys: crate::lightning::ln::chan_utils::ChannelPublicKeys { inner: core::ptr::null_mut(), is_owned: true },
1574 set_pubkeys: Some(InMemorySigner_BaseSign_set_pubkeys),
1575 channel_keys_id: InMemorySigner_BaseSign_channel_keys_id,
1576 sign_counterparty_commitment: InMemorySigner_BaseSign_sign_counterparty_commitment,
1577 validate_counterparty_revocation: InMemorySigner_BaseSign_validate_counterparty_revocation,
1578 sign_holder_commitment_and_htlcs: InMemorySigner_BaseSign_sign_holder_commitment_and_htlcs,
1579 sign_justice_revoked_output: InMemorySigner_BaseSign_sign_justice_revoked_output,
1580 sign_justice_revoked_htlc: InMemorySigner_BaseSign_sign_justice_revoked_htlc,
1581 sign_counterparty_htlc_transaction: InMemorySigner_BaseSign_sign_counterparty_htlc_transaction,
1582 sign_closing_transaction: InMemorySigner_BaseSign_sign_closing_transaction,
1583 sign_channel_announcement: InMemorySigner_BaseSign_sign_channel_announcement,
1584 ready_channel: InMemorySigner_BaseSign_ready_channel,
1586 write: InMemorySigner_write_void,
1587 cloned: Some(Sign_InMemorySigner_cloned),
1591 extern "C" fn Sign_InMemorySigner_cloned(new_obj: &mut crate::lightning::chain::keysinterface::Sign) {
1592 new_obj.this_arg = InMemorySigner_clone_void(new_obj.this_arg);
1593 new_obj.free = Some(InMemorySigner_free_void);
1594 new_obj.BaseSign.this_arg = new_obj.this_arg;
1595 new_obj.BaseSign.free = None;
1599 /// Serialize the InMemorySigner object into a byte array which can be read by InMemorySigner_read
1600 pub extern "C" fn InMemorySigner_write(obj: &InMemorySigner) -> crate::c_types::derived::CVec_u8Z {
1601 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
1604 pub(crate) extern "C" fn InMemorySigner_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1605 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeInMemorySigner) })
1608 /// Read a InMemorySigner from a byte array, created by InMemorySigner_write
1609 pub extern "C" fn InMemorySigner_read(ser: crate::c_types::u8slice, arg: crate::c_types::SecretKey) -> crate::c_types::derived::CResult_InMemorySignerDecodeErrorZ {
1610 let arg_conv = arg.into_rust();
1611 let res: Result<lightning::chain::keysinterface::InMemorySigner, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj_arg(ser, arg_conv);
1612 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() };
1616 use lightning::chain::keysinterface::KeysManager as nativeKeysManagerImport;
1617 pub(crate) type nativeKeysManager = nativeKeysManagerImport;
1619 /// Simple KeysInterface implementor that takes a 32-byte seed for use as a BIP 32 extended key
1620 /// and derives keys from that.
1622 /// Your node_id is seed/0'
1623 /// ChannelMonitor closes may use seed/1'
1624 /// Cooperative closes may use seed/2'
1625 /// The two close keys may be needed to claim on-chain funds!
1627 /// This struct cannot be used for nodes that wish to support receiving phantom payments;
1628 /// [`PhantomKeysManager`] must be used instead.
1630 /// Note that switching between this struct and [`PhantomKeysManager`] will invalidate any
1631 /// previously issued invoices and attempts to pay previous invoices will fail.
1634 pub struct KeysManager {
1635 /// A pointer to the opaque Rust object.
1637 /// Nearly everywhere, inner must be non-null, however in places where
1638 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1639 pub inner: *mut nativeKeysManager,
1640 /// Indicates that this is the only struct which contains the same pointer.
1642 /// Rust functions which take ownership of an object provided via an argument require
1643 /// this to be true and invalidate the object pointed to by inner.
1647 impl Drop for KeysManager {
1648 fn drop(&mut self) {
1649 if self.is_owned && !<*mut nativeKeysManager>::is_null(self.inner) {
1650 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1654 /// Frees any resources used by the KeysManager, if is_owned is set and inner is non-NULL.
1656 pub extern "C" fn KeysManager_free(this_obj: KeysManager) { }
1658 /// Used only if an object of this type is returned as a trait impl by a method
1659 pub(crate) extern "C" fn KeysManager_free_void(this_ptr: *mut c_void) {
1660 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeKeysManager); }
1664 pub(crate) fn get_native_ref(&self) -> &'static nativeKeysManager {
1665 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1667 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeKeysManager {
1668 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1670 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1671 pub(crate) fn take_inner(mut self) -> *mut nativeKeysManager {
1672 assert!(self.is_owned);
1673 let ret = ObjOps::untweak_ptr(self.inner);
1674 self.inner = core::ptr::null_mut();
1678 /// Constructs a KeysManager from a 32-byte seed. If the seed is in some way biased (eg your
1679 /// CSRNG is busted) this may panic (but more importantly, you will possibly lose funds).
1680 /// starting_time isn't strictly required to actually be a time, but it must absolutely,
1681 /// without a doubt, be unique to this instance. ie if you start multiple times with the same
1682 /// seed, starting_time must be unique to each run. Thus, the easiest way to achieve this is to
1683 /// simply use the current time (with very high precision).
1685 /// The seed MUST be backed up safely prior to use so that the keys can be re-created, however,
1686 /// obviously, starting_time should be unique every time you reload the library - it is only
1687 /// used to generate new ephemeral key data (which will be stored by the individual channel if
1690 /// Note that the seed is required to recover certain on-chain funds independent of
1691 /// ChannelMonitor data, though a current copy of ChannelMonitor data is also required for any
1692 /// channel, and some on-chain during-closing funds.
1694 /// Note that until the 0.1 release there is no guarantee of backward compatibility between
1695 /// versions. Once the library is more fully supported, the docs will be updated to include a
1696 /// detailed description of the guarantee.
1699 pub extern "C" fn KeysManager_new(seed: *const [u8; 32], mut starting_time_secs: u64, mut starting_time_nanos: u32) -> KeysManager {
1700 let mut ret = lightning::chain::keysinterface::KeysManager::new(unsafe { &*seed}, starting_time_secs, starting_time_nanos);
1701 KeysManager { inner: ObjOps::heap_alloc(ret), is_owned: true }
1704 /// Derive an old Sign containing per-channel secrets based on a key derivation parameters.
1706 /// Key derivation parameters are accessible through a per-channel secrets
1707 /// Sign::channel_keys_id and is provided inside DynamicOuputP2WSH in case of
1708 /// onchain output detection for which a corresponding delayed_payment_key must be derived.
1711 pub extern "C" fn KeysManager_derive_channel_keys(this_arg: &KeysManager, mut channel_value_satoshis: u64, params: *const [u8; 32]) -> crate::lightning::chain::keysinterface::InMemorySigner {
1712 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.derive_channel_keys(channel_value_satoshis, unsafe { &*params});
1713 crate::lightning::chain::keysinterface::InMemorySigner { inner: ObjOps::heap_alloc(ret), is_owned: true }
1716 /// Creates a Transaction which spends the given descriptors to the given outputs, plus an
1717 /// output to the given change destination (if sufficient change value remains). The
1718 /// transaction will have a feerate, at least, of the given value.
1720 /// Returns `Err(())` if the output value is greater than the input value minus required fee,
1721 /// if a descriptor was duplicated, or if an output descriptor `script_pubkey`
1722 /// does not match the one we can spend.
1724 /// We do not enforce that outputs meet the dust limit or that any output scripts are standard.
1726 /// May panic if the `SpendableOutputDescriptor`s were not generated by Channels which used
1727 /// this KeysManager or one of the `InMemorySigner` created by this KeysManager.
1730 pub extern "C" fn KeysManager_spend_spendable_outputs(this_arg: &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 {
1731 let mut local_descriptors = Vec::new(); for mut item in descriptors.into_rust().drain(..) { local_descriptors.push( { item.into_native() }); };
1732 let mut local_outputs = Vec::new(); for mut item in outputs.into_rust().drain(..) { local_outputs.push( { item.into_rust() }); };
1733 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::SECP256K1);
1734 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() };
1738 impl From<nativeKeysManager> for crate::lightning::chain::keysinterface::KeysInterface {
1739 fn from(obj: nativeKeysManager) -> Self {
1740 let mut rust_obj = KeysManager { inner: ObjOps::heap_alloc(obj), is_owned: true };
1741 let mut ret = KeysManager_as_KeysInterface(&rust_obj);
1742 // 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
1743 rust_obj.inner = core::ptr::null_mut();
1744 ret.free = Some(KeysManager_free_void);
1748 /// Constructs a new KeysInterface which calls the relevant methods on this_arg.
1749 /// This copies the `inner` pointer in this_arg and thus the returned KeysInterface must be freed before this_arg is
1751 pub extern "C" fn KeysManager_as_KeysInterface(this_arg: &KeysManager) -> crate::lightning::chain::keysinterface::KeysInterface {
1752 crate::lightning::chain::keysinterface::KeysInterface {
1753 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
1755 get_node_secret: KeysManager_KeysInterface_get_node_secret,
1756 get_destination_script: KeysManager_KeysInterface_get_destination_script,
1757 get_shutdown_scriptpubkey: KeysManager_KeysInterface_get_shutdown_scriptpubkey,
1758 get_channel_signer: KeysManager_KeysInterface_get_channel_signer,
1759 get_secure_random_bytes: KeysManager_KeysInterface_get_secure_random_bytes,
1760 read_chan_signer: KeysManager_KeysInterface_read_chan_signer,
1761 sign_invoice: KeysManager_KeysInterface_sign_invoice,
1762 get_inbound_payment_key_material: KeysManager_KeysInterface_get_inbound_payment_key_material,
1767 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 {
1768 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_node_secret(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, recipient.into_native());
1769 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() };
1773 extern "C" fn KeysManager_KeysInterface_get_inbound_payment_key_material(this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes {
1774 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_inbound_payment_key_material(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, );
1775 crate::c_types::ThirtyTwoBytes { data: ret.0 }
1778 extern "C" fn KeysManager_KeysInterface_get_destination_script(this_arg: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1779 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_destination_script(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, );
1780 ret.into_bytes().into()
1783 extern "C" fn KeysManager_KeysInterface_get_shutdown_scriptpubkey(this_arg: *const c_void) -> crate::lightning::ln::script::ShutdownScript {
1784 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_shutdown_scriptpubkey(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, );
1785 crate::lightning::ln::script::ShutdownScript { inner: ObjOps::heap_alloc(ret), is_owned: true }
1788 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 {
1789 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_channel_signer(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, _inbound, channel_value_satoshis);
1793 extern "C" fn KeysManager_KeysInterface_get_secure_random_bytes(this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes {
1794 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_secure_random_bytes(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, );
1795 crate::c_types::ThirtyTwoBytes { data: ret }
1798 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 {
1799 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::read_chan_signer(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, reader.to_slice());
1800 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() };
1804 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 {
1805 let mut local_invoice_data = Vec::new(); for mut item in invoice_data.into_rust().drain(..) { local_invoice_data.push( { item.into() }); };
1806 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());
1807 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 use lightning::chain::keysinterface::PhantomKeysManager as nativePhantomKeysManagerImport;
1813 pub(crate) type nativePhantomKeysManager = nativePhantomKeysManagerImport;
1815 /// Similar to [`KeysManager`], but allows the node using this struct to receive phantom node
1818 /// A phantom node payment is a payment made to a phantom invoice, which is an invoice that can be
1819 /// paid to one of multiple nodes. This works because we encode the invoice route hints such that
1820 /// LDK will recognize an incoming payment as destined for a phantom node, and collect the payment
1821 /// itself without ever needing to forward to this fake node.
1823 /// Phantom node payments are useful for load balancing between multiple LDK nodes. They also
1824 /// provide some fault tolerance, because payers will automatically retry paying other provided
1825 /// nodes in the case that one node goes down.
1827 /// Note that multi-path payments are not supported in phantom invoices for security reasons.
1828 /// Switching between this struct and [`KeysManager`] will invalidate any previously issued
1829 /// invoices and attempts to pay previous invoices will fail.
1832 pub struct PhantomKeysManager {
1833 /// A pointer to the opaque Rust object.
1835 /// Nearly everywhere, inner must be non-null, however in places where
1836 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1837 pub inner: *mut nativePhantomKeysManager,
1838 /// Indicates that this is the only struct which contains the same pointer.
1840 /// Rust functions which take ownership of an object provided via an argument require
1841 /// this to be true and invalidate the object pointed to by inner.
1845 impl Drop for PhantomKeysManager {
1846 fn drop(&mut self) {
1847 if self.is_owned && !<*mut nativePhantomKeysManager>::is_null(self.inner) {
1848 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1852 /// Frees any resources used by the PhantomKeysManager, if is_owned is set and inner is non-NULL.
1854 pub extern "C" fn PhantomKeysManager_free(this_obj: PhantomKeysManager) { }
1856 /// Used only if an object of this type is returned as a trait impl by a method
1857 pub(crate) extern "C" fn PhantomKeysManager_free_void(this_ptr: *mut c_void) {
1858 unsafe { let _ = Box::from_raw(this_ptr as *mut nativePhantomKeysManager); }
1861 impl PhantomKeysManager {
1862 pub(crate) fn get_native_ref(&self) -> &'static nativePhantomKeysManager {
1863 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1865 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativePhantomKeysManager {
1866 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1868 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1869 pub(crate) fn take_inner(mut self) -> *mut nativePhantomKeysManager {
1870 assert!(self.is_owned);
1871 let ret = ObjOps::untweak_ptr(self.inner);
1872 self.inner = core::ptr::null_mut();
1876 impl From<nativePhantomKeysManager> for crate::lightning::chain::keysinterface::KeysInterface {
1877 fn from(obj: nativePhantomKeysManager) -> Self {
1878 let mut rust_obj = PhantomKeysManager { inner: ObjOps::heap_alloc(obj), is_owned: true };
1879 let mut ret = PhantomKeysManager_as_KeysInterface(&rust_obj);
1880 // 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
1881 rust_obj.inner = core::ptr::null_mut();
1882 ret.free = Some(PhantomKeysManager_free_void);
1886 /// Constructs a new KeysInterface which calls the relevant methods on this_arg.
1887 /// This copies the `inner` pointer in this_arg and thus the returned KeysInterface must be freed before this_arg is
1889 pub extern "C" fn PhantomKeysManager_as_KeysInterface(this_arg: &PhantomKeysManager) -> crate::lightning::chain::keysinterface::KeysInterface {
1890 crate::lightning::chain::keysinterface::KeysInterface {
1891 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
1893 get_node_secret: PhantomKeysManager_KeysInterface_get_node_secret,
1894 get_destination_script: PhantomKeysManager_KeysInterface_get_destination_script,
1895 get_shutdown_scriptpubkey: PhantomKeysManager_KeysInterface_get_shutdown_scriptpubkey,
1896 get_channel_signer: PhantomKeysManager_KeysInterface_get_channel_signer,
1897 get_secure_random_bytes: PhantomKeysManager_KeysInterface_get_secure_random_bytes,
1898 read_chan_signer: PhantomKeysManager_KeysInterface_read_chan_signer,
1899 sign_invoice: PhantomKeysManager_KeysInterface_sign_invoice,
1900 get_inbound_payment_key_material: PhantomKeysManager_KeysInterface_get_inbound_payment_key_material,
1905 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 {
1906 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_node_secret(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, recipient.into_native());
1907 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() };
1911 extern "C" fn PhantomKeysManager_KeysInterface_get_inbound_payment_key_material(this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes {
1912 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_inbound_payment_key_material(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, );
1913 crate::c_types::ThirtyTwoBytes { data: ret.0 }
1916 extern "C" fn PhantomKeysManager_KeysInterface_get_destination_script(this_arg: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1917 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_destination_script(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, );
1918 ret.into_bytes().into()
1921 extern "C" fn PhantomKeysManager_KeysInterface_get_shutdown_scriptpubkey(this_arg: *const c_void) -> crate::lightning::ln::script::ShutdownScript {
1922 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_shutdown_scriptpubkey(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, );
1923 crate::lightning::ln::script::ShutdownScript { inner: ObjOps::heap_alloc(ret), is_owned: true }
1926 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 {
1927 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_channel_signer(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, inbound, channel_value_satoshis);
1931 extern "C" fn PhantomKeysManager_KeysInterface_get_secure_random_bytes(this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes {
1932 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_secure_random_bytes(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, );
1933 crate::c_types::ThirtyTwoBytes { data: ret }
1936 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 {
1937 let mut ret = <nativePhantomKeysManager as lightning::chain::keysinterface::KeysInterface<>>::read_chan_signer(unsafe { &mut *(this_arg as *mut nativePhantomKeysManager) }, reader.to_slice());
1938 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() };
1942 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 {
1943 let mut local_invoice_data = Vec::new(); for mut item in invoice_data.into_rust().drain(..) { local_invoice_data.push( { item.into() }); };
1944 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());
1945 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() };
1949 /// Constructs a `PhantomKeysManager` given a 32-byte seed and an additional `cross_node_seed`
1950 /// that is shared across all nodes that intend to participate in [phantom node payments] together.
1952 /// See [`KeysManager::new`] for more information on `seed`, `starting_time_secs`, and
1953 /// `starting_time_nanos`.
1955 /// `cross_node_seed` must be the same across all phantom payment-receiving nodes and also the
1956 /// same across restarts, or else inbound payments may fail.
1958 /// [phantom node payments]: PhantomKeysManager
1961 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]) -> PhantomKeysManager {
1962 let mut ret = lightning::chain::keysinterface::PhantomKeysManager::new(unsafe { &*seed}, starting_time_secs, starting_time_nanos, unsafe { &*cross_node_seed});
1963 PhantomKeysManager { inner: ObjOps::heap_alloc(ret), is_owned: true }
1966 /// See [`KeysManager::spend_spendable_outputs`] for documentation on this method.
1969 pub extern "C" fn PhantomKeysManager_spend_spendable_outputs(this_arg: &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 {
1970 let mut local_descriptors = Vec::new(); for mut item in descriptors.into_rust().drain(..) { local_descriptors.push( { item.into_native() }); };
1971 let mut local_outputs = Vec::new(); for mut item in outputs.into_rust().drain(..) { local_outputs.push( { item.into_rust() }); };
1972 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::SECP256K1);
1973 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() };
1977 /// See [`KeysManager::derive_channel_keys`] for documentation on this method.
1980 pub extern "C" fn PhantomKeysManager_derive_channel_keys(this_arg: &PhantomKeysManager, mut channel_value_satoshis: u64, params: *const [u8; 32]) -> crate::lightning::chain::keysinterface::InMemorySigner {
1981 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.derive_channel_keys(channel_value_satoshis, unsafe { &*params});
1982 crate::lightning::chain::keysinterface::InMemorySigner { inner: ObjOps::heap_alloc(ret), is_owned: true }