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 related to channels. These are
10 //! largely of interest for those implementing the traits on [`crate::sign`] by hand.
12 use alloc::str::FromStr;
13 use alloc::string::String;
14 use core::ffi::c_void;
15 use core::convert::Infallible;
16 use bitcoin::hashes::Hash;
17 use crate::c_types::*;
18 #[cfg(feature="no-std")]
19 use alloc::{vec::Vec, boxed::Box};
21 /// Maximum number of one-way in-flight HTLC (protocol-level value).
24 pub static MAX_HTLCS: u16 = lightning::ln::chan_utils::MAX_HTLCS;
25 /// The weight of a BIP141 witnessScript for a BOLT3's \"offered HTLC output\" on a commitment transaction, non-anchor variant.
28 pub static OFFERED_HTLC_SCRIPT_WEIGHT: usize = lightning::ln::chan_utils::OFFERED_HTLC_SCRIPT_WEIGHT;
29 /// The weight of a BIP141 witnessScript for a BOLT3's \"offered HTLC output\" on a commitment transaction, anchor variant.
32 pub static OFFERED_HTLC_SCRIPT_WEIGHT_ANCHORS: usize = lightning::ln::chan_utils::OFFERED_HTLC_SCRIPT_WEIGHT_ANCHORS;
33 /// The weight of a BIP141 witnessScript for a BOLT3's \"received HTLC output\" can vary in function of its CLTV argument value.
34 /// We define a range that encompasses both its non-anchors and anchors variants.
35 /// This is the maximum post-anchor value.
38 pub static MAX_ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = lightning::ln::chan_utils::MAX_ACCEPTED_HTLC_SCRIPT_WEIGHT;
39 /// The upper bound weight of an anchor input.
42 pub static ANCHOR_INPUT_WITNESS_WEIGHT: u64 = lightning::ln::chan_utils::ANCHOR_INPUT_WITNESS_WEIGHT;
43 /// The upper bound weight of an HTLC timeout input from a commitment transaction with anchor
47 pub static HTLC_TIMEOUT_INPUT_ANCHOR_WITNESS_WEIGHT: u64 = lightning::ln::chan_utils::HTLC_TIMEOUT_INPUT_ANCHOR_WITNESS_WEIGHT;
48 /// The upper bound weight of an HTLC success input from a commitment transaction with anchor
52 pub static HTLC_SUCCESS_INPUT_ANCHOR_WITNESS_WEIGHT: u64 = lightning::ln::chan_utils::HTLC_SUCCESS_INPUT_ANCHOR_WITNESS_WEIGHT;
53 /// Gets the weight for an HTLC-Success transaction.
55 pub extern "C" fn htlc_success_tx_weight(channel_type_features: &crate::lightning::ln::features::ChannelTypeFeatures) -> u64 {
56 let mut ret = lightning::ln::chan_utils::htlc_success_tx_weight(channel_type_features.get_native_ref());
60 /// Gets the weight for an HTLC-Timeout transaction.
62 pub extern "C" fn htlc_timeout_tx_weight(channel_type_features: &crate::lightning::ln::features::ChannelTypeFeatures) -> u64 {
63 let mut ret = lightning::ln::chan_utils::htlc_timeout_tx_weight(channel_type_features.get_native_ref());
67 /// Describes the type of HTLC claim as determined by analyzing the witness.
72 /// Claims an offered output on a commitment transaction through the timeout path.
74 /// Claims an offered output on a commitment transaction through the success path.
76 /// Claims an accepted output on a commitment transaction through the timeout path.
78 /// Claims an accepted output on a commitment transaction through the success path.
80 /// Claims an offered/accepted output on a commitment transaction through the revocation path.
83 use lightning::ln::chan_utils::HTLCClaim as HTLCClaimImport;
84 pub(crate) type nativeHTLCClaim = HTLCClaimImport;
88 pub(crate) fn to_native(&self) -> nativeHTLCClaim {
90 HTLCClaim::OfferedTimeout => nativeHTLCClaim::OfferedTimeout,
91 HTLCClaim::OfferedPreimage => nativeHTLCClaim::OfferedPreimage,
92 HTLCClaim::AcceptedTimeout => nativeHTLCClaim::AcceptedTimeout,
93 HTLCClaim::AcceptedPreimage => nativeHTLCClaim::AcceptedPreimage,
94 HTLCClaim::Revocation => nativeHTLCClaim::Revocation,
98 pub(crate) fn into_native(self) -> nativeHTLCClaim {
100 HTLCClaim::OfferedTimeout => nativeHTLCClaim::OfferedTimeout,
101 HTLCClaim::OfferedPreimage => nativeHTLCClaim::OfferedPreimage,
102 HTLCClaim::AcceptedTimeout => nativeHTLCClaim::AcceptedTimeout,
103 HTLCClaim::AcceptedPreimage => nativeHTLCClaim::AcceptedPreimage,
104 HTLCClaim::Revocation => nativeHTLCClaim::Revocation,
108 pub(crate) fn from_native(native: &HTLCClaimImport) -> Self {
109 let native = unsafe { &*(native as *const _ as *const c_void as *const nativeHTLCClaim) };
111 nativeHTLCClaim::OfferedTimeout => HTLCClaim::OfferedTimeout,
112 nativeHTLCClaim::OfferedPreimage => HTLCClaim::OfferedPreimage,
113 nativeHTLCClaim::AcceptedTimeout => HTLCClaim::AcceptedTimeout,
114 nativeHTLCClaim::AcceptedPreimage => HTLCClaim::AcceptedPreimage,
115 nativeHTLCClaim::Revocation => HTLCClaim::Revocation,
119 pub(crate) fn native_into(native: nativeHTLCClaim) -> Self {
121 nativeHTLCClaim::OfferedTimeout => HTLCClaim::OfferedTimeout,
122 nativeHTLCClaim::OfferedPreimage => HTLCClaim::OfferedPreimage,
123 nativeHTLCClaim::AcceptedTimeout => HTLCClaim::AcceptedTimeout,
124 nativeHTLCClaim::AcceptedPreimage => HTLCClaim::AcceptedPreimage,
125 nativeHTLCClaim::Revocation => HTLCClaim::Revocation,
129 /// Creates a copy of the HTLCClaim
131 pub extern "C" fn HTLCClaim_clone(orig: &HTLCClaim) -> HTLCClaim {
135 /// Used only if an object of this type is returned as a trait impl by a method
136 pub(crate) extern "C" fn HTLCClaim_clone_void(this_ptr: *const c_void) -> *mut c_void {
137 Box::into_raw(Box::new(unsafe { (*(this_ptr as *const HTLCClaim)).clone() })) as *mut c_void
140 /// Used only if an object of this type is returned as a trait impl by a method
141 pub(crate) extern "C" fn HTLCClaim_free_void(this_ptr: *mut c_void) {
142 let _ = unsafe { Box::from_raw(this_ptr as *mut HTLCClaim) };
145 /// Utility method to constructs a new OfferedTimeout-variant HTLCClaim
146 pub extern "C" fn HTLCClaim_offered_timeout() -> HTLCClaim {
147 HTLCClaim::OfferedTimeout}
149 /// Utility method to constructs a new OfferedPreimage-variant HTLCClaim
150 pub extern "C" fn HTLCClaim_offered_preimage() -> HTLCClaim {
151 HTLCClaim::OfferedPreimage}
153 /// Utility method to constructs a new AcceptedTimeout-variant HTLCClaim
154 pub extern "C" fn HTLCClaim_accepted_timeout() -> HTLCClaim {
155 HTLCClaim::AcceptedTimeout}
157 /// Utility method to constructs a new AcceptedPreimage-variant HTLCClaim
158 pub extern "C" fn HTLCClaim_accepted_preimage() -> HTLCClaim {
159 HTLCClaim::AcceptedPreimage}
161 /// Utility method to constructs a new Revocation-variant HTLCClaim
162 pub extern "C" fn HTLCClaim_revocation() -> HTLCClaim {
163 HTLCClaim::Revocation}
164 /// Checks if two HTLCClaims contain equal inner contents.
165 /// This ignores pointers and is_owned flags and looks at the values in fields.
167 pub extern "C" fn HTLCClaim_eq(a: &HTLCClaim, b: &HTLCClaim) -> bool {
168 if &a.to_native() == &b.to_native() { true } else { false }
170 /// Check if a given input witness attempts to claim a HTLC.
173 pub extern "C" fn HTLCClaim_from_witness(mut witness: crate::c_types::Witness) -> crate::c_types::derived::COption_HTLCClaimZ {
174 let mut ret = lightning::ln::chan_utils::HTLCClaim::from_witness(&witness.into_bitcoin());
175 let mut local_ret = if ret.is_none() { crate::c_types::derived::COption_HTLCClaimZ::None } else { crate::c_types::derived::COption_HTLCClaimZ::Some( { crate::lightning::ln::chan_utils::HTLCClaim::native_into(ret.unwrap()) }) };
179 /// Build the commitment secret from the seed and the commitment number
181 pub extern "C" fn build_commitment_secret(commitment_seed: *const [u8; 32], mut idx: u64) -> crate::c_types::ThirtyTwoBytes {
182 let mut ret = lightning::ln::chan_utils::build_commitment_secret(unsafe { &*commitment_seed}, idx);
183 crate::c_types::ThirtyTwoBytes { data: ret }
186 /// Build a closing transaction
188 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 {
189 let mut ret = lightning::ln::chan_utils::build_closing_transaction(to_holder_value_sat, to_counterparty_value_sat, ::bitcoin::blockdata::script::ScriptBuf::from(to_holder_script.into_rust()), ::bitcoin::blockdata::script::ScriptBuf::from(to_counterparty_script.into_rust()), crate::c_types::C_to_bitcoin_outpoint(funding_outpoint));
190 crate::c_types::Transaction::from_bitcoin(&ret)
194 use lightning::ln::chan_utils::CounterpartyCommitmentSecrets as nativeCounterpartyCommitmentSecretsImport;
195 pub(crate) type nativeCounterpartyCommitmentSecrets = nativeCounterpartyCommitmentSecretsImport;
197 /// Implements the per-commitment secret storage scheme from
198 /// [BOLT 3](https://github.com/lightning/bolts/blob/dcbf8583976df087c79c3ce0b535311212e6812d/03-transactions.md#efficient-per-commitment-secret-storage).
200 /// Allows us to keep track of all of the revocation secrets of our counterparty in just 50*32 bytes
204 pub struct CounterpartyCommitmentSecrets {
205 /// A pointer to the opaque Rust object.
207 /// Nearly everywhere, inner must be non-null, however in places where
208 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
209 pub inner: *mut nativeCounterpartyCommitmentSecrets,
210 /// Indicates that this is the only struct which contains the same pointer.
212 /// Rust functions which take ownership of an object provided via an argument require
213 /// this to be true and invalidate the object pointed to by inner.
217 impl Drop for CounterpartyCommitmentSecrets {
219 if self.is_owned && !<*mut nativeCounterpartyCommitmentSecrets>::is_null(self.inner) {
220 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
224 /// Frees any resources used by the CounterpartyCommitmentSecrets, if is_owned is set and inner is non-NULL.
226 pub extern "C" fn CounterpartyCommitmentSecrets_free(this_obj: CounterpartyCommitmentSecrets) { }
228 /// Used only if an object of this type is returned as a trait impl by a method
229 pub(crate) extern "C" fn CounterpartyCommitmentSecrets_free_void(this_ptr: *mut c_void) {
230 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeCounterpartyCommitmentSecrets) };
233 impl CounterpartyCommitmentSecrets {
234 pub(crate) fn get_native_ref(&self) -> &'static nativeCounterpartyCommitmentSecrets {
235 unsafe { &*ObjOps::untweak_ptr(self.inner) }
237 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeCounterpartyCommitmentSecrets {
238 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
240 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
241 pub(crate) fn take_inner(mut self) -> *mut nativeCounterpartyCommitmentSecrets {
242 assert!(self.is_owned);
243 let ret = ObjOps::untweak_ptr(self.inner);
244 self.inner = core::ptr::null_mut();
248 impl Clone for CounterpartyCommitmentSecrets {
249 fn clone(&self) -> Self {
251 inner: if <*mut nativeCounterpartyCommitmentSecrets>::is_null(self.inner) { core::ptr::null_mut() } else {
252 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
258 /// Used only if an object of this type is returned as a trait impl by a method
259 pub(crate) extern "C" fn CounterpartyCommitmentSecrets_clone_void(this_ptr: *const c_void) -> *mut c_void {
260 Box::into_raw(Box::new(unsafe { (*(this_ptr as *const nativeCounterpartyCommitmentSecrets)).clone() })) as *mut c_void
263 /// Creates a copy of the CounterpartyCommitmentSecrets
264 pub extern "C" fn CounterpartyCommitmentSecrets_clone(orig: &CounterpartyCommitmentSecrets) -> CounterpartyCommitmentSecrets {
267 /// Creates a new empty `CounterpartyCommitmentSecrets` structure.
270 pub extern "C" fn CounterpartyCommitmentSecrets_new() -> crate::lightning::ln::chan_utils::CounterpartyCommitmentSecrets {
271 let mut ret = lightning::ln::chan_utils::CounterpartyCommitmentSecrets::new();
272 crate::lightning::ln::chan_utils::CounterpartyCommitmentSecrets { inner: ObjOps::heap_alloc(ret), is_owned: true }
275 /// Returns the minimum index of all stored secrets. Note that indexes start
276 /// at 1 << 48 and get decremented by one for each new secret.
279 pub extern "C" fn CounterpartyCommitmentSecrets_get_min_seen_secret(this_arg: &crate::lightning::ln::chan_utils::CounterpartyCommitmentSecrets) -> u64 {
280 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_min_seen_secret();
284 /// Inserts the `secret` at `idx`. Returns `Ok(())` if the secret
285 /// was generated in accordance with BOLT 3 and is consistent with previous secrets.
288 pub extern "C" fn CounterpartyCommitmentSecrets_provide_secret(this_arg: &mut crate::lightning::ln::chan_utils::CounterpartyCommitmentSecrets, mut idx: u64, mut secret: crate::c_types::ThirtyTwoBytes) -> crate::c_types::derived::CResult_NoneNoneZ {
289 let mut ret = unsafe { &mut (*ObjOps::untweak_ptr(this_arg.inner as *mut crate::lightning::ln::chan_utils::nativeCounterpartyCommitmentSecrets)) }.provide_secret(idx, secret.data);
290 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { () /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
294 /// Returns the secret at `idx`.
295 /// Returns `None` if `idx` is < [`CounterpartyCommitmentSecrets::get_min_seen_secret`].
297 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
300 pub extern "C" fn CounterpartyCommitmentSecrets_get_secret(this_arg: &crate::lightning::ln::chan_utils::CounterpartyCommitmentSecrets, mut idx: u64) -> crate::c_types::ThirtyTwoBytes {
301 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_secret(idx);
302 let mut local_ret = if ret.is_none() { crate::c_types::ThirtyTwoBytes { data: [0; 32] } } else { { crate::c_types::ThirtyTwoBytes { data: (ret.unwrap()) } } };
307 /// Serialize the CounterpartyCommitmentSecrets object into a byte array which can be read by CounterpartyCommitmentSecrets_read
308 pub extern "C" fn CounterpartyCommitmentSecrets_write(obj: &crate::lightning::ln::chan_utils::CounterpartyCommitmentSecrets) -> crate::c_types::derived::CVec_u8Z {
309 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
312 pub(crate) extern "C" fn CounterpartyCommitmentSecrets_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
313 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeCounterpartyCommitmentSecrets) })
316 /// Read a CounterpartyCommitmentSecrets from a byte array, created by CounterpartyCommitmentSecrets_write
317 pub extern "C" fn CounterpartyCommitmentSecrets_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_CounterpartyCommitmentSecretsDecodeErrorZ {
318 let res: Result<lightning::ln::chan_utils::CounterpartyCommitmentSecrets, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
319 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::chan_utils::CounterpartyCommitmentSecrets { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
322 /// Derives a per-commitment-transaction private key (eg an htlc key or delayed_payment key)
323 /// from the base secret and the per_commitment_point.
325 pub extern "C" fn derive_private_key(mut per_commitment_point: crate::c_types::PublicKey, base_secret: *const [u8; 32]) -> crate::c_types::SecretKey {
326 let mut ret = lightning::ln::chan_utils::derive_private_key(secp256k1::global::SECP256K1, &per_commitment_point.into_rust(), &::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *base_secret}[..]).unwrap());
327 crate::c_types::SecretKey::from_rust(ret)
330 /// Derives a per-commitment-transaction revocation key from its constituent parts.
332 /// Only the cheating participant owns a valid witness to propagate a revoked
333 /// commitment transaction, thus per_commitment_secret always come from cheater
334 /// and revocation_base_secret always come from punisher, which is the broadcaster
335 /// of the transaction spending with this key knowledge.
337 pub extern "C" fn derive_private_revocation_key(per_commitment_secret: *const [u8; 32], countersignatory_revocation_base_secret: *const [u8; 32]) -> crate::c_types::SecretKey {
338 let mut ret = lightning::ln::chan_utils::derive_private_revocation_key(secp256k1::global::SECP256K1, &::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *per_commitment_secret}[..]).unwrap(), &::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *countersignatory_revocation_base_secret}[..]).unwrap());
339 crate::c_types::SecretKey::from_rust(ret)
343 use lightning::ln::chan_utils::TxCreationKeys as nativeTxCreationKeysImport;
344 pub(crate) type nativeTxCreationKeys = nativeTxCreationKeysImport;
346 /// The set of public keys which are used in the creation of one commitment transaction.
347 /// These are derived from the channel base keys and per-commitment data.
349 /// A broadcaster key is provided from potential broadcaster of the computed transaction.
350 /// A countersignatory key is coming from a protocol participant unable to broadcast the
353 /// These keys are assumed to be good, either because the code derived them from
354 /// channel basepoints via the new function, or they were obtained via
355 /// CommitmentTransaction.trust().keys() because we trusted the source of the
356 /// pre-calculated keys.
359 pub struct TxCreationKeys {
360 /// A pointer to the opaque Rust object.
362 /// Nearly everywhere, inner must be non-null, however in places where
363 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
364 pub inner: *mut nativeTxCreationKeys,
365 /// Indicates that this is the only struct which contains the same pointer.
367 /// Rust functions which take ownership of an object provided via an argument require
368 /// this to be true and invalidate the object pointed to by inner.
372 impl Drop for TxCreationKeys {
374 if self.is_owned && !<*mut nativeTxCreationKeys>::is_null(self.inner) {
375 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
379 /// Frees any resources used by the TxCreationKeys, if is_owned is set and inner is non-NULL.
381 pub extern "C" fn TxCreationKeys_free(this_obj: TxCreationKeys) { }
383 /// Used only if an object of this type is returned as a trait impl by a method
384 pub(crate) extern "C" fn TxCreationKeys_free_void(this_ptr: *mut c_void) {
385 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeTxCreationKeys) };
388 impl TxCreationKeys {
389 pub(crate) fn get_native_ref(&self) -> &'static nativeTxCreationKeys {
390 unsafe { &*ObjOps::untweak_ptr(self.inner) }
392 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeTxCreationKeys {
393 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
395 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
396 pub(crate) fn take_inner(mut self) -> *mut nativeTxCreationKeys {
397 assert!(self.is_owned);
398 let ret = ObjOps::untweak_ptr(self.inner);
399 self.inner = core::ptr::null_mut();
403 /// The broadcaster's per-commitment public key which was used to derive the other keys.
405 pub extern "C" fn TxCreationKeys_get_per_commitment_point(this_ptr: &TxCreationKeys) -> crate::c_types::PublicKey {
406 let mut inner_val = &mut this_ptr.get_native_mut_ref().per_commitment_point;
407 crate::c_types::PublicKey::from_rust(&inner_val)
409 /// The broadcaster's per-commitment public key which was used to derive the other keys.
411 pub extern "C" fn TxCreationKeys_set_per_commitment_point(this_ptr: &mut TxCreationKeys, mut val: crate::c_types::PublicKey) {
412 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.per_commitment_point = val.into_rust();
414 /// The revocation key which is used to allow the broadcaster of the commitment
415 /// transaction to provide their counterparty the ability to punish them if they broadcast
418 pub extern "C" fn TxCreationKeys_get_revocation_key(this_ptr: &TxCreationKeys) -> crate::lightning::ln::channel_keys::RevocationKey {
419 let mut inner_val = &mut this_ptr.get_native_mut_ref().revocation_key;
420 crate::lightning::ln::channel_keys::RevocationKey { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::ln::channel_keys::RevocationKey<>) as *mut _) }, is_owned: false }
422 /// The revocation key which is used to allow the broadcaster of the commitment
423 /// transaction to provide their counterparty the ability to punish them if they broadcast
426 pub extern "C" fn TxCreationKeys_set_revocation_key(this_ptr: &mut TxCreationKeys, mut val: crate::lightning::ln::channel_keys::RevocationKey) {
427 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.revocation_key = *unsafe { Box::from_raw(val.take_inner()) };
429 /// Broadcaster's HTLC Key
431 pub extern "C" fn TxCreationKeys_get_broadcaster_htlc_key(this_ptr: &TxCreationKeys) -> crate::lightning::ln::channel_keys::HtlcKey {
432 let mut inner_val = &mut this_ptr.get_native_mut_ref().broadcaster_htlc_key;
433 crate::lightning::ln::channel_keys::HtlcKey { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::ln::channel_keys::HtlcKey<>) as *mut _) }, is_owned: false }
435 /// Broadcaster's HTLC Key
437 pub extern "C" fn TxCreationKeys_set_broadcaster_htlc_key(this_ptr: &mut TxCreationKeys, mut val: crate::lightning::ln::channel_keys::HtlcKey) {
438 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.broadcaster_htlc_key = *unsafe { Box::from_raw(val.take_inner()) };
440 /// Countersignatory's HTLC Key
442 pub extern "C" fn TxCreationKeys_get_countersignatory_htlc_key(this_ptr: &TxCreationKeys) -> crate::lightning::ln::channel_keys::HtlcKey {
443 let mut inner_val = &mut this_ptr.get_native_mut_ref().countersignatory_htlc_key;
444 crate::lightning::ln::channel_keys::HtlcKey { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::ln::channel_keys::HtlcKey<>) as *mut _) }, is_owned: false }
446 /// Countersignatory's HTLC Key
448 pub extern "C" fn TxCreationKeys_set_countersignatory_htlc_key(this_ptr: &mut TxCreationKeys, mut val: crate::lightning::ln::channel_keys::HtlcKey) {
449 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.countersignatory_htlc_key = *unsafe { Box::from_raw(val.take_inner()) };
451 /// Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
453 pub extern "C" fn TxCreationKeys_get_broadcaster_delayed_payment_key(this_ptr: &TxCreationKeys) -> crate::lightning::ln::channel_keys::DelayedPaymentKey {
454 let mut inner_val = &mut this_ptr.get_native_mut_ref().broadcaster_delayed_payment_key;
455 crate::lightning::ln::channel_keys::DelayedPaymentKey { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::ln::channel_keys::DelayedPaymentKey<>) as *mut _) }, is_owned: false }
457 /// Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
459 pub extern "C" fn TxCreationKeys_set_broadcaster_delayed_payment_key(this_ptr: &mut TxCreationKeys, mut val: crate::lightning::ln::channel_keys::DelayedPaymentKey) {
460 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.broadcaster_delayed_payment_key = *unsafe { Box::from_raw(val.take_inner()) };
462 /// Constructs a new TxCreationKeys given each field
465 pub extern "C" fn TxCreationKeys_new(mut per_commitment_point_arg: crate::c_types::PublicKey, mut revocation_key_arg: crate::lightning::ln::channel_keys::RevocationKey, mut broadcaster_htlc_key_arg: crate::lightning::ln::channel_keys::HtlcKey, mut countersignatory_htlc_key_arg: crate::lightning::ln::channel_keys::HtlcKey, mut broadcaster_delayed_payment_key_arg: crate::lightning::ln::channel_keys::DelayedPaymentKey) -> TxCreationKeys {
466 TxCreationKeys { inner: ObjOps::heap_alloc(nativeTxCreationKeys {
467 per_commitment_point: per_commitment_point_arg.into_rust(),
468 revocation_key: *unsafe { Box::from_raw(revocation_key_arg.take_inner()) },
469 broadcaster_htlc_key: *unsafe { Box::from_raw(broadcaster_htlc_key_arg.take_inner()) },
470 countersignatory_htlc_key: *unsafe { Box::from_raw(countersignatory_htlc_key_arg.take_inner()) },
471 broadcaster_delayed_payment_key: *unsafe { Box::from_raw(broadcaster_delayed_payment_key_arg.take_inner()) },
474 /// Checks if two TxCreationKeyss contain equal inner contents.
475 /// This ignores pointers and is_owned flags and looks at the values in fields.
476 /// Two objects with NULL inner values will be considered "equal" here.
478 pub extern "C" fn TxCreationKeys_eq(a: &TxCreationKeys, b: &TxCreationKeys) -> bool {
479 if a.inner == b.inner { return true; }
480 if a.inner.is_null() || b.inner.is_null() { return false; }
481 if a.get_native_ref() == b.get_native_ref() { true } else { false }
483 impl Clone for TxCreationKeys {
484 fn clone(&self) -> Self {
486 inner: if <*mut nativeTxCreationKeys>::is_null(self.inner) { core::ptr::null_mut() } else {
487 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
493 /// Used only if an object of this type is returned as a trait impl by a method
494 pub(crate) extern "C" fn TxCreationKeys_clone_void(this_ptr: *const c_void) -> *mut c_void {
495 Box::into_raw(Box::new(unsafe { (*(this_ptr as *const nativeTxCreationKeys)).clone() })) as *mut c_void
498 /// Creates a copy of the TxCreationKeys
499 pub extern "C" fn TxCreationKeys_clone(orig: &TxCreationKeys) -> TxCreationKeys {
502 /// Get a string which allows debug introspection of a TxCreationKeys object
503 pub extern "C" fn TxCreationKeys_debug_str_void(o: *const c_void) -> Str {
504 alloc::format!("{:?}", unsafe { o as *const crate::lightning::ln::chan_utils::TxCreationKeys }).into()}
506 /// Serialize the TxCreationKeys object into a byte array which can be read by TxCreationKeys_read
507 pub extern "C" fn TxCreationKeys_write(obj: &crate::lightning::ln::chan_utils::TxCreationKeys) -> crate::c_types::derived::CVec_u8Z {
508 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
511 pub(crate) extern "C" fn TxCreationKeys_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
512 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeTxCreationKeys) })
515 /// Read a TxCreationKeys from a byte array, created by TxCreationKeys_write
516 pub extern "C" fn TxCreationKeys_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_TxCreationKeysDecodeErrorZ {
517 let res: Result<lightning::ln::chan_utils::TxCreationKeys, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
518 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::native_into(e) }).into() };
522 use lightning::ln::chan_utils::ChannelPublicKeys as nativeChannelPublicKeysImport;
523 pub(crate) type nativeChannelPublicKeys = nativeChannelPublicKeysImport;
525 /// One counterparty's public keys which do not change over the life of a channel.
528 pub struct ChannelPublicKeys {
529 /// A pointer to the opaque Rust object.
531 /// Nearly everywhere, inner must be non-null, however in places where
532 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
533 pub inner: *mut nativeChannelPublicKeys,
534 /// Indicates that this is the only struct which contains the same pointer.
536 /// Rust functions which take ownership of an object provided via an argument require
537 /// this to be true and invalidate the object pointed to by inner.
541 impl Drop for ChannelPublicKeys {
543 if self.is_owned && !<*mut nativeChannelPublicKeys>::is_null(self.inner) {
544 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
548 /// Frees any resources used by the ChannelPublicKeys, if is_owned is set and inner is non-NULL.
550 pub extern "C" fn ChannelPublicKeys_free(this_obj: ChannelPublicKeys) { }
552 /// Used only if an object of this type is returned as a trait impl by a method
553 pub(crate) extern "C" fn ChannelPublicKeys_free_void(this_ptr: *mut c_void) {
554 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeChannelPublicKeys) };
557 impl ChannelPublicKeys {
558 pub(crate) fn get_native_ref(&self) -> &'static nativeChannelPublicKeys {
559 unsafe { &*ObjOps::untweak_ptr(self.inner) }
561 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChannelPublicKeys {
562 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
564 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
565 pub(crate) fn take_inner(mut self) -> *mut nativeChannelPublicKeys {
566 assert!(self.is_owned);
567 let ret = ObjOps::untweak_ptr(self.inner);
568 self.inner = core::ptr::null_mut();
572 /// The public key which is used to sign all commitment transactions, as it appears in the
573 /// on-chain channel lock-in 2-of-2 multisig output.
575 pub extern "C" fn ChannelPublicKeys_get_funding_pubkey(this_ptr: &ChannelPublicKeys) -> crate::c_types::PublicKey {
576 let mut inner_val = &mut this_ptr.get_native_mut_ref().funding_pubkey;
577 crate::c_types::PublicKey::from_rust(&inner_val)
579 /// The public key which is used to sign all commitment transactions, as it appears in the
580 /// on-chain channel lock-in 2-of-2 multisig output.
582 pub extern "C" fn ChannelPublicKeys_set_funding_pubkey(this_ptr: &mut ChannelPublicKeys, mut val: crate::c_types::PublicKey) {
583 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.funding_pubkey = val.into_rust();
585 /// The base point which is used (with derive_public_revocation_key) to derive per-commitment
586 /// revocation keys. This is combined with the per-commitment-secret generated by the
587 /// counterparty to create a secret which the counterparty can reveal to revoke previous
590 pub extern "C" fn ChannelPublicKeys_get_revocation_basepoint(this_ptr: &ChannelPublicKeys) -> crate::lightning::ln::channel_keys::RevocationBasepoint {
591 let mut inner_val = &mut this_ptr.get_native_mut_ref().revocation_basepoint;
592 crate::lightning::ln::channel_keys::RevocationBasepoint { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::ln::channel_keys::RevocationBasepoint<>) as *mut _) }, is_owned: false }
594 /// The base point which is used (with derive_public_revocation_key) to derive per-commitment
595 /// revocation keys. This is combined with the per-commitment-secret generated by the
596 /// counterparty to create a secret which the counterparty can reveal to revoke previous
599 pub extern "C" fn ChannelPublicKeys_set_revocation_basepoint(this_ptr: &mut ChannelPublicKeys, mut val: crate::lightning::ln::channel_keys::RevocationBasepoint) {
600 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.revocation_basepoint = *unsafe { Box::from_raw(val.take_inner()) };
602 /// The public key on which the non-broadcaster (ie the countersignatory) receives an immediately
603 /// spendable primary channel balance on the broadcaster's commitment transaction. This key is
604 /// static across every commitment transaction.
606 pub extern "C" fn ChannelPublicKeys_get_payment_point(this_ptr: &ChannelPublicKeys) -> crate::c_types::PublicKey {
607 let mut inner_val = &mut this_ptr.get_native_mut_ref().payment_point;
608 crate::c_types::PublicKey::from_rust(&inner_val)
610 /// The public key on which the non-broadcaster (ie the countersignatory) receives an immediately
611 /// spendable primary channel balance on the broadcaster's commitment transaction. This key is
612 /// static across every commitment transaction.
614 pub extern "C" fn ChannelPublicKeys_set_payment_point(this_ptr: &mut ChannelPublicKeys, mut val: crate::c_types::PublicKey) {
615 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.payment_point = val.into_rust();
617 /// The base point which is used (with derive_public_key) to derive a per-commitment payment
618 /// public key which receives non-HTLC-encumbered funds which are only available for spending
619 /// after some delay (or can be claimed via the revocation path).
621 pub extern "C" fn ChannelPublicKeys_get_delayed_payment_basepoint(this_ptr: &ChannelPublicKeys) -> crate::lightning::ln::channel_keys::DelayedPaymentBasepoint {
622 let mut inner_val = &mut this_ptr.get_native_mut_ref().delayed_payment_basepoint;
623 crate::lightning::ln::channel_keys::DelayedPaymentBasepoint { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::ln::channel_keys::DelayedPaymentBasepoint<>) as *mut _) }, is_owned: false }
625 /// The base point which is used (with derive_public_key) to derive a per-commitment payment
626 /// public key which receives non-HTLC-encumbered funds which are only available for spending
627 /// after some delay (or can be claimed via the revocation path).
629 pub extern "C" fn ChannelPublicKeys_set_delayed_payment_basepoint(this_ptr: &mut ChannelPublicKeys, mut val: crate::lightning::ln::channel_keys::DelayedPaymentBasepoint) {
630 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.delayed_payment_basepoint = *unsafe { Box::from_raw(val.take_inner()) };
632 /// The base point which is used (with derive_public_key) to derive a per-commitment public key
633 /// which is used to encumber HTLC-in-flight outputs.
635 pub extern "C" fn ChannelPublicKeys_get_htlc_basepoint(this_ptr: &ChannelPublicKeys) -> crate::lightning::ln::channel_keys::HtlcBasepoint {
636 let mut inner_val = &mut this_ptr.get_native_mut_ref().htlc_basepoint;
637 crate::lightning::ln::channel_keys::HtlcBasepoint { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::ln::channel_keys::HtlcBasepoint<>) as *mut _) }, is_owned: false }
639 /// The base point which is used (with derive_public_key) to derive a per-commitment public key
640 /// which is used to encumber HTLC-in-flight outputs.
642 pub extern "C" fn ChannelPublicKeys_set_htlc_basepoint(this_ptr: &mut ChannelPublicKeys, mut val: crate::lightning::ln::channel_keys::HtlcBasepoint) {
643 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.htlc_basepoint = *unsafe { Box::from_raw(val.take_inner()) };
645 /// Constructs a new ChannelPublicKeys given each field
648 pub extern "C" fn ChannelPublicKeys_new(mut funding_pubkey_arg: crate::c_types::PublicKey, mut revocation_basepoint_arg: crate::lightning::ln::channel_keys::RevocationBasepoint, mut payment_point_arg: crate::c_types::PublicKey, mut delayed_payment_basepoint_arg: crate::lightning::ln::channel_keys::DelayedPaymentBasepoint, mut htlc_basepoint_arg: crate::lightning::ln::channel_keys::HtlcBasepoint) -> ChannelPublicKeys {
649 ChannelPublicKeys { inner: ObjOps::heap_alloc(nativeChannelPublicKeys {
650 funding_pubkey: funding_pubkey_arg.into_rust(),
651 revocation_basepoint: *unsafe { Box::from_raw(revocation_basepoint_arg.take_inner()) },
652 payment_point: payment_point_arg.into_rust(),
653 delayed_payment_basepoint: *unsafe { Box::from_raw(delayed_payment_basepoint_arg.take_inner()) },
654 htlc_basepoint: *unsafe { Box::from_raw(htlc_basepoint_arg.take_inner()) },
657 impl Clone for ChannelPublicKeys {
658 fn clone(&self) -> Self {
660 inner: if <*mut nativeChannelPublicKeys>::is_null(self.inner) { core::ptr::null_mut() } else {
661 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
667 /// Used only if an object of this type is returned as a trait impl by a method
668 pub(crate) extern "C" fn ChannelPublicKeys_clone_void(this_ptr: *const c_void) -> *mut c_void {
669 Box::into_raw(Box::new(unsafe { (*(this_ptr as *const nativeChannelPublicKeys)).clone() })) as *mut c_void
672 /// Creates a copy of the ChannelPublicKeys
673 pub extern "C" fn ChannelPublicKeys_clone(orig: &ChannelPublicKeys) -> ChannelPublicKeys {
676 /// Get a string which allows debug introspection of a ChannelPublicKeys object
677 pub extern "C" fn ChannelPublicKeys_debug_str_void(o: *const c_void) -> Str {
678 alloc::format!("{:?}", unsafe { o as *const crate::lightning::ln::chan_utils::ChannelPublicKeys }).into()}
679 /// Generates a non-cryptographic 64-bit hash of the ChannelPublicKeys.
681 pub extern "C" fn ChannelPublicKeys_hash(o: &ChannelPublicKeys) -> u64 {
682 if o.inner.is_null() { return 0; }
683 // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
685 let mut hasher = core::hash::SipHasher::new();
686 core::hash::Hash::hash(o.get_native_ref(), &mut hasher);
687 core::hash::Hasher::finish(&hasher)
689 /// Checks if two ChannelPublicKeyss contain equal inner contents.
690 /// This ignores pointers and is_owned flags and looks at the values in fields.
691 /// Two objects with NULL inner values will be considered "equal" here.
693 pub extern "C" fn ChannelPublicKeys_eq(a: &ChannelPublicKeys, b: &ChannelPublicKeys) -> bool {
694 if a.inner == b.inner { return true; }
695 if a.inner.is_null() || b.inner.is_null() { return false; }
696 if a.get_native_ref() == b.get_native_ref() { true } else { false }
699 /// Serialize the ChannelPublicKeys object into a byte array which can be read by ChannelPublicKeys_read
700 pub extern "C" fn ChannelPublicKeys_write(obj: &crate::lightning::ln::chan_utils::ChannelPublicKeys) -> crate::c_types::derived::CVec_u8Z {
701 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
704 pub(crate) extern "C" fn ChannelPublicKeys_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
705 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelPublicKeys) })
708 /// Read a ChannelPublicKeys from a byte array, created by ChannelPublicKeys_write
709 pub extern "C" fn ChannelPublicKeys_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ChannelPublicKeysDecodeErrorZ {
710 let res: Result<lightning::ln::chan_utils::ChannelPublicKeys, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
711 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::native_into(e) }).into() };
714 /// Create per-state keys from channel base points and the per-commitment point.
715 /// Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
718 pub extern "C" fn TxCreationKeys_derive_new(mut per_commitment_point: crate::c_types::PublicKey, broadcaster_delayed_payment_base: &crate::lightning::ln::channel_keys::DelayedPaymentBasepoint, broadcaster_htlc_base: &crate::lightning::ln::channel_keys::HtlcBasepoint, countersignatory_revocation_base: &crate::lightning::ln::channel_keys::RevocationBasepoint, countersignatory_htlc_base: &crate::lightning::ln::channel_keys::HtlcBasepoint) -> crate::lightning::ln::chan_utils::TxCreationKeys {
719 let mut ret = lightning::ln::chan_utils::TxCreationKeys::derive_new(secp256k1::global::SECP256K1, &per_commitment_point.into_rust(), broadcaster_delayed_payment_base.get_native_ref(), broadcaster_htlc_base.get_native_ref(), countersignatory_revocation_base.get_native_ref(), countersignatory_htlc_base.get_native_ref());
720 crate::lightning::ln::chan_utils::TxCreationKeys { inner: ObjOps::heap_alloc(ret), is_owned: true }
723 /// Generate per-state keys from channel static keys.
724 /// Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
727 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::lightning::ln::chan_utils::TxCreationKeys {
728 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::global::SECP256K1);
729 crate::lightning::ln::chan_utils::TxCreationKeys { inner: ObjOps::heap_alloc(ret), is_owned: true }
732 /// The maximum length of a script returned by get_revokeable_redeemscript.
735 pub static REVOKEABLE_REDEEMSCRIPT_MAX_LENGTH: usize = lightning::ln::chan_utils::REVOKEABLE_REDEEMSCRIPT_MAX_LENGTH;
736 /// A script either spendable by the revocation
737 /// key or the broadcaster_delayed_payment_key and satisfying the relative-locktime OP_CSV constrain.
738 /// Encumbering a `to_holder` output on a commitment transaction or 2nd-stage HTLC transactions.
740 pub extern "C" fn get_revokeable_redeemscript(revocation_key: &crate::lightning::ln::channel_keys::RevocationKey, mut contest_delay: u16, broadcaster_delayed_payment_key: &crate::lightning::ln::channel_keys::DelayedPaymentKey) -> crate::c_types::derived::CVec_u8Z {
741 let mut ret = lightning::ln::chan_utils::get_revokeable_redeemscript(revocation_key.get_native_ref(), contest_delay, broadcaster_delayed_payment_key.get_native_ref());
742 ret.to_bytes().into()
745 /// Returns the script for the counterparty's output on a holder's commitment transaction based on
746 /// the channel type.
748 pub extern "C" fn get_counterparty_payment_script(channel_type_features: &crate::lightning::ln::features::ChannelTypeFeatures, mut payment_key: crate::c_types::PublicKey) -> crate::c_types::derived::CVec_u8Z {
749 let mut ret = lightning::ln::chan_utils::get_counterparty_payment_script(channel_type_features.get_native_ref(), &payment_key.into_rust());
750 ret.to_bytes().into()
754 use lightning::ln::chan_utils::HTLCOutputInCommitment as nativeHTLCOutputInCommitmentImport;
755 pub(crate) type nativeHTLCOutputInCommitment = nativeHTLCOutputInCommitmentImport;
757 /// Information about an HTLC as it appears in a commitment transaction
760 pub struct HTLCOutputInCommitment {
761 /// A pointer to the opaque Rust object.
763 /// Nearly everywhere, inner must be non-null, however in places where
764 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
765 pub inner: *mut nativeHTLCOutputInCommitment,
766 /// Indicates that this is the only struct which contains the same pointer.
768 /// Rust functions which take ownership of an object provided via an argument require
769 /// this to be true and invalidate the object pointed to by inner.
773 impl Drop for HTLCOutputInCommitment {
775 if self.is_owned && !<*mut nativeHTLCOutputInCommitment>::is_null(self.inner) {
776 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
780 /// Frees any resources used by the HTLCOutputInCommitment, if is_owned is set and inner is non-NULL.
782 pub extern "C" fn HTLCOutputInCommitment_free(this_obj: HTLCOutputInCommitment) { }
784 /// Used only if an object of this type is returned as a trait impl by a method
785 pub(crate) extern "C" fn HTLCOutputInCommitment_free_void(this_ptr: *mut c_void) {
786 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeHTLCOutputInCommitment) };
789 impl HTLCOutputInCommitment {
790 pub(crate) fn get_native_ref(&self) -> &'static nativeHTLCOutputInCommitment {
791 unsafe { &*ObjOps::untweak_ptr(self.inner) }
793 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeHTLCOutputInCommitment {
794 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
796 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
797 pub(crate) fn take_inner(mut self) -> *mut nativeHTLCOutputInCommitment {
798 assert!(self.is_owned);
799 let ret = ObjOps::untweak_ptr(self.inner);
800 self.inner = core::ptr::null_mut();
804 /// Whether the HTLC was \"offered\" (ie outbound in relation to this commitment transaction).
805 /// Note that this is not the same as whether it is ountbound *from us*. To determine that you
806 /// need to compare this value to whether the commitment transaction in question is that of
807 /// the counterparty or our own.
809 pub extern "C" fn HTLCOutputInCommitment_get_offered(this_ptr: &HTLCOutputInCommitment) -> bool {
810 let mut inner_val = &mut this_ptr.get_native_mut_ref().offered;
813 /// Whether the HTLC was \"offered\" (ie outbound in relation to this commitment transaction).
814 /// Note that this is not the same as whether it is ountbound *from us*. To determine that you
815 /// need to compare this value to whether the commitment transaction in question is that of
816 /// the counterparty or our own.
818 pub extern "C" fn HTLCOutputInCommitment_set_offered(this_ptr: &mut HTLCOutputInCommitment, mut val: bool) {
819 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.offered = val;
821 /// The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
822 /// this divided by 1000.
824 pub extern "C" fn HTLCOutputInCommitment_get_amount_msat(this_ptr: &HTLCOutputInCommitment) -> u64 {
825 let mut inner_val = &mut this_ptr.get_native_mut_ref().amount_msat;
828 /// The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
829 /// this divided by 1000.
831 pub extern "C" fn HTLCOutputInCommitment_set_amount_msat(this_ptr: &mut HTLCOutputInCommitment, mut val: u64) {
832 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.amount_msat = val;
834 /// The CLTV lock-time at which this HTLC expires.
836 pub extern "C" fn HTLCOutputInCommitment_get_cltv_expiry(this_ptr: &HTLCOutputInCommitment) -> u32 {
837 let mut inner_val = &mut this_ptr.get_native_mut_ref().cltv_expiry;
840 /// The CLTV lock-time at which this HTLC expires.
842 pub extern "C" fn HTLCOutputInCommitment_set_cltv_expiry(this_ptr: &mut HTLCOutputInCommitment, mut val: u32) {
843 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.cltv_expiry = val;
845 /// The hash of the preimage which unlocks this HTLC.
847 pub extern "C" fn HTLCOutputInCommitment_get_payment_hash(this_ptr: &HTLCOutputInCommitment) -> *const [u8; 32] {
848 let mut inner_val = &mut this_ptr.get_native_mut_ref().payment_hash;
851 /// The hash of the preimage which unlocks this HTLC.
853 pub extern "C" fn HTLCOutputInCommitment_set_payment_hash(this_ptr: &mut HTLCOutputInCommitment, mut val: crate::c_types::ThirtyTwoBytes) {
854 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.payment_hash = ::lightning::ln::types::PaymentHash(val.data);
856 /// The position within the commitment transactions' outputs. This may be None if the value is
857 /// below the dust limit (in which case no output appears in the commitment transaction and the
858 /// value is spent to additional transaction fees).
860 pub extern "C" fn HTLCOutputInCommitment_get_transaction_output_index(this_ptr: &HTLCOutputInCommitment) -> crate::c_types::derived::COption_u32Z {
861 let mut inner_val = &mut this_ptr.get_native_mut_ref().transaction_output_index;
862 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() }) };
865 /// The position within the commitment transactions' outputs. This may be None if the value is
866 /// below the dust limit (in which case no output appears in the commitment transaction and the
867 /// value is spent to additional transaction fees).
869 pub extern "C" fn HTLCOutputInCommitment_set_transaction_output_index(this_ptr: &mut HTLCOutputInCommitment, mut val: crate::c_types::derived::COption_u32Z) {
870 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
871 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.transaction_output_index = local_val;
873 /// Constructs a new HTLCOutputInCommitment given each field
876 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 {
877 let mut local_transaction_output_index_arg = if transaction_output_index_arg.is_some() { Some( { transaction_output_index_arg.take() }) } else { None };
878 HTLCOutputInCommitment { inner: ObjOps::heap_alloc(nativeHTLCOutputInCommitment {
879 offered: offered_arg,
880 amount_msat: amount_msat_arg,
881 cltv_expiry: cltv_expiry_arg,
882 payment_hash: ::lightning::ln::types::PaymentHash(payment_hash_arg.data),
883 transaction_output_index: local_transaction_output_index_arg,
886 impl Clone for HTLCOutputInCommitment {
887 fn clone(&self) -> Self {
889 inner: if <*mut nativeHTLCOutputInCommitment>::is_null(self.inner) { core::ptr::null_mut() } else {
890 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
896 /// Used only if an object of this type is returned as a trait impl by a method
897 pub(crate) extern "C" fn HTLCOutputInCommitment_clone_void(this_ptr: *const c_void) -> *mut c_void {
898 Box::into_raw(Box::new(unsafe { (*(this_ptr as *const nativeHTLCOutputInCommitment)).clone() })) as *mut c_void
901 /// Creates a copy of the HTLCOutputInCommitment
902 pub extern "C" fn HTLCOutputInCommitment_clone(orig: &HTLCOutputInCommitment) -> HTLCOutputInCommitment {
905 /// Get a string which allows debug introspection of a HTLCOutputInCommitment object
906 pub extern "C" fn HTLCOutputInCommitment_debug_str_void(o: *const c_void) -> Str {
907 alloc::format!("{:?}", unsafe { o as *const crate::lightning::ln::chan_utils::HTLCOutputInCommitment }).into()}
908 /// Checks if two HTLCOutputInCommitments contain equal inner contents.
909 /// This ignores pointers and is_owned flags and looks at the values in fields.
910 /// Two objects with NULL inner values will be considered "equal" here.
912 pub extern "C" fn HTLCOutputInCommitment_eq(a: &HTLCOutputInCommitment, b: &HTLCOutputInCommitment) -> bool {
913 if a.inner == b.inner { return true; }
914 if a.inner.is_null() || b.inner.is_null() { return false; }
915 if a.get_native_ref() == b.get_native_ref() { true } else { false }
918 /// Serialize the HTLCOutputInCommitment object into a byte array which can be read by HTLCOutputInCommitment_read
919 pub extern "C" fn HTLCOutputInCommitment_write(obj: &crate::lightning::ln::chan_utils::HTLCOutputInCommitment) -> crate::c_types::derived::CVec_u8Z {
920 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
923 pub(crate) extern "C" fn HTLCOutputInCommitment_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
924 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeHTLCOutputInCommitment) })
927 /// Read a HTLCOutputInCommitment from a byte array, created by HTLCOutputInCommitment_write
928 pub extern "C" fn HTLCOutputInCommitment_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_HTLCOutputInCommitmentDecodeErrorZ {
929 let res: Result<lightning::ln::chan_utils::HTLCOutputInCommitment, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
930 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::native_into(e) }).into() };
933 /// Gets the witness redeemscript for an HTLC output in a commitment transaction. Note that htlc
934 /// does not need to have its previous_output_index filled.
936 pub extern "C" fn get_htlc_redeemscript(htlc: &crate::lightning::ln::chan_utils::HTLCOutputInCommitment, channel_type_features: &crate::lightning::ln::features::ChannelTypeFeatures, keys: &crate::lightning::ln::chan_utils::TxCreationKeys) -> crate::c_types::derived::CVec_u8Z {
937 let mut ret = lightning::ln::chan_utils::get_htlc_redeemscript(htlc.get_native_ref(), channel_type_features.get_native_ref(), keys.get_native_ref());
938 ret.to_bytes().into()
941 /// Gets the redeemscript for a funding output from the two funding public keys.
942 /// Note that the order of funding public keys does not matter.
944 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 {
945 let mut ret = lightning::ln::chan_utils::make_funding_redeemscript(&broadcaster.into_rust(), &countersignatory.into_rust());
946 ret.to_bytes().into()
949 /// Builds an unsigned HTLC-Success or HTLC-Timeout transaction from the given channel and HTLC
950 /// parameters. This is used by [`TrustedCommitmentTransaction::get_htlc_sigs`] to fetch the
951 /// transaction which needs signing, and can be used to construct an HTLC transaction which is
952 /// broadcastable given a counterparty HTLC signature.
954 /// Panics if htlc.transaction_output_index.is_none() (as such HTLCs do not appear in the
955 /// commitment transaction).
957 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, channel_type_features: &crate::lightning::ln::features::ChannelTypeFeatures, broadcaster_delayed_payment_key: &crate::lightning::ln::channel_keys::DelayedPaymentKey, revocation_key: &crate::lightning::ln::channel_keys::RevocationKey) -> crate::c_types::Transaction {
958 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(), channel_type_features.get_native_ref(), broadcaster_delayed_payment_key.get_native_ref(), revocation_key.get_native_ref());
959 crate::c_types::Transaction::from_bitcoin(&ret)
962 /// Returns the witness required to satisfy and spend a HTLC input.
964 pub extern "C" fn build_htlc_input_witness(mut local_sig: crate::c_types::ECDSASignature, mut remote_sig: crate::c_types::ECDSASignature, mut preimage: crate::c_types::derived::COption_ThirtyTwoBytesZ, mut redeem_script: crate::c_types::u8slice, channel_type_features: &crate::lightning::ln::features::ChannelTypeFeatures) -> crate::c_types::Witness {
965 let mut local_preimage = { /*preimage*/ let preimage_opt = preimage; if preimage_opt.is_none() { None } else { Some({ { ::lightning::ln::types::PaymentPreimage({ preimage_opt.take() }.data) }})} };
966 let mut ret = lightning::ln::chan_utils::build_htlc_input_witness(&local_sig.into_rust(), &remote_sig.into_rust(), &local_preimage, ::bitcoin::blockdata::script::Script::from_bytes(redeem_script.to_slice()), channel_type_features.get_native_ref());
967 crate::c_types::Witness::from_bitcoin(&ret)
970 /// Gets the witnessScript for the to_remote output when anchors are enabled.
972 pub extern "C" fn get_to_countersignatory_with_anchors_redeemscript(mut payment_point: crate::c_types::PublicKey) -> crate::c_types::derived::CVec_u8Z {
973 let mut ret = lightning::ln::chan_utils::get_to_countersignatory_with_anchors_redeemscript(&payment_point.into_rust());
974 ret.to_bytes().into()
977 /// Gets the witnessScript for an anchor output from the funding public key.
978 /// The witness in the spending input must be:
979 /// <BIP 143 funding_signature>
980 /// After 16 blocks of confirmation, an alternative satisfying witness could be:
982 /// (empty vector required to satisfy compliance with MINIMALIF-standard rule)
984 pub extern "C" fn get_anchor_redeemscript(mut funding_pubkey: crate::c_types::PublicKey) -> crate::c_types::derived::CVec_u8Z {
985 let mut ret = lightning::ln::chan_utils::get_anchor_redeemscript(&funding_pubkey.into_rust());
986 ret.to_bytes().into()
989 /// Returns the witness required to satisfy and spend an anchor input.
991 pub extern "C" fn build_anchor_input_witness(mut funding_key: crate::c_types::PublicKey, mut funding_sig: crate::c_types::ECDSASignature) -> crate::c_types::Witness {
992 let mut ret = lightning::ln::chan_utils::build_anchor_input_witness(&funding_key.into_rust(), &funding_sig.into_rust());
993 crate::c_types::Witness::from_bitcoin(&ret)
997 use lightning::ln::chan_utils::ChannelTransactionParameters as nativeChannelTransactionParametersImport;
998 pub(crate) type nativeChannelTransactionParameters = nativeChannelTransactionParametersImport;
1000 /// Per-channel data used to build transactions in conjunction with the per-commitment data (CommitmentTransaction).
1001 /// The fields are organized by holder/counterparty.
1003 /// Normally, this is converted to the broadcaster/countersignatory-organized DirectedChannelTransactionParameters
1004 /// before use, via the as_holder_broadcastable and as_counterparty_broadcastable functions.
1007 pub struct ChannelTransactionParameters {
1008 /// A pointer to the opaque Rust object.
1010 /// Nearly everywhere, inner must be non-null, however in places where
1011 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1012 pub inner: *mut nativeChannelTransactionParameters,
1013 /// Indicates that this is the only struct which contains the same pointer.
1015 /// Rust functions which take ownership of an object provided via an argument require
1016 /// this to be true and invalidate the object pointed to by inner.
1020 impl Drop for ChannelTransactionParameters {
1021 fn drop(&mut self) {
1022 if self.is_owned && !<*mut nativeChannelTransactionParameters>::is_null(self.inner) {
1023 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1027 /// Frees any resources used by the ChannelTransactionParameters, if is_owned is set and inner is non-NULL.
1029 pub extern "C" fn ChannelTransactionParameters_free(this_obj: ChannelTransactionParameters) { }
1031 /// Used only if an object of this type is returned as a trait impl by a method
1032 pub(crate) extern "C" fn ChannelTransactionParameters_free_void(this_ptr: *mut c_void) {
1033 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeChannelTransactionParameters) };
1036 impl ChannelTransactionParameters {
1037 pub(crate) fn get_native_ref(&self) -> &'static nativeChannelTransactionParameters {
1038 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1040 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChannelTransactionParameters {
1041 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1043 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1044 pub(crate) fn take_inner(mut self) -> *mut nativeChannelTransactionParameters {
1045 assert!(self.is_owned);
1046 let ret = ObjOps::untweak_ptr(self.inner);
1047 self.inner = core::ptr::null_mut();
1051 /// Holder public keys
1053 pub extern "C" fn ChannelTransactionParameters_get_holder_pubkeys(this_ptr: &ChannelTransactionParameters) -> crate::lightning::ln::chan_utils::ChannelPublicKeys {
1054 let mut inner_val = &mut this_ptr.get_native_mut_ref().holder_pubkeys;
1055 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 }
1057 /// Holder public keys
1059 pub extern "C" fn ChannelTransactionParameters_set_holder_pubkeys(this_ptr: &mut ChannelTransactionParameters, mut val: crate::lightning::ln::chan_utils::ChannelPublicKeys) {
1060 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.holder_pubkeys = *unsafe { Box::from_raw(val.take_inner()) };
1062 /// The contest delay selected by the holder, which applies to counterparty-broadcast transactions
1064 pub extern "C" fn ChannelTransactionParameters_get_holder_selected_contest_delay(this_ptr: &ChannelTransactionParameters) -> u16 {
1065 let mut inner_val = &mut this_ptr.get_native_mut_ref().holder_selected_contest_delay;
1068 /// The contest delay selected by the holder, which applies to counterparty-broadcast transactions
1070 pub extern "C" fn ChannelTransactionParameters_set_holder_selected_contest_delay(this_ptr: &mut ChannelTransactionParameters, mut val: u16) {
1071 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.holder_selected_contest_delay = val;
1073 /// Whether the holder is the initiator of this channel.
1074 /// This is an input to the commitment number obscure factor computation.
1076 pub extern "C" fn ChannelTransactionParameters_get_is_outbound_from_holder(this_ptr: &ChannelTransactionParameters) -> bool {
1077 let mut inner_val = &mut this_ptr.get_native_mut_ref().is_outbound_from_holder;
1080 /// Whether the holder is the initiator of this channel.
1081 /// This is an input to the commitment number obscure factor computation.
1083 pub extern "C" fn ChannelTransactionParameters_set_is_outbound_from_holder(this_ptr: &mut ChannelTransactionParameters, mut val: bool) {
1084 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.is_outbound_from_holder = val;
1086 /// The late-bound counterparty channel transaction parameters.
1087 /// These parameters are populated at the point in the protocol where the counterparty provides them.
1089 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
1091 pub extern "C" fn ChannelTransactionParameters_get_counterparty_parameters(this_ptr: &ChannelTransactionParameters) -> crate::lightning::ln::chan_utils::CounterpartyChannelTransactionParameters {
1092 let mut inner_val = &mut this_ptr.get_native_mut_ref().counterparty_parameters;
1093 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 };
1096 /// The late-bound counterparty channel transaction parameters.
1097 /// These parameters are populated at the point in the protocol where the counterparty provides them.
1099 /// Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
1101 pub extern "C" fn ChannelTransactionParameters_set_counterparty_parameters(this_ptr: &mut ChannelTransactionParameters, mut val: crate::lightning::ln::chan_utils::CounterpartyChannelTransactionParameters) {
1102 let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
1103 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.counterparty_parameters = local_val;
1105 /// The late-bound funding outpoint
1107 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
1109 pub extern "C" fn ChannelTransactionParameters_get_funding_outpoint(this_ptr: &ChannelTransactionParameters) -> crate::lightning::chain::transaction::OutPoint {
1110 let mut inner_val = &mut this_ptr.get_native_mut_ref().funding_outpoint;
1111 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 };
1114 /// The late-bound funding outpoint
1116 /// Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
1118 pub extern "C" fn ChannelTransactionParameters_set_funding_outpoint(this_ptr: &mut ChannelTransactionParameters, mut val: crate::lightning::chain::transaction::OutPoint) {
1119 let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
1120 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.funding_outpoint = local_val;
1122 /// This channel's type, as negotiated during channel open. For old objects where this field
1123 /// wasn't serialized, it will default to static_remote_key at deserialization.
1125 pub extern "C" fn ChannelTransactionParameters_get_channel_type_features(this_ptr: &ChannelTransactionParameters) -> crate::lightning::ln::features::ChannelTypeFeatures {
1126 let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_type_features;
1127 crate::lightning::ln::features::ChannelTypeFeatures { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::ln::features::ChannelTypeFeatures<>) as *mut _) }, is_owned: false }
1129 /// This channel's type, as negotiated during channel open. For old objects where this field
1130 /// wasn't serialized, it will default to static_remote_key at deserialization.
1132 pub extern "C" fn ChannelTransactionParameters_set_channel_type_features(this_ptr: &mut ChannelTransactionParameters, mut val: crate::lightning::ln::features::ChannelTypeFeatures) {
1133 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_type_features = *unsafe { Box::from_raw(val.take_inner()) };
1135 /// Constructs a new ChannelTransactionParameters given each field
1137 /// Note that counterparty_parameters_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
1138 /// Note that funding_outpoint_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
1141 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 channel_type_features_arg: crate::lightning::ln::features::ChannelTypeFeatures) -> ChannelTransactionParameters {
1142 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()) } }) };
1143 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()) } }) };
1144 ChannelTransactionParameters { inner: ObjOps::heap_alloc(nativeChannelTransactionParameters {
1145 holder_pubkeys: *unsafe { Box::from_raw(holder_pubkeys_arg.take_inner()) },
1146 holder_selected_contest_delay: holder_selected_contest_delay_arg,
1147 is_outbound_from_holder: is_outbound_from_holder_arg,
1148 counterparty_parameters: local_counterparty_parameters_arg,
1149 funding_outpoint: local_funding_outpoint_arg,
1150 channel_type_features: *unsafe { Box::from_raw(channel_type_features_arg.take_inner()) },
1151 }), is_owned: true }
1153 impl Clone for ChannelTransactionParameters {
1154 fn clone(&self) -> Self {
1156 inner: if <*mut nativeChannelTransactionParameters>::is_null(self.inner) { core::ptr::null_mut() } else {
1157 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1163 /// Used only if an object of this type is returned as a trait impl by a method
1164 pub(crate) extern "C" fn ChannelTransactionParameters_clone_void(this_ptr: *const c_void) -> *mut c_void {
1165 Box::into_raw(Box::new(unsafe { (*(this_ptr as *const nativeChannelTransactionParameters)).clone() })) as *mut c_void
1168 /// Creates a copy of the ChannelTransactionParameters
1169 pub extern "C" fn ChannelTransactionParameters_clone(orig: &ChannelTransactionParameters) -> ChannelTransactionParameters {
1172 /// Get a string which allows debug introspection of a ChannelTransactionParameters object
1173 pub extern "C" fn ChannelTransactionParameters_debug_str_void(o: *const c_void) -> Str {
1174 alloc::format!("{:?}", unsafe { o as *const crate::lightning::ln::chan_utils::ChannelTransactionParameters }).into()}
1175 /// Generates a non-cryptographic 64-bit hash of the ChannelTransactionParameters.
1177 pub extern "C" fn ChannelTransactionParameters_hash(o: &ChannelTransactionParameters) -> u64 {
1178 if o.inner.is_null() { return 0; }
1179 // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
1180 #[allow(deprecated)]
1181 let mut hasher = core::hash::SipHasher::new();
1182 core::hash::Hash::hash(o.get_native_ref(), &mut hasher);
1183 core::hash::Hasher::finish(&hasher)
1185 /// Checks if two ChannelTransactionParameterss contain equal inner contents.
1186 /// This ignores pointers and is_owned flags and looks at the values in fields.
1187 /// Two objects with NULL inner values will be considered "equal" here.
1189 pub extern "C" fn ChannelTransactionParameters_eq(a: &ChannelTransactionParameters, b: &ChannelTransactionParameters) -> bool {
1190 if a.inner == b.inner { return true; }
1191 if a.inner.is_null() || b.inner.is_null() { return false; }
1192 if a.get_native_ref() == b.get_native_ref() { true } else { false }
1195 use lightning::ln::chan_utils::CounterpartyChannelTransactionParameters as nativeCounterpartyChannelTransactionParametersImport;
1196 pub(crate) type nativeCounterpartyChannelTransactionParameters = nativeCounterpartyChannelTransactionParametersImport;
1198 /// Late-bound per-channel counterparty data used to build transactions.
1201 pub struct CounterpartyChannelTransactionParameters {
1202 /// A pointer to the opaque Rust object.
1204 /// Nearly everywhere, inner must be non-null, however in places where
1205 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1206 pub inner: *mut nativeCounterpartyChannelTransactionParameters,
1207 /// Indicates that this is the only struct which contains the same pointer.
1209 /// Rust functions which take ownership of an object provided via an argument require
1210 /// this to be true and invalidate the object pointed to by inner.
1214 impl Drop for CounterpartyChannelTransactionParameters {
1215 fn drop(&mut self) {
1216 if self.is_owned && !<*mut nativeCounterpartyChannelTransactionParameters>::is_null(self.inner) {
1217 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1221 /// Frees any resources used by the CounterpartyChannelTransactionParameters, if is_owned is set and inner is non-NULL.
1223 pub extern "C" fn CounterpartyChannelTransactionParameters_free(this_obj: CounterpartyChannelTransactionParameters) { }
1225 /// Used only if an object of this type is returned as a trait impl by a method
1226 pub(crate) extern "C" fn CounterpartyChannelTransactionParameters_free_void(this_ptr: *mut c_void) {
1227 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeCounterpartyChannelTransactionParameters) };
1230 impl CounterpartyChannelTransactionParameters {
1231 pub(crate) fn get_native_ref(&self) -> &'static nativeCounterpartyChannelTransactionParameters {
1232 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1234 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeCounterpartyChannelTransactionParameters {
1235 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1237 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1238 pub(crate) fn take_inner(mut self) -> *mut nativeCounterpartyChannelTransactionParameters {
1239 assert!(self.is_owned);
1240 let ret = ObjOps::untweak_ptr(self.inner);
1241 self.inner = core::ptr::null_mut();
1245 /// Counter-party public keys
1247 pub extern "C" fn CounterpartyChannelTransactionParameters_get_pubkeys(this_ptr: &CounterpartyChannelTransactionParameters) -> crate::lightning::ln::chan_utils::ChannelPublicKeys {
1248 let mut inner_val = &mut this_ptr.get_native_mut_ref().pubkeys;
1249 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 }
1251 /// Counter-party public keys
1253 pub extern "C" fn CounterpartyChannelTransactionParameters_set_pubkeys(this_ptr: &mut CounterpartyChannelTransactionParameters, mut val: crate::lightning::ln::chan_utils::ChannelPublicKeys) {
1254 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.pubkeys = *unsafe { Box::from_raw(val.take_inner()) };
1256 /// The contest delay selected by the counterparty, which applies to holder-broadcast transactions
1258 pub extern "C" fn CounterpartyChannelTransactionParameters_get_selected_contest_delay(this_ptr: &CounterpartyChannelTransactionParameters) -> u16 {
1259 let mut inner_val = &mut this_ptr.get_native_mut_ref().selected_contest_delay;
1262 /// The contest delay selected by the counterparty, which applies to holder-broadcast transactions
1264 pub extern "C" fn CounterpartyChannelTransactionParameters_set_selected_contest_delay(this_ptr: &mut CounterpartyChannelTransactionParameters, mut val: u16) {
1265 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.selected_contest_delay = val;
1267 /// Constructs a new CounterpartyChannelTransactionParameters given each field
1270 pub extern "C" fn CounterpartyChannelTransactionParameters_new(mut pubkeys_arg: crate::lightning::ln::chan_utils::ChannelPublicKeys, mut selected_contest_delay_arg: u16) -> CounterpartyChannelTransactionParameters {
1271 CounterpartyChannelTransactionParameters { inner: ObjOps::heap_alloc(nativeCounterpartyChannelTransactionParameters {
1272 pubkeys: *unsafe { Box::from_raw(pubkeys_arg.take_inner()) },
1273 selected_contest_delay: selected_contest_delay_arg,
1274 }), is_owned: true }
1276 impl Clone for CounterpartyChannelTransactionParameters {
1277 fn clone(&self) -> Self {
1279 inner: if <*mut nativeCounterpartyChannelTransactionParameters>::is_null(self.inner) { core::ptr::null_mut() } else {
1280 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1286 /// Used only if an object of this type is returned as a trait impl by a method
1287 pub(crate) extern "C" fn CounterpartyChannelTransactionParameters_clone_void(this_ptr: *const c_void) -> *mut c_void {
1288 Box::into_raw(Box::new(unsafe { (*(this_ptr as *const nativeCounterpartyChannelTransactionParameters)).clone() })) as *mut c_void
1291 /// Creates a copy of the CounterpartyChannelTransactionParameters
1292 pub extern "C" fn CounterpartyChannelTransactionParameters_clone(orig: &CounterpartyChannelTransactionParameters) -> CounterpartyChannelTransactionParameters {
1295 /// Get a string which allows debug introspection of a CounterpartyChannelTransactionParameters object
1296 pub extern "C" fn CounterpartyChannelTransactionParameters_debug_str_void(o: *const c_void) -> Str {
1297 alloc::format!("{:?}", unsafe { o as *const crate::lightning::ln::chan_utils::CounterpartyChannelTransactionParameters }).into()}
1298 /// Generates a non-cryptographic 64-bit hash of the CounterpartyChannelTransactionParameters.
1300 pub extern "C" fn CounterpartyChannelTransactionParameters_hash(o: &CounterpartyChannelTransactionParameters) -> u64 {
1301 if o.inner.is_null() { return 0; }
1302 // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
1303 #[allow(deprecated)]
1304 let mut hasher = core::hash::SipHasher::new();
1305 core::hash::Hash::hash(o.get_native_ref(), &mut hasher);
1306 core::hash::Hasher::finish(&hasher)
1308 /// Checks if two CounterpartyChannelTransactionParameterss contain equal inner contents.
1309 /// This ignores pointers and is_owned flags and looks at the values in fields.
1310 /// Two objects with NULL inner values will be considered "equal" here.
1312 pub extern "C" fn CounterpartyChannelTransactionParameters_eq(a: &CounterpartyChannelTransactionParameters, b: &CounterpartyChannelTransactionParameters) -> bool {
1313 if a.inner == b.inner { return true; }
1314 if a.inner.is_null() || b.inner.is_null() { return false; }
1315 if a.get_native_ref() == b.get_native_ref() { true } else { false }
1317 /// Whether the late bound parameters are populated.
1320 pub extern "C" fn ChannelTransactionParameters_is_populated(this_arg: &crate::lightning::ln::chan_utils::ChannelTransactionParameters) -> bool {
1321 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.is_populated();
1325 /// Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
1326 /// given that the holder is the broadcaster.
1328 /// self.is_populated() must be true before calling this function.
1331 pub extern "C" fn ChannelTransactionParameters_as_holder_broadcastable(this_arg: &crate::lightning::ln::chan_utils::ChannelTransactionParameters) -> crate::lightning::ln::chan_utils::DirectedChannelTransactionParameters {
1332 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.as_holder_broadcastable();
1333 crate::lightning::ln::chan_utils::DirectedChannelTransactionParameters { inner: ObjOps::heap_alloc(ret), is_owned: true }
1336 /// Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
1337 /// given that the counterparty is the broadcaster.
1339 /// self.is_populated() must be true before calling this function.
1342 pub extern "C" fn ChannelTransactionParameters_as_counterparty_broadcastable(this_arg: &crate::lightning::ln::chan_utils::ChannelTransactionParameters) -> crate::lightning::ln::chan_utils::DirectedChannelTransactionParameters {
1343 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.as_counterparty_broadcastable();
1344 crate::lightning::ln::chan_utils::DirectedChannelTransactionParameters { inner: ObjOps::heap_alloc(ret), is_owned: true }
1348 /// Serialize the CounterpartyChannelTransactionParameters object into a byte array which can be read by CounterpartyChannelTransactionParameters_read
1349 pub extern "C" fn CounterpartyChannelTransactionParameters_write(obj: &crate::lightning::ln::chan_utils::CounterpartyChannelTransactionParameters) -> crate::c_types::derived::CVec_u8Z {
1350 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
1353 pub(crate) extern "C" fn CounterpartyChannelTransactionParameters_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1354 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeCounterpartyChannelTransactionParameters) })
1357 /// Read a CounterpartyChannelTransactionParameters from a byte array, created by CounterpartyChannelTransactionParameters_write
1358 pub extern "C" fn CounterpartyChannelTransactionParameters_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_CounterpartyChannelTransactionParametersDecodeErrorZ {
1359 let res: Result<lightning::ln::chan_utils::CounterpartyChannelTransactionParameters, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
1360 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::native_into(e) }).into() };
1364 /// Serialize the ChannelTransactionParameters object into a byte array which can be read by ChannelTransactionParameters_read
1365 pub extern "C" fn ChannelTransactionParameters_write(obj: &crate::lightning::ln::chan_utils::ChannelTransactionParameters) -> crate::c_types::derived::CVec_u8Z {
1366 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
1369 pub(crate) extern "C" fn ChannelTransactionParameters_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1370 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelTransactionParameters) })
1373 /// Read a ChannelTransactionParameters from a byte array, created by ChannelTransactionParameters_write
1374 pub extern "C" fn ChannelTransactionParameters_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ChannelTransactionParametersDecodeErrorZ {
1375 let res: Result<lightning::ln::chan_utils::ChannelTransactionParameters, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
1376 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::native_into(e) }).into() };
1380 use lightning::ln::chan_utils::DirectedChannelTransactionParameters as nativeDirectedChannelTransactionParametersImport;
1381 pub(crate) type nativeDirectedChannelTransactionParameters = nativeDirectedChannelTransactionParametersImport<'static, >;
1383 /// Static channel fields used to build transactions given per-commitment fields, organized by
1384 /// broadcaster/countersignatory.
1386 /// This is derived from the holder/counterparty-organized ChannelTransactionParameters via the
1387 /// as_holder_broadcastable and as_counterparty_broadcastable functions.
1390 pub struct DirectedChannelTransactionParameters {
1391 /// A pointer to the opaque Rust object.
1393 /// Nearly everywhere, inner must be non-null, however in places where
1394 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1395 pub inner: *mut nativeDirectedChannelTransactionParameters,
1396 /// Indicates that this is the only struct which contains the same pointer.
1398 /// Rust functions which take ownership of an object provided via an argument require
1399 /// this to be true and invalidate the object pointed to by inner.
1403 impl Drop for DirectedChannelTransactionParameters {
1404 fn drop(&mut self) {
1405 if self.is_owned && !<*mut nativeDirectedChannelTransactionParameters>::is_null(self.inner) {
1406 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1410 /// Frees any resources used by the DirectedChannelTransactionParameters, if is_owned is set and inner is non-NULL.
1412 pub extern "C" fn DirectedChannelTransactionParameters_free(this_obj: DirectedChannelTransactionParameters) { }
1414 /// Used only if an object of this type is returned as a trait impl by a method
1415 pub(crate) extern "C" fn DirectedChannelTransactionParameters_free_void(this_ptr: *mut c_void) {
1416 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeDirectedChannelTransactionParameters) };
1419 impl DirectedChannelTransactionParameters {
1420 pub(crate) fn get_native_ref(&self) -> &'static nativeDirectedChannelTransactionParameters {
1421 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1423 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeDirectedChannelTransactionParameters {
1424 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1426 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1427 pub(crate) fn take_inner(mut self) -> *mut nativeDirectedChannelTransactionParameters {
1428 assert!(self.is_owned);
1429 let ret = ObjOps::untweak_ptr(self.inner);
1430 self.inner = core::ptr::null_mut();
1434 /// Get the channel pubkeys for the broadcaster
1437 pub extern "C" fn DirectedChannelTransactionParameters_broadcaster_pubkeys(this_arg: &crate::lightning::ln::chan_utils::DirectedChannelTransactionParameters) -> crate::lightning::ln::chan_utils::ChannelPublicKeys {
1438 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.broadcaster_pubkeys();
1439 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 }
1442 /// Get the channel pubkeys for the countersignatory
1445 pub extern "C" fn DirectedChannelTransactionParameters_countersignatory_pubkeys(this_arg: &crate::lightning::ln::chan_utils::DirectedChannelTransactionParameters) -> crate::lightning::ln::chan_utils::ChannelPublicKeys {
1446 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.countersignatory_pubkeys();
1447 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 }
1450 /// Get the contest delay applicable to the transactions.
1451 /// Note that the contest delay was selected by the countersignatory.
1454 pub extern "C" fn DirectedChannelTransactionParameters_contest_delay(this_arg: &crate::lightning::ln::chan_utils::DirectedChannelTransactionParameters) -> u16 {
1455 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.contest_delay();
1459 /// Whether the channel is outbound from the broadcaster.
1461 /// The boolean representing the side that initiated the channel is
1462 /// an input to the commitment number obscure factor computation.
1465 pub extern "C" fn DirectedChannelTransactionParameters_is_outbound(this_arg: &crate::lightning::ln::chan_utils::DirectedChannelTransactionParameters) -> bool {
1466 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.is_outbound();
1470 /// The funding outpoint
1473 pub extern "C" fn DirectedChannelTransactionParameters_funding_outpoint(this_arg: &crate::lightning::ln::chan_utils::DirectedChannelTransactionParameters) -> crate::lightning::chain::transaction::OutPoint {
1474 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.funding_outpoint();
1475 crate::c_types::bitcoin_to_C_outpoint(&ret)
1478 /// Whether to use anchors for this channel
1481 pub extern "C" fn DirectedChannelTransactionParameters_channel_type_features(this_arg: &crate::lightning::ln::chan_utils::DirectedChannelTransactionParameters) -> crate::lightning::ln::features::ChannelTypeFeatures {
1482 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.channel_type_features();
1483 crate::lightning::ln::features::ChannelTypeFeatures { inner: unsafe { ObjOps::nonnull_ptr_to_inner((ret as *const lightning::ln::features::ChannelTypeFeatures<>) as *mut _) }, is_owned: false }
1487 use lightning::ln::chan_utils::HolderCommitmentTransaction as nativeHolderCommitmentTransactionImport;
1488 pub(crate) type nativeHolderCommitmentTransaction = nativeHolderCommitmentTransactionImport;
1490 /// Information needed to build and sign a holder's commitment transaction.
1492 /// The transaction is only signed once we are ready to broadcast.
1495 pub struct HolderCommitmentTransaction {
1496 /// A pointer to the opaque Rust object.
1498 /// Nearly everywhere, inner must be non-null, however in places where
1499 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1500 pub inner: *mut nativeHolderCommitmentTransaction,
1501 /// Indicates that this is the only struct which contains the same pointer.
1503 /// Rust functions which take ownership of an object provided via an argument require
1504 /// this to be true and invalidate the object pointed to by inner.
1508 impl Drop for HolderCommitmentTransaction {
1509 fn drop(&mut self) {
1510 if self.is_owned && !<*mut nativeHolderCommitmentTransaction>::is_null(self.inner) {
1511 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1515 /// Frees any resources used by the HolderCommitmentTransaction, if is_owned is set and inner is non-NULL.
1517 pub extern "C" fn HolderCommitmentTransaction_free(this_obj: HolderCommitmentTransaction) { }
1519 /// Used only if an object of this type is returned as a trait impl by a method
1520 pub(crate) extern "C" fn HolderCommitmentTransaction_free_void(this_ptr: *mut c_void) {
1521 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeHolderCommitmentTransaction) };
1524 impl HolderCommitmentTransaction {
1525 pub(crate) fn get_native_ref(&self) -> &'static nativeHolderCommitmentTransaction {
1526 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1528 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeHolderCommitmentTransaction {
1529 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1531 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1532 pub(crate) fn take_inner(mut self) -> *mut nativeHolderCommitmentTransaction {
1533 assert!(self.is_owned);
1534 let ret = ObjOps::untweak_ptr(self.inner);
1535 self.inner = core::ptr::null_mut();
1539 /// Our counterparty's signature for the transaction
1541 pub extern "C" fn HolderCommitmentTransaction_get_counterparty_sig(this_ptr: &HolderCommitmentTransaction) -> crate::c_types::ECDSASignature {
1542 let mut inner_val = &mut this_ptr.get_native_mut_ref().counterparty_sig;
1543 crate::c_types::ECDSASignature::from_rust(&inner_val)
1545 /// Our counterparty's signature for the transaction
1547 pub extern "C" fn HolderCommitmentTransaction_set_counterparty_sig(this_ptr: &mut HolderCommitmentTransaction, mut val: crate::c_types::ECDSASignature) {
1548 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.counterparty_sig = val.into_rust();
1550 /// All non-dust counterparty HTLC signatures, in the order they appear in the transaction
1552 /// Returns a copy of the field.
1554 pub extern "C" fn HolderCommitmentTransaction_get_counterparty_htlc_sigs(this_ptr: &HolderCommitmentTransaction) -> crate::c_types::derived::CVec_ECDSASignatureZ {
1555 let mut inner_val = this_ptr.get_native_mut_ref().counterparty_htlc_sigs.clone();
1556 let mut local_inner_val = Vec::new(); for mut item in inner_val.drain(..) { local_inner_val.push( { crate::c_types::ECDSASignature::from_rust(&item) }); };
1557 local_inner_val.into()
1559 /// All non-dust counterparty HTLC signatures, in the order they appear in the transaction
1561 pub extern "C" fn HolderCommitmentTransaction_set_counterparty_htlc_sigs(this_ptr: &mut HolderCommitmentTransaction, mut val: crate::c_types::derived::CVec_ECDSASignatureZ) {
1562 let mut local_val = Vec::new(); for mut item in val.into_rust().drain(..) { local_val.push( { item.into_rust() }); };
1563 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.counterparty_htlc_sigs = local_val;
1565 impl Clone for HolderCommitmentTransaction {
1566 fn clone(&self) -> Self {
1568 inner: if <*mut nativeHolderCommitmentTransaction>::is_null(self.inner) { core::ptr::null_mut() } else {
1569 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1575 /// Used only if an object of this type is returned as a trait impl by a method
1576 pub(crate) extern "C" fn HolderCommitmentTransaction_clone_void(this_ptr: *const c_void) -> *mut c_void {
1577 Box::into_raw(Box::new(unsafe { (*(this_ptr as *const nativeHolderCommitmentTransaction)).clone() })) as *mut c_void
1580 /// Creates a copy of the HolderCommitmentTransaction
1581 pub extern "C" fn HolderCommitmentTransaction_clone(orig: &HolderCommitmentTransaction) -> HolderCommitmentTransaction {
1584 /// Get a string which allows debug introspection of a HolderCommitmentTransaction object
1585 pub extern "C" fn HolderCommitmentTransaction_debug_str_void(o: *const c_void) -> Str {
1586 alloc::format!("{:?}", unsafe { o as *const crate::lightning::ln::chan_utils::HolderCommitmentTransaction }).into()}
1588 /// Serialize the HolderCommitmentTransaction object into a byte array which can be read by HolderCommitmentTransaction_read
1589 pub extern "C" fn HolderCommitmentTransaction_write(obj: &crate::lightning::ln::chan_utils::HolderCommitmentTransaction) -> crate::c_types::derived::CVec_u8Z {
1590 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
1593 pub(crate) extern "C" fn HolderCommitmentTransaction_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1594 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeHolderCommitmentTransaction) })
1597 /// Read a HolderCommitmentTransaction from a byte array, created by HolderCommitmentTransaction_write
1598 pub extern "C" fn HolderCommitmentTransaction_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_HolderCommitmentTransactionDecodeErrorZ {
1599 let res: Result<lightning::ln::chan_utils::HolderCommitmentTransaction, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
1600 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::native_into(e) }).into() };
1603 /// Create a new holder transaction with the given counterparty signatures.
1604 /// The funding keys are used to figure out which signature should go first when building the transaction for broadcast.
1607 pub extern "C" fn HolderCommitmentTransaction_new(mut commitment_tx: crate::lightning::ln::chan_utils::CommitmentTransaction, mut counterparty_sig: crate::c_types::ECDSASignature, mut counterparty_htlc_sigs: crate::c_types::derived::CVec_ECDSASignatureZ, mut holder_funding_key: crate::c_types::PublicKey, mut counterparty_funding_key: crate::c_types::PublicKey) -> crate::lightning::ln::chan_utils::HolderCommitmentTransaction {
1608 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() }); };
1609 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());
1610 crate::lightning::ln::chan_utils::HolderCommitmentTransaction { inner: ObjOps::heap_alloc(ret), is_owned: true }
1614 use lightning::ln::chan_utils::BuiltCommitmentTransaction as nativeBuiltCommitmentTransactionImport;
1615 pub(crate) type nativeBuiltCommitmentTransaction = nativeBuiltCommitmentTransactionImport;
1617 /// A pre-built Bitcoin commitment transaction and its txid.
1620 pub struct BuiltCommitmentTransaction {
1621 /// A pointer to the opaque Rust object.
1623 /// Nearly everywhere, inner must be non-null, however in places where
1624 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1625 pub inner: *mut nativeBuiltCommitmentTransaction,
1626 /// Indicates that this is the only struct which contains the same pointer.
1628 /// Rust functions which take ownership of an object provided via an argument require
1629 /// this to be true and invalidate the object pointed to by inner.
1633 impl Drop for BuiltCommitmentTransaction {
1634 fn drop(&mut self) {
1635 if self.is_owned && !<*mut nativeBuiltCommitmentTransaction>::is_null(self.inner) {
1636 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1640 /// Frees any resources used by the BuiltCommitmentTransaction, if is_owned is set and inner is non-NULL.
1642 pub extern "C" fn BuiltCommitmentTransaction_free(this_obj: BuiltCommitmentTransaction) { }
1644 /// Used only if an object of this type is returned as a trait impl by a method
1645 pub(crate) extern "C" fn BuiltCommitmentTransaction_free_void(this_ptr: *mut c_void) {
1646 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeBuiltCommitmentTransaction) };
1649 impl BuiltCommitmentTransaction {
1650 pub(crate) fn get_native_ref(&self) -> &'static nativeBuiltCommitmentTransaction {
1651 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1653 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeBuiltCommitmentTransaction {
1654 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1656 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1657 pub(crate) fn take_inner(mut self) -> *mut nativeBuiltCommitmentTransaction {
1658 assert!(self.is_owned);
1659 let ret = ObjOps::untweak_ptr(self.inner);
1660 self.inner = core::ptr::null_mut();
1664 /// The commitment transaction
1666 pub extern "C" fn BuiltCommitmentTransaction_get_transaction(this_ptr: &BuiltCommitmentTransaction) -> crate::c_types::Transaction {
1667 let mut inner_val = &mut this_ptr.get_native_mut_ref().transaction;
1668 crate::c_types::Transaction::from_bitcoin(inner_val)
1670 /// The commitment transaction
1672 pub extern "C" fn BuiltCommitmentTransaction_set_transaction(this_ptr: &mut BuiltCommitmentTransaction, mut val: crate::c_types::Transaction) {
1673 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.transaction = val.into_bitcoin();
1675 /// The txid for the commitment transaction.
1677 /// This is provided as a performance optimization, instead of calling transaction.txid()
1680 pub extern "C" fn BuiltCommitmentTransaction_get_txid(this_ptr: &BuiltCommitmentTransaction) -> *const [u8; 32] {
1681 let mut inner_val = &mut this_ptr.get_native_mut_ref().txid;
1684 /// The txid for the commitment transaction.
1686 /// This is provided as a performance optimization, instead of calling transaction.txid()
1689 pub extern "C" fn BuiltCommitmentTransaction_set_txid(this_ptr: &mut BuiltCommitmentTransaction, mut val: crate::c_types::ThirtyTwoBytes) {
1690 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.txid = ::bitcoin::hash_types::Txid::from_slice(&val.data[..]).unwrap();
1692 /// Constructs a new BuiltCommitmentTransaction given each field
1695 pub extern "C" fn BuiltCommitmentTransaction_new(mut transaction_arg: crate::c_types::Transaction, mut txid_arg: crate::c_types::ThirtyTwoBytes) -> BuiltCommitmentTransaction {
1696 BuiltCommitmentTransaction { inner: ObjOps::heap_alloc(nativeBuiltCommitmentTransaction {
1697 transaction: transaction_arg.into_bitcoin(),
1698 txid: ::bitcoin::hash_types::Txid::from_slice(&txid_arg.data[..]).unwrap(),
1699 }), is_owned: true }
1701 impl Clone for BuiltCommitmentTransaction {
1702 fn clone(&self) -> Self {
1704 inner: if <*mut nativeBuiltCommitmentTransaction>::is_null(self.inner) { core::ptr::null_mut() } else {
1705 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1711 /// Used only if an object of this type is returned as a trait impl by a method
1712 pub(crate) extern "C" fn BuiltCommitmentTransaction_clone_void(this_ptr: *const c_void) -> *mut c_void {
1713 Box::into_raw(Box::new(unsafe { (*(this_ptr as *const nativeBuiltCommitmentTransaction)).clone() })) as *mut c_void
1716 /// Creates a copy of the BuiltCommitmentTransaction
1717 pub extern "C" fn BuiltCommitmentTransaction_clone(orig: &BuiltCommitmentTransaction) -> BuiltCommitmentTransaction {
1720 /// Get a string which allows debug introspection of a BuiltCommitmentTransaction object
1721 pub extern "C" fn BuiltCommitmentTransaction_debug_str_void(o: *const c_void) -> Str {
1722 alloc::format!("{:?}", unsafe { o as *const crate::lightning::ln::chan_utils::BuiltCommitmentTransaction }).into()}
1724 /// Serialize the BuiltCommitmentTransaction object into a byte array which can be read by BuiltCommitmentTransaction_read
1725 pub extern "C" fn BuiltCommitmentTransaction_write(obj: &crate::lightning::ln::chan_utils::BuiltCommitmentTransaction) -> crate::c_types::derived::CVec_u8Z {
1726 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
1729 pub(crate) extern "C" fn BuiltCommitmentTransaction_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1730 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeBuiltCommitmentTransaction) })
1733 /// Read a BuiltCommitmentTransaction from a byte array, created by BuiltCommitmentTransaction_write
1734 pub extern "C" fn BuiltCommitmentTransaction_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_BuiltCommitmentTransactionDecodeErrorZ {
1735 let res: Result<lightning::ln::chan_utils::BuiltCommitmentTransaction, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
1736 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::native_into(e) }).into() };
1739 /// Get the SIGHASH_ALL sighash value of the transaction.
1741 /// This can be used to verify a signature.
1744 pub extern "C" fn BuiltCommitmentTransaction_get_sighash_all(this_arg: &crate::lightning::ln::chan_utils::BuiltCommitmentTransaction, mut funding_redeemscript: crate::c_types::u8slice, mut channel_value_satoshis: u64) -> crate::c_types::ThirtyTwoBytes {
1745 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_sighash_all(::bitcoin::blockdata::script::Script::from_bytes(funding_redeemscript.to_slice()), channel_value_satoshis);
1746 crate::c_types::ThirtyTwoBytes { data: ret.as_ref().clone() }
1749 /// Signs the counterparty's commitment transaction.
1752 pub extern "C" fn BuiltCommitmentTransaction_sign_counterparty_commitment(this_arg: &crate::lightning::ln::chan_utils::BuiltCommitmentTransaction, funding_key: *const [u8; 32], mut funding_redeemscript: crate::c_types::u8slice, mut channel_value_satoshis: u64) -> crate::c_types::ECDSASignature {
1753 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.sign_counterparty_commitment(&::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *funding_key}[..]).unwrap(), ::bitcoin::blockdata::script::Script::from_bytes(funding_redeemscript.to_slice()), channel_value_satoshis, secp256k1::global::SECP256K1);
1754 crate::c_types::ECDSASignature::from_rust(&ret)
1757 /// Signs the holder commitment transaction because we are about to broadcast it.
1760 pub extern "C" fn BuiltCommitmentTransaction_sign_holder_commitment(this_arg: &crate::lightning::ln::chan_utils::BuiltCommitmentTransaction, funding_key: *const [u8; 32], mut funding_redeemscript: crate::c_types::u8slice, mut channel_value_satoshis: u64, entropy_source: &crate::lightning::sign::EntropySource) -> crate::c_types::ECDSASignature {
1761 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.sign_holder_commitment(&::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *funding_key}[..]).unwrap(), ::bitcoin::blockdata::script::Script::from_bytes(funding_redeemscript.to_slice()), channel_value_satoshis, entropy_source, secp256k1::global::SECP256K1);
1762 crate::c_types::ECDSASignature::from_rust(&ret)
1766 use lightning::ln::chan_utils::ClosingTransaction as nativeClosingTransactionImport;
1767 pub(crate) type nativeClosingTransaction = nativeClosingTransactionImport;
1769 /// This class tracks the per-transaction information needed to build a closing transaction and will
1770 /// actually build it and sign.
1772 /// This class can be used inside a signer implementation to generate a signature given the relevant
1776 pub struct ClosingTransaction {
1777 /// A pointer to the opaque Rust object.
1779 /// Nearly everywhere, inner must be non-null, however in places where
1780 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1781 pub inner: *mut nativeClosingTransaction,
1782 /// Indicates that this is the only struct which contains the same pointer.
1784 /// Rust functions which take ownership of an object provided via an argument require
1785 /// this to be true and invalidate the object pointed to by inner.
1789 impl Drop for ClosingTransaction {
1790 fn drop(&mut self) {
1791 if self.is_owned && !<*mut nativeClosingTransaction>::is_null(self.inner) {
1792 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1796 /// Frees any resources used by the ClosingTransaction, if is_owned is set and inner is non-NULL.
1798 pub extern "C" fn ClosingTransaction_free(this_obj: ClosingTransaction) { }
1800 /// Used only if an object of this type is returned as a trait impl by a method
1801 pub(crate) extern "C" fn ClosingTransaction_free_void(this_ptr: *mut c_void) {
1802 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeClosingTransaction) };
1805 impl ClosingTransaction {
1806 pub(crate) fn get_native_ref(&self) -> &'static nativeClosingTransaction {
1807 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1809 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeClosingTransaction {
1810 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1812 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1813 pub(crate) fn take_inner(mut self) -> *mut nativeClosingTransaction {
1814 assert!(self.is_owned);
1815 let ret = ObjOps::untweak_ptr(self.inner);
1816 self.inner = core::ptr::null_mut();
1820 impl Clone for ClosingTransaction {
1821 fn clone(&self) -> Self {
1823 inner: if <*mut nativeClosingTransaction>::is_null(self.inner) { core::ptr::null_mut() } else {
1824 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1830 /// Used only if an object of this type is returned as a trait impl by a method
1831 pub(crate) extern "C" fn ClosingTransaction_clone_void(this_ptr: *const c_void) -> *mut c_void {
1832 Box::into_raw(Box::new(unsafe { (*(this_ptr as *const nativeClosingTransaction)).clone() })) as *mut c_void
1835 /// Creates a copy of the ClosingTransaction
1836 pub extern "C" fn ClosingTransaction_clone(orig: &ClosingTransaction) -> ClosingTransaction {
1839 /// Generates a non-cryptographic 64-bit hash of the ClosingTransaction.
1841 pub extern "C" fn ClosingTransaction_hash(o: &ClosingTransaction) -> u64 {
1842 if o.inner.is_null() { return 0; }
1843 // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
1844 #[allow(deprecated)]
1845 let mut hasher = core::hash::SipHasher::new();
1846 core::hash::Hash::hash(o.get_native_ref(), &mut hasher);
1847 core::hash::Hasher::finish(&hasher)
1849 /// Checks if two ClosingTransactions contain equal inner contents.
1850 /// This ignores pointers and is_owned flags and looks at the values in fields.
1851 /// Two objects with NULL inner values will be considered "equal" here.
1853 pub extern "C" fn ClosingTransaction_eq(a: &ClosingTransaction, b: &ClosingTransaction) -> bool {
1854 if a.inner == b.inner { return true; }
1855 if a.inner.is_null() || b.inner.is_null() { return false; }
1856 if a.get_native_ref() == b.get_native_ref() { true } else { false }
1858 /// Construct an object of the class
1861 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) -> crate::lightning::ln::chan_utils::ClosingTransaction {
1862 let mut ret = lightning::ln::chan_utils::ClosingTransaction::new(to_holder_value_sat, to_counterparty_value_sat, ::bitcoin::blockdata::script::ScriptBuf::from(to_holder_script.into_rust()), ::bitcoin::blockdata::script::ScriptBuf::from(to_counterparty_script.into_rust()), crate::c_types::C_to_bitcoin_outpoint(funding_outpoint));
1863 crate::lightning::ln::chan_utils::ClosingTransaction { inner: ObjOps::heap_alloc(ret), is_owned: true }
1866 /// Trust our pre-built transaction.
1868 /// Applies a wrapper which allows access to the transaction.
1870 /// This should only be used if you fully trust the builder of this object. It should not
1871 /// be used by an external signer - instead use the verify function.
1874 pub extern "C" fn ClosingTransaction_trust(this_arg: &crate::lightning::ln::chan_utils::ClosingTransaction) -> crate::lightning::ln::chan_utils::TrustedClosingTransaction {
1875 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.trust();
1876 crate::lightning::ln::chan_utils::TrustedClosingTransaction { inner: ObjOps::heap_alloc(ret), is_owned: true }
1879 /// Verify our pre-built transaction.
1881 /// Applies a wrapper which allows access to the transaction.
1883 /// An external validating signer must call this method before signing
1884 /// or using the built transaction.
1887 pub extern "C" fn ClosingTransaction_verify(this_arg: &crate::lightning::ln::chan_utils::ClosingTransaction, mut funding_outpoint: crate::lightning::chain::transaction::OutPoint) -> crate::c_types::derived::CResult_TrustedClosingTransactionNoneZ {
1888 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.verify(crate::c_types::C_to_bitcoin_outpoint(funding_outpoint));
1889 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() };
1893 /// The value to be sent to the holder, or zero if the output will be omitted
1896 pub extern "C" fn ClosingTransaction_to_holder_value_sat(this_arg: &crate::lightning::ln::chan_utils::ClosingTransaction) -> u64 {
1897 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.to_holder_value_sat();
1901 /// The value to be sent to the counterparty, or zero if the output will be omitted
1904 pub extern "C" fn ClosingTransaction_to_counterparty_value_sat(this_arg: &crate::lightning::ln::chan_utils::ClosingTransaction) -> u64 {
1905 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.to_counterparty_value_sat();
1909 /// The destination of the holder's output
1912 pub extern "C" fn ClosingTransaction_to_holder_script(this_arg: &crate::lightning::ln::chan_utils::ClosingTransaction) -> crate::c_types::u8slice {
1913 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.to_holder_script();
1914 crate::c_types::u8slice::from_slice(ret.as_ref())
1917 /// The destination of the counterparty's output
1920 pub extern "C" fn ClosingTransaction_to_counterparty_script(this_arg: &crate::lightning::ln::chan_utils::ClosingTransaction) -> crate::c_types::u8slice {
1921 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.to_counterparty_script();
1922 crate::c_types::u8slice::from_slice(ret.as_ref())
1926 use lightning::ln::chan_utils::TrustedClosingTransaction as nativeTrustedClosingTransactionImport;
1927 pub(crate) type nativeTrustedClosingTransaction = nativeTrustedClosingTransactionImport<'static, >;
1929 /// A wrapper on ClosingTransaction indicating that the built bitcoin
1930 /// transaction is trusted.
1932 /// See trust() and verify() functions on CommitmentTransaction.
1934 /// This structure implements Deref.
1937 pub struct TrustedClosingTransaction {
1938 /// A pointer to the opaque Rust object.
1940 /// Nearly everywhere, inner must be non-null, however in places where
1941 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1942 pub inner: *mut nativeTrustedClosingTransaction,
1943 /// Indicates that this is the only struct which contains the same pointer.
1945 /// Rust functions which take ownership of an object provided via an argument require
1946 /// this to be true and invalidate the object pointed to by inner.
1950 impl Drop for TrustedClosingTransaction {
1951 fn drop(&mut self) {
1952 if self.is_owned && !<*mut nativeTrustedClosingTransaction>::is_null(self.inner) {
1953 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1957 /// Frees any resources used by the TrustedClosingTransaction, if is_owned is set and inner is non-NULL.
1959 pub extern "C" fn TrustedClosingTransaction_free(this_obj: TrustedClosingTransaction) { }
1961 /// Used only if an object of this type is returned as a trait impl by a method
1962 pub(crate) extern "C" fn TrustedClosingTransaction_free_void(this_ptr: *mut c_void) {
1963 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeTrustedClosingTransaction) };
1966 impl TrustedClosingTransaction {
1967 pub(crate) fn get_native_ref(&self) -> &'static nativeTrustedClosingTransaction {
1968 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1970 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeTrustedClosingTransaction {
1971 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1973 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1974 pub(crate) fn take_inner(mut self) -> *mut nativeTrustedClosingTransaction {
1975 assert!(self.is_owned);
1976 let ret = ObjOps::untweak_ptr(self.inner);
1977 self.inner = core::ptr::null_mut();
1981 /// The pre-built Bitcoin commitment transaction
1984 pub extern "C" fn TrustedClosingTransaction_built_transaction(this_arg: &crate::lightning::ln::chan_utils::TrustedClosingTransaction) -> crate::c_types::Transaction {
1985 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.built_transaction();
1986 crate::c_types::Transaction::from_bitcoin(ret)
1989 /// Get the SIGHASH_ALL sighash value of the transaction.
1991 /// This can be used to verify a signature.
1994 pub extern "C" fn TrustedClosingTransaction_get_sighash_all(this_arg: &crate::lightning::ln::chan_utils::TrustedClosingTransaction, mut funding_redeemscript: crate::c_types::u8slice, mut channel_value_satoshis: u64) -> crate::c_types::ThirtyTwoBytes {
1995 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_sighash_all(::bitcoin::blockdata::script::Script::from_bytes(funding_redeemscript.to_slice()), channel_value_satoshis);
1996 crate::c_types::ThirtyTwoBytes { data: ret.as_ref().clone() }
1999 /// Sign a transaction, either because we are counter-signing the counterparty's transaction or
2000 /// because we are about to broadcast a holder transaction.
2003 pub extern "C" fn TrustedClosingTransaction_sign(this_arg: &crate::lightning::ln::chan_utils::TrustedClosingTransaction, funding_key: *const [u8; 32], mut funding_redeemscript: crate::c_types::u8slice, mut channel_value_satoshis: u64) -> crate::c_types::ECDSASignature {
2004 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.sign(&::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *funding_key}[..]).unwrap(), ::bitcoin::blockdata::script::Script::from_bytes(funding_redeemscript.to_slice()), channel_value_satoshis, secp256k1::global::SECP256K1);
2005 crate::c_types::ECDSASignature::from_rust(&ret)
2009 use lightning::ln::chan_utils::CommitmentTransaction as nativeCommitmentTransactionImport;
2010 pub(crate) type nativeCommitmentTransaction = nativeCommitmentTransactionImport;
2012 /// This class tracks the per-transaction information needed to build a commitment transaction and will
2013 /// actually build it and sign. It is used for holder transactions that we sign only when needed
2014 /// and for transactions we sign for the counterparty.
2016 /// This class can be used inside a signer implementation to generate a signature given the relevant
2020 pub struct CommitmentTransaction {
2021 /// A pointer to the opaque Rust object.
2023 /// Nearly everywhere, inner must be non-null, however in places where
2024 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
2025 pub inner: *mut nativeCommitmentTransaction,
2026 /// Indicates that this is the only struct which contains the same pointer.
2028 /// Rust functions which take ownership of an object provided via an argument require
2029 /// this to be true and invalidate the object pointed to by inner.
2033 impl Drop for CommitmentTransaction {
2034 fn drop(&mut self) {
2035 if self.is_owned && !<*mut nativeCommitmentTransaction>::is_null(self.inner) {
2036 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
2040 /// Frees any resources used by the CommitmentTransaction, if is_owned is set and inner is non-NULL.
2042 pub extern "C" fn CommitmentTransaction_free(this_obj: CommitmentTransaction) { }
2044 /// Used only if an object of this type is returned as a trait impl by a method
2045 pub(crate) extern "C" fn CommitmentTransaction_free_void(this_ptr: *mut c_void) {
2046 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeCommitmentTransaction) };
2049 impl CommitmentTransaction {
2050 pub(crate) fn get_native_ref(&self) -> &'static nativeCommitmentTransaction {
2051 unsafe { &*ObjOps::untweak_ptr(self.inner) }
2053 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeCommitmentTransaction {
2054 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
2056 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
2057 pub(crate) fn take_inner(mut self) -> *mut nativeCommitmentTransaction {
2058 assert!(self.is_owned);
2059 let ret = ObjOps::untweak_ptr(self.inner);
2060 self.inner = core::ptr::null_mut();
2064 impl Clone for CommitmentTransaction {
2065 fn clone(&self) -> Self {
2067 inner: if <*mut nativeCommitmentTransaction>::is_null(self.inner) { core::ptr::null_mut() } else {
2068 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
2074 /// Used only if an object of this type is returned as a trait impl by a method
2075 pub(crate) extern "C" fn CommitmentTransaction_clone_void(this_ptr: *const c_void) -> *mut c_void {
2076 Box::into_raw(Box::new(unsafe { (*(this_ptr as *const nativeCommitmentTransaction)).clone() })) as *mut c_void
2079 /// Creates a copy of the CommitmentTransaction
2080 pub extern "C" fn CommitmentTransaction_clone(orig: &CommitmentTransaction) -> CommitmentTransaction {
2083 /// Get a string which allows debug introspection of a CommitmentTransaction object
2084 pub extern "C" fn CommitmentTransaction_debug_str_void(o: *const c_void) -> Str {
2085 alloc::format!("{:?}", unsafe { o as *const crate::lightning::ln::chan_utils::CommitmentTransaction }).into()}
2087 /// Serialize the CommitmentTransaction object into a byte array which can be read by CommitmentTransaction_read
2088 pub extern "C" fn CommitmentTransaction_write(obj: &crate::lightning::ln::chan_utils::CommitmentTransaction) -> crate::c_types::derived::CVec_u8Z {
2089 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
2092 pub(crate) extern "C" fn CommitmentTransaction_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
2093 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeCommitmentTransaction) })
2096 /// Read a CommitmentTransaction from a byte array, created by CommitmentTransaction_write
2097 pub extern "C" fn CommitmentTransaction_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_CommitmentTransactionDecodeErrorZ {
2098 let res: Result<lightning::ln::chan_utils::CommitmentTransaction, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
2099 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::native_into(e) }).into() };
2102 /// The backwards-counting commitment number
2105 pub extern "C" fn CommitmentTransaction_commitment_number(this_arg: &crate::lightning::ln::chan_utils::CommitmentTransaction) -> u64 {
2106 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.commitment_number();
2110 /// The per commitment point used by the broadcaster.
2113 pub extern "C" fn CommitmentTransaction_per_commitment_point(this_arg: &crate::lightning::ln::chan_utils::CommitmentTransaction) -> crate::c_types::PublicKey {
2114 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.per_commitment_point();
2115 crate::c_types::PublicKey::from_rust(&ret)
2118 /// The value to be sent to the broadcaster
2121 pub extern "C" fn CommitmentTransaction_to_broadcaster_value_sat(this_arg: &crate::lightning::ln::chan_utils::CommitmentTransaction) -> u64 {
2122 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.to_broadcaster_value_sat();
2126 /// The value to be sent to the counterparty
2129 pub extern "C" fn CommitmentTransaction_to_countersignatory_value_sat(this_arg: &crate::lightning::ln::chan_utils::CommitmentTransaction) -> u64 {
2130 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.to_countersignatory_value_sat();
2134 /// The feerate paid per 1000-weight-unit in this commitment transaction.
2137 pub extern "C" fn CommitmentTransaction_feerate_per_kw(this_arg: &crate::lightning::ln::chan_utils::CommitmentTransaction) -> u32 {
2138 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.feerate_per_kw();
2142 /// Trust our pre-built transaction and derived transaction creation public keys.
2144 /// Applies a wrapper which allows access to these fields.
2146 /// This should only be used if you fully trust the builder of this object. It should not
2147 /// be used by an external signer - instead use the verify function.
2150 pub extern "C" fn CommitmentTransaction_trust(this_arg: &crate::lightning::ln::chan_utils::CommitmentTransaction) -> crate::lightning::ln::chan_utils::TrustedCommitmentTransaction {
2151 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.trust();
2152 crate::lightning::ln::chan_utils::TrustedCommitmentTransaction { inner: ObjOps::heap_alloc(ret), is_owned: true }
2155 /// Verify our pre-built transaction and derived transaction creation public keys.
2157 /// Applies a wrapper which allows access to these fields.
2159 /// An external validating signer must call this method before signing
2160 /// or using the built transaction.
2163 pub extern "C" fn CommitmentTransaction_verify(this_arg: &crate::lightning::ln::chan_utils::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 {
2164 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::global::SECP256K1);
2165 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() };
2170 use lightning::ln::chan_utils::TrustedCommitmentTransaction as nativeTrustedCommitmentTransactionImport;
2171 pub(crate) type nativeTrustedCommitmentTransaction = nativeTrustedCommitmentTransactionImport<'static, >;
2173 /// A wrapper on CommitmentTransaction indicating that the derived fields (the built bitcoin
2174 /// transaction and the transaction creation keys) are trusted.
2176 /// See trust() and verify() functions on CommitmentTransaction.
2178 /// This structure implements Deref.
2181 pub struct TrustedCommitmentTransaction {
2182 /// A pointer to the opaque Rust object.
2184 /// Nearly everywhere, inner must be non-null, however in places where
2185 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
2186 pub inner: *mut nativeTrustedCommitmentTransaction,
2187 /// Indicates that this is the only struct which contains the same pointer.
2189 /// Rust functions which take ownership of an object provided via an argument require
2190 /// this to be true and invalidate the object pointed to by inner.
2194 impl Drop for TrustedCommitmentTransaction {
2195 fn drop(&mut self) {
2196 if self.is_owned && !<*mut nativeTrustedCommitmentTransaction>::is_null(self.inner) {
2197 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
2201 /// Frees any resources used by the TrustedCommitmentTransaction, if is_owned is set and inner is non-NULL.
2203 pub extern "C" fn TrustedCommitmentTransaction_free(this_obj: TrustedCommitmentTransaction) { }
2205 /// Used only if an object of this type is returned as a trait impl by a method
2206 pub(crate) extern "C" fn TrustedCommitmentTransaction_free_void(this_ptr: *mut c_void) {
2207 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeTrustedCommitmentTransaction) };
2210 impl TrustedCommitmentTransaction {
2211 pub(crate) fn get_native_ref(&self) -> &'static nativeTrustedCommitmentTransaction {
2212 unsafe { &*ObjOps::untweak_ptr(self.inner) }
2214 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeTrustedCommitmentTransaction {
2215 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
2217 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
2218 pub(crate) fn take_inner(mut self) -> *mut nativeTrustedCommitmentTransaction {
2219 assert!(self.is_owned);
2220 let ret = ObjOps::untweak_ptr(self.inner);
2221 self.inner = core::ptr::null_mut();
2225 /// The transaction ID of the built Bitcoin transaction
2228 pub extern "C" fn TrustedCommitmentTransaction_txid(this_arg: &crate::lightning::ln::chan_utils::TrustedCommitmentTransaction) -> crate::c_types::ThirtyTwoBytes {
2229 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.txid();
2230 crate::c_types::ThirtyTwoBytes { data: *ret.as_ref() }
2233 /// The pre-built Bitcoin commitment transaction
2236 pub extern "C" fn TrustedCommitmentTransaction_built_transaction(this_arg: &crate::lightning::ln::chan_utils::TrustedCommitmentTransaction) -> crate::lightning::ln::chan_utils::BuiltCommitmentTransaction {
2237 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.built_transaction();
2238 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 }
2241 /// The pre-calculated transaction creation public keys.
2244 pub extern "C" fn TrustedCommitmentTransaction_keys(this_arg: &crate::lightning::ln::chan_utils::TrustedCommitmentTransaction) -> crate::lightning::ln::chan_utils::TxCreationKeys {
2245 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.keys();
2246 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 }
2249 /// Should anchors be used.
2252 pub extern "C" fn TrustedCommitmentTransaction_channel_type_features(this_arg: &crate::lightning::ln::chan_utils::TrustedCommitmentTransaction) -> crate::lightning::ln::features::ChannelTypeFeatures {
2253 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.channel_type_features();
2254 crate::lightning::ln::features::ChannelTypeFeatures { inner: unsafe { ObjOps::nonnull_ptr_to_inner((ret as *const lightning::ln::features::ChannelTypeFeatures<>) as *mut _) }, is_owned: false }
2257 /// Get a signature for each HTLC which was included in the commitment transaction (ie for
2258 /// which HTLCOutputInCommitment::transaction_output_index.is_some()).
2260 /// The returned Vec has one entry for each HTLC, and in the same order.
2262 /// This function is only valid in the holder commitment context, it always uses EcdsaSighashType::All.
2265 pub extern "C" fn TrustedCommitmentTransaction_get_htlc_sigs(this_arg: &crate::lightning::ln::chan_utils::TrustedCommitmentTransaction, htlc_base_key: *const [u8; 32], channel_parameters: &crate::lightning::ln::chan_utils::DirectedChannelTransactionParameters, entropy_source: &crate::lightning::sign::EntropySource) -> crate::c_types::derived::CResult_CVec_ECDSASignatureZNoneZ {
2266 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_htlc_sigs(&::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *htlc_base_key}[..]).unwrap(), channel_parameters.get_native_ref(), entropy_source, secp256k1::global::SECP256K1);
2267 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::ECDSASignature::from_rust(&item) }); }; local_ret_0.into() }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
2271 /// Returns the index of the revokeable output, i.e. the `to_local` output sending funds to
2272 /// the broadcaster, in the built transaction, if any exists.
2274 /// There are two cases where this may return `None`:
2275 /// - The balance of the revokeable output is below the dust limit (only found on commitments
2276 /// early in the channel's lifetime, i.e. before the channel reserve is met).
2277 /// - This commitment was created before LDK 0.0.117. In this case, the
2278 /// commitment transaction previously didn't contain enough information to locate the
2279 /// revokeable output.
2282 pub extern "C" fn TrustedCommitmentTransaction_revokeable_output_index(this_arg: &crate::lightning::ln::chan_utils::TrustedCommitmentTransaction) -> crate::c_types::derived::COption_usizeZ {
2283 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.revokeable_output_index();
2284 let mut local_ret = if ret.is_none() { crate::c_types::derived::COption_usizeZ::None } else { crate::c_types::derived::COption_usizeZ::Some( { ret.unwrap() }) };
2288 /// Helper method to build an unsigned justice transaction spending the revokeable
2289 /// `to_local` output to a destination script. Fee estimation accounts for the expected
2290 /// revocation witness data that will be added when signed.
2292 /// This method will error if the given fee rate results in a fee greater than the value
2293 /// of the output being spent, or if there exists no revokeable `to_local` output on this
2294 /// commitment transaction. See [`Self::revokeable_output_index`] for more details.
2296 /// The built transaction will allow fee bumping with RBF, and this method takes
2297 /// `feerate_per_kw` as an input such that multiple copies of a justice transaction at different
2298 /// fee rates may be built.
2301 pub extern "C" fn TrustedCommitmentTransaction_build_to_local_justice_tx(this_arg: &crate::lightning::ln::chan_utils::TrustedCommitmentTransaction, mut feerate_per_kw: u64, mut destination_script: crate::c_types::derived::CVec_u8Z) -> crate::c_types::derived::CResult_TransactionNoneZ {
2302 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.build_to_local_justice_tx(feerate_per_kw, ::bitcoin::blockdata::script::ScriptBuf::from(destination_script.into_rust()));
2303 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::Transaction::from_bitcoin(&o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
2307 /// Commitment transaction numbers which appear in the transactions themselves are XOR'd with a
2308 /// shared secret first. This prevents on-chain observers from discovering how many commitment
2309 /// transactions occurred in a channel before it was closed.
2311 /// This function gets the shared secret from relevant channel public keys and can be used to
2312 /// \"decrypt\" the commitment transaction number given a commitment transaction on-chain.
2314 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 {
2315 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);