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 //! Various utilities for building scripts and deriving keys related to channels. These are
10 //! largely of interest for those implementing chain::keysinterface::Sign message signing by hand.
12 use alloc::str::FromStr;
13 use core::ffi::c_void;
14 use core::convert::Infallible;
15 use bitcoin::hashes::Hash;
16 use crate::c_types::*;
17 #[cfg(feature="no-std")]
18 use alloc::{vec::Vec, boxed::Box};
20 /// Gets the weight for an HTLC-Success transaction.
22 pub extern "C" fn htlc_success_tx_weight(mut opt_anchors: bool) -> u64 {
23 let mut ret = lightning::ln::chan_utils::htlc_success_tx_weight(opt_anchors);
27 /// Gets the weight for an HTLC-Timeout transaction.
29 pub extern "C" fn htlc_timeout_tx_weight(mut opt_anchors: bool) -> u64 {
30 let mut ret = lightning::ln::chan_utils::htlc_timeout_tx_weight(opt_anchors);
34 /// Build the commitment secret from the seed and the commitment number
36 pub extern "C" fn build_commitment_secret(commitment_seed: *const [u8; 32], mut idx: u64) -> crate::c_types::ThirtyTwoBytes {
37 let mut ret = lightning::ln::chan_utils::build_commitment_secret(unsafe { &*commitment_seed}, idx);
38 crate::c_types::ThirtyTwoBytes { data: ret }
41 /// Build a closing transaction
43 pub extern "C" fn build_closing_transaction(mut to_holder_value_sat: u64, mut to_counterparty_value_sat: u64, mut to_holder_script: crate::c_types::derived::CVec_u8Z, mut to_counterparty_script: crate::c_types::derived::CVec_u8Z, mut funding_outpoint: crate::lightning::chain::transaction::OutPoint) -> crate::c_types::Transaction {
44 let mut ret = lightning::ln::chan_utils::build_closing_transaction(to_holder_value_sat, to_counterparty_value_sat, ::bitcoin::blockdata::script::Script::from(to_holder_script.into_rust()), ::bitcoin::blockdata::script::Script::from(to_counterparty_script.into_rust()), crate::c_types::C_to_bitcoin_outpoint(funding_outpoint));
45 crate::c_types::Transaction::from_bitcoin(&ret)
48 /// Derives a per-commitment-transaction private key (eg an htlc key or delayed_payment key)
49 /// from the base secret and the per_commitment_point.
51 /// Note that this is infallible iff we trust that at least one of the two input keys are randomly
52 /// generated (ie our own).
54 pub extern "C" fn derive_private_key(mut per_commitment_point: crate::c_types::PublicKey, base_secret: *const [u8; 32]) -> crate::c_types::derived::CResult_SecretKeyErrorZ {
55 let mut ret = lightning::ln::chan_utils::derive_private_key(secp256k1::SECP256K1, &per_commitment_point.into_rust(), &::bitcoin::secp256k1::key::SecretKey::from_slice(&unsafe { *base_secret}[..]).unwrap());
56 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::SecretKey::from_rust(o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::c_types::Secp256k1Error::from_rust(e) }).into() };
60 /// Derives a per-commitment-transaction public key (eg an htlc key or a delayed_payment key)
61 /// from the base point and the per_commitment_key. This is the public equivalent of
62 /// derive_private_key - using only public keys to derive a public key instead of private keys.
64 /// Note that this is infallible iff we trust that at least one of the two input keys are randomly
65 /// generated (ie our own).
67 pub extern "C" fn derive_public_key(mut per_commitment_point: crate::c_types::PublicKey, mut base_point: crate::c_types::PublicKey) -> crate::c_types::derived::CResult_PublicKeyErrorZ {
68 let mut ret = lightning::ln::chan_utils::derive_public_key(secp256k1::SECP256K1, &per_commitment_point.into_rust(), &base_point.into_rust());
69 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::PublicKey::from_rust(&o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::c_types::Secp256k1Error::from_rust(e) }).into() };
73 /// Derives a per-commitment-transaction revocation key from its constituent parts.
75 /// Only the cheating participant owns a valid witness to propagate a revoked
76 /// commitment transaction, thus per_commitment_secret always come from cheater
77 /// and revocation_base_secret always come from punisher, which is the broadcaster
78 /// of the transaction spending with this key knowledge.
80 /// Note that this is infallible iff we trust that at least one of the two input keys are randomly
81 /// generated (ie our own).
83 pub extern "C" fn derive_private_revocation_key(per_commitment_secret: *const [u8; 32], countersignatory_revocation_base_secret: *const [u8; 32]) -> crate::c_types::derived::CResult_SecretKeyErrorZ {
84 let mut ret = lightning::ln::chan_utils::derive_private_revocation_key(secp256k1::SECP256K1, &::bitcoin::secp256k1::key::SecretKey::from_slice(&unsafe { *per_commitment_secret}[..]).unwrap(), &::bitcoin::secp256k1::key::SecretKey::from_slice(&unsafe { *countersignatory_revocation_base_secret}[..]).unwrap());
85 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::SecretKey::from_rust(o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::c_types::Secp256k1Error::from_rust(e) }).into() };
89 /// Derives a per-commitment-transaction revocation public key from its constituent parts. This is
90 /// the public equivalend of derive_private_revocation_key - using only public keys to derive a
91 /// public key instead of private keys.
93 /// Only the cheating participant owns a valid witness to propagate a revoked
94 /// commitment transaction, thus per_commitment_point always come from cheater
95 /// and revocation_base_point always come from punisher, which is the broadcaster
96 /// of the transaction spending with this key knowledge.
98 /// Note that this is infallible iff we trust that at least one of the two input keys are randomly
99 /// generated (ie our own).
101 pub extern "C" fn derive_public_revocation_key(mut per_commitment_point: crate::c_types::PublicKey, mut countersignatory_revocation_base_point: crate::c_types::PublicKey) -> crate::c_types::derived::CResult_PublicKeyErrorZ {
102 let mut ret = lightning::ln::chan_utils::derive_public_revocation_key(secp256k1::SECP256K1, &per_commitment_point.into_rust(), &countersignatory_revocation_base_point.into_rust());
103 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::PublicKey::from_rust(&o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::c_types::Secp256k1Error::from_rust(e) }).into() };
108 use lightning::ln::chan_utils::TxCreationKeys as nativeTxCreationKeysImport;
109 pub(crate) type nativeTxCreationKeys = nativeTxCreationKeysImport;
111 /// The set of public keys which are used in the creation of one commitment transaction.
112 /// These are derived from the channel base keys and per-commitment data.
114 /// A broadcaster key is provided from potential broadcaster of the computed transaction.
115 /// A countersignatory key is coming from a protocol participant unable to broadcast the
118 /// These keys are assumed to be good, either because the code derived them from
119 /// channel basepoints via the new function, or they were obtained via
120 /// CommitmentTransaction.trust().keys() because we trusted the source of the
121 /// pre-calculated keys.
124 pub struct TxCreationKeys {
125 /// A pointer to the opaque Rust object.
127 /// Nearly everywhere, inner must be non-null, however in places where
128 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
129 pub inner: *mut nativeTxCreationKeys,
130 /// Indicates that this is the only struct which contains the same pointer.
132 /// Rust functions which take ownership of an object provided via an argument require
133 /// this to be true and invalidate the object pointed to by inner.
137 impl Drop for TxCreationKeys {
139 if self.is_owned && !<*mut nativeTxCreationKeys>::is_null(self.inner) {
140 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
144 /// Frees any resources used by the TxCreationKeys, if is_owned is set and inner is non-NULL.
146 pub extern "C" fn TxCreationKeys_free(this_obj: TxCreationKeys) { }
148 /// Used only if an object of this type is returned as a trait impl by a method
149 pub(crate) extern "C" fn TxCreationKeys_free_void(this_ptr: *mut c_void) {
150 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeTxCreationKeys); }
153 impl TxCreationKeys {
154 pub(crate) fn get_native_ref(&self) -> &'static nativeTxCreationKeys {
155 unsafe { &*ObjOps::untweak_ptr(self.inner) }
157 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeTxCreationKeys {
158 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
160 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
161 pub(crate) fn take_inner(mut self) -> *mut nativeTxCreationKeys {
162 assert!(self.is_owned);
163 let ret = ObjOps::untweak_ptr(self.inner);
164 self.inner = core::ptr::null_mut();
168 /// The broadcaster's per-commitment public key which was used to derive the other keys.
170 pub extern "C" fn TxCreationKeys_get_per_commitment_point(this_ptr: &TxCreationKeys) -> crate::c_types::PublicKey {
171 let mut inner_val = &mut this_ptr.get_native_mut_ref().per_commitment_point;
172 crate::c_types::PublicKey::from_rust(&inner_val)
174 /// The broadcaster's per-commitment public key which was used to derive the other keys.
176 pub extern "C" fn TxCreationKeys_set_per_commitment_point(this_ptr: &mut TxCreationKeys, mut val: crate::c_types::PublicKey) {
177 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.per_commitment_point = val.into_rust();
179 /// The revocation key which is used to allow the broadcaster of the commitment
180 /// transaction to provide their counterparty the ability to punish them if they broadcast
183 pub extern "C" fn TxCreationKeys_get_revocation_key(this_ptr: &TxCreationKeys) -> crate::c_types::PublicKey {
184 let mut inner_val = &mut this_ptr.get_native_mut_ref().revocation_key;
185 crate::c_types::PublicKey::from_rust(&inner_val)
187 /// The revocation key which is used to allow the broadcaster of the commitment
188 /// transaction to provide their counterparty the ability to punish them if they broadcast
191 pub extern "C" fn TxCreationKeys_set_revocation_key(this_ptr: &mut TxCreationKeys, mut val: crate::c_types::PublicKey) {
192 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.revocation_key = val.into_rust();
194 /// Broadcaster's HTLC Key
196 pub extern "C" fn TxCreationKeys_get_broadcaster_htlc_key(this_ptr: &TxCreationKeys) -> crate::c_types::PublicKey {
197 let mut inner_val = &mut this_ptr.get_native_mut_ref().broadcaster_htlc_key;
198 crate::c_types::PublicKey::from_rust(&inner_val)
200 /// Broadcaster's HTLC Key
202 pub extern "C" fn TxCreationKeys_set_broadcaster_htlc_key(this_ptr: &mut TxCreationKeys, mut val: crate::c_types::PublicKey) {
203 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.broadcaster_htlc_key = val.into_rust();
205 /// Countersignatory's HTLC Key
207 pub extern "C" fn TxCreationKeys_get_countersignatory_htlc_key(this_ptr: &TxCreationKeys) -> crate::c_types::PublicKey {
208 let mut inner_val = &mut this_ptr.get_native_mut_ref().countersignatory_htlc_key;
209 crate::c_types::PublicKey::from_rust(&inner_val)
211 /// Countersignatory's HTLC Key
213 pub extern "C" fn TxCreationKeys_set_countersignatory_htlc_key(this_ptr: &mut TxCreationKeys, mut val: crate::c_types::PublicKey) {
214 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.countersignatory_htlc_key = val.into_rust();
216 /// Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
218 pub extern "C" fn TxCreationKeys_get_broadcaster_delayed_payment_key(this_ptr: &TxCreationKeys) -> crate::c_types::PublicKey {
219 let mut inner_val = &mut this_ptr.get_native_mut_ref().broadcaster_delayed_payment_key;
220 crate::c_types::PublicKey::from_rust(&inner_val)
222 /// Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
224 pub extern "C" fn TxCreationKeys_set_broadcaster_delayed_payment_key(this_ptr: &mut TxCreationKeys, mut val: crate::c_types::PublicKey) {
225 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.broadcaster_delayed_payment_key = val.into_rust();
227 /// Constructs a new TxCreationKeys given each field
230 pub extern "C" fn TxCreationKeys_new(mut per_commitment_point_arg: crate::c_types::PublicKey, mut revocation_key_arg: crate::c_types::PublicKey, mut broadcaster_htlc_key_arg: crate::c_types::PublicKey, mut countersignatory_htlc_key_arg: crate::c_types::PublicKey, mut broadcaster_delayed_payment_key_arg: crate::c_types::PublicKey) -> TxCreationKeys {
231 TxCreationKeys { inner: ObjOps::heap_alloc(nativeTxCreationKeys {
232 per_commitment_point: per_commitment_point_arg.into_rust(),
233 revocation_key: revocation_key_arg.into_rust(),
234 broadcaster_htlc_key: broadcaster_htlc_key_arg.into_rust(),
235 countersignatory_htlc_key: countersignatory_htlc_key_arg.into_rust(),
236 broadcaster_delayed_payment_key: broadcaster_delayed_payment_key_arg.into_rust(),
239 impl Clone for TxCreationKeys {
240 fn clone(&self) -> Self {
242 inner: if <*mut nativeTxCreationKeys>::is_null(self.inner) { core::ptr::null_mut() } else {
243 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
249 /// Used only if an object of this type is returned as a trait impl by a method
250 pub(crate) extern "C" fn TxCreationKeys_clone_void(this_ptr: *const c_void) -> *mut c_void {
251 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeTxCreationKeys)).clone() })) as *mut c_void
254 /// Creates a copy of the TxCreationKeys
255 pub extern "C" fn TxCreationKeys_clone(orig: &TxCreationKeys) -> TxCreationKeys {
259 /// Serialize the TxCreationKeys object into a byte array which can be read by TxCreationKeys_read
260 pub extern "C" fn TxCreationKeys_write(obj: &TxCreationKeys) -> crate::c_types::derived::CVec_u8Z {
261 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
264 pub(crate) extern "C" fn TxCreationKeys_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
265 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeTxCreationKeys) })
268 /// Read a TxCreationKeys from a byte array, created by TxCreationKeys_write
269 pub extern "C" fn TxCreationKeys_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_TxCreationKeysDecodeErrorZ {
270 let res: Result<lightning::ln::chan_utils::TxCreationKeys, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
271 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::chan_utils::TxCreationKeys { 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() };
275 use lightning::ln::chan_utils::ChannelPublicKeys as nativeChannelPublicKeysImport;
276 pub(crate) type nativeChannelPublicKeys = nativeChannelPublicKeysImport;
278 /// One counterparty's public keys which do not change over the life of a channel.
281 pub struct ChannelPublicKeys {
282 /// A pointer to the opaque Rust object.
284 /// Nearly everywhere, inner must be non-null, however in places where
285 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
286 pub inner: *mut nativeChannelPublicKeys,
287 /// Indicates that this is the only struct which contains the same pointer.
289 /// Rust functions which take ownership of an object provided via an argument require
290 /// this to be true and invalidate the object pointed to by inner.
294 impl Drop for ChannelPublicKeys {
296 if self.is_owned && !<*mut nativeChannelPublicKeys>::is_null(self.inner) {
297 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
301 /// Frees any resources used by the ChannelPublicKeys, if is_owned is set and inner is non-NULL.
303 pub extern "C" fn ChannelPublicKeys_free(this_obj: ChannelPublicKeys) { }
305 /// Used only if an object of this type is returned as a trait impl by a method
306 pub(crate) extern "C" fn ChannelPublicKeys_free_void(this_ptr: *mut c_void) {
307 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelPublicKeys); }
310 impl ChannelPublicKeys {
311 pub(crate) fn get_native_ref(&self) -> &'static nativeChannelPublicKeys {
312 unsafe { &*ObjOps::untweak_ptr(self.inner) }
314 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChannelPublicKeys {
315 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
317 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
318 pub(crate) fn take_inner(mut self) -> *mut nativeChannelPublicKeys {
319 assert!(self.is_owned);
320 let ret = ObjOps::untweak_ptr(self.inner);
321 self.inner = core::ptr::null_mut();
325 /// The public key which is used to sign all commitment transactions, as it appears in the
326 /// on-chain channel lock-in 2-of-2 multisig output.
328 pub extern "C" fn ChannelPublicKeys_get_funding_pubkey(this_ptr: &ChannelPublicKeys) -> crate::c_types::PublicKey {
329 let mut inner_val = &mut this_ptr.get_native_mut_ref().funding_pubkey;
330 crate::c_types::PublicKey::from_rust(&inner_val)
332 /// The public key which is used to sign all commitment transactions, as it appears in the
333 /// on-chain channel lock-in 2-of-2 multisig output.
335 pub extern "C" fn ChannelPublicKeys_set_funding_pubkey(this_ptr: &mut ChannelPublicKeys, mut val: crate::c_types::PublicKey) {
336 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.funding_pubkey = val.into_rust();
338 /// The base point which is used (with derive_public_revocation_key) to derive per-commitment
339 /// revocation keys. This is combined with the per-commitment-secret generated by the
340 /// counterparty to create a secret which the counterparty can reveal to revoke previous
343 pub extern "C" fn ChannelPublicKeys_get_revocation_basepoint(this_ptr: &ChannelPublicKeys) -> crate::c_types::PublicKey {
344 let mut inner_val = &mut this_ptr.get_native_mut_ref().revocation_basepoint;
345 crate::c_types::PublicKey::from_rust(&inner_val)
347 /// The base point which is used (with derive_public_revocation_key) to derive per-commitment
348 /// revocation keys. This is combined with the per-commitment-secret generated by the
349 /// counterparty to create a secret which the counterparty can reveal to revoke previous
352 pub extern "C" fn ChannelPublicKeys_set_revocation_basepoint(this_ptr: &mut ChannelPublicKeys, mut val: crate::c_types::PublicKey) {
353 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.revocation_basepoint = val.into_rust();
355 /// The public key on which the non-broadcaster (ie the countersignatory) receives an immediately
356 /// spendable primary channel balance on the broadcaster's commitment transaction. This key is
357 /// static across every commitment transaction.
359 pub extern "C" fn ChannelPublicKeys_get_payment_point(this_ptr: &ChannelPublicKeys) -> crate::c_types::PublicKey {
360 let mut inner_val = &mut this_ptr.get_native_mut_ref().payment_point;
361 crate::c_types::PublicKey::from_rust(&inner_val)
363 /// The public key on which the non-broadcaster (ie the countersignatory) receives an immediately
364 /// spendable primary channel balance on the broadcaster's commitment transaction. This key is
365 /// static across every commitment transaction.
367 pub extern "C" fn ChannelPublicKeys_set_payment_point(this_ptr: &mut ChannelPublicKeys, mut val: crate::c_types::PublicKey) {
368 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.payment_point = val.into_rust();
370 /// The base point which is used (with derive_public_key) to derive a per-commitment payment
371 /// public key which receives non-HTLC-encumbered funds which are only available for spending
372 /// after some delay (or can be claimed via the revocation path).
374 pub extern "C" fn ChannelPublicKeys_get_delayed_payment_basepoint(this_ptr: &ChannelPublicKeys) -> crate::c_types::PublicKey {
375 let mut inner_val = &mut this_ptr.get_native_mut_ref().delayed_payment_basepoint;
376 crate::c_types::PublicKey::from_rust(&inner_val)
378 /// The base point which is used (with derive_public_key) to derive a per-commitment payment
379 /// public key which receives non-HTLC-encumbered funds which are only available for spending
380 /// after some delay (or can be claimed via the revocation path).
382 pub extern "C" fn ChannelPublicKeys_set_delayed_payment_basepoint(this_ptr: &mut ChannelPublicKeys, mut val: crate::c_types::PublicKey) {
383 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.delayed_payment_basepoint = val.into_rust();
385 /// The base point which is used (with derive_public_key) to derive a per-commitment public key
386 /// which is used to encumber HTLC-in-flight outputs.
388 pub extern "C" fn ChannelPublicKeys_get_htlc_basepoint(this_ptr: &ChannelPublicKeys) -> crate::c_types::PublicKey {
389 let mut inner_val = &mut this_ptr.get_native_mut_ref().htlc_basepoint;
390 crate::c_types::PublicKey::from_rust(&inner_val)
392 /// The base point which is used (with derive_public_key) to derive a per-commitment public key
393 /// which is used to encumber HTLC-in-flight outputs.
395 pub extern "C" fn ChannelPublicKeys_set_htlc_basepoint(this_ptr: &mut ChannelPublicKeys, mut val: crate::c_types::PublicKey) {
396 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.htlc_basepoint = val.into_rust();
398 /// Constructs a new ChannelPublicKeys given each field
401 pub extern "C" fn ChannelPublicKeys_new(mut funding_pubkey_arg: crate::c_types::PublicKey, mut revocation_basepoint_arg: crate::c_types::PublicKey, mut payment_point_arg: crate::c_types::PublicKey, mut delayed_payment_basepoint_arg: crate::c_types::PublicKey, mut htlc_basepoint_arg: crate::c_types::PublicKey) -> ChannelPublicKeys {
402 ChannelPublicKeys { inner: ObjOps::heap_alloc(nativeChannelPublicKeys {
403 funding_pubkey: funding_pubkey_arg.into_rust(),
404 revocation_basepoint: revocation_basepoint_arg.into_rust(),
405 payment_point: payment_point_arg.into_rust(),
406 delayed_payment_basepoint: delayed_payment_basepoint_arg.into_rust(),
407 htlc_basepoint: htlc_basepoint_arg.into_rust(),
410 impl Clone for ChannelPublicKeys {
411 fn clone(&self) -> Self {
413 inner: if <*mut nativeChannelPublicKeys>::is_null(self.inner) { core::ptr::null_mut() } else {
414 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
420 /// Used only if an object of this type is returned as a trait impl by a method
421 pub(crate) extern "C" fn ChannelPublicKeys_clone_void(this_ptr: *const c_void) -> *mut c_void {
422 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChannelPublicKeys)).clone() })) as *mut c_void
425 /// Creates a copy of the ChannelPublicKeys
426 pub extern "C" fn ChannelPublicKeys_clone(orig: &ChannelPublicKeys) -> ChannelPublicKeys {
430 /// Serialize the ChannelPublicKeys object into a byte array which can be read by ChannelPublicKeys_read
431 pub extern "C" fn ChannelPublicKeys_write(obj: &ChannelPublicKeys) -> crate::c_types::derived::CVec_u8Z {
432 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
435 pub(crate) extern "C" fn ChannelPublicKeys_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
436 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelPublicKeys) })
439 /// Read a ChannelPublicKeys from a byte array, created by ChannelPublicKeys_write
440 pub extern "C" fn ChannelPublicKeys_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ChannelPublicKeysDecodeErrorZ {
441 let res: Result<lightning::ln::chan_utils::ChannelPublicKeys, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
442 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::chan_utils::ChannelPublicKeys { 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() };
445 /// Create per-state keys from channel base points and the per-commitment point.
446 /// Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
449 pub extern "C" fn TxCreationKeys_derive_new(mut per_commitment_point: crate::c_types::PublicKey, mut broadcaster_delayed_payment_base: crate::c_types::PublicKey, mut broadcaster_htlc_base: crate::c_types::PublicKey, mut countersignatory_revocation_base: crate::c_types::PublicKey, mut countersignatory_htlc_base: crate::c_types::PublicKey) -> crate::c_types::derived::CResult_TxCreationKeysErrorZ {
450 let mut ret = lightning::ln::chan_utils::TxCreationKeys::derive_new(secp256k1::SECP256K1, &per_commitment_point.into_rust(), &broadcaster_delayed_payment_base.into_rust(), &broadcaster_htlc_base.into_rust(), &countersignatory_revocation_base.into_rust(), &countersignatory_htlc_base.into_rust());
451 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::chan_utils::TxCreationKeys { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::c_types::Secp256k1Error::from_rust(e) }).into() };
455 /// Generate per-state keys from channel static keys.
456 /// Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
459 pub extern "C" fn TxCreationKeys_from_channel_static_keys(mut per_commitment_point: crate::c_types::PublicKey, broadcaster_keys: &crate::lightning::ln::chan_utils::ChannelPublicKeys, countersignatory_keys: &crate::lightning::ln::chan_utils::ChannelPublicKeys) -> crate::c_types::derived::CResult_TxCreationKeysErrorZ {
460 let mut ret = lightning::ln::chan_utils::TxCreationKeys::from_channel_static_keys(&per_commitment_point.into_rust(), broadcaster_keys.get_native_ref(), countersignatory_keys.get_native_ref(), secp256k1::SECP256K1);
461 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::chan_utils::TxCreationKeys { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::c_types::Secp256k1Error::from_rust(e) }).into() };
465 /// The maximum length of a script returned by get_revokeable_redeemscript.
468 pub static REVOKEABLE_REDEEMSCRIPT_MAX_LENGTH: usize = lightning::ln::chan_utils::REVOKEABLE_REDEEMSCRIPT_MAX_LENGTH;
469 /// A script either spendable by the revocation
470 /// key or the broadcaster_delayed_payment_key and satisfying the relative-locktime OP_CSV constrain.
471 /// Encumbering a `to_holder` output on a commitment transaction or 2nd-stage HTLC transactions.
473 pub extern "C" fn get_revokeable_redeemscript(mut revocation_key: crate::c_types::PublicKey, mut contest_delay: u16, mut broadcaster_delayed_payment_key: crate::c_types::PublicKey) -> crate::c_types::derived::CVec_u8Z {
474 let mut ret = lightning::ln::chan_utils::get_revokeable_redeemscript(&revocation_key.into_rust(), contest_delay, &broadcaster_delayed_payment_key.into_rust());
475 ret.into_bytes().into()
479 use lightning::ln::chan_utils::HTLCOutputInCommitment as nativeHTLCOutputInCommitmentImport;
480 pub(crate) type nativeHTLCOutputInCommitment = nativeHTLCOutputInCommitmentImport;
482 /// Information about an HTLC as it appears in a commitment transaction
485 pub struct HTLCOutputInCommitment {
486 /// A pointer to the opaque Rust object.
488 /// Nearly everywhere, inner must be non-null, however in places where
489 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
490 pub inner: *mut nativeHTLCOutputInCommitment,
491 /// Indicates that this is the only struct which contains the same pointer.
493 /// Rust functions which take ownership of an object provided via an argument require
494 /// this to be true and invalidate the object pointed to by inner.
498 impl Drop for HTLCOutputInCommitment {
500 if self.is_owned && !<*mut nativeHTLCOutputInCommitment>::is_null(self.inner) {
501 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
505 /// Frees any resources used by the HTLCOutputInCommitment, if is_owned is set and inner is non-NULL.
507 pub extern "C" fn HTLCOutputInCommitment_free(this_obj: HTLCOutputInCommitment) { }
509 /// Used only if an object of this type is returned as a trait impl by a method
510 pub(crate) extern "C" fn HTLCOutputInCommitment_free_void(this_ptr: *mut c_void) {
511 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeHTLCOutputInCommitment); }
514 impl HTLCOutputInCommitment {
515 pub(crate) fn get_native_ref(&self) -> &'static nativeHTLCOutputInCommitment {
516 unsafe { &*ObjOps::untweak_ptr(self.inner) }
518 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeHTLCOutputInCommitment {
519 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
521 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
522 pub(crate) fn take_inner(mut self) -> *mut nativeHTLCOutputInCommitment {
523 assert!(self.is_owned);
524 let ret = ObjOps::untweak_ptr(self.inner);
525 self.inner = core::ptr::null_mut();
529 /// Whether the HTLC was \"offered\" (ie outbound in relation to this commitment transaction).
530 /// Note that this is not the same as whether it is ountbound *from us*. To determine that you
531 /// need to compare this value to whether the commitment transaction in question is that of
532 /// the counterparty or our own.
534 pub extern "C" fn HTLCOutputInCommitment_get_offered(this_ptr: &HTLCOutputInCommitment) -> bool {
535 let mut inner_val = &mut this_ptr.get_native_mut_ref().offered;
538 /// Whether the HTLC was \"offered\" (ie outbound in relation to this commitment transaction).
539 /// Note that this is not the same as whether it is ountbound *from us*. To determine that you
540 /// need to compare this value to whether the commitment transaction in question is that of
541 /// the counterparty or our own.
543 pub extern "C" fn HTLCOutputInCommitment_set_offered(this_ptr: &mut HTLCOutputInCommitment, mut val: bool) {
544 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.offered = val;
546 /// The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
547 /// this divided by 1000.
549 pub extern "C" fn HTLCOutputInCommitment_get_amount_msat(this_ptr: &HTLCOutputInCommitment) -> u64 {
550 let mut inner_val = &mut this_ptr.get_native_mut_ref().amount_msat;
553 /// The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
554 /// this divided by 1000.
556 pub extern "C" fn HTLCOutputInCommitment_set_amount_msat(this_ptr: &mut HTLCOutputInCommitment, mut val: u64) {
557 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.amount_msat = val;
559 /// The CLTV lock-time at which this HTLC expires.
561 pub extern "C" fn HTLCOutputInCommitment_get_cltv_expiry(this_ptr: &HTLCOutputInCommitment) -> u32 {
562 let mut inner_val = &mut this_ptr.get_native_mut_ref().cltv_expiry;
565 /// The CLTV lock-time at which this HTLC expires.
567 pub extern "C" fn HTLCOutputInCommitment_set_cltv_expiry(this_ptr: &mut HTLCOutputInCommitment, mut val: u32) {
568 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.cltv_expiry = val;
570 /// The hash of the preimage which unlocks this HTLC.
572 pub extern "C" fn HTLCOutputInCommitment_get_payment_hash(this_ptr: &HTLCOutputInCommitment) -> *const [u8; 32] {
573 let mut inner_val = &mut this_ptr.get_native_mut_ref().payment_hash;
576 /// The hash of the preimage which unlocks this HTLC.
578 pub extern "C" fn HTLCOutputInCommitment_set_payment_hash(this_ptr: &mut HTLCOutputInCommitment, mut val: crate::c_types::ThirtyTwoBytes) {
579 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.payment_hash = ::lightning::ln::PaymentHash(val.data);
581 /// The position within the commitment transactions' outputs. This may be None if the value is
582 /// below the dust limit (in which case no output appears in the commitment transaction and the
583 /// value is spent to additional transaction fees).
585 pub extern "C" fn HTLCOutputInCommitment_get_transaction_output_index(this_ptr: &HTLCOutputInCommitment) -> crate::c_types::derived::COption_u32Z {
586 let mut inner_val = &mut this_ptr.get_native_mut_ref().transaction_output_index;
587 let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_u32Z::None } else { crate::c_types::derived::COption_u32Z::Some( { inner_val.unwrap() }) };
590 /// The position within the commitment transactions' outputs. This may be None if the value is
591 /// below the dust limit (in which case no output appears in the commitment transaction and the
592 /// value is spent to additional transaction fees).
594 pub extern "C" fn HTLCOutputInCommitment_set_transaction_output_index(this_ptr: &mut HTLCOutputInCommitment, mut val: crate::c_types::derived::COption_u32Z) {
595 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
596 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.transaction_output_index = local_val;
598 /// Constructs a new HTLCOutputInCommitment given each field
601 pub extern "C" fn HTLCOutputInCommitment_new(mut offered_arg: bool, mut amount_msat_arg: u64, mut cltv_expiry_arg: u32, mut payment_hash_arg: crate::c_types::ThirtyTwoBytes, mut transaction_output_index_arg: crate::c_types::derived::COption_u32Z) -> HTLCOutputInCommitment {
602 let mut local_transaction_output_index_arg = if transaction_output_index_arg.is_some() { Some( { transaction_output_index_arg.take() }) } else { None };
603 HTLCOutputInCommitment { inner: ObjOps::heap_alloc(nativeHTLCOutputInCommitment {
604 offered: offered_arg,
605 amount_msat: amount_msat_arg,
606 cltv_expiry: cltv_expiry_arg,
607 payment_hash: ::lightning::ln::PaymentHash(payment_hash_arg.data),
608 transaction_output_index: local_transaction_output_index_arg,
611 impl Clone for HTLCOutputInCommitment {
612 fn clone(&self) -> Self {
614 inner: if <*mut nativeHTLCOutputInCommitment>::is_null(self.inner) { core::ptr::null_mut() } else {
615 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
621 /// Used only if an object of this type is returned as a trait impl by a method
622 pub(crate) extern "C" fn HTLCOutputInCommitment_clone_void(this_ptr: *const c_void) -> *mut c_void {
623 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeHTLCOutputInCommitment)).clone() })) as *mut c_void
626 /// Creates a copy of the HTLCOutputInCommitment
627 pub extern "C" fn HTLCOutputInCommitment_clone(orig: &HTLCOutputInCommitment) -> HTLCOutputInCommitment {
631 /// Serialize the HTLCOutputInCommitment object into a byte array which can be read by HTLCOutputInCommitment_read
632 pub extern "C" fn HTLCOutputInCommitment_write(obj: &HTLCOutputInCommitment) -> crate::c_types::derived::CVec_u8Z {
633 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
636 pub(crate) extern "C" fn HTLCOutputInCommitment_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
637 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeHTLCOutputInCommitment) })
640 /// Read a HTLCOutputInCommitment from a byte array, created by HTLCOutputInCommitment_write
641 pub extern "C" fn HTLCOutputInCommitment_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_HTLCOutputInCommitmentDecodeErrorZ {
642 let res: Result<lightning::ln::chan_utils::HTLCOutputInCommitment, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
643 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::chan_utils::HTLCOutputInCommitment { 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() };
646 /// Gets the witness redeemscript for an HTLC output in a commitment transaction. Note that htlc
647 /// does not need to have its previous_output_index filled.
649 pub extern "C" fn get_htlc_redeemscript(htlc: &crate::lightning::ln::chan_utils::HTLCOutputInCommitment, mut opt_anchors: bool, keys: &crate::lightning::ln::chan_utils::TxCreationKeys) -> crate::c_types::derived::CVec_u8Z {
650 let mut ret = lightning::ln::chan_utils::get_htlc_redeemscript(htlc.get_native_ref(), opt_anchors, keys.get_native_ref());
651 ret.into_bytes().into()
654 /// Gets the redeemscript for a funding output from the two funding public keys.
655 /// Note that the order of funding public keys does not matter.
657 pub extern "C" fn make_funding_redeemscript(mut broadcaster: crate::c_types::PublicKey, mut countersignatory: crate::c_types::PublicKey) -> crate::c_types::derived::CVec_u8Z {
658 let mut ret = lightning::ln::chan_utils::make_funding_redeemscript(&broadcaster.into_rust(), &countersignatory.into_rust());
659 ret.into_bytes().into()
662 /// Builds an unsigned HTLC-Success or HTLC-Timeout transaction from the given channel and HTLC
663 /// parameters. This is used by [`TrustedCommitmentTransaction::get_htlc_sigs`] to fetch the
664 /// transaction which needs signing, and can be used to construct an HTLC transaction which is
665 /// broadcastable given a counterparty HTLC signature.
667 /// Panics if htlc.transaction_output_index.is_none() (as such HTLCs do not appear in the
668 /// commitment transaction).
670 pub extern "C" fn build_htlc_transaction(commitment_txid: *const [u8; 32], mut feerate_per_kw: u32, mut contest_delay: u16, htlc: &crate::lightning::ln::chan_utils::HTLCOutputInCommitment, mut opt_anchors: bool, mut broadcaster_delayed_payment_key: crate::c_types::PublicKey, mut revocation_key: crate::c_types::PublicKey) -> crate::c_types::Transaction {
671 let mut ret = lightning::ln::chan_utils::build_htlc_transaction(&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*commitment_txid }[..]).unwrap(), feerate_per_kw, contest_delay, htlc.get_native_ref(), opt_anchors, &broadcaster_delayed_payment_key.into_rust(), &revocation_key.into_rust());
672 crate::c_types::Transaction::from_bitcoin(&ret)
675 /// Gets the witnessScript for an anchor output from the funding public key.
676 /// The witness in the spending input must be:
677 /// <BIP 143 funding_signature>
678 /// After 16 blocks of confirmation, an alternative satisfying witness could be:
680 /// (empty vector required to satisfy compliance with MINIMALIF-standard rule)
682 pub extern "C" fn get_anchor_redeemscript(mut funding_pubkey: crate::c_types::PublicKey) -> crate::c_types::derived::CVec_u8Z {
683 let mut ret = lightning::ln::chan_utils::get_anchor_redeemscript(&funding_pubkey.into_rust());
684 ret.into_bytes().into()
688 use lightning::ln::chan_utils::ChannelTransactionParameters as nativeChannelTransactionParametersImport;
689 pub(crate) type nativeChannelTransactionParameters = nativeChannelTransactionParametersImport;
691 /// Per-channel data used to build transactions in conjunction with the per-commitment data (CommitmentTransaction).
692 /// The fields are organized by holder/counterparty.
694 /// Normally, this is converted to the broadcaster/countersignatory-organized DirectedChannelTransactionParameters
695 /// before use, via the as_holder_broadcastable and as_counterparty_broadcastable functions.
698 pub struct ChannelTransactionParameters {
699 /// A pointer to the opaque Rust object.
701 /// Nearly everywhere, inner must be non-null, however in places where
702 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
703 pub inner: *mut nativeChannelTransactionParameters,
704 /// Indicates that this is the only struct which contains the same pointer.
706 /// Rust functions which take ownership of an object provided via an argument require
707 /// this to be true and invalidate the object pointed to by inner.
711 impl Drop for ChannelTransactionParameters {
713 if self.is_owned && !<*mut nativeChannelTransactionParameters>::is_null(self.inner) {
714 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
718 /// Frees any resources used by the ChannelTransactionParameters, if is_owned is set and inner is non-NULL.
720 pub extern "C" fn ChannelTransactionParameters_free(this_obj: ChannelTransactionParameters) { }
722 /// Used only if an object of this type is returned as a trait impl by a method
723 pub(crate) extern "C" fn ChannelTransactionParameters_free_void(this_ptr: *mut c_void) {
724 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelTransactionParameters); }
727 impl ChannelTransactionParameters {
728 pub(crate) fn get_native_ref(&self) -> &'static nativeChannelTransactionParameters {
729 unsafe { &*ObjOps::untweak_ptr(self.inner) }
731 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChannelTransactionParameters {
732 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
734 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
735 pub(crate) fn take_inner(mut self) -> *mut nativeChannelTransactionParameters {
736 assert!(self.is_owned);
737 let ret = ObjOps::untweak_ptr(self.inner);
738 self.inner = core::ptr::null_mut();
742 /// Holder public keys
744 pub extern "C" fn ChannelTransactionParameters_get_holder_pubkeys(this_ptr: &ChannelTransactionParameters) -> crate::lightning::ln::chan_utils::ChannelPublicKeys {
745 let mut inner_val = &mut this_ptr.get_native_mut_ref().holder_pubkeys;
746 crate::lightning::ln::chan_utils::ChannelPublicKeys { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::ln::chan_utils::ChannelPublicKeys<>) as *mut _) }, is_owned: false }
748 /// Holder public keys
750 pub extern "C" fn ChannelTransactionParameters_set_holder_pubkeys(this_ptr: &mut ChannelTransactionParameters, mut val: crate::lightning::ln::chan_utils::ChannelPublicKeys) {
751 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.holder_pubkeys = *unsafe { Box::from_raw(val.take_inner()) };
753 /// The contest delay selected by the holder, which applies to counterparty-broadcast transactions
755 pub extern "C" fn ChannelTransactionParameters_get_holder_selected_contest_delay(this_ptr: &ChannelTransactionParameters) -> u16 {
756 let mut inner_val = &mut this_ptr.get_native_mut_ref().holder_selected_contest_delay;
759 /// The contest delay selected by the holder, which applies to counterparty-broadcast transactions
761 pub extern "C" fn ChannelTransactionParameters_set_holder_selected_contest_delay(this_ptr: &mut ChannelTransactionParameters, mut val: u16) {
762 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.holder_selected_contest_delay = val;
764 /// Whether the holder is the initiator of this channel.
765 /// This is an input to the commitment number obscure factor computation.
767 pub extern "C" fn ChannelTransactionParameters_get_is_outbound_from_holder(this_ptr: &ChannelTransactionParameters) -> bool {
768 let mut inner_val = &mut this_ptr.get_native_mut_ref().is_outbound_from_holder;
771 /// Whether the holder is the initiator of this channel.
772 /// This is an input to the commitment number obscure factor computation.
774 pub extern "C" fn ChannelTransactionParameters_set_is_outbound_from_holder(this_ptr: &mut ChannelTransactionParameters, mut val: bool) {
775 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.is_outbound_from_holder = val;
777 /// The late-bound counterparty channel transaction parameters.
778 /// These parameters are populated at the point in the protocol where the counterparty provides them.
780 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
782 pub extern "C" fn ChannelTransactionParameters_get_counterparty_parameters(this_ptr: &ChannelTransactionParameters) -> crate::lightning::ln::chan_utils::CounterpartyChannelTransactionParameters {
783 let mut inner_val = &mut this_ptr.get_native_mut_ref().counterparty_parameters;
784 let mut local_inner_val = crate::lightning::ln::chan_utils::CounterpartyChannelTransactionParameters { inner: unsafe { (if inner_val.is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner( { (inner_val.as_ref().unwrap()) }) } as *const lightning::ln::chan_utils::CounterpartyChannelTransactionParameters<>) as *mut _ }, is_owned: false };
787 /// The late-bound counterparty channel transaction parameters.
788 /// These parameters are populated at the point in the protocol where the counterparty provides them.
790 /// Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
792 pub extern "C" fn ChannelTransactionParameters_set_counterparty_parameters(this_ptr: &mut ChannelTransactionParameters, mut val: crate::lightning::ln::chan_utils::CounterpartyChannelTransactionParameters) {
793 let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
794 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.counterparty_parameters = local_val;
796 /// The late-bound funding outpoint
798 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
800 pub extern "C" fn ChannelTransactionParameters_get_funding_outpoint(this_ptr: &ChannelTransactionParameters) -> crate::lightning::chain::transaction::OutPoint {
801 let mut inner_val = &mut this_ptr.get_native_mut_ref().funding_outpoint;
802 let mut local_inner_val = crate::lightning::chain::transaction::OutPoint { inner: unsafe { (if inner_val.is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner( { (inner_val.as_ref().unwrap()) }) } as *const lightning::chain::transaction::OutPoint<>) as *mut _ }, is_owned: false };
805 /// The late-bound funding outpoint
807 /// Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
809 pub extern "C" fn ChannelTransactionParameters_set_funding_outpoint(this_ptr: &mut ChannelTransactionParameters, mut val: crate::lightning::chain::transaction::OutPoint) {
810 let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
811 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.funding_outpoint = local_val;
813 /// Are anchors used for this channel. Boolean is serialization backwards-compatible
815 pub extern "C" fn ChannelTransactionParameters_get_opt_anchors(this_ptr: &ChannelTransactionParameters) -> crate::c_types::derived::COption_NoneZ {
816 let mut inner_val = &mut this_ptr.get_native_mut_ref().opt_anchors;
817 let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_NoneZ::None } else { crate::c_types::derived::COption_NoneZ::Some /* { () /**/ } */};
820 /// Are anchors used for this channel. Boolean is serialization backwards-compatible
822 pub extern "C" fn ChannelTransactionParameters_set_opt_anchors(this_ptr: &mut ChannelTransactionParameters, mut val: crate::c_types::derived::COption_NoneZ) {
823 let mut local_val = if val.is_some() { Some( { () /*val.take()*/ }) } else { None };
824 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.opt_anchors = local_val;
826 /// Constructs a new ChannelTransactionParameters given each field
829 pub extern "C" fn ChannelTransactionParameters_new(mut holder_pubkeys_arg: crate::lightning::ln::chan_utils::ChannelPublicKeys, mut holder_selected_contest_delay_arg: u16, mut is_outbound_from_holder_arg: bool, mut counterparty_parameters_arg: crate::lightning::ln::chan_utils::CounterpartyChannelTransactionParameters, mut funding_outpoint_arg: crate::lightning::chain::transaction::OutPoint, mut opt_anchors_arg: crate::c_types::derived::COption_NoneZ) -> ChannelTransactionParameters {
830 let mut local_counterparty_parameters_arg = if counterparty_parameters_arg.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(counterparty_parameters_arg.take_inner()) } }) };
831 let mut local_funding_outpoint_arg = if funding_outpoint_arg.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(funding_outpoint_arg.take_inner()) } }) };
832 let mut local_opt_anchors_arg = if opt_anchors_arg.is_some() { Some( { () /*opt_anchors_arg.take()*/ }) } else { None };
833 ChannelTransactionParameters { inner: ObjOps::heap_alloc(nativeChannelTransactionParameters {
834 holder_pubkeys: *unsafe { Box::from_raw(holder_pubkeys_arg.take_inner()) },
835 holder_selected_contest_delay: holder_selected_contest_delay_arg,
836 is_outbound_from_holder: is_outbound_from_holder_arg,
837 counterparty_parameters: local_counterparty_parameters_arg,
838 funding_outpoint: local_funding_outpoint_arg,
839 opt_anchors: local_opt_anchors_arg,
842 impl Clone for ChannelTransactionParameters {
843 fn clone(&self) -> Self {
845 inner: if <*mut nativeChannelTransactionParameters>::is_null(self.inner) { core::ptr::null_mut() } else {
846 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
852 /// Used only if an object of this type is returned as a trait impl by a method
853 pub(crate) extern "C" fn ChannelTransactionParameters_clone_void(this_ptr: *const c_void) -> *mut c_void {
854 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChannelTransactionParameters)).clone() })) as *mut c_void
857 /// Creates a copy of the ChannelTransactionParameters
858 pub extern "C" fn ChannelTransactionParameters_clone(orig: &ChannelTransactionParameters) -> ChannelTransactionParameters {
862 use lightning::ln::chan_utils::CounterpartyChannelTransactionParameters as nativeCounterpartyChannelTransactionParametersImport;
863 pub(crate) type nativeCounterpartyChannelTransactionParameters = nativeCounterpartyChannelTransactionParametersImport;
865 /// Late-bound per-channel counterparty data used to build transactions.
868 pub struct CounterpartyChannelTransactionParameters {
869 /// A pointer to the opaque Rust object.
871 /// Nearly everywhere, inner must be non-null, however in places where
872 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
873 pub inner: *mut nativeCounterpartyChannelTransactionParameters,
874 /// Indicates that this is the only struct which contains the same pointer.
876 /// Rust functions which take ownership of an object provided via an argument require
877 /// this to be true and invalidate the object pointed to by inner.
881 impl Drop for CounterpartyChannelTransactionParameters {
883 if self.is_owned && !<*mut nativeCounterpartyChannelTransactionParameters>::is_null(self.inner) {
884 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
888 /// Frees any resources used by the CounterpartyChannelTransactionParameters, if is_owned is set and inner is non-NULL.
890 pub extern "C" fn CounterpartyChannelTransactionParameters_free(this_obj: CounterpartyChannelTransactionParameters) { }
892 /// Used only if an object of this type is returned as a trait impl by a method
893 pub(crate) extern "C" fn CounterpartyChannelTransactionParameters_free_void(this_ptr: *mut c_void) {
894 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeCounterpartyChannelTransactionParameters); }
897 impl CounterpartyChannelTransactionParameters {
898 pub(crate) fn get_native_ref(&self) -> &'static nativeCounterpartyChannelTransactionParameters {
899 unsafe { &*ObjOps::untweak_ptr(self.inner) }
901 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeCounterpartyChannelTransactionParameters {
902 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
904 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
905 pub(crate) fn take_inner(mut self) -> *mut nativeCounterpartyChannelTransactionParameters {
906 assert!(self.is_owned);
907 let ret = ObjOps::untweak_ptr(self.inner);
908 self.inner = core::ptr::null_mut();
912 /// Counter-party public keys
914 pub extern "C" fn CounterpartyChannelTransactionParameters_get_pubkeys(this_ptr: &CounterpartyChannelTransactionParameters) -> crate::lightning::ln::chan_utils::ChannelPublicKeys {
915 let mut inner_val = &mut this_ptr.get_native_mut_ref().pubkeys;
916 crate::lightning::ln::chan_utils::ChannelPublicKeys { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::ln::chan_utils::ChannelPublicKeys<>) as *mut _) }, is_owned: false }
918 /// Counter-party public keys
920 pub extern "C" fn CounterpartyChannelTransactionParameters_set_pubkeys(this_ptr: &mut CounterpartyChannelTransactionParameters, mut val: crate::lightning::ln::chan_utils::ChannelPublicKeys) {
921 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.pubkeys = *unsafe { Box::from_raw(val.take_inner()) };
923 /// The contest delay selected by the counterparty, which applies to holder-broadcast transactions
925 pub extern "C" fn CounterpartyChannelTransactionParameters_get_selected_contest_delay(this_ptr: &CounterpartyChannelTransactionParameters) -> u16 {
926 let mut inner_val = &mut this_ptr.get_native_mut_ref().selected_contest_delay;
929 /// The contest delay selected by the counterparty, which applies to holder-broadcast transactions
931 pub extern "C" fn CounterpartyChannelTransactionParameters_set_selected_contest_delay(this_ptr: &mut CounterpartyChannelTransactionParameters, mut val: u16) {
932 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.selected_contest_delay = val;
934 /// Constructs a new CounterpartyChannelTransactionParameters given each field
937 pub extern "C" fn CounterpartyChannelTransactionParameters_new(mut pubkeys_arg: crate::lightning::ln::chan_utils::ChannelPublicKeys, mut selected_contest_delay_arg: u16) -> CounterpartyChannelTransactionParameters {
938 CounterpartyChannelTransactionParameters { inner: ObjOps::heap_alloc(nativeCounterpartyChannelTransactionParameters {
939 pubkeys: *unsafe { Box::from_raw(pubkeys_arg.take_inner()) },
940 selected_contest_delay: selected_contest_delay_arg,
943 impl Clone for CounterpartyChannelTransactionParameters {
944 fn clone(&self) -> Self {
946 inner: if <*mut nativeCounterpartyChannelTransactionParameters>::is_null(self.inner) { core::ptr::null_mut() } else {
947 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
953 /// Used only if an object of this type is returned as a trait impl by a method
954 pub(crate) extern "C" fn CounterpartyChannelTransactionParameters_clone_void(this_ptr: *const c_void) -> *mut c_void {
955 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeCounterpartyChannelTransactionParameters)).clone() })) as *mut c_void
958 /// Creates a copy of the CounterpartyChannelTransactionParameters
959 pub extern "C" fn CounterpartyChannelTransactionParameters_clone(orig: &CounterpartyChannelTransactionParameters) -> CounterpartyChannelTransactionParameters {
962 /// Whether the late bound parameters are populated.
965 pub extern "C" fn ChannelTransactionParameters_is_populated(this_arg: &ChannelTransactionParameters) -> bool {
966 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.is_populated();
970 /// Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
971 /// given that the holder is the broadcaster.
973 /// self.is_populated() must be true before calling this function.
976 pub extern "C" fn ChannelTransactionParameters_as_holder_broadcastable(this_arg: &ChannelTransactionParameters) -> crate::lightning::ln::chan_utils::DirectedChannelTransactionParameters {
977 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.as_holder_broadcastable();
978 crate::lightning::ln::chan_utils::DirectedChannelTransactionParameters { inner: ObjOps::heap_alloc(ret), is_owned: true }
981 /// Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
982 /// given that the counterparty is the broadcaster.
984 /// self.is_populated() must be true before calling this function.
987 pub extern "C" fn ChannelTransactionParameters_as_counterparty_broadcastable(this_arg: &ChannelTransactionParameters) -> crate::lightning::ln::chan_utils::DirectedChannelTransactionParameters {
988 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.as_counterparty_broadcastable();
989 crate::lightning::ln::chan_utils::DirectedChannelTransactionParameters { inner: ObjOps::heap_alloc(ret), is_owned: true }
993 /// Serialize the CounterpartyChannelTransactionParameters object into a byte array which can be read by CounterpartyChannelTransactionParameters_read
994 pub extern "C" fn CounterpartyChannelTransactionParameters_write(obj: &CounterpartyChannelTransactionParameters) -> crate::c_types::derived::CVec_u8Z {
995 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
998 pub(crate) extern "C" fn CounterpartyChannelTransactionParameters_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
999 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeCounterpartyChannelTransactionParameters) })
1002 /// Read a CounterpartyChannelTransactionParameters from a byte array, created by CounterpartyChannelTransactionParameters_write
1003 pub extern "C" fn CounterpartyChannelTransactionParameters_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_CounterpartyChannelTransactionParametersDecodeErrorZ {
1004 let res: Result<lightning::ln::chan_utils::CounterpartyChannelTransactionParameters, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
1005 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::chan_utils::CounterpartyChannelTransactionParameters { 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() };
1009 /// Serialize the ChannelTransactionParameters object into a byte array which can be read by ChannelTransactionParameters_read
1010 pub extern "C" fn ChannelTransactionParameters_write(obj: &ChannelTransactionParameters) -> crate::c_types::derived::CVec_u8Z {
1011 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
1014 pub(crate) extern "C" fn ChannelTransactionParameters_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1015 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelTransactionParameters) })
1018 /// Read a ChannelTransactionParameters from a byte array, created by ChannelTransactionParameters_write
1019 pub extern "C" fn ChannelTransactionParameters_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ChannelTransactionParametersDecodeErrorZ {
1020 let res: Result<lightning::ln::chan_utils::ChannelTransactionParameters, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
1021 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::chan_utils::ChannelTransactionParameters { 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() };
1025 use lightning::ln::chan_utils::DirectedChannelTransactionParameters as nativeDirectedChannelTransactionParametersImport;
1026 pub(crate) type nativeDirectedChannelTransactionParameters = nativeDirectedChannelTransactionParametersImport<'static>;
1028 /// Static channel fields used to build transactions given per-commitment fields, organized by
1029 /// broadcaster/countersignatory.
1031 /// This is derived from the holder/counterparty-organized ChannelTransactionParameters via the
1032 /// as_holder_broadcastable and as_counterparty_broadcastable functions.
1035 pub struct DirectedChannelTransactionParameters {
1036 /// A pointer to the opaque Rust object.
1038 /// Nearly everywhere, inner must be non-null, however in places where
1039 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1040 pub inner: *mut nativeDirectedChannelTransactionParameters,
1041 /// Indicates that this is the only struct which contains the same pointer.
1043 /// Rust functions which take ownership of an object provided via an argument require
1044 /// this to be true and invalidate the object pointed to by inner.
1048 impl Drop for DirectedChannelTransactionParameters {
1049 fn drop(&mut self) {
1050 if self.is_owned && !<*mut nativeDirectedChannelTransactionParameters>::is_null(self.inner) {
1051 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1055 /// Frees any resources used by the DirectedChannelTransactionParameters, if is_owned is set and inner is non-NULL.
1057 pub extern "C" fn DirectedChannelTransactionParameters_free(this_obj: DirectedChannelTransactionParameters) { }
1059 /// Used only if an object of this type is returned as a trait impl by a method
1060 pub(crate) extern "C" fn DirectedChannelTransactionParameters_free_void(this_ptr: *mut c_void) {
1061 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeDirectedChannelTransactionParameters); }
1064 impl DirectedChannelTransactionParameters {
1065 pub(crate) fn get_native_ref(&self) -> &'static nativeDirectedChannelTransactionParameters {
1066 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1068 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeDirectedChannelTransactionParameters {
1069 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1071 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1072 pub(crate) fn take_inner(mut self) -> *mut nativeDirectedChannelTransactionParameters {
1073 assert!(self.is_owned);
1074 let ret = ObjOps::untweak_ptr(self.inner);
1075 self.inner = core::ptr::null_mut();
1079 /// Get the channel pubkeys for the broadcaster
1082 pub extern "C" fn DirectedChannelTransactionParameters_broadcaster_pubkeys(this_arg: &DirectedChannelTransactionParameters) -> crate::lightning::ln::chan_utils::ChannelPublicKeys {
1083 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.broadcaster_pubkeys();
1084 crate::lightning::ln::chan_utils::ChannelPublicKeys { inner: unsafe { ObjOps::nonnull_ptr_to_inner((ret as *const lightning::ln::chan_utils::ChannelPublicKeys<>) as *mut _) }, is_owned: false }
1087 /// Get the channel pubkeys for the countersignatory
1090 pub extern "C" fn DirectedChannelTransactionParameters_countersignatory_pubkeys(this_arg: &DirectedChannelTransactionParameters) -> crate::lightning::ln::chan_utils::ChannelPublicKeys {
1091 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.countersignatory_pubkeys();
1092 crate::lightning::ln::chan_utils::ChannelPublicKeys { inner: unsafe { ObjOps::nonnull_ptr_to_inner((ret as *const lightning::ln::chan_utils::ChannelPublicKeys<>) as *mut _) }, is_owned: false }
1095 /// Get the contest delay applicable to the transactions.
1096 /// Note that the contest delay was selected by the countersignatory.
1099 pub extern "C" fn DirectedChannelTransactionParameters_contest_delay(this_arg: &DirectedChannelTransactionParameters) -> u16 {
1100 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.contest_delay();
1104 /// Whether the channel is outbound from the broadcaster.
1106 /// The boolean representing the side that initiated the channel is
1107 /// an input to the commitment number obscure factor computation.
1110 pub extern "C" fn DirectedChannelTransactionParameters_is_outbound(this_arg: &DirectedChannelTransactionParameters) -> bool {
1111 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.is_outbound();
1115 /// The funding outpoint
1118 pub extern "C" fn DirectedChannelTransactionParameters_funding_outpoint(this_arg: &DirectedChannelTransactionParameters) -> crate::lightning::chain::transaction::OutPoint {
1119 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.funding_outpoint();
1120 crate::c_types::bitcoin_to_C_outpoint(ret)
1123 /// Whether to use anchors for this channel
1126 pub extern "C" fn DirectedChannelTransactionParameters_opt_anchors(this_arg: &DirectedChannelTransactionParameters) -> bool {
1127 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.opt_anchors();
1132 use lightning::ln::chan_utils::HolderCommitmentTransaction as nativeHolderCommitmentTransactionImport;
1133 pub(crate) type nativeHolderCommitmentTransaction = nativeHolderCommitmentTransactionImport;
1135 /// Information needed to build and sign a holder's commitment transaction.
1137 /// The transaction is only signed once we are ready to broadcast.
1140 pub struct HolderCommitmentTransaction {
1141 /// A pointer to the opaque Rust object.
1143 /// Nearly everywhere, inner must be non-null, however in places where
1144 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1145 pub inner: *mut nativeHolderCommitmentTransaction,
1146 /// Indicates that this is the only struct which contains the same pointer.
1148 /// Rust functions which take ownership of an object provided via an argument require
1149 /// this to be true and invalidate the object pointed to by inner.
1153 impl Drop for HolderCommitmentTransaction {
1154 fn drop(&mut self) {
1155 if self.is_owned && !<*mut nativeHolderCommitmentTransaction>::is_null(self.inner) {
1156 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1160 /// Frees any resources used by the HolderCommitmentTransaction, if is_owned is set and inner is non-NULL.
1162 pub extern "C" fn HolderCommitmentTransaction_free(this_obj: HolderCommitmentTransaction) { }
1164 /// Used only if an object of this type is returned as a trait impl by a method
1165 pub(crate) extern "C" fn HolderCommitmentTransaction_free_void(this_ptr: *mut c_void) {
1166 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeHolderCommitmentTransaction); }
1169 impl HolderCommitmentTransaction {
1170 pub(crate) fn get_native_ref(&self) -> &'static nativeHolderCommitmentTransaction {
1171 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1173 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeHolderCommitmentTransaction {
1174 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1176 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1177 pub(crate) fn take_inner(mut self) -> *mut nativeHolderCommitmentTransaction {
1178 assert!(self.is_owned);
1179 let ret = ObjOps::untweak_ptr(self.inner);
1180 self.inner = core::ptr::null_mut();
1184 /// Our counterparty's signature for the transaction
1186 pub extern "C" fn HolderCommitmentTransaction_get_counterparty_sig(this_ptr: &HolderCommitmentTransaction) -> crate::c_types::Signature {
1187 let mut inner_val = &mut this_ptr.get_native_mut_ref().counterparty_sig;
1188 crate::c_types::Signature::from_rust(&inner_val)
1190 /// Our counterparty's signature for the transaction
1192 pub extern "C" fn HolderCommitmentTransaction_set_counterparty_sig(this_ptr: &mut HolderCommitmentTransaction, mut val: crate::c_types::Signature) {
1193 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.counterparty_sig = val.into_rust();
1195 /// All non-dust counterparty HTLC signatures, in the order they appear in the transaction
1197 pub extern "C" fn HolderCommitmentTransaction_set_counterparty_htlc_sigs(this_ptr: &mut HolderCommitmentTransaction, mut val: crate::c_types::derived::CVec_SignatureZ) {
1198 let mut local_val = Vec::new(); for mut item in val.into_rust().drain(..) { local_val.push( { item.into_rust() }); };
1199 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.counterparty_htlc_sigs = local_val;
1201 impl Clone for HolderCommitmentTransaction {
1202 fn clone(&self) -> Self {
1204 inner: if <*mut nativeHolderCommitmentTransaction>::is_null(self.inner) { core::ptr::null_mut() } else {
1205 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1211 /// Used only if an object of this type is returned as a trait impl by a method
1212 pub(crate) extern "C" fn HolderCommitmentTransaction_clone_void(this_ptr: *const c_void) -> *mut c_void {
1213 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeHolderCommitmentTransaction)).clone() })) as *mut c_void
1216 /// Creates a copy of the HolderCommitmentTransaction
1217 pub extern "C" fn HolderCommitmentTransaction_clone(orig: &HolderCommitmentTransaction) -> HolderCommitmentTransaction {
1221 /// Serialize the HolderCommitmentTransaction object into a byte array which can be read by HolderCommitmentTransaction_read
1222 pub extern "C" fn HolderCommitmentTransaction_write(obj: &HolderCommitmentTransaction) -> crate::c_types::derived::CVec_u8Z {
1223 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
1226 pub(crate) extern "C" fn HolderCommitmentTransaction_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1227 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeHolderCommitmentTransaction) })
1230 /// Read a HolderCommitmentTransaction from a byte array, created by HolderCommitmentTransaction_write
1231 pub extern "C" fn HolderCommitmentTransaction_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_HolderCommitmentTransactionDecodeErrorZ {
1232 let res: Result<lightning::ln::chan_utils::HolderCommitmentTransaction, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
1233 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::chan_utils::HolderCommitmentTransaction { 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() };
1236 /// Create a new holder transaction with the given counterparty signatures.
1237 /// The funding keys are used to figure out which signature should go first when building the transaction for broadcast.
1240 pub extern "C" fn HolderCommitmentTransaction_new(mut commitment_tx: crate::lightning::ln::chan_utils::CommitmentTransaction, mut counterparty_sig: crate::c_types::Signature, mut counterparty_htlc_sigs: crate::c_types::derived::CVec_SignatureZ, mut holder_funding_key: crate::c_types::PublicKey, mut counterparty_funding_key: crate::c_types::PublicKey) -> HolderCommitmentTransaction {
1241 let mut local_counterparty_htlc_sigs = Vec::new(); for mut item in counterparty_htlc_sigs.into_rust().drain(..) { local_counterparty_htlc_sigs.push( { item.into_rust() }); };
1242 let mut ret = lightning::ln::chan_utils::HolderCommitmentTransaction::new(*unsafe { Box::from_raw(commitment_tx.take_inner()) }, counterparty_sig.into_rust(), local_counterparty_htlc_sigs, &holder_funding_key.into_rust(), &counterparty_funding_key.into_rust());
1243 HolderCommitmentTransaction { inner: ObjOps::heap_alloc(ret), is_owned: true }
1247 use lightning::ln::chan_utils::BuiltCommitmentTransaction as nativeBuiltCommitmentTransactionImport;
1248 pub(crate) type nativeBuiltCommitmentTransaction = nativeBuiltCommitmentTransactionImport;
1250 /// A pre-built Bitcoin commitment transaction and its txid.
1253 pub struct BuiltCommitmentTransaction {
1254 /// A pointer to the opaque Rust object.
1256 /// Nearly everywhere, inner must be non-null, however in places where
1257 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1258 pub inner: *mut nativeBuiltCommitmentTransaction,
1259 /// Indicates that this is the only struct which contains the same pointer.
1261 /// Rust functions which take ownership of an object provided via an argument require
1262 /// this to be true and invalidate the object pointed to by inner.
1266 impl Drop for BuiltCommitmentTransaction {
1267 fn drop(&mut self) {
1268 if self.is_owned && !<*mut nativeBuiltCommitmentTransaction>::is_null(self.inner) {
1269 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1273 /// Frees any resources used by the BuiltCommitmentTransaction, if is_owned is set and inner is non-NULL.
1275 pub extern "C" fn BuiltCommitmentTransaction_free(this_obj: BuiltCommitmentTransaction) { }
1277 /// Used only if an object of this type is returned as a trait impl by a method
1278 pub(crate) extern "C" fn BuiltCommitmentTransaction_free_void(this_ptr: *mut c_void) {
1279 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeBuiltCommitmentTransaction); }
1282 impl BuiltCommitmentTransaction {
1283 pub(crate) fn get_native_ref(&self) -> &'static nativeBuiltCommitmentTransaction {
1284 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1286 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeBuiltCommitmentTransaction {
1287 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1289 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1290 pub(crate) fn take_inner(mut self) -> *mut nativeBuiltCommitmentTransaction {
1291 assert!(self.is_owned);
1292 let ret = ObjOps::untweak_ptr(self.inner);
1293 self.inner = core::ptr::null_mut();
1297 /// The commitment transaction
1299 pub extern "C" fn BuiltCommitmentTransaction_get_transaction(this_ptr: &BuiltCommitmentTransaction) -> crate::c_types::Transaction {
1300 let mut inner_val = &mut this_ptr.get_native_mut_ref().transaction;
1301 crate::c_types::Transaction::from_bitcoin(inner_val)
1303 /// The commitment transaction
1305 pub extern "C" fn BuiltCommitmentTransaction_set_transaction(this_ptr: &mut BuiltCommitmentTransaction, mut val: crate::c_types::Transaction) {
1306 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.transaction = val.into_bitcoin();
1308 /// The txid for the commitment transaction.
1310 /// This is provided as a performance optimization, instead of calling transaction.txid()
1313 pub extern "C" fn BuiltCommitmentTransaction_get_txid(this_ptr: &BuiltCommitmentTransaction) -> *const [u8; 32] {
1314 let mut inner_val = &mut this_ptr.get_native_mut_ref().txid;
1315 inner_val.as_inner()
1317 /// The txid for the commitment transaction.
1319 /// This is provided as a performance optimization, instead of calling transaction.txid()
1322 pub extern "C" fn BuiltCommitmentTransaction_set_txid(this_ptr: &mut BuiltCommitmentTransaction, mut val: crate::c_types::ThirtyTwoBytes) {
1323 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.txid = ::bitcoin::hash_types::Txid::from_slice(&val.data[..]).unwrap();
1325 /// Constructs a new BuiltCommitmentTransaction given each field
1328 pub extern "C" fn BuiltCommitmentTransaction_new(mut transaction_arg: crate::c_types::Transaction, mut txid_arg: crate::c_types::ThirtyTwoBytes) -> BuiltCommitmentTransaction {
1329 BuiltCommitmentTransaction { inner: ObjOps::heap_alloc(nativeBuiltCommitmentTransaction {
1330 transaction: transaction_arg.into_bitcoin(),
1331 txid: ::bitcoin::hash_types::Txid::from_slice(&txid_arg.data[..]).unwrap(),
1332 }), is_owned: true }
1334 impl Clone for BuiltCommitmentTransaction {
1335 fn clone(&self) -> Self {
1337 inner: if <*mut nativeBuiltCommitmentTransaction>::is_null(self.inner) { core::ptr::null_mut() } else {
1338 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1344 /// Used only if an object of this type is returned as a trait impl by a method
1345 pub(crate) extern "C" fn BuiltCommitmentTransaction_clone_void(this_ptr: *const c_void) -> *mut c_void {
1346 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeBuiltCommitmentTransaction)).clone() })) as *mut c_void
1349 /// Creates a copy of the BuiltCommitmentTransaction
1350 pub extern "C" fn BuiltCommitmentTransaction_clone(orig: &BuiltCommitmentTransaction) -> BuiltCommitmentTransaction {
1354 /// Serialize the BuiltCommitmentTransaction object into a byte array which can be read by BuiltCommitmentTransaction_read
1355 pub extern "C" fn BuiltCommitmentTransaction_write(obj: &BuiltCommitmentTransaction) -> crate::c_types::derived::CVec_u8Z {
1356 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
1359 pub(crate) extern "C" fn BuiltCommitmentTransaction_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1360 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeBuiltCommitmentTransaction) })
1363 /// Read a BuiltCommitmentTransaction from a byte array, created by BuiltCommitmentTransaction_write
1364 pub extern "C" fn BuiltCommitmentTransaction_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_BuiltCommitmentTransactionDecodeErrorZ {
1365 let res: Result<lightning::ln::chan_utils::BuiltCommitmentTransaction, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
1366 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::chan_utils::BuiltCommitmentTransaction { 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() };
1369 /// Get the SIGHASH_ALL sighash value of the transaction.
1371 /// This can be used to verify a signature.
1374 pub extern "C" fn BuiltCommitmentTransaction_get_sighash_all(this_arg: &BuiltCommitmentTransaction, mut funding_redeemscript: crate::c_types::u8slice, mut channel_value_satoshis: u64) -> crate::c_types::ThirtyTwoBytes {
1375 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_sighash_all(&::bitcoin::blockdata::script::Script::from(Vec::from(funding_redeemscript.to_slice())), channel_value_satoshis);
1376 crate::c_types::ThirtyTwoBytes { data: ret.as_ref().clone() }
1379 /// Sign a transaction, either because we are counter-signing the counterparty's transaction or
1380 /// because we are about to broadcast a holder transaction.
1383 pub extern "C" fn BuiltCommitmentTransaction_sign(this_arg: &BuiltCommitmentTransaction, funding_key: *const [u8; 32], mut funding_redeemscript: crate::c_types::u8slice, mut channel_value_satoshis: u64) -> crate::c_types::Signature {
1384 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.sign(&::bitcoin::secp256k1::key::SecretKey::from_slice(&unsafe { *funding_key}[..]).unwrap(), &::bitcoin::blockdata::script::Script::from(Vec::from(funding_redeemscript.to_slice())), channel_value_satoshis, secp256k1::SECP256K1);
1385 crate::c_types::Signature::from_rust(&ret)
1389 use lightning::ln::chan_utils::ClosingTransaction as nativeClosingTransactionImport;
1390 pub(crate) type nativeClosingTransaction = nativeClosingTransactionImport;
1392 /// This class tracks the per-transaction information needed to build a closing transaction and will
1393 /// actually build it and sign.
1395 /// This class can be used inside a signer implementation to generate a signature given the relevant
1399 pub struct ClosingTransaction {
1400 /// A pointer to the opaque Rust object.
1402 /// Nearly everywhere, inner must be non-null, however in places where
1403 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1404 pub inner: *mut nativeClosingTransaction,
1405 /// Indicates that this is the only struct which contains the same pointer.
1407 /// Rust functions which take ownership of an object provided via an argument require
1408 /// this to be true and invalidate the object pointed to by inner.
1412 impl Drop for ClosingTransaction {
1413 fn drop(&mut self) {
1414 if self.is_owned && !<*mut nativeClosingTransaction>::is_null(self.inner) {
1415 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1419 /// Frees any resources used by the ClosingTransaction, if is_owned is set and inner is non-NULL.
1421 pub extern "C" fn ClosingTransaction_free(this_obj: ClosingTransaction) { }
1423 /// Used only if an object of this type is returned as a trait impl by a method
1424 pub(crate) extern "C" fn ClosingTransaction_free_void(this_ptr: *mut c_void) {
1425 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeClosingTransaction); }
1428 impl ClosingTransaction {
1429 pub(crate) fn get_native_ref(&self) -> &'static nativeClosingTransaction {
1430 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1432 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeClosingTransaction {
1433 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1435 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1436 pub(crate) fn take_inner(mut self) -> *mut nativeClosingTransaction {
1437 assert!(self.is_owned);
1438 let ret = ObjOps::untweak_ptr(self.inner);
1439 self.inner = core::ptr::null_mut();
1443 impl Clone for ClosingTransaction {
1444 fn clone(&self) -> Self {
1446 inner: if <*mut nativeClosingTransaction>::is_null(self.inner) { core::ptr::null_mut() } else {
1447 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1453 /// Used only if an object of this type is returned as a trait impl by a method
1454 pub(crate) extern "C" fn ClosingTransaction_clone_void(this_ptr: *const c_void) -> *mut c_void {
1455 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeClosingTransaction)).clone() })) as *mut c_void
1458 /// Creates a copy of the ClosingTransaction
1459 pub extern "C" fn ClosingTransaction_clone(orig: &ClosingTransaction) -> ClosingTransaction {
1462 /// Checks if two ClosingTransactions contain equal inner contents.
1464 pub extern "C" fn ClosingTransaction_hash(o: &ClosingTransaction) -> u64 {
1465 if o.inner.is_null() { return 0; }
1466 // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
1467 #[allow(deprecated)]
1468 let mut hasher = core::hash::SipHasher::new();
1469 core::hash::Hash::hash(o.get_native_ref(), &mut hasher);
1470 core::hash::Hasher::finish(&hasher)
1472 /// Construct an object of the class
1475 pub extern "C" fn ClosingTransaction_new(mut to_holder_value_sat: u64, mut to_counterparty_value_sat: u64, mut to_holder_script: crate::c_types::derived::CVec_u8Z, mut to_counterparty_script: crate::c_types::derived::CVec_u8Z, mut funding_outpoint: crate::lightning::chain::transaction::OutPoint) -> ClosingTransaction {
1476 let mut ret = lightning::ln::chan_utils::ClosingTransaction::new(to_holder_value_sat, to_counterparty_value_sat, ::bitcoin::blockdata::script::Script::from(to_holder_script.into_rust()), ::bitcoin::blockdata::script::Script::from(to_counterparty_script.into_rust()), crate::c_types::C_to_bitcoin_outpoint(funding_outpoint));
1477 ClosingTransaction { inner: ObjOps::heap_alloc(ret), is_owned: true }
1480 /// Trust our pre-built transaction.
1482 /// Applies a wrapper which allows access to the transaction.
1484 /// This should only be used if you fully trust the builder of this object. It should not
1485 /// be used by an external signer - instead use the verify function.
1488 pub extern "C" fn ClosingTransaction_trust(this_arg: &ClosingTransaction) -> crate::lightning::ln::chan_utils::TrustedClosingTransaction {
1489 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.trust();
1490 crate::lightning::ln::chan_utils::TrustedClosingTransaction { inner: ObjOps::heap_alloc(ret), is_owned: true }
1493 /// Verify our pre-built transaction.
1495 /// Applies a wrapper which allows access to the transaction.
1497 /// An external validating signer must call this method before signing
1498 /// or using the built transaction.
1501 pub extern "C" fn ClosingTransaction_verify(this_arg: &ClosingTransaction, mut funding_outpoint: crate::lightning::chain::transaction::OutPoint) -> crate::c_types::derived::CResult_TrustedClosingTransactionNoneZ {
1502 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.verify(crate::c_types::C_to_bitcoin_outpoint(funding_outpoint));
1503 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::chan_utils::TrustedClosingTransaction { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1507 /// The value to be sent to the holder, or zero if the output will be omitted
1510 pub extern "C" fn ClosingTransaction_to_holder_value_sat(this_arg: &ClosingTransaction) -> u64 {
1511 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.to_holder_value_sat();
1515 /// The value to be sent to the counterparty, or zero if the output will be omitted
1518 pub extern "C" fn ClosingTransaction_to_counterparty_value_sat(this_arg: &ClosingTransaction) -> u64 {
1519 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.to_counterparty_value_sat();
1523 /// The destination of the holder's output
1526 pub extern "C" fn ClosingTransaction_to_holder_script(this_arg: &ClosingTransaction) -> crate::c_types::u8slice {
1527 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.to_holder_script();
1528 crate::c_types::u8slice::from_slice(&ret[..])
1531 /// The destination of the counterparty's output
1534 pub extern "C" fn ClosingTransaction_to_counterparty_script(this_arg: &ClosingTransaction) -> crate::c_types::u8slice {
1535 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.to_counterparty_script();
1536 crate::c_types::u8slice::from_slice(&ret[..])
1540 use lightning::ln::chan_utils::TrustedClosingTransaction as nativeTrustedClosingTransactionImport;
1541 pub(crate) type nativeTrustedClosingTransaction = nativeTrustedClosingTransactionImport<'static>;
1543 /// A wrapper on ClosingTransaction indicating that the built bitcoin
1544 /// transaction is trusted.
1546 /// See trust() and verify() functions on CommitmentTransaction.
1548 /// This structure implements Deref.
1551 pub struct TrustedClosingTransaction {
1552 /// A pointer to the opaque Rust object.
1554 /// Nearly everywhere, inner must be non-null, however in places where
1555 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1556 pub inner: *mut nativeTrustedClosingTransaction,
1557 /// Indicates that this is the only struct which contains the same pointer.
1559 /// Rust functions which take ownership of an object provided via an argument require
1560 /// this to be true and invalidate the object pointed to by inner.
1564 impl Drop for TrustedClosingTransaction {
1565 fn drop(&mut self) {
1566 if self.is_owned && !<*mut nativeTrustedClosingTransaction>::is_null(self.inner) {
1567 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1571 /// Frees any resources used by the TrustedClosingTransaction, if is_owned is set and inner is non-NULL.
1573 pub extern "C" fn TrustedClosingTransaction_free(this_obj: TrustedClosingTransaction) { }
1575 /// Used only if an object of this type is returned as a trait impl by a method
1576 pub(crate) extern "C" fn TrustedClosingTransaction_free_void(this_ptr: *mut c_void) {
1577 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeTrustedClosingTransaction); }
1580 impl TrustedClosingTransaction {
1581 pub(crate) fn get_native_ref(&self) -> &'static nativeTrustedClosingTransaction {
1582 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1584 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeTrustedClosingTransaction {
1585 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1587 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1588 pub(crate) fn take_inner(mut self) -> *mut nativeTrustedClosingTransaction {
1589 assert!(self.is_owned);
1590 let ret = ObjOps::untweak_ptr(self.inner);
1591 self.inner = core::ptr::null_mut();
1595 /// The pre-built Bitcoin commitment transaction
1598 pub extern "C" fn TrustedClosingTransaction_built_transaction(this_arg: &TrustedClosingTransaction) -> crate::c_types::Transaction {
1599 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.built_transaction();
1600 crate::c_types::Transaction::from_bitcoin(ret)
1603 /// Get the SIGHASH_ALL sighash value of the transaction.
1605 /// This can be used to verify a signature.
1608 pub extern "C" fn TrustedClosingTransaction_get_sighash_all(this_arg: &TrustedClosingTransaction, mut funding_redeemscript: crate::c_types::u8slice, mut channel_value_satoshis: u64) -> crate::c_types::ThirtyTwoBytes {
1609 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_sighash_all(&::bitcoin::blockdata::script::Script::from(Vec::from(funding_redeemscript.to_slice())), channel_value_satoshis);
1610 crate::c_types::ThirtyTwoBytes { data: ret.as_ref().clone() }
1613 /// Sign a transaction, either because we are counter-signing the counterparty's transaction or
1614 /// because we are about to broadcast a holder transaction.
1617 pub extern "C" fn TrustedClosingTransaction_sign(this_arg: &TrustedClosingTransaction, funding_key: *const [u8; 32], mut funding_redeemscript: crate::c_types::u8slice, mut channel_value_satoshis: u64) -> crate::c_types::Signature {
1618 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.sign(&::bitcoin::secp256k1::key::SecretKey::from_slice(&unsafe { *funding_key}[..]).unwrap(), &::bitcoin::blockdata::script::Script::from(Vec::from(funding_redeemscript.to_slice())), channel_value_satoshis, secp256k1::SECP256K1);
1619 crate::c_types::Signature::from_rust(&ret)
1623 use lightning::ln::chan_utils::CommitmentTransaction as nativeCommitmentTransactionImport;
1624 pub(crate) type nativeCommitmentTransaction = nativeCommitmentTransactionImport;
1626 /// This class tracks the per-transaction information needed to build a commitment transaction and will
1627 /// actually build it and sign. It is used for holder transactions that we sign only when needed
1628 /// and for transactions we sign for the counterparty.
1630 /// This class can be used inside a signer implementation to generate a signature given the relevant
1634 pub struct CommitmentTransaction {
1635 /// A pointer to the opaque Rust object.
1637 /// Nearly everywhere, inner must be non-null, however in places where
1638 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1639 pub inner: *mut nativeCommitmentTransaction,
1640 /// Indicates that this is the only struct which contains the same pointer.
1642 /// Rust functions which take ownership of an object provided via an argument require
1643 /// this to be true and invalidate the object pointed to by inner.
1647 impl Drop for CommitmentTransaction {
1648 fn drop(&mut self) {
1649 if self.is_owned && !<*mut nativeCommitmentTransaction>::is_null(self.inner) {
1650 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1654 /// Frees any resources used by the CommitmentTransaction, if is_owned is set and inner is non-NULL.
1656 pub extern "C" fn CommitmentTransaction_free(this_obj: CommitmentTransaction) { }
1658 /// Used only if an object of this type is returned as a trait impl by a method
1659 pub(crate) extern "C" fn CommitmentTransaction_free_void(this_ptr: *mut c_void) {
1660 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeCommitmentTransaction); }
1663 impl CommitmentTransaction {
1664 pub(crate) fn get_native_ref(&self) -> &'static nativeCommitmentTransaction {
1665 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1667 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeCommitmentTransaction {
1668 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1670 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1671 pub(crate) fn take_inner(mut self) -> *mut nativeCommitmentTransaction {
1672 assert!(self.is_owned);
1673 let ret = ObjOps::untweak_ptr(self.inner);
1674 self.inner = core::ptr::null_mut();
1678 impl Clone for CommitmentTransaction {
1679 fn clone(&self) -> Self {
1681 inner: if <*mut nativeCommitmentTransaction>::is_null(self.inner) { core::ptr::null_mut() } else {
1682 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1688 /// Used only if an object of this type is returned as a trait impl by a method
1689 pub(crate) extern "C" fn CommitmentTransaction_clone_void(this_ptr: *const c_void) -> *mut c_void {
1690 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeCommitmentTransaction)).clone() })) as *mut c_void
1693 /// Creates a copy of the CommitmentTransaction
1694 pub extern "C" fn CommitmentTransaction_clone(orig: &CommitmentTransaction) -> CommitmentTransaction {
1698 /// Serialize the CommitmentTransaction object into a byte array which can be read by CommitmentTransaction_read
1699 pub extern "C" fn CommitmentTransaction_write(obj: &CommitmentTransaction) -> crate::c_types::derived::CVec_u8Z {
1700 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
1703 pub(crate) extern "C" fn CommitmentTransaction_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1704 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeCommitmentTransaction) })
1707 /// Read a CommitmentTransaction from a byte array, created by CommitmentTransaction_write
1708 pub extern "C" fn CommitmentTransaction_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_CommitmentTransactionDecodeErrorZ {
1709 let res: Result<lightning::ln::chan_utils::CommitmentTransaction, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
1710 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::chan_utils::CommitmentTransaction { 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() };
1713 /// The backwards-counting commitment number
1716 pub extern "C" fn CommitmentTransaction_commitment_number(this_arg: &CommitmentTransaction) -> u64 {
1717 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.commitment_number();
1721 /// The value to be sent to the broadcaster
1724 pub extern "C" fn CommitmentTransaction_to_broadcaster_value_sat(this_arg: &CommitmentTransaction) -> u64 {
1725 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.to_broadcaster_value_sat();
1729 /// The value to be sent to the counterparty
1732 pub extern "C" fn CommitmentTransaction_to_countersignatory_value_sat(this_arg: &CommitmentTransaction) -> u64 {
1733 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.to_countersignatory_value_sat();
1737 /// The feerate paid per 1000-weight-unit in this commitment transaction.
1740 pub extern "C" fn CommitmentTransaction_feerate_per_kw(this_arg: &CommitmentTransaction) -> u32 {
1741 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.feerate_per_kw();
1745 /// Trust our pre-built transaction and derived transaction creation public keys.
1747 /// Applies a wrapper which allows access to these fields.
1749 /// This should only be used if you fully trust the builder of this object. It should not
1750 /// be used by an external signer - instead use the verify function.
1753 pub extern "C" fn CommitmentTransaction_trust(this_arg: &CommitmentTransaction) -> crate::lightning::ln::chan_utils::TrustedCommitmentTransaction {
1754 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.trust();
1755 crate::lightning::ln::chan_utils::TrustedCommitmentTransaction { inner: ObjOps::heap_alloc(ret), is_owned: true }
1758 /// Verify our pre-built transaction and derived transaction creation public keys.
1760 /// Applies a wrapper which allows access to these fields.
1762 /// An external validating signer must call this method before signing
1763 /// or using the built transaction.
1766 pub extern "C" fn CommitmentTransaction_verify(this_arg: &CommitmentTransaction, channel_parameters: &crate::lightning::ln::chan_utils::DirectedChannelTransactionParameters, broadcaster_keys: &crate::lightning::ln::chan_utils::ChannelPublicKeys, countersignatory_keys: &crate::lightning::ln::chan_utils::ChannelPublicKeys) -> crate::c_types::derived::CResult_TrustedCommitmentTransactionNoneZ {
1767 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.verify(channel_parameters.get_native_ref(), broadcaster_keys.get_native_ref(), countersignatory_keys.get_native_ref(), secp256k1::SECP256K1);
1768 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::chan_utils::TrustedCommitmentTransaction { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1773 use lightning::ln::chan_utils::TrustedCommitmentTransaction as nativeTrustedCommitmentTransactionImport;
1774 pub(crate) type nativeTrustedCommitmentTransaction = nativeTrustedCommitmentTransactionImport<'static>;
1776 /// A wrapper on CommitmentTransaction indicating that the derived fields (the built bitcoin
1777 /// transaction and the transaction creation keys) are trusted.
1779 /// See trust() and verify() functions on CommitmentTransaction.
1781 /// This structure implements Deref.
1784 pub struct TrustedCommitmentTransaction {
1785 /// A pointer to the opaque Rust object.
1787 /// Nearly everywhere, inner must be non-null, however in places where
1788 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1789 pub inner: *mut nativeTrustedCommitmentTransaction,
1790 /// Indicates that this is the only struct which contains the same pointer.
1792 /// Rust functions which take ownership of an object provided via an argument require
1793 /// this to be true and invalidate the object pointed to by inner.
1797 impl Drop for TrustedCommitmentTransaction {
1798 fn drop(&mut self) {
1799 if self.is_owned && !<*mut nativeTrustedCommitmentTransaction>::is_null(self.inner) {
1800 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1804 /// Frees any resources used by the TrustedCommitmentTransaction, if is_owned is set and inner is non-NULL.
1806 pub extern "C" fn TrustedCommitmentTransaction_free(this_obj: TrustedCommitmentTransaction) { }
1808 /// Used only if an object of this type is returned as a trait impl by a method
1809 pub(crate) extern "C" fn TrustedCommitmentTransaction_free_void(this_ptr: *mut c_void) {
1810 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeTrustedCommitmentTransaction); }
1813 impl TrustedCommitmentTransaction {
1814 pub(crate) fn get_native_ref(&self) -> &'static nativeTrustedCommitmentTransaction {
1815 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1817 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeTrustedCommitmentTransaction {
1818 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1820 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1821 pub(crate) fn take_inner(mut self) -> *mut nativeTrustedCommitmentTransaction {
1822 assert!(self.is_owned);
1823 let ret = ObjOps::untweak_ptr(self.inner);
1824 self.inner = core::ptr::null_mut();
1828 /// The transaction ID of the built Bitcoin transaction
1831 pub extern "C" fn TrustedCommitmentTransaction_txid(this_arg: &TrustedCommitmentTransaction) -> crate::c_types::ThirtyTwoBytes {
1832 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.txid();
1833 crate::c_types::ThirtyTwoBytes { data: ret.into_inner() }
1836 /// The pre-built Bitcoin commitment transaction
1839 pub extern "C" fn TrustedCommitmentTransaction_built_transaction(this_arg: &TrustedCommitmentTransaction) -> crate::lightning::ln::chan_utils::BuiltCommitmentTransaction {
1840 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.built_transaction();
1841 crate::lightning::ln::chan_utils::BuiltCommitmentTransaction { inner: unsafe { ObjOps::nonnull_ptr_to_inner((ret as *const lightning::ln::chan_utils::BuiltCommitmentTransaction<>) as *mut _) }, is_owned: false }
1844 /// The pre-calculated transaction creation public keys.
1847 pub extern "C" fn TrustedCommitmentTransaction_keys(this_arg: &TrustedCommitmentTransaction) -> crate::lightning::ln::chan_utils::TxCreationKeys {
1848 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.keys();
1849 crate::lightning::ln::chan_utils::TxCreationKeys { inner: unsafe { ObjOps::nonnull_ptr_to_inner((ret as *const lightning::ln::chan_utils::TxCreationKeys<>) as *mut _) }, is_owned: false }
1852 /// Should anchors be used.
1855 pub extern "C" fn TrustedCommitmentTransaction_opt_anchors(this_arg: &TrustedCommitmentTransaction) -> bool {
1856 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.opt_anchors();
1860 /// Get a signature for each HTLC which was included in the commitment transaction (ie for
1861 /// which HTLCOutputInCommitment::transaction_output_index.is_some()).
1863 /// The returned Vec has one entry for each HTLC, and in the same order.
1866 pub extern "C" fn TrustedCommitmentTransaction_get_htlc_sigs(this_arg: &TrustedCommitmentTransaction, htlc_base_key: *const [u8; 32], channel_parameters: &crate::lightning::ln::chan_utils::DirectedChannelTransactionParameters) -> crate::c_types::derived::CResult_CVec_SignatureZNoneZ {
1867 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_htlc_sigs(&::bitcoin::secp256k1::key::SecretKey::from_slice(&unsafe { *htlc_base_key}[..]).unwrap(), channel_parameters.get_native_ref(), secp256k1::SECP256K1);
1868 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( { crate::c_types::Signature::from_rust(&item) }); }; local_ret_0.into() }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
1872 /// Commitment transaction numbers which appear in the transactions themselves are XOR'd with a
1873 /// shared secret first. This prevents on-chain observers from discovering how many commitment
1874 /// transactions occurred in a channel before it was closed.
1876 /// This function gets the shared secret from relevant channel public keys and can be used to
1877 /// \"decrypt\" the commitment transaction number given a commitment transaction on-chain.
1879 pub extern "C" fn get_commitment_transaction_number_obscure_factor(mut broadcaster_payment_basepoint: crate::c_types::PublicKey, mut countersignatory_payment_basepoint: crate::c_types::PublicKey, mut outbound_from_broadcaster: bool) -> u64 {
1880 let mut ret = lightning::ln::chan_utils::get_commitment_transaction_number_obscure_factor(&broadcaster_payment_basepoint.into_rust(), &countersignatory_payment_basepoint.into_rust(), outbound_from_broadcaster);