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 std::str::FromStr;
15 use core::convert::Infallible;
16 use bitcoin::hashes::Hash;
17 use crate::c_types::*;
20 use lightning::chain::keysinterface::DelayedPaymentOutputDescriptor as nativeDelayedPaymentOutputDescriptorImport;
21 type nativeDelayedPaymentOutputDescriptor = nativeDelayedPaymentOutputDescriptorImport;
23 /// Information about a spendable output to a P2WSH script. See
24 /// SpendableOutputDescriptor::DelayedPaymentOutput for more details on how to spend this.
27 pub struct DelayedPaymentOutputDescriptor {
28 /// A pointer to the opaque Rust object.
30 /// Nearly everywhere, inner must be non-null, however in places where
31 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
32 pub inner: *mut nativeDelayedPaymentOutputDescriptor,
33 /// Indicates that this is the only struct which contains the same pointer.
35 /// Rust functions which take ownership of an object provided via an argument require
36 /// this to be true and invalidate the object pointed to by inner.
40 impl Drop for DelayedPaymentOutputDescriptor {
42 if self.is_owned && !<*mut nativeDelayedPaymentOutputDescriptor>::is_null(self.inner) {
43 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
47 /// Frees any resources used by the DelayedPaymentOutputDescriptor, if is_owned is set and inner is non-NULL.
49 pub extern "C" fn DelayedPaymentOutputDescriptor_free(this_obj: DelayedPaymentOutputDescriptor) { }
51 /// Used only if an object of this type is returned as a trait impl by a method
52 extern "C" fn DelayedPaymentOutputDescriptor_free_void(this_ptr: *mut c_void) {
53 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeDelayedPaymentOutputDescriptor); }
56 impl DelayedPaymentOutputDescriptor {
57 pub(crate) fn get_native_ref(&self) -> &'static nativeDelayedPaymentOutputDescriptor {
58 unsafe { &*ObjOps::untweak_ptr(self.inner) }
60 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeDelayedPaymentOutputDescriptor {
61 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
63 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
64 pub(crate) fn take_inner(mut self) -> *mut nativeDelayedPaymentOutputDescriptor {
65 assert!(self.is_owned);
66 let ret = ObjOps::untweak_ptr(self.inner);
67 self.inner = std::ptr::null_mut();
71 /// The outpoint which is spendable
73 pub extern "C" fn DelayedPaymentOutputDescriptor_get_outpoint(this_ptr: &DelayedPaymentOutputDescriptor) -> crate::lightning::chain::transaction::OutPoint {
74 let mut inner_val = &mut this_ptr.get_native_mut_ref().outpoint;
75 crate::lightning::chain::transaction::OutPoint { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const _) as *mut _) }, is_owned: false }
77 /// The outpoint which is spendable
79 pub extern "C" fn DelayedPaymentOutputDescriptor_set_outpoint(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: crate::lightning::chain::transaction::OutPoint) {
80 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.outpoint = *unsafe { Box::from_raw(val.take_inner()) };
82 /// Per commitment point to derive delayed_payment_key by key holder
84 pub extern "C" fn DelayedPaymentOutputDescriptor_get_per_commitment_point(this_ptr: &DelayedPaymentOutputDescriptor) -> crate::c_types::PublicKey {
85 let mut inner_val = &mut this_ptr.get_native_mut_ref().per_commitment_point;
86 crate::c_types::PublicKey::from_rust(&inner_val)
88 /// Per commitment point to derive delayed_payment_key by key holder
90 pub extern "C" fn DelayedPaymentOutputDescriptor_set_per_commitment_point(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: crate::c_types::PublicKey) {
91 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.per_commitment_point = val.into_rust();
93 /// The nSequence value which must be set in the spending input to satisfy the OP_CSV in
94 /// the witness_script.
96 pub extern "C" fn DelayedPaymentOutputDescriptor_get_to_self_delay(this_ptr: &DelayedPaymentOutputDescriptor) -> u16 {
97 let mut inner_val = &mut this_ptr.get_native_mut_ref().to_self_delay;
100 /// The nSequence value which must be set in the spending input to satisfy the OP_CSV in
101 /// the witness_script.
103 pub extern "C" fn DelayedPaymentOutputDescriptor_set_to_self_delay(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: u16) {
104 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.to_self_delay = val;
106 /// The output which is referenced by the given outpoint
108 pub extern "C" fn DelayedPaymentOutputDescriptor_set_output(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: crate::c_types::TxOut) {
109 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.output = val.into_rust();
111 /// The revocation point specific to the commitment transaction which was broadcast. Used to
112 /// derive the witnessScript for this output.
114 pub extern "C" fn DelayedPaymentOutputDescriptor_get_revocation_pubkey(this_ptr: &DelayedPaymentOutputDescriptor) -> crate::c_types::PublicKey {
115 let mut inner_val = &mut this_ptr.get_native_mut_ref().revocation_pubkey;
116 crate::c_types::PublicKey::from_rust(&inner_val)
118 /// The revocation point specific to the commitment transaction which was broadcast. Used to
119 /// derive the witnessScript for this output.
121 pub extern "C" fn DelayedPaymentOutputDescriptor_set_revocation_pubkey(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: crate::c_types::PublicKey) {
122 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.revocation_pubkey = val.into_rust();
124 /// Arbitrary identification information returned by a call to
125 /// `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
126 /// the channel to spend the output.
128 pub extern "C" fn DelayedPaymentOutputDescriptor_get_channel_keys_id(this_ptr: &DelayedPaymentOutputDescriptor) -> *const [u8; 32] {
129 let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_keys_id;
132 /// Arbitrary identification information returned by a call to
133 /// `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
134 /// the channel to spend the output.
136 pub extern "C" fn DelayedPaymentOutputDescriptor_set_channel_keys_id(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: crate::c_types::ThirtyTwoBytes) {
137 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_keys_id = val.data;
139 /// The value of the channel which this output originated from, possibly indirectly.
141 pub extern "C" fn DelayedPaymentOutputDescriptor_get_channel_value_satoshis(this_ptr: &DelayedPaymentOutputDescriptor) -> u64 {
142 let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_value_satoshis;
145 /// The value of the channel which this output originated from, possibly indirectly.
147 pub extern "C" fn DelayedPaymentOutputDescriptor_set_channel_value_satoshis(this_ptr: &mut DelayedPaymentOutputDescriptor, mut val: u64) {
148 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_value_satoshis = val;
150 /// Constructs a new DelayedPaymentOutputDescriptor given each field
153 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 {
154 DelayedPaymentOutputDescriptor { inner: ObjOps::heap_alloc(nativeDelayedPaymentOutputDescriptor {
155 outpoint: *unsafe { Box::from_raw(outpoint_arg.take_inner()) },
156 per_commitment_point: per_commitment_point_arg.into_rust(),
157 to_self_delay: to_self_delay_arg,
158 output: output_arg.into_rust(),
159 revocation_pubkey: revocation_pubkey_arg.into_rust(),
160 channel_keys_id: channel_keys_id_arg.data,
161 channel_value_satoshis: channel_value_satoshis_arg,
164 impl Clone for DelayedPaymentOutputDescriptor {
165 fn clone(&self) -> Self {
167 inner: if <*mut nativeDelayedPaymentOutputDescriptor>::is_null(self.inner) { std::ptr::null_mut() } else {
168 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
174 /// Used only if an object of this type is returned as a trait impl by a method
175 pub(crate) extern "C" fn DelayedPaymentOutputDescriptor_clone_void(this_ptr: *const c_void) -> *mut c_void {
176 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeDelayedPaymentOutputDescriptor)).clone() })) as *mut c_void
179 /// Creates a copy of the DelayedPaymentOutputDescriptor
180 pub extern "C" fn DelayedPaymentOutputDescriptor_clone(orig: &DelayedPaymentOutputDescriptor) -> DelayedPaymentOutputDescriptor {
184 /// Serialize the DelayedPaymentOutputDescriptor object into a byte array which can be read by DelayedPaymentOutputDescriptor_read
185 pub extern "C" fn DelayedPaymentOutputDescriptor_write(obj: &DelayedPaymentOutputDescriptor) -> crate::c_types::derived::CVec_u8Z {
186 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
189 pub(crate) extern "C" fn DelayedPaymentOutputDescriptor_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
190 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeDelayedPaymentOutputDescriptor) })
193 /// Read a DelayedPaymentOutputDescriptor from a byte array, created by DelayedPaymentOutputDescriptor_write
194 pub extern "C" fn DelayedPaymentOutputDescriptor_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_DelayedPaymentOutputDescriptorDecodeErrorZ {
195 let res = crate::c_types::deserialize_obj(ser);
196 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() };
200 use lightning::chain::keysinterface::StaticPaymentOutputDescriptor as nativeStaticPaymentOutputDescriptorImport;
201 type nativeStaticPaymentOutputDescriptor = nativeStaticPaymentOutputDescriptorImport;
203 /// Information about a spendable output to our \"payment key\". See
204 /// SpendableOutputDescriptor::StaticPaymentOutput for more details on how to spend this.
207 pub struct StaticPaymentOutputDescriptor {
208 /// A pointer to the opaque Rust object.
210 /// Nearly everywhere, inner must be non-null, however in places where
211 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
212 pub inner: *mut nativeStaticPaymentOutputDescriptor,
213 /// Indicates that this is the only struct which contains the same pointer.
215 /// Rust functions which take ownership of an object provided via an argument require
216 /// this to be true and invalidate the object pointed to by inner.
220 impl Drop for StaticPaymentOutputDescriptor {
222 if self.is_owned && !<*mut nativeStaticPaymentOutputDescriptor>::is_null(self.inner) {
223 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
227 /// Frees any resources used by the StaticPaymentOutputDescriptor, if is_owned is set and inner is non-NULL.
229 pub extern "C" fn StaticPaymentOutputDescriptor_free(this_obj: StaticPaymentOutputDescriptor) { }
231 /// Used only if an object of this type is returned as a trait impl by a method
232 extern "C" fn StaticPaymentOutputDescriptor_free_void(this_ptr: *mut c_void) {
233 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeStaticPaymentOutputDescriptor); }
236 impl StaticPaymentOutputDescriptor {
237 pub(crate) fn get_native_ref(&self) -> &'static nativeStaticPaymentOutputDescriptor {
238 unsafe { &*ObjOps::untweak_ptr(self.inner) }
240 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeStaticPaymentOutputDescriptor {
241 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
243 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
244 pub(crate) fn take_inner(mut self) -> *mut nativeStaticPaymentOutputDescriptor {
245 assert!(self.is_owned);
246 let ret = ObjOps::untweak_ptr(self.inner);
247 self.inner = std::ptr::null_mut();
251 /// The outpoint which is spendable
253 pub extern "C" fn StaticPaymentOutputDescriptor_get_outpoint(this_ptr: &StaticPaymentOutputDescriptor) -> crate::lightning::chain::transaction::OutPoint {
254 let mut inner_val = &mut this_ptr.get_native_mut_ref().outpoint;
255 crate::lightning::chain::transaction::OutPoint { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const _) as *mut _) }, is_owned: false }
257 /// The outpoint which is spendable
259 pub extern "C" fn StaticPaymentOutputDescriptor_set_outpoint(this_ptr: &mut StaticPaymentOutputDescriptor, mut val: crate::lightning::chain::transaction::OutPoint) {
260 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.outpoint = *unsafe { Box::from_raw(val.take_inner()) };
262 /// The output which is referenced by the given outpoint
264 pub extern "C" fn StaticPaymentOutputDescriptor_set_output(this_ptr: &mut StaticPaymentOutputDescriptor, mut val: crate::c_types::TxOut) {
265 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.output = val.into_rust();
267 /// Arbitrary identification information returned by a call to
268 /// `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
269 /// the channel to spend the output.
271 pub extern "C" fn StaticPaymentOutputDescriptor_get_channel_keys_id(this_ptr: &StaticPaymentOutputDescriptor) -> *const [u8; 32] {
272 let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_keys_id;
275 /// Arbitrary identification information returned by a call to
276 /// `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
277 /// the channel to spend the output.
279 pub extern "C" fn StaticPaymentOutputDescriptor_set_channel_keys_id(this_ptr: &mut StaticPaymentOutputDescriptor, mut val: crate::c_types::ThirtyTwoBytes) {
280 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_keys_id = val.data;
282 /// The value of the channel which this transactions spends.
284 pub extern "C" fn StaticPaymentOutputDescriptor_get_channel_value_satoshis(this_ptr: &StaticPaymentOutputDescriptor) -> u64 {
285 let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_value_satoshis;
288 /// The value of the channel which this transactions spends.
290 pub extern "C" fn StaticPaymentOutputDescriptor_set_channel_value_satoshis(this_ptr: &mut StaticPaymentOutputDescriptor, mut val: u64) {
291 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_value_satoshis = val;
293 /// Constructs a new StaticPaymentOutputDescriptor given each field
296 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 {
297 StaticPaymentOutputDescriptor { inner: ObjOps::heap_alloc(nativeStaticPaymentOutputDescriptor {
298 outpoint: *unsafe { Box::from_raw(outpoint_arg.take_inner()) },
299 output: output_arg.into_rust(),
300 channel_keys_id: channel_keys_id_arg.data,
301 channel_value_satoshis: channel_value_satoshis_arg,
304 impl Clone for StaticPaymentOutputDescriptor {
305 fn clone(&self) -> Self {
307 inner: if <*mut nativeStaticPaymentOutputDescriptor>::is_null(self.inner) { std::ptr::null_mut() } else {
308 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
314 /// Used only if an object of this type is returned as a trait impl by a method
315 pub(crate) extern "C" fn StaticPaymentOutputDescriptor_clone_void(this_ptr: *const c_void) -> *mut c_void {
316 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeStaticPaymentOutputDescriptor)).clone() })) as *mut c_void
319 /// Creates a copy of the StaticPaymentOutputDescriptor
320 pub extern "C" fn StaticPaymentOutputDescriptor_clone(orig: &StaticPaymentOutputDescriptor) -> StaticPaymentOutputDescriptor {
324 /// Serialize the StaticPaymentOutputDescriptor object into a byte array which can be read by StaticPaymentOutputDescriptor_read
325 pub extern "C" fn StaticPaymentOutputDescriptor_write(obj: &StaticPaymentOutputDescriptor) -> crate::c_types::derived::CVec_u8Z {
326 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
329 pub(crate) extern "C" fn StaticPaymentOutputDescriptor_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
330 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeStaticPaymentOutputDescriptor) })
333 /// Read a StaticPaymentOutputDescriptor from a byte array, created by StaticPaymentOutputDescriptor_write
334 pub extern "C" fn StaticPaymentOutputDescriptor_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_StaticPaymentOutputDescriptorDecodeErrorZ {
335 let res = crate::c_types::deserialize_obj(ser);
336 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() };
339 /// When on-chain outputs are created by rust-lightning (which our counterparty is not able to
340 /// claim at any point in the future) an event is generated which you must track and be able to
341 /// spend on-chain. The information needed to do this is provided in this enum, including the
342 /// outpoint describing which txid and output index is available, the full output which exists at
343 /// that txid/index, and any keys or other information required to sign.
347 pub enum SpendableOutputDescriptor {
348 /// An output to a script which was provided via KeysInterface directly, either from
349 /// `get_destination_script()` or `get_shutdown_scriptpubkey()`, thus you should already know
350 /// how to spend it. No secret keys are provided as rust-lightning was never given any key.
351 /// These may include outputs from a transaction punishing our counterparty or claiming an HTLC
352 /// on-chain using the payment preimage or after it has timed out.
354 /// The outpoint which is spendable
355 outpoint: crate::lightning::chain::transaction::OutPoint,
356 /// The output which is referenced by the given outpoint.
357 output: crate::c_types::TxOut,
359 /// An output to a P2WSH script which can be spent with a single signature after a CSV delay.
361 /// The witness in the spending input should be:
362 /// <BIP 143 signature> <empty vector> (MINIMALIF standard rule) <provided witnessScript>
364 /// Note that the nSequence field in the spending input must be set to to_self_delay
365 /// (which means the transaction is not broadcastable until at least to_self_delay
366 /// blocks after the outpoint confirms).
368 /// These are generally the result of a \"revocable\" output to us, spendable only by us unless
369 /// it is an output from an old state which we broadcast (which should never happen).
371 /// To derive the delayed_payment key which is used to sign for this input, you must pass the
372 /// holder delayed_payment_base_key (ie the private key which corresponds to the pubkey in
373 /// Sign::pubkeys().delayed_payment_basepoint) and the provided per_commitment_point to
374 /// chan_utils::derive_private_key. The public key can be generated without the secret key
375 /// using chan_utils::derive_public_key and only the delayed_payment_basepoint which appears in
378 /// To derive the revocation_pubkey provided here (which is used in the witness
379 /// script generation), you must pass the counterparty revocation_basepoint (which appears in the
380 /// call to Sign::ready_channel) and the provided per_commitment point
381 /// to chan_utils::derive_public_revocation_key.
383 /// The witness script which is hashed and included in the output script_pubkey may be
384 /// regenerated by passing the revocation_pubkey (derived as above), our delayed_payment pubkey
385 /// (derived as above), and the to_self_delay contained here to
386 /// chan_utils::get_revokeable_redeemscript.
387 DelayedPaymentOutput(crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor),
388 /// An output to a P2WPKH, spendable exclusively by our payment key (ie the private key which
389 /// corresponds to the public key in Sign::pubkeys().payment_point).
390 /// The witness in the spending input, is, thus, simply:
391 /// <BIP 143 signature> <payment key>
393 /// These are generally the result of our counterparty having broadcast the current state,
394 /// allowing us to claim the non-HTLC-encumbered outputs immediately.
395 StaticPaymentOutput(crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor),
397 use lightning::chain::keysinterface::SpendableOutputDescriptor as nativeSpendableOutputDescriptor;
398 impl SpendableOutputDescriptor {
400 pub(crate) fn to_native(&self) -> nativeSpendableOutputDescriptor {
402 SpendableOutputDescriptor::StaticOutput {ref outpoint, ref output, } => {
403 let mut outpoint_nonref = (*outpoint).clone();
404 let mut output_nonref = (*output).clone();
405 nativeSpendableOutputDescriptor::StaticOutput {
406 outpoint: *unsafe { Box::from_raw(outpoint_nonref.take_inner()) },
407 output: output_nonref.into_rust(),
410 SpendableOutputDescriptor::DelayedPaymentOutput (ref a, ) => {
411 let mut a_nonref = (*a).clone();
412 nativeSpendableOutputDescriptor::DelayedPaymentOutput (
413 *unsafe { Box::from_raw(a_nonref.take_inner()) },
416 SpendableOutputDescriptor::StaticPaymentOutput (ref a, ) => {
417 let mut a_nonref = (*a).clone();
418 nativeSpendableOutputDescriptor::StaticPaymentOutput (
419 *unsafe { Box::from_raw(a_nonref.take_inner()) },
425 pub(crate) fn into_native(self) -> nativeSpendableOutputDescriptor {
427 SpendableOutputDescriptor::StaticOutput {mut outpoint, mut output, } => {
428 nativeSpendableOutputDescriptor::StaticOutput {
429 outpoint: *unsafe { Box::from_raw(outpoint.take_inner()) },
430 output: output.into_rust(),
433 SpendableOutputDescriptor::DelayedPaymentOutput (mut a, ) => {
434 nativeSpendableOutputDescriptor::DelayedPaymentOutput (
435 *unsafe { Box::from_raw(a.take_inner()) },
438 SpendableOutputDescriptor::StaticPaymentOutput (mut a, ) => {
439 nativeSpendableOutputDescriptor::StaticPaymentOutput (
440 *unsafe { Box::from_raw(a.take_inner()) },
446 pub(crate) fn from_native(native: &nativeSpendableOutputDescriptor) -> Self {
448 nativeSpendableOutputDescriptor::StaticOutput {ref outpoint, ref output, } => {
449 let mut outpoint_nonref = (*outpoint).clone();
450 let mut output_nonref = (*output).clone();
451 SpendableOutputDescriptor::StaticOutput {
452 outpoint: crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(outpoint_nonref), is_owned: true },
453 output: crate::c_types::TxOut::from_rust(output_nonref),
456 nativeSpendableOutputDescriptor::DelayedPaymentOutput (ref a, ) => {
457 let mut a_nonref = (*a).clone();
458 SpendableOutputDescriptor::DelayedPaymentOutput (
459 crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor { inner: ObjOps::heap_alloc(a_nonref), is_owned: true },
462 nativeSpendableOutputDescriptor::StaticPaymentOutput (ref a, ) => {
463 let mut a_nonref = (*a).clone();
464 SpendableOutputDescriptor::StaticPaymentOutput (
465 crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor { inner: ObjOps::heap_alloc(a_nonref), is_owned: true },
471 pub(crate) fn native_into(native: nativeSpendableOutputDescriptor) -> Self {
473 nativeSpendableOutputDescriptor::StaticOutput {mut outpoint, mut output, } => {
474 SpendableOutputDescriptor::StaticOutput {
475 outpoint: crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(outpoint), is_owned: true },
476 output: crate::c_types::TxOut::from_rust(output),
479 nativeSpendableOutputDescriptor::DelayedPaymentOutput (mut a, ) => {
480 SpendableOutputDescriptor::DelayedPaymentOutput (
481 crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor { inner: ObjOps::heap_alloc(a), is_owned: true },
484 nativeSpendableOutputDescriptor::StaticPaymentOutput (mut a, ) => {
485 SpendableOutputDescriptor::StaticPaymentOutput (
486 crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor { inner: ObjOps::heap_alloc(a), is_owned: true },
492 /// Frees any resources used by the SpendableOutputDescriptor
494 pub extern "C" fn SpendableOutputDescriptor_free(this_ptr: SpendableOutputDescriptor) { }
495 /// Creates a copy of the SpendableOutputDescriptor
497 pub extern "C" fn SpendableOutputDescriptor_clone(orig: &SpendableOutputDescriptor) -> SpendableOutputDescriptor {
501 /// Utility method to constructs a new StaticOutput-variant SpendableOutputDescriptor
502 pub extern "C" fn SpendableOutputDescriptor_static_output(outpoint: crate::lightning::chain::transaction::OutPoint, output: crate::c_types::TxOut) -> SpendableOutputDescriptor {
503 SpendableOutputDescriptor::StaticOutput {
509 /// Utility method to constructs a new DelayedPaymentOutput-variant SpendableOutputDescriptor
510 pub extern "C" fn SpendableOutputDescriptor_delayed_payment_output(a: crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor) -> SpendableOutputDescriptor {
511 SpendableOutputDescriptor::DelayedPaymentOutput(a, )
514 /// Utility method to constructs a new StaticPaymentOutput-variant SpendableOutputDescriptor
515 pub extern "C" fn SpendableOutputDescriptor_static_payment_output(a: crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor) -> SpendableOutputDescriptor {
516 SpendableOutputDescriptor::StaticPaymentOutput(a, )
519 /// Serialize the SpendableOutputDescriptor object into a byte array which can be read by SpendableOutputDescriptor_read
520 pub extern "C" fn SpendableOutputDescriptor_write(obj: &SpendableOutputDescriptor) -> crate::c_types::derived::CVec_u8Z {
521 crate::c_types::serialize_obj(&unsafe { &*obj }.to_native())
524 /// Read a SpendableOutputDescriptor from a byte array, created by SpendableOutputDescriptor_write
525 pub extern "C" fn SpendableOutputDescriptor_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_SpendableOutputDescriptorDecodeErrorZ {
526 let res = crate::c_types::deserialize_obj(ser);
527 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() };
530 /// A trait to sign lightning channel transactions as described in BOLT 3.
532 /// Signing services could be implemented on a hardware wallet. In this case,
533 /// the current Sign would be a front-end on top of a communication
534 /// channel connected to your secure device and lightning key material wouldn't
535 /// reside on a hot server. Nevertheless, a this deployment would still need
536 /// to trust the ChannelManager to avoid loss of funds as this latest component
537 /// could ask to sign commitment transaction with HTLCs paying to attacker pubkeys.
539 /// A more secure iteration would be to use hashlock (or payment points) to pair
540 /// invoice/incoming HTLCs with outgoing HTLCs to implement a no-trust-ChannelManager
541 /// at the price of more state and computation on the hardware wallet side. In the future,
542 /// we are looking forward to design such interface.
544 /// In any case, ChannelMonitor or fallback watchtowers are always going to be trusted
545 /// to act, as liveness and breach reply correctness are always going to be hard requirements
546 /// of LN security model, orthogonal of key management issues.
548 pub struct BaseSign {
549 /// An opaque pointer which is passed to your function implementations as an argument.
550 /// This has no meaning in the LDK, and can be NULL or any other value.
551 pub this_arg: *mut c_void,
552 /// Gets the per-commitment point for a specific commitment number
554 /// Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
556 pub get_per_commitment_point: extern "C" fn (this_arg: *const c_void, idx: u64) -> crate::c_types::PublicKey,
557 /// Gets the commitment secret for a specific commitment number as part of the revocation process
559 /// An external signer implementation should error here if the commitment was already signed
560 /// and should refuse to sign it in the future.
562 /// May be called more than once for the same index.
564 /// Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
566 pub release_commitment_secret: extern "C" fn (this_arg: *const c_void, idx: u64) -> crate::c_types::ThirtyTwoBytes,
567 /// Validate the counterparty's signatures on the holder commitment transaction and HTLCs.
569 /// This is required in order for the signer to make sure that releasing a commitment
570 /// secret won't leave us without a broadcastable holder transaction.
571 /// Policy checks should be implemented in this function, including checking the amount
572 /// sent to us and checking the HTLCs.
574 pub validate_holder_commitment: extern "C" fn (this_arg: *const c_void, holder_tx: &crate::lightning::ln::chan_utils::HolderCommitmentTransaction) -> crate::c_types::derived::CResult_NoneNoneZ,
575 /// Gets the holder's channel public keys and basepoints
576 pub pubkeys: crate::lightning::ln::chan_utils::ChannelPublicKeys,
577 /// Fill in the pubkeys field as a reference to it will be given to Rust after this returns
578 /// Note that this takes a pointer to this object, not the this_ptr like other methods do
579 /// This function pointer may be NULL if pubkeys is filled in when this object is created and never needs updating.
580 pub set_pubkeys: Option<extern "C" fn(&BaseSign)>,
581 /// Gets an arbitrary identifier describing the set of keys which are provided back to you in
582 /// some SpendableOutputDescriptor types. This should be sufficient to identify this
583 /// Sign object uniquely and lookup or re-derive its keys.
585 pub channel_keys_id: extern "C" fn (this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes,
586 /// Create a signature for a counterparty's commitment transaction and associated HTLC transactions.
588 /// Note that if signing fails or is rejected, the channel will be force-closed.
590 /// Policy checks should be implemented in this function, including checking the amount
591 /// sent to us and checking the HTLCs.
593 pub sign_counterparty_commitment: extern "C" fn (this_arg: *const c_void, commitment_tx: &crate::lightning::ln::chan_utils::CommitmentTransaction) -> crate::c_types::derived::CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ,
594 /// Validate the counterparty's revocation.
596 /// This is required in order for the signer to make sure that the state has moved
597 /// forward and it is safe to sign the next counterparty commitment.
599 pub validate_counterparty_revocation: extern "C" fn (this_arg: *const c_void, idx: u64, secret: *const [u8; 32]) -> crate::c_types::derived::CResult_NoneNoneZ,
600 /// Create a signatures for a holder's commitment transaction and its claiming HTLC transactions.
601 /// This will only ever be called with a non-revoked commitment_tx. This will be called with the
602 /// latest commitment_tx when we initiate a force-close.
603 /// This will be called with the previous latest, just to get claiming HTLC signatures, if we are
604 /// reacting to a ChannelMonitor replica that decided to broadcast before it had been updated to
606 /// This may be called multiple times for the same transaction.
608 /// An external signer implementation should check that the commitment has not been revoked.
610 /// May return Err if key derivation fails. Callers, such as ChannelMonitor, will panic in such a case.
612 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,
613 /// Create a signature for the given input in a transaction spending an HTLC transaction output
614 /// or a commitment transaction `to_local` output when our counterparty broadcasts an old state.
616 /// A justice transaction may claim multiple outputs at the same time if timelocks are
617 /// similar, but only a signature for the input at index `input` should be signed for here.
618 /// It may be called multiple times for same output(s) if a fee-bump is needed with regards
619 /// to an upcoming timelock expiration.
621 /// Amount is value of the output spent by this input, committed to in the BIP 143 signature.
623 /// per_commitment_key is revocation secret which was provided by our counterparty when they
624 /// revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
625 /// not allow the spending of any funds by itself (you need our holder revocation_secret to do
628 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,
629 /// Create a signature for the given input in a transaction spending a commitment transaction
630 /// HTLC 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 /// htlc holds HTLC elements (hash, timelock), thus changing the format of the witness script
645 /// (which is committed to in the BIP 143 signatures).
647 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,
648 /// Create a signature for a claiming transaction for a HTLC output on a counterparty's commitment
649 /// transaction, either offered or received.
651 /// Such a transaction may claim multiples offered outputs at same time if we know the
652 /// preimage for each when we create it, but only the input at index `input` should be
653 /// signed for here. It may be called multiple times for same output(s) if a fee-bump is
654 /// needed with regards to an upcoming timelock expiration.
656 /// Witness_script is either a offered or received script as defined in BOLT3 for HTLC
659 /// Amount is value of the output spent by this input, committed to in the BIP 143 signature.
661 /// Per_commitment_point is the dynamic point corresponding to the channel state
662 /// detected onchain. It has been generated by our counterparty and is used to derive
663 /// channel state keys, which are then included in the witness script and committed to in the
664 /// BIP 143 signature.
666 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,
667 /// Create a signature for a (proposed) closing transaction.
669 /// Note that, due to rounding, there may be one \"missing\" satoshi, and either party may have
670 /// chosen to forgo their output as dust.
672 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,
673 /// Signs a channel announcement message with our funding key, proving it comes from one
674 /// of the channel participants.
676 /// Note that if this fails or is rejected, the channel will not be publicly announced and
677 /// our counterparty may (though likely will not) close the channel on us for violating the
680 pub sign_channel_announcement: extern "C" fn (this_arg: *const c_void, msg: &crate::lightning::ln::msgs::UnsignedChannelAnnouncement) -> crate::c_types::derived::CResult_SignatureNoneZ,
681 /// Set the counterparty static channel data, including basepoints,
682 /// counterparty_selected/holder_selected_contest_delay and funding outpoint.
683 /// This is done as soon as the funding outpoint is known. Since these are static channel data,
684 /// they MUST NOT be allowed to change to different values once set.
686 /// channel_parameters.is_populated() MUST be true.
688 /// We bind holder_selected_contest_delay late here for API convenience.
690 /// Will be called before any signatures are applied.
691 pub ready_channel: extern "C" fn (this_arg: *mut c_void, channel_parameters: &crate::lightning::ln::chan_utils::ChannelTransactionParameters),
692 /// Frees any resources associated with this object given its this_arg pointer.
693 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
694 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
696 unsafe impl Send for BaseSign {}
697 unsafe impl Sync for BaseSign {}
699 pub(crate) extern "C" fn BaseSign_clone_fields(orig: &BaseSign) -> BaseSign {
701 this_arg: orig.this_arg,
702 get_per_commitment_point: Clone::clone(&orig.get_per_commitment_point),
703 release_commitment_secret: Clone::clone(&orig.release_commitment_secret),
704 validate_holder_commitment: Clone::clone(&orig.validate_holder_commitment),
705 pubkeys: Clone::clone(&orig.pubkeys),
706 set_pubkeys: Clone::clone(&orig.set_pubkeys),
707 channel_keys_id: Clone::clone(&orig.channel_keys_id),
708 sign_counterparty_commitment: Clone::clone(&orig.sign_counterparty_commitment),
709 validate_counterparty_revocation: Clone::clone(&orig.validate_counterparty_revocation),
710 sign_holder_commitment_and_htlcs: Clone::clone(&orig.sign_holder_commitment_and_htlcs),
711 sign_justice_revoked_output: Clone::clone(&orig.sign_justice_revoked_output),
712 sign_justice_revoked_htlc: Clone::clone(&orig.sign_justice_revoked_htlc),
713 sign_counterparty_htlc_transaction: Clone::clone(&orig.sign_counterparty_htlc_transaction),
714 sign_closing_transaction: Clone::clone(&orig.sign_closing_transaction),
715 sign_channel_announcement: Clone::clone(&orig.sign_channel_announcement),
716 ready_channel: Clone::clone(&orig.ready_channel),
717 free: Clone::clone(&orig.free),
721 use lightning::chain::keysinterface::BaseSign as rustBaseSign;
722 impl rustBaseSign for BaseSign {
723 fn get_per_commitment_point(&self, mut idx: u64, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> bitcoin::secp256k1::key::PublicKey {
724 let mut ret = (self.get_per_commitment_point)(self.this_arg, idx);
727 fn release_commitment_secret(&self, mut idx: u64) -> [u8; 32] {
728 let mut ret = (self.release_commitment_secret)(self.this_arg, idx);
731 fn validate_holder_commitment(&self, mut holder_tx: &lightning::ln::chan_utils::HolderCommitmentTransaction) -> Result<(), ()> {
732 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 _) as *mut _) }, is_owned: false });
733 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)) })*/ })};
736 fn pubkeys(&self) -> &lightning::ln::chan_utils::ChannelPublicKeys {
737 if let Some(f) = self.set_pubkeys {
740 self.pubkeys.get_native_ref()
742 fn channel_keys_id(&self) -> [u8; 32] {
743 let mut ret = (self.channel_keys_id)(self.this_arg);
746 fn sign_counterparty_commitment(&self, mut commitment_tx: &lightning::ln::chan_utils::CommitmentTransaction, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<(bitcoin::secp256k1::Signature, Vec<bitcoin::secp256k1::Signature>), ()> {
747 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 _) as *mut _) }, is_owned: false });
748 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)) })*/ })};
751 fn validate_counterparty_revocation(&self, mut idx: u64, mut secret: &bitcoin::secp256k1::key::SecretKey) -> Result<(), ()> {
752 let mut ret = (self.validate_counterparty_revocation)(self.this_arg, idx, secret.as_ref());
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 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>), ()> {
757 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 _) as *mut _) }, is_owned: false });
758 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)) })*/ })};
761 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, ()> {
762 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());
763 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)) })*/ })};
766 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, ()> {
767 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 _) as *mut _) }, is_owned: false });
768 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)) })*/ })};
771 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, ()> {
772 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 _) as *mut _) }, is_owned: false });
773 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)) })*/ })};
776 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, ()> {
777 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 _) as *mut _) }, is_owned: false });
778 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)) })*/ })};
781 fn sign_channel_announcement(&self, mut msg: &lightning::ln::msgs::UnsignedChannelAnnouncement, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<bitcoin::secp256k1::Signature, ()> {
782 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 _) as *mut _) }, is_owned: false });
783 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)) })*/ })};
786 fn ready_channel(&mut self, mut channel_parameters: &lightning::ln::chan_utils::ChannelTransactionParameters) {
787 (self.ready_channel)(self.this_arg, &crate::lightning::ln::chan_utils::ChannelTransactionParameters { inner: unsafe { ObjOps::nonnull_ptr_to_inner((channel_parameters as *const _) as *mut _) }, is_owned: false })
791 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
792 // directly as a Deref trait in higher-level structs:
793 impl std::ops::Deref for BaseSign {
795 fn deref(&self) -> &Self {
799 /// Calls the free function if one is set
801 pub extern "C" fn BaseSign_free(this_ptr: BaseSign) { }
802 impl Drop for BaseSign {
804 if let Some(f) = self.free {
809 /// A cloneable signer.
811 /// Although we require signers to be cloneable, it may be useful for developers to be able to use
812 /// signers in an un-sized way, for example as `dyn BaseSign`. Therefore we separate the Clone trait,
813 /// which implies Sized, into this derived trait.
816 /// An opaque pointer which is passed to your function implementations as an argument.
817 /// This has no meaning in the LDK, and can be NULL or any other value.
818 pub this_arg: *mut c_void,
819 /// Implementation of BaseSign for this object.
820 pub BaseSign: crate::lightning::chain::keysinterface::BaseSign,
821 /// Serialize the object into a byte array
822 pub write: extern "C" fn (this_arg: *const c_void) -> crate::c_types::derived::CVec_u8Z,
823 /// Called, if set, after this Sign has been cloned into a duplicate object.
824 /// The new Sign is provided, and should be mutated as needed to perform a
825 /// deep copy of the object pointed to by this_arg or avoid any double-freeing.
826 pub cloned: Option<extern "C" fn (new_Sign: &mut Sign)>,
827 /// Frees any resources associated with this object given its this_arg pointer.
828 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
829 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
831 unsafe impl Send for Sign {}
832 unsafe impl Sync for Sign {}
834 pub(crate) extern "C" fn Sign_clone_fields(orig: &Sign) -> Sign {
836 this_arg: orig.this_arg,
837 BaseSign: crate::lightning::chain::keysinterface::BaseSign_clone_fields(&orig.BaseSign),
838 write: Clone::clone(&orig.write),
839 cloned: Clone::clone(&orig.cloned),
840 free: Clone::clone(&orig.free),
843 impl lightning::chain::keysinterface::BaseSign for Sign {
844 fn get_per_commitment_point(&self, mut idx: u64, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> bitcoin::secp256k1::key::PublicKey {
845 let mut ret = (self.BaseSign.get_per_commitment_point)(self.BaseSign.this_arg, idx);
848 fn release_commitment_secret(&self, mut idx: u64) -> [u8; 32] {
849 let mut ret = (self.BaseSign.release_commitment_secret)(self.BaseSign.this_arg, idx);
852 fn validate_holder_commitment(&self, mut holder_tx: &lightning::ln::chan_utils::HolderCommitmentTransaction) -> Result<(), ()> {
853 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 _) as *mut _) }, is_owned: false });
854 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)) })*/ })};
857 fn pubkeys(&self) -> &lightning::ln::chan_utils::ChannelPublicKeys {
858 if let Some(f) = self.BaseSign.set_pubkeys {
861 self.BaseSign.pubkeys.get_native_ref()
863 fn channel_keys_id(&self) -> [u8; 32] {
864 let mut ret = (self.BaseSign.channel_keys_id)(self.BaseSign.this_arg);
867 fn sign_counterparty_commitment(&self, mut commitment_tx: &lightning::ln::chan_utils::CommitmentTransaction, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<(bitcoin::secp256k1::Signature, Vec<bitcoin::secp256k1::Signature>), ()> {
868 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 _) as *mut _) }, is_owned: false });
869 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)) })*/ })};
872 fn validate_counterparty_revocation(&self, mut idx: u64, mut secret: &bitcoin::secp256k1::key::SecretKey) -> Result<(), ()> {
873 let mut ret = (self.BaseSign.validate_counterparty_revocation)(self.BaseSign.this_arg, idx, secret.as_ref());
874 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)) })*/ })};
877 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>), ()> {
878 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 _) as *mut _) }, is_owned: false });
879 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)) })*/ })};
882 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, ()> {
883 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());
884 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)) })*/ })};
887 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, ()> {
888 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 _) as *mut _) }, is_owned: false });
889 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)) })*/ })};
892 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, ()> {
893 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 _) as *mut _) }, is_owned: false });
894 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)) })*/ })};
897 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, ()> {
898 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 _) as *mut _) }, is_owned: false });
899 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)) })*/ })};
902 fn sign_channel_announcement(&self, mut msg: &lightning::ln::msgs::UnsignedChannelAnnouncement, mut _secp_ctx: &bitcoin::secp256k1::Secp256k1<bitcoin::secp256k1::All>) -> Result<bitcoin::secp256k1::Signature, ()> {
903 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 _) as *mut _) }, is_owned: false });
904 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)) })*/ })};
907 fn ready_channel(&mut self, mut channel_parameters: &lightning::ln::chan_utils::ChannelTransactionParameters) {
908 (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 _) as *mut _) }, is_owned: false })
911 impl lightning::util::ser::Writeable for Sign {
912 fn write<W: lightning::util::ser::Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
913 let vec = (self.write)(self.this_arg);
914 w.write_all(vec.as_slice())
918 /// Creates a copy of a Sign
919 pub extern "C" fn Sign_clone(orig: &Sign) -> Sign {
920 let mut res = Sign_clone_fields(orig);
921 if let Some(f) = orig.cloned { (f)(&mut res) };
924 impl Clone for Sign {
925 fn clone(&self) -> Self {
930 use lightning::chain::keysinterface::Sign as rustSign;
931 impl rustSign for Sign {
934 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
935 // directly as a Deref trait in higher-level structs:
936 impl std::ops::Deref for Sign {
938 fn deref(&self) -> &Self {
942 /// Calls the free function if one is set
944 pub extern "C" fn Sign_free(this_ptr: Sign) { }
947 if let Some(f) = self.free {
952 /// A trait to describe an object which can get user secrets and key material.
954 pub struct KeysInterface {
955 /// An opaque pointer which is passed to your function implementations as an argument.
956 /// This has no meaning in the LDK, and can be NULL or any other value.
957 pub this_arg: *mut c_void,
958 /// Get node secret key (aka node_id or network_key).
960 /// This method must return the same value each time it is called.
962 pub get_node_secret: extern "C" fn (this_arg: *const c_void) -> crate::c_types::SecretKey,
963 /// Get a script pubkey which we send funds to when claiming on-chain contestable outputs.
965 /// This method should return a different value each time it is called, to avoid linking
966 /// on-chain funds across channels as controlled to the same user.
968 pub get_destination_script: extern "C" fn (this_arg: *const c_void) -> crate::c_types::derived::CVec_u8Z,
969 /// Get a script pubkey which we will send funds to when closing a channel.
971 /// This method should return a different value each time it is called, to avoid linking
972 /// on-chain funds across channels as controlled to the same user.
974 pub get_shutdown_scriptpubkey: extern "C" fn (this_arg: *const c_void) -> crate::lightning::ln::script::ShutdownScript,
975 /// Get a new set of Sign for per-channel secrets. These MUST be unique even if you
976 /// restarted with some stale data!
978 /// This method must return a different value each time it is called.
980 pub get_channel_signer: extern "C" fn (this_arg: *const c_void, inbound: bool, channel_value_satoshis: u64) -> crate::lightning::chain::keysinterface::Sign,
981 /// Gets a unique, cryptographically-secure, random 32 byte value. This is used for encrypting
982 /// onion packets and for temporary channel IDs. There is no requirement that these be
983 /// persisted anywhere, though they must be unique across restarts.
985 /// This method must return a different value each time it is called.
987 pub get_secure_random_bytes: extern "C" fn (this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes,
988 /// Reads a `Signer` for this `KeysInterface` from the given input stream.
989 /// This is only called during deserialization of other objects which contain
990 /// `Sign`-implementing objects (ie `ChannelMonitor`s and `ChannelManager`s).
991 /// The bytes are exactly those which `<Self::Signer as Writeable>::write()` writes, and
992 /// contain no versioning scheme. You may wish to include your own version prefix and ensure
993 /// you've read all of the provided bytes to ensure no corruption occurred.
995 pub read_chan_signer: extern "C" fn (this_arg: *const c_void, reader: crate::c_types::u8slice) -> crate::c_types::derived::CResult_SignDecodeErrorZ,
996 /// Sign an invoice's preimage (note that this is the preimage of the invoice, not the HTLC's
997 /// preimage). By parameterizing by the preimage instead of the hash, we allow implementors of
998 /// this trait to parse the invoice and make sure they're signing what they expect, rather than
999 /// blindly signing the hash.
1001 pub sign_invoice: extern "C" fn (this_arg: *const c_void, invoice_preimage: crate::c_types::derived::CVec_u8Z) -> crate::c_types::derived::CResult_RecoverableSignatureNoneZ,
1002 /// Frees any resources associated with this object given its this_arg pointer.
1003 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
1004 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
1006 unsafe impl Send for KeysInterface {}
1007 unsafe impl Sync for KeysInterface {}
1009 pub(crate) extern "C" fn KeysInterface_clone_fields(orig: &KeysInterface) -> KeysInterface {
1011 this_arg: orig.this_arg,
1012 get_node_secret: Clone::clone(&orig.get_node_secret),
1013 get_destination_script: Clone::clone(&orig.get_destination_script),
1014 get_shutdown_scriptpubkey: Clone::clone(&orig.get_shutdown_scriptpubkey),
1015 get_channel_signer: Clone::clone(&orig.get_channel_signer),
1016 get_secure_random_bytes: Clone::clone(&orig.get_secure_random_bytes),
1017 read_chan_signer: Clone::clone(&orig.read_chan_signer),
1018 sign_invoice: Clone::clone(&orig.sign_invoice),
1019 free: Clone::clone(&orig.free),
1023 use lightning::chain::keysinterface::KeysInterface as rustKeysInterface;
1024 impl rustKeysInterface for KeysInterface {
1025 type Signer = crate::lightning::chain::keysinterface::Sign;
1026 fn get_node_secret(&self) -> bitcoin::secp256k1::key::SecretKey {
1027 let mut ret = (self.get_node_secret)(self.this_arg);
1030 fn get_destination_script(&self) -> bitcoin::blockdata::script::Script {
1031 let mut ret = (self.get_destination_script)(self.this_arg);
1032 ::bitcoin::blockdata::script::Script::from(ret.into_rust())
1034 fn get_shutdown_scriptpubkey(&self) -> lightning::ln::script::ShutdownScript {
1035 let mut ret = (self.get_shutdown_scriptpubkey)(self.this_arg);
1036 *unsafe { Box::from_raw(ret.take_inner()) }
1038 fn get_channel_signer(&self, mut inbound: bool, mut channel_value_satoshis: u64) -> crate::lightning::chain::keysinterface::Sign {
1039 let mut ret = (self.get_channel_signer)(self.this_arg, inbound, channel_value_satoshis);
1042 fn get_secure_random_bytes(&self) -> [u8; 32] {
1043 let mut ret = (self.get_secure_random_bytes)(self.this_arg);
1046 fn read_chan_signer(&self, mut reader: &[u8]) -> Result<crate::lightning::chain::keysinterface::Sign, lightning::ln::msgs::DecodeError> {
1047 let mut local_reader = crate::c_types::u8slice::from_slice(reader);
1048 let mut ret = (self.read_chan_signer)(self.this_arg, local_reader);
1049 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()) } })};
1052 fn sign_invoice(&self, mut invoice_preimage: Vec<u8>) -> Result<bitcoin::secp256k1::recovery::RecoverableSignature, ()> {
1053 let mut local_invoice_preimage = Vec::new(); for mut item in invoice_preimage.drain(..) { local_invoice_preimage.push( { item }); };
1054 let mut ret = (self.sign_invoice)(self.this_arg, local_invoice_preimage.into());
1055 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)) })*/ })};
1060 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
1061 // directly as a Deref trait in higher-level structs:
1062 impl std::ops::Deref for KeysInterface {
1064 fn deref(&self) -> &Self {
1068 /// Calls the free function if one is set
1070 pub extern "C" fn KeysInterface_free(this_ptr: KeysInterface) { }
1071 impl Drop for KeysInterface {
1072 fn drop(&mut self) {
1073 if let Some(f) = self.free {
1079 use lightning::chain::keysinterface::InMemorySigner as nativeInMemorySignerImport;
1080 type nativeInMemorySigner = nativeInMemorySignerImport;
1082 /// A simple implementation of Sign that just keeps the private keys in memory.
1084 /// This implementation performs no policy checks and is insufficient by itself as
1085 /// a secure external signer.
1088 pub struct InMemorySigner {
1089 /// A pointer to the opaque Rust object.
1091 /// Nearly everywhere, inner must be non-null, however in places where
1092 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1093 pub inner: *mut nativeInMemorySigner,
1094 /// Indicates that this is the only struct which contains the same pointer.
1096 /// Rust functions which take ownership of an object provided via an argument require
1097 /// this to be true and invalidate the object pointed to by inner.
1101 impl Drop for InMemorySigner {
1102 fn drop(&mut self) {
1103 if self.is_owned && !<*mut nativeInMemorySigner>::is_null(self.inner) {
1104 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1108 /// Frees any resources used by the InMemorySigner, if is_owned is set and inner is non-NULL.
1110 pub extern "C" fn InMemorySigner_free(this_obj: InMemorySigner) { }
1112 /// Used only if an object of this type is returned as a trait impl by a method
1113 extern "C" fn InMemorySigner_free_void(this_ptr: *mut c_void) {
1114 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeInMemorySigner); }
1117 impl InMemorySigner {
1118 pub(crate) fn get_native_ref(&self) -> &'static nativeInMemorySigner {
1119 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1121 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeInMemorySigner {
1122 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1124 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1125 pub(crate) fn take_inner(mut self) -> *mut nativeInMemorySigner {
1126 assert!(self.is_owned);
1127 let ret = ObjOps::untweak_ptr(self.inner);
1128 self.inner = std::ptr::null_mut();
1132 /// Private key of anchor tx
1134 pub extern "C" fn InMemorySigner_get_funding_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1135 let mut inner_val = &mut this_ptr.get_native_mut_ref().funding_key;
1138 /// Private key of anchor tx
1140 pub extern "C" fn InMemorySigner_set_funding_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1141 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.funding_key = val.into_rust();
1143 /// Holder secret key for blinded revocation pubkey
1145 pub extern "C" fn InMemorySigner_get_revocation_base_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1146 let mut inner_val = &mut this_ptr.get_native_mut_ref().revocation_base_key;
1149 /// Holder secret key for blinded revocation pubkey
1151 pub extern "C" fn InMemorySigner_set_revocation_base_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1152 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.revocation_base_key = val.into_rust();
1154 /// Holder secret key used for our balance in counterparty-broadcasted commitment transactions
1156 pub extern "C" fn InMemorySigner_get_payment_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1157 let mut inner_val = &mut this_ptr.get_native_mut_ref().payment_key;
1160 /// Holder secret key used for our balance in counterparty-broadcasted commitment transactions
1162 pub extern "C" fn InMemorySigner_set_payment_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1163 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.payment_key = val.into_rust();
1165 /// Holder secret key used in HTLC tx
1167 pub extern "C" fn InMemorySigner_get_delayed_payment_base_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1168 let mut inner_val = &mut this_ptr.get_native_mut_ref().delayed_payment_base_key;
1171 /// Holder secret key used in HTLC tx
1173 pub extern "C" fn InMemorySigner_set_delayed_payment_base_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1174 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.delayed_payment_base_key = val.into_rust();
1176 /// Holder htlc secret key used in commitment tx htlc outputs
1178 pub extern "C" fn InMemorySigner_get_htlc_base_key(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1179 let mut inner_val = &mut this_ptr.get_native_mut_ref().htlc_base_key;
1182 /// Holder htlc secret key used in commitment tx htlc outputs
1184 pub extern "C" fn InMemorySigner_set_htlc_base_key(this_ptr: &mut InMemorySigner, mut val: crate::c_types::SecretKey) {
1185 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.htlc_base_key = val.into_rust();
1189 pub extern "C" fn InMemorySigner_get_commitment_seed(this_ptr: &InMemorySigner) -> *const [u8; 32] {
1190 let mut inner_val = &mut this_ptr.get_native_mut_ref().commitment_seed;
1195 pub extern "C" fn InMemorySigner_set_commitment_seed(this_ptr: &mut InMemorySigner, mut val: crate::c_types::ThirtyTwoBytes) {
1196 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.commitment_seed = val.data;
1198 impl Clone for InMemorySigner {
1199 fn clone(&self) -> Self {
1201 inner: if <*mut nativeInMemorySigner>::is_null(self.inner) { std::ptr::null_mut() } else {
1202 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1208 /// Used only if an object of this type is returned as a trait impl by a method
1209 pub(crate) extern "C" fn InMemorySigner_clone_void(this_ptr: *const c_void) -> *mut c_void {
1210 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeInMemorySigner)).clone() })) as *mut c_void
1213 /// Creates a copy of the InMemorySigner
1214 pub extern "C" fn InMemorySigner_clone(orig: &InMemorySigner) -> InMemorySigner {
1217 /// Create a new InMemorySigner
1220 pub extern "C" fn InMemorySigner_new(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 {
1221 let mut ret = lightning::chain::keysinterface::InMemorySigner::new(secp256k1::SECP256K1, 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);
1222 crate::lightning::chain::keysinterface::InMemorySigner { inner: ObjOps::heap_alloc(ret), is_owned: true }
1225 /// Counterparty pubkeys.
1226 /// Will panic if ready_channel wasn't called.
1229 pub extern "C" fn InMemorySigner_counterparty_pubkeys(this_arg: &InMemorySigner) -> crate::lightning::ln::chan_utils::ChannelPublicKeys {
1230 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.counterparty_pubkeys();
1231 crate::lightning::ln::chan_utils::ChannelPublicKeys { inner: unsafe { ObjOps::nonnull_ptr_to_inner((ret as *const _) as *mut _) }, is_owned: false }
1234 /// The contest_delay value specified by our counterparty and applied on holder-broadcastable
1235 /// transactions, ie the amount of time that we have to wait to recover our funds if we
1236 /// broadcast a transaction.
1237 /// Will panic if ready_channel wasn't called.
1240 pub extern "C" fn InMemorySigner_counterparty_selected_contest_delay(this_arg: &InMemorySigner) -> u16 {
1241 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.counterparty_selected_contest_delay();
1245 /// The contest_delay value specified by us and applied on transactions broadcastable
1246 /// by our counterparty, ie the amount of time that they have to wait to recover their funds
1247 /// if they broadcast a transaction.
1248 /// Will panic if ready_channel wasn't called.
1251 pub extern "C" fn InMemorySigner_holder_selected_contest_delay(this_arg: &InMemorySigner) -> u16 {
1252 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.holder_selected_contest_delay();
1256 /// Whether the holder is the initiator
1257 /// Will panic if ready_channel wasn't called.
1260 pub extern "C" fn InMemorySigner_is_outbound(this_arg: &InMemorySigner) -> bool {
1261 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.is_outbound();
1265 /// Funding outpoint
1266 /// Will panic if ready_channel wasn't called.
1269 pub extern "C" fn InMemorySigner_funding_outpoint(this_arg: &InMemorySigner) -> crate::lightning::chain::transaction::OutPoint {
1270 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.funding_outpoint();
1271 crate::lightning::chain::transaction::OutPoint { inner: unsafe { ObjOps::nonnull_ptr_to_inner((ret as *const _) as *mut _) }, is_owned: false }
1274 /// Obtain a ChannelTransactionParameters for this channel, to be used when verifying or
1275 /// building transactions.
1277 /// Will panic if ready_channel wasn't called.
1280 pub extern "C" fn InMemorySigner_get_channel_parameters(this_arg: &InMemorySigner) -> crate::lightning::ln::chan_utils::ChannelTransactionParameters {
1281 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_channel_parameters();
1282 crate::lightning::ln::chan_utils::ChannelTransactionParameters { inner: unsafe { ObjOps::nonnull_ptr_to_inner((ret as *const _) as *mut _) }, is_owned: false }
1285 /// Sign the single input of spend_tx at index `input_idx` which spends the output
1286 /// described by descriptor, returning the witness stack for the input.
1288 /// Returns an Err if the input at input_idx does not exist, has a non-empty script_sig,
1289 /// or is not spending the outpoint described by `descriptor.outpoint`.
1292 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 {
1293 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);
1294 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() };
1298 /// Sign the single input of spend_tx at index `input_idx` which spends the output
1299 /// described by descriptor, returning the witness stack for the input.
1301 /// Returns an Err if the input at input_idx does not exist, has a non-empty script_sig,
1302 /// is not spending the outpoint described by `descriptor.outpoint`, or does not have a
1303 /// sequence set to `descriptor.to_self_delay`.
1306 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 {
1307 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);
1308 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() };
1312 impl From<nativeInMemorySigner> for crate::lightning::chain::keysinterface::BaseSign {
1313 fn from(obj: nativeInMemorySigner) -> Self {
1314 let mut rust_obj = InMemorySigner { inner: ObjOps::heap_alloc(obj), is_owned: true };
1315 let mut ret = InMemorySigner_as_BaseSign(&rust_obj);
1316 // 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
1317 rust_obj.inner = std::ptr::null_mut();
1318 ret.free = Some(InMemorySigner_free_void);
1322 /// Constructs a new BaseSign which calls the relevant methods on this_arg.
1323 /// This copies the `inner` pointer in this_arg and thus the returned BaseSign must be freed before this_arg is
1325 pub extern "C" fn InMemorySigner_as_BaseSign(this_arg: &InMemorySigner) -> crate::lightning::chain::keysinterface::BaseSign {
1326 crate::lightning::chain::keysinterface::BaseSign {
1327 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
1329 get_per_commitment_point: InMemorySigner_BaseSign_get_per_commitment_point,
1330 release_commitment_secret: InMemorySigner_BaseSign_release_commitment_secret,
1331 validate_holder_commitment: InMemorySigner_BaseSign_validate_holder_commitment,
1333 pubkeys: crate::lightning::ln::chan_utils::ChannelPublicKeys { inner: std::ptr::null_mut(), is_owned: true },
1334 set_pubkeys: Some(InMemorySigner_BaseSign_set_pubkeys),
1335 channel_keys_id: InMemorySigner_BaseSign_channel_keys_id,
1336 sign_counterparty_commitment: InMemorySigner_BaseSign_sign_counterparty_commitment,
1337 validate_counterparty_revocation: InMemorySigner_BaseSign_validate_counterparty_revocation,
1338 sign_holder_commitment_and_htlcs: InMemorySigner_BaseSign_sign_holder_commitment_and_htlcs,
1339 sign_justice_revoked_output: InMemorySigner_BaseSign_sign_justice_revoked_output,
1340 sign_justice_revoked_htlc: InMemorySigner_BaseSign_sign_justice_revoked_htlc,
1341 sign_counterparty_htlc_transaction: InMemorySigner_BaseSign_sign_counterparty_htlc_transaction,
1342 sign_closing_transaction: InMemorySigner_BaseSign_sign_closing_transaction,
1343 sign_channel_announcement: InMemorySigner_BaseSign_sign_channel_announcement,
1344 ready_channel: InMemorySigner_BaseSign_ready_channel,
1349 extern "C" fn InMemorySigner_BaseSign_get_per_commitment_point(this_arg: *const c_void, mut idx: u64) -> crate::c_types::PublicKey {
1350 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::get_per_commitment_point(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, idx, secp256k1::SECP256K1);
1351 crate::c_types::PublicKey::from_rust(&ret)
1354 extern "C" fn InMemorySigner_BaseSign_release_commitment_secret(this_arg: *const c_void, mut idx: u64) -> crate::c_types::ThirtyTwoBytes {
1355 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::release_commitment_secret(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, idx);
1356 crate::c_types::ThirtyTwoBytes { data: ret }
1359 extern "C" fn InMemorySigner_BaseSign_validate_holder_commitment(this_arg: *const c_void, _holder_tx: &crate::lightning::ln::chan_utils::HolderCommitmentTransaction) -> crate::c_types::derived::CResult_NoneNoneZ {
1360 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::validate_holder_commitment(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, _holder_tx.get_native_ref());
1361 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() };
1365 extern "C" fn InMemorySigner_BaseSign_pubkeys(this_arg: *const c_void) -> crate::lightning::ln::chan_utils::ChannelPublicKeys {
1366 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::pubkeys(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, );
1367 crate::lightning::ln::chan_utils::ChannelPublicKeys { inner: unsafe { ObjOps::nonnull_ptr_to_inner((ret as *const _) as *mut _) }, is_owned: false }
1369 extern "C" fn InMemorySigner_BaseSign_set_pubkeys(trait_self_arg: &BaseSign) {
1370 // This is a bit race-y in the general case, but for our specific use-cases today, we're safe
1371 // Specifically, we must ensure that the first time we're called it can never be in parallel
1372 if trait_self_arg.pubkeys.inner.is_null() {
1373 unsafe { &mut *(trait_self_arg as *const BaseSign as *mut BaseSign) }.pubkeys = InMemorySigner_BaseSign_pubkeys(trait_self_arg.this_arg);
1377 extern "C" fn InMemorySigner_BaseSign_channel_keys_id(this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes {
1378 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::channel_keys_id(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, );
1379 crate::c_types::ThirtyTwoBytes { data: ret }
1382 extern "C" fn InMemorySigner_BaseSign_sign_counterparty_commitment(this_arg: *const c_void, commitment_tx: &crate::lightning::ln::chan_utils::CommitmentTransaction) -> crate::c_types::derived::CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ {
1383 let mut ret = <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::sign_counterparty_commitment(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, commitment_tx.get_native_ref(), secp256k1::SECP256K1);
1384 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() };
1388 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 {
1389 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());
1390 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() };
1394 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 {
1395 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);
1396 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() };
1400 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 {
1401 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);
1402 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() };
1406 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 {
1407 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);
1408 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() };
1412 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 {
1413 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);
1414 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() };
1418 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 {
1419 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);
1420 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() };
1424 extern "C" fn InMemorySigner_BaseSign_sign_channel_announcement(this_arg: *const c_void, msg: &crate::lightning::ln::msgs::UnsignedChannelAnnouncement) -> crate::c_types::derived::CResult_SignatureNoneZ {
1425 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);
1426 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() };
1429 extern "C" fn InMemorySigner_BaseSign_ready_channel(this_arg: *mut c_void, channel_parameters: &crate::lightning::ln::chan_utils::ChannelTransactionParameters) {
1430 <nativeInMemorySigner as lightning::chain::keysinterface::BaseSign<>>::ready_channel(unsafe { &mut *(this_arg as *mut nativeInMemorySigner) }, channel_parameters.get_native_ref())
1433 impl From<nativeInMemorySigner> for crate::lightning::chain::keysinterface::Sign {
1434 fn from(obj: nativeInMemorySigner) -> Self {
1435 let mut rust_obj = InMemorySigner { inner: ObjOps::heap_alloc(obj), is_owned: true };
1436 let mut ret = InMemorySigner_as_Sign(&rust_obj);
1437 // 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
1438 rust_obj.inner = std::ptr::null_mut();
1439 ret.free = Some(InMemorySigner_free_void);
1443 /// Constructs a new Sign which calls the relevant methods on this_arg.
1444 /// This copies the `inner` pointer in this_arg and thus the returned Sign must be freed before this_arg is
1446 pub extern "C" fn InMemorySigner_as_Sign(this_arg: &InMemorySigner) -> crate::lightning::chain::keysinterface::Sign {
1447 crate::lightning::chain::keysinterface::Sign {
1448 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
1450 BaseSign: crate::lightning::chain::keysinterface::BaseSign {
1451 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
1453 get_per_commitment_point: InMemorySigner_BaseSign_get_per_commitment_point,
1454 release_commitment_secret: InMemorySigner_BaseSign_release_commitment_secret,
1455 validate_holder_commitment: InMemorySigner_BaseSign_validate_holder_commitment,
1457 pubkeys: crate::lightning::ln::chan_utils::ChannelPublicKeys { inner: std::ptr::null_mut(), is_owned: true },
1458 set_pubkeys: Some(InMemorySigner_BaseSign_set_pubkeys),
1459 channel_keys_id: InMemorySigner_BaseSign_channel_keys_id,
1460 sign_counterparty_commitment: InMemorySigner_BaseSign_sign_counterparty_commitment,
1461 validate_counterparty_revocation: InMemorySigner_BaseSign_validate_counterparty_revocation,
1462 sign_holder_commitment_and_htlcs: InMemorySigner_BaseSign_sign_holder_commitment_and_htlcs,
1463 sign_justice_revoked_output: InMemorySigner_BaseSign_sign_justice_revoked_output,
1464 sign_justice_revoked_htlc: InMemorySigner_BaseSign_sign_justice_revoked_htlc,
1465 sign_counterparty_htlc_transaction: InMemorySigner_BaseSign_sign_counterparty_htlc_transaction,
1466 sign_closing_transaction: InMemorySigner_BaseSign_sign_closing_transaction,
1467 sign_channel_announcement: InMemorySigner_BaseSign_sign_channel_announcement,
1468 ready_channel: InMemorySigner_BaseSign_ready_channel,
1470 write: InMemorySigner_write_void,
1471 cloned: Some(Sign_InMemorySigner_cloned),
1475 extern "C" fn Sign_InMemorySigner_cloned(new_obj: &mut crate::lightning::chain::keysinterface::Sign) {
1476 new_obj.this_arg = InMemorySigner_clone_void(new_obj.this_arg);
1477 new_obj.free = Some(InMemorySigner_free_void);
1478 new_obj.BaseSign.this_arg = new_obj.this_arg;
1479 new_obj.BaseSign.free = None;
1483 /// Serialize the InMemorySigner object into a byte array which can be read by InMemorySigner_read
1484 pub extern "C" fn InMemorySigner_write(obj: &InMemorySigner) -> crate::c_types::derived::CVec_u8Z {
1485 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
1488 pub(crate) extern "C" fn InMemorySigner_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1489 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeInMemorySigner) })
1492 /// Read a InMemorySigner from a byte array, created by InMemorySigner_write
1493 pub extern "C" fn InMemorySigner_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_InMemorySignerDecodeErrorZ {
1494 let res = crate::c_types::deserialize_obj(ser);
1495 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() };
1499 use lightning::chain::keysinterface::KeysManager as nativeKeysManagerImport;
1500 type nativeKeysManager = nativeKeysManagerImport;
1502 /// Simple KeysInterface implementor that takes a 32-byte seed for use as a BIP 32 extended key
1503 /// and derives keys from that.
1505 /// Your node_id is seed/0'
1506 /// ChannelMonitor closes may use seed/1'
1507 /// Cooperative closes may use seed/2'
1508 /// The two close keys may be needed to claim on-chain funds!
1511 pub struct KeysManager {
1512 /// A pointer to the opaque Rust object.
1514 /// Nearly everywhere, inner must be non-null, however in places where
1515 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1516 pub inner: *mut nativeKeysManager,
1517 /// Indicates that this is the only struct which contains the same pointer.
1519 /// Rust functions which take ownership of an object provided via an argument require
1520 /// this to be true and invalidate the object pointed to by inner.
1524 impl Drop for KeysManager {
1525 fn drop(&mut self) {
1526 if self.is_owned && !<*mut nativeKeysManager>::is_null(self.inner) {
1527 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1531 /// Frees any resources used by the KeysManager, if is_owned is set and inner is non-NULL.
1533 pub extern "C" fn KeysManager_free(this_obj: KeysManager) { }
1535 /// Used only if an object of this type is returned as a trait impl by a method
1536 extern "C" fn KeysManager_free_void(this_ptr: *mut c_void) {
1537 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeKeysManager); }
1541 pub(crate) fn get_native_ref(&self) -> &'static nativeKeysManager {
1542 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1544 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeKeysManager {
1545 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1547 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1548 pub(crate) fn take_inner(mut self) -> *mut nativeKeysManager {
1549 assert!(self.is_owned);
1550 let ret = ObjOps::untweak_ptr(self.inner);
1551 self.inner = std::ptr::null_mut();
1555 /// Constructs a KeysManager from a 32-byte seed. If the seed is in some way biased (eg your
1556 /// CSRNG is busted) this may panic (but more importantly, you will possibly lose funds).
1557 /// starting_time isn't strictly required to actually be a time, but it must absolutely,
1558 /// without a doubt, be unique to this instance. ie if you start multiple times with the same
1559 /// seed, starting_time must be unique to each run. Thus, the easiest way to achieve this is to
1560 /// simply use the current time (with very high precision).
1562 /// The seed MUST be backed up safely prior to use so that the keys can be re-created, however,
1563 /// obviously, starting_time should be unique every time you reload the library - it is only
1564 /// used to generate new ephemeral key data (which will be stored by the individual channel if
1567 /// Note that the seed is required to recover certain on-chain funds independent of
1568 /// ChannelMonitor data, though a current copy of ChannelMonitor data is also required for any
1569 /// channel, and some on-chain during-closing funds.
1571 /// Note that until the 0.1 release there is no guarantee of backward compatibility between
1572 /// versions. Once the library is more fully supported, the docs will be updated to include a
1573 /// detailed description of the guarantee.
1576 pub extern "C" fn KeysManager_new(seed: *const [u8; 32], mut starting_time_secs: u64, mut starting_time_nanos: u32) -> KeysManager {
1577 let mut ret = lightning::chain::keysinterface::KeysManager::new(unsafe { &*seed}, starting_time_secs, starting_time_nanos);
1578 KeysManager { inner: ObjOps::heap_alloc(ret), is_owned: true }
1581 /// Derive an old Sign containing per-channel secrets based on a key derivation parameters.
1583 /// Key derivation parameters are accessible through a per-channel secrets
1584 /// Sign::channel_keys_id and is provided inside DynamicOuputP2WSH in case of
1585 /// onchain output detection for which a corresponding delayed_payment_key must be derived.
1588 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 {
1589 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.derive_channel_keys(channel_value_satoshis, unsafe { &*params});
1590 crate::lightning::chain::keysinterface::InMemorySigner { inner: ObjOps::heap_alloc(ret), is_owned: true }
1593 /// Creates a Transaction which spends the given descriptors to the given outputs, plus an
1594 /// output to the given change destination (if sufficient change value remains). The
1595 /// transaction will have a feerate, at least, of the given value.
1597 /// Returns `Err(())` if the output value is greater than the input value minus required fee or
1598 /// if a descriptor was duplicated.
1600 /// We do not enforce that outputs meet the dust limit or that any output scripts are standard.
1602 /// May panic if the `SpendableOutputDescriptor`s were not generated by Channels which used
1603 /// this KeysManager or one of the `InMemorySigner` created by this KeysManager.
1606 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 {
1607 let mut local_descriptors = Vec::new(); for mut item in descriptors.into_rust().drain(..) { local_descriptors.push( { item.into_native() }); };
1608 let mut local_outputs = Vec::new(); for mut item in outputs.into_rust().drain(..) { local_outputs.push( { item.into_rust() }); };
1609 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);
1610 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() };
1614 impl From<nativeKeysManager> for crate::lightning::chain::keysinterface::KeysInterface {
1615 fn from(obj: nativeKeysManager) -> Self {
1616 let mut rust_obj = KeysManager { inner: ObjOps::heap_alloc(obj), is_owned: true };
1617 let mut ret = KeysManager_as_KeysInterface(&rust_obj);
1618 // 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
1619 rust_obj.inner = std::ptr::null_mut();
1620 ret.free = Some(KeysManager_free_void);
1624 /// Constructs a new KeysInterface which calls the relevant methods on this_arg.
1625 /// This copies the `inner` pointer in this_arg and thus the returned KeysInterface must be freed before this_arg is
1627 pub extern "C" fn KeysManager_as_KeysInterface(this_arg: &KeysManager) -> crate::lightning::chain::keysinterface::KeysInterface {
1628 crate::lightning::chain::keysinterface::KeysInterface {
1629 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
1631 get_node_secret: KeysManager_KeysInterface_get_node_secret,
1632 get_destination_script: KeysManager_KeysInterface_get_destination_script,
1633 get_shutdown_scriptpubkey: KeysManager_KeysInterface_get_shutdown_scriptpubkey,
1634 get_channel_signer: KeysManager_KeysInterface_get_channel_signer,
1635 get_secure_random_bytes: KeysManager_KeysInterface_get_secure_random_bytes,
1636 read_chan_signer: KeysManager_KeysInterface_read_chan_signer,
1637 sign_invoice: KeysManager_KeysInterface_sign_invoice,
1642 extern "C" fn KeysManager_KeysInterface_get_node_secret(this_arg: *const c_void) -> crate::c_types::SecretKey {
1643 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_node_secret(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, );
1644 crate::c_types::SecretKey::from_rust(ret)
1647 extern "C" fn KeysManager_KeysInterface_get_destination_script(this_arg: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1648 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_destination_script(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, );
1649 ret.into_bytes().into()
1652 extern "C" fn KeysManager_KeysInterface_get_shutdown_scriptpubkey(this_arg: *const c_void) -> crate::lightning::ln::script::ShutdownScript {
1653 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_shutdown_scriptpubkey(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, );
1654 crate::lightning::ln::script::ShutdownScript { inner: ObjOps::heap_alloc(ret), is_owned: true }
1657 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 {
1658 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_channel_signer(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, _inbound, channel_value_satoshis);
1662 extern "C" fn KeysManager_KeysInterface_get_secure_random_bytes(this_arg: *const c_void) -> crate::c_types::ThirtyTwoBytes {
1663 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::get_secure_random_bytes(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, );
1664 crate::c_types::ThirtyTwoBytes { data: ret }
1667 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 {
1668 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::read_chan_signer(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, reader.to_slice());
1669 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() };
1673 extern "C" fn KeysManager_KeysInterface_sign_invoice(this_arg: *const c_void, mut invoice_preimage: crate::c_types::derived::CVec_u8Z) -> crate::c_types::derived::CResult_RecoverableSignatureNoneZ {
1674 let mut local_invoice_preimage = Vec::new(); for mut item in invoice_preimage.into_rust().drain(..) { local_invoice_preimage.push( { item }); };
1675 let mut ret = <nativeKeysManager as lightning::chain::keysinterface::KeysInterface<>>::sign_invoice(unsafe { &mut *(this_arg as *mut nativeKeysManager) }, local_invoice_preimage);
1676 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() };