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 //! Abstractions for scripts used in the Lightning Network.
11 use std::str::FromStr;
13 use bitcoin::hashes::Hash;
14 use crate::c_types::*;
17 use lightning::ln::script::ShutdownScript as nativeShutdownScriptImport;
18 type nativeShutdownScript = nativeShutdownScriptImport;
20 /// A script pubkey for shutting down a channel as defined by [BOLT #2].
22 /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
25 pub struct ShutdownScript {
26 /// A pointer to the opaque Rust object.
28 /// Nearly everywhere, inner must be non-null, however in places where
29 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
30 pub inner: *mut nativeShutdownScript,
31 /// Indicates that this is the only struct which contains the same pointer.
33 /// Rust functions which take ownership of an object provided via an argument require
34 /// this to be true and invalidate the object pointed to by inner.
38 impl Drop for ShutdownScript {
40 if self.is_owned && !<*mut nativeShutdownScript>::is_null(self.inner) {
41 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
45 /// Frees any resources used by the ShutdownScript, if is_owned is set and inner is non-NULL.
47 pub extern "C" fn ShutdownScript_free(this_obj: ShutdownScript) { }
49 /// Used only if an object of this type is returned as a trait impl by a method
50 extern "C" fn ShutdownScript_free_void(this_ptr: *mut c_void) {
51 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeShutdownScript); }
55 pub(crate) fn get_native_ref(&self) -> &'static nativeShutdownScript {
56 unsafe { &*ObjOps::untweak_ptr(self.inner) }
58 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeShutdownScript {
59 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
61 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
62 pub(crate) fn take_inner(mut self) -> *mut nativeShutdownScript {
63 assert!(self.is_owned);
64 let ret = ObjOps::untweak_ptr(self.inner);
65 self.inner = std::ptr::null_mut();
69 impl Clone for ShutdownScript {
70 fn clone(&self) -> Self {
72 inner: if <*mut nativeShutdownScript>::is_null(self.inner) { std::ptr::null_mut() } else {
73 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
79 /// Used only if an object of this type is returned as a trait impl by a method
80 pub(crate) extern "C" fn ShutdownScript_clone_void(this_ptr: *const c_void) -> *mut c_void {
81 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeShutdownScript)).clone() })) as *mut c_void
84 /// Creates a copy of the ShutdownScript
85 pub extern "C" fn ShutdownScript_clone(orig: &ShutdownScript) -> ShutdownScript {
89 use lightning::ln::script::InvalidShutdownScript as nativeInvalidShutdownScriptImport;
90 type nativeInvalidShutdownScript = nativeInvalidShutdownScriptImport;
92 /// An error occurring when converting from [`Script`] to [`ShutdownScript`].
95 pub struct InvalidShutdownScript {
96 /// A pointer to the opaque Rust object.
98 /// Nearly everywhere, inner must be non-null, however in places where
99 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
100 pub inner: *mut nativeInvalidShutdownScript,
101 /// Indicates that this is the only struct which contains the same pointer.
103 /// Rust functions which take ownership of an object provided via an argument require
104 /// this to be true and invalidate the object pointed to by inner.
108 impl Drop for InvalidShutdownScript {
110 if self.is_owned && !<*mut nativeInvalidShutdownScript>::is_null(self.inner) {
111 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
115 /// Frees any resources used by the InvalidShutdownScript, if is_owned is set and inner is non-NULL.
117 pub extern "C" fn InvalidShutdownScript_free(this_obj: InvalidShutdownScript) { }
119 /// Used only if an object of this type is returned as a trait impl by a method
120 extern "C" fn InvalidShutdownScript_free_void(this_ptr: *mut c_void) {
121 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeInvalidShutdownScript); }
124 impl InvalidShutdownScript {
125 pub(crate) fn get_native_ref(&self) -> &'static nativeInvalidShutdownScript {
126 unsafe { &*ObjOps::untweak_ptr(self.inner) }
128 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeInvalidShutdownScript {
129 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
131 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
132 pub(crate) fn take_inner(mut self) -> *mut nativeInvalidShutdownScript {
133 assert!(self.is_owned);
134 let ret = ObjOps::untweak_ptr(self.inner);
135 self.inner = std::ptr::null_mut();
139 /// The script that did not meet the requirements from [BOLT #2].
141 /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
143 pub extern "C" fn InvalidShutdownScript_get_script(this_ptr: &InvalidShutdownScript) -> crate::c_types::u8slice {
144 let mut inner_val = &mut this_ptr.get_native_mut_ref().script;
145 crate::c_types::u8slice::from_slice(&inner_val[..])
147 /// The script that did not meet the requirements from [BOLT #2].
149 /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
151 pub extern "C" fn InvalidShutdownScript_set_script(this_ptr: &mut InvalidShutdownScript, mut val: crate::c_types::derived::CVec_u8Z) {
152 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.script = ::bitcoin::blockdata::script::Script::from(val.into_rust());
154 /// Constructs a new InvalidShutdownScript given each field
157 pub extern "C" fn InvalidShutdownScript_new(mut script_arg: crate::c_types::derived::CVec_u8Z) -> InvalidShutdownScript {
158 InvalidShutdownScript { inner: ObjOps::heap_alloc(nativeInvalidShutdownScript {
159 script: ::bitcoin::blockdata::script::Script::from(script_arg.into_rust()),
163 /// Serialize the ShutdownScript object into a byte array which can be read by ShutdownScript_read
164 pub extern "C" fn ShutdownScript_write(obj: &ShutdownScript) -> crate::c_types::derived::CVec_u8Z {
165 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
168 pub(crate) extern "C" fn ShutdownScript_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
169 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeShutdownScript) })
172 /// Read a ShutdownScript from a byte array, created by ShutdownScript_write
173 pub extern "C" fn ShutdownScript_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ShutdownScriptDecodeErrorZ {
174 let res = crate::c_types::deserialize_obj(ser);
175 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::script::ShutdownScript { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
178 /// Generates a P2PKH script pubkey from the given [`PubkeyHash`].
181 pub extern "C" fn ShutdownScript_new_p2pkh(pubkey_hash: *const [u8; 20]) -> ShutdownScript {
182 let mut ret = lightning::ln::script::ShutdownScript::new_p2pkh(&bitcoin::hash_types::PubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *pubkey_hash }.clone())));
183 ShutdownScript { inner: ObjOps::heap_alloc(ret), is_owned: true }
186 /// Generates a P2SH script pubkey from the given [`ScriptHash`].
189 pub extern "C" fn ShutdownScript_new_p2sh(script_hash: *const [u8; 20]) -> ShutdownScript {
190 let mut ret = lightning::ln::script::ShutdownScript::new_p2sh(&bitcoin::hash_types::ScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *script_hash }.clone())));
191 ShutdownScript { inner: ObjOps::heap_alloc(ret), is_owned: true }
194 /// Generates a P2WPKH script pubkey from the given [`WPubkeyHash`].
197 pub extern "C" fn ShutdownScript_new_p2wpkh(pubkey_hash: *const [u8; 20]) -> ShutdownScript {
198 let mut ret = lightning::ln::script::ShutdownScript::new_p2wpkh(&bitcoin::hash_types::WPubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *pubkey_hash }.clone())));
199 ShutdownScript { inner: ObjOps::heap_alloc(ret), is_owned: true }
202 /// Generates a P2WSH script pubkey from the given [`WScriptHash`].
205 pub extern "C" fn ShutdownScript_new_p2wsh(script_hash: *const [u8; 32]) -> ShutdownScript {
206 let mut ret = lightning::ln::script::ShutdownScript::new_p2wsh(&bitcoin::hash_types::WScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *script_hash }.clone())));
207 ShutdownScript { inner: ObjOps::heap_alloc(ret), is_owned: true }
210 /// Generates a P2WSH script pubkey from the given segwit version and program.
214 /// This function may return an error if `program` is invalid for the segwit `version`.
217 pub extern "C" fn ShutdownScript_new_witness_program(mut version: u8, mut program: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ShutdownScriptInvalidShutdownScriptZ {
218 let mut ret = lightning::ln::script::ShutdownScript::new_witness_program(core::num::NonZeroU8::new(version).expect("Value must be non-zero"), program.to_slice());
219 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::script::ShutdownScript { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::script::InvalidShutdownScript { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
223 /// Converts the shutdown script into the underlying [`Script`].
226 pub extern "C" fn ShutdownScript_into_inner(mut this_arg: ShutdownScript) -> crate::c_types::derived::CVec_u8Z {
227 let mut ret = (*unsafe { Box::from_raw(this_arg.take_inner()) }).into_inner();
228 ret.into_bytes().into()
231 /// Returns the [`PublicKey`] used for a P2WPKH shutdown script if constructed directly from it.
233 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
236 pub extern "C" fn ShutdownScript_as_legacy_pubkey(this_arg: &ShutdownScript) -> crate::c_types::PublicKey {
237 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.as_legacy_pubkey();
238 let mut local_ret = if ret.is_none() { crate::c_types::PublicKey::null() } else { { crate::c_types::PublicKey::from_rust(&(ret.unwrap())) } };
242 /// Returns whether the shutdown script is compatible with the features as defined by BOLT #2.
244 /// Specifically, checks for compliance with feature `option_shutdown_anysegwit`.
247 pub extern "C" fn ShutdownScript_is_compatible(this_arg: &ShutdownScript, features: &crate::lightning::ln::features::InitFeatures) -> bool {
248 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.is_compatible(features.get_native_ref());