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 alloc::str::FromStr;
12 use alloc::string::String;
13 use core::ffi::c_void;
14 use core::convert::Infallible;
15 use bitcoin::hashes::Hash;
16 use crate::c_types::*;
17 #[cfg(feature="no-std")]
18 use alloc::{vec::Vec, boxed::Box};
21 use lightning::ln::script::ShutdownScript as nativeShutdownScriptImport;
22 pub(crate) type nativeShutdownScript = nativeShutdownScriptImport;
24 /// A script pubkey for shutting down a channel as defined by [BOLT #2].
26 /// [BOLT #2]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md
29 pub struct ShutdownScript {
30 /// A pointer to the opaque Rust object.
32 /// Nearly everywhere, inner must be non-null, however in places where
33 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
34 pub inner: *mut nativeShutdownScript,
35 /// Indicates that this is the only struct which contains the same pointer.
37 /// Rust functions which take ownership of an object provided via an argument require
38 /// this to be true and invalidate the object pointed to by inner.
42 impl Drop for ShutdownScript {
44 if self.is_owned && !<*mut nativeShutdownScript>::is_null(self.inner) {
45 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
49 /// Frees any resources used by the ShutdownScript, if is_owned is set and inner is non-NULL.
51 pub extern "C" fn ShutdownScript_free(this_obj: ShutdownScript) { }
53 /// Used only if an object of this type is returned as a trait impl by a method
54 pub(crate) extern "C" fn ShutdownScript_free_void(this_ptr: *mut c_void) {
55 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeShutdownScript) };
59 pub(crate) fn get_native_ref(&self) -> &'static nativeShutdownScript {
60 unsafe { &*ObjOps::untweak_ptr(self.inner) }
62 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeShutdownScript {
63 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
65 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
66 pub(crate) fn take_inner(mut self) -> *mut nativeShutdownScript {
67 assert!(self.is_owned);
68 let ret = ObjOps::untweak_ptr(self.inner);
69 self.inner = core::ptr::null_mut();
73 impl Clone for ShutdownScript {
74 fn clone(&self) -> Self {
76 inner: if <*mut nativeShutdownScript>::is_null(self.inner) { core::ptr::null_mut() } else {
77 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
83 /// Used only if an object of this type is returned as a trait impl by a method
84 pub(crate) extern "C" fn ShutdownScript_clone_void(this_ptr: *const c_void) -> *mut c_void {
85 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeShutdownScript)).clone() })) as *mut c_void
88 /// Creates a copy of the ShutdownScript
89 pub extern "C" fn ShutdownScript_clone(orig: &ShutdownScript) -> ShutdownScript {
92 /// Checks if two ShutdownScripts contain equal inner contents.
93 /// This ignores pointers and is_owned flags and looks at the values in fields.
94 /// Two objects with NULL inner values will be considered "equal" here.
96 pub extern "C" fn ShutdownScript_eq(a: &ShutdownScript, b: &ShutdownScript) -> bool {
97 if a.inner == b.inner { return true; }
98 if a.inner.is_null() || b.inner.is_null() { return false; }
99 if a.get_native_ref() == b.get_native_ref() { true } else { false }
102 use lightning::ln::script::InvalidShutdownScript as nativeInvalidShutdownScriptImport;
103 pub(crate) type nativeInvalidShutdownScript = nativeInvalidShutdownScriptImport;
105 /// An error occurring when converting from [`Script`] to [`ShutdownScript`].
108 pub struct InvalidShutdownScript {
109 /// A pointer to the opaque Rust object.
111 /// Nearly everywhere, inner must be non-null, however in places where
112 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
113 pub inner: *mut nativeInvalidShutdownScript,
114 /// Indicates that this is the only struct which contains the same pointer.
116 /// Rust functions which take ownership of an object provided via an argument require
117 /// this to be true and invalidate the object pointed to by inner.
121 impl Drop for InvalidShutdownScript {
123 if self.is_owned && !<*mut nativeInvalidShutdownScript>::is_null(self.inner) {
124 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
128 /// Frees any resources used by the InvalidShutdownScript, if is_owned is set and inner is non-NULL.
130 pub extern "C" fn InvalidShutdownScript_free(this_obj: InvalidShutdownScript) { }
132 /// Used only if an object of this type is returned as a trait impl by a method
133 pub(crate) extern "C" fn InvalidShutdownScript_free_void(this_ptr: *mut c_void) {
134 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeInvalidShutdownScript) };
137 impl InvalidShutdownScript {
138 pub(crate) fn get_native_ref(&self) -> &'static nativeInvalidShutdownScript {
139 unsafe { &*ObjOps::untweak_ptr(self.inner) }
141 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeInvalidShutdownScript {
142 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
144 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
145 pub(crate) fn take_inner(mut self) -> *mut nativeInvalidShutdownScript {
146 assert!(self.is_owned);
147 let ret = ObjOps::untweak_ptr(self.inner);
148 self.inner = core::ptr::null_mut();
152 /// The script that did not meet the requirements from [BOLT #2].
154 /// [BOLT #2]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md
156 pub extern "C" fn InvalidShutdownScript_get_script(this_ptr: &InvalidShutdownScript) -> crate::c_types::u8slice {
157 let mut inner_val = &mut this_ptr.get_native_mut_ref().script;
158 crate::c_types::u8slice::from_slice(&inner_val[..])
160 /// The script that did not meet the requirements from [BOLT #2].
162 /// [BOLT #2]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md
164 pub extern "C" fn InvalidShutdownScript_set_script(this_ptr: &mut InvalidShutdownScript, mut val: crate::c_types::derived::CVec_u8Z) {
165 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.script = ::bitcoin::blockdata::script::Script::from(val.into_rust());
167 /// Constructs a new InvalidShutdownScript given each field
170 pub extern "C" fn InvalidShutdownScript_new(mut script_arg: crate::c_types::derived::CVec_u8Z) -> InvalidShutdownScript {
171 InvalidShutdownScript { inner: ObjOps::heap_alloc(nativeInvalidShutdownScript {
172 script: ::bitcoin::blockdata::script::Script::from(script_arg.into_rust()),
175 impl Clone for InvalidShutdownScript {
176 fn clone(&self) -> Self {
178 inner: if <*mut nativeInvalidShutdownScript>::is_null(self.inner) { core::ptr::null_mut() } else {
179 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
185 /// Used only if an object of this type is returned as a trait impl by a method
186 pub(crate) extern "C" fn InvalidShutdownScript_clone_void(this_ptr: *const c_void) -> *mut c_void {
187 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeInvalidShutdownScript)).clone() })) as *mut c_void
190 /// Creates a copy of the InvalidShutdownScript
191 pub extern "C" fn InvalidShutdownScript_clone(orig: &InvalidShutdownScript) -> InvalidShutdownScript {
195 /// Serialize the ShutdownScript object into a byte array which can be read by ShutdownScript_read
196 pub extern "C" fn ShutdownScript_write(obj: &crate::lightning::ln::script::ShutdownScript) -> crate::c_types::derived::CVec_u8Z {
197 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
200 pub(crate) extern "C" fn ShutdownScript_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
201 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeShutdownScript) })
204 /// Read a ShutdownScript from a byte array, created by ShutdownScript_write
205 pub extern "C" fn ShutdownScript_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ShutdownScriptDecodeErrorZ {
206 let res: Result<lightning::ln::script::ShutdownScript, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
207 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::native_into(e) }).into() };
210 /// Generates a P2WPKH script pubkey from the given [`WPubkeyHash`].
213 pub extern "C" fn ShutdownScript_new_p2wpkh(pubkey_hash: *const [u8; 20]) -> crate::lightning::ln::script::ShutdownScript {
214 let mut ret = lightning::ln::script::ShutdownScript::new_p2wpkh(&bitcoin::hash_types::WPubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *pubkey_hash }.clone())));
215 crate::lightning::ln::script::ShutdownScript { inner: ObjOps::heap_alloc(ret), is_owned: true }
218 /// Generates a P2WSH script pubkey from the given [`WScriptHash`].
221 pub extern "C" fn ShutdownScript_new_p2wsh(script_hash: *const [u8; 32]) -> crate::lightning::ln::script::ShutdownScript {
222 let mut ret = lightning::ln::script::ShutdownScript::new_p2wsh(&bitcoin::hash_types::WScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *script_hash }.clone())));
223 crate::lightning::ln::script::ShutdownScript { inner: ObjOps::heap_alloc(ret), is_owned: true }
226 /// Generates a witness script pubkey from the given segwit version and program.
228 /// Note for version-zero witness scripts you must use [`ShutdownScript::new_p2wpkh`] or
229 /// [`ShutdownScript::new_p2wsh`] instead.
233 /// This function may return an error if `program` is invalid for the segwit `version`.
236 pub extern "C" fn ShutdownScript_new_witness_program(mut version: crate::c_types::WitnessVersion, mut program: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ShutdownScriptInvalidShutdownScriptZ {
237 let mut ret = lightning::ln::script::ShutdownScript::new_witness_program(version.into(), program.to_slice());
238 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() };
242 /// Converts the shutdown script into the underlying [`Script`].
245 pub extern "C" fn ShutdownScript_into_inner(mut this_arg: crate::lightning::ln::script::ShutdownScript) -> crate::c_types::derived::CVec_u8Z {
246 let mut ret = (*unsafe { Box::from_raw(this_arg.take_inner()) }).into_inner();
247 ret.into_bytes().into()
250 /// Returns the [`PublicKey`] used for a P2WPKH shutdown script if constructed directly from it.
252 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
255 pub extern "C" fn ShutdownScript_as_legacy_pubkey(this_arg: &crate::lightning::ln::script::ShutdownScript) -> crate::c_types::PublicKey {
256 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.as_legacy_pubkey();
257 let mut local_ret = if ret.is_none() { crate::c_types::PublicKey::null() } else { { crate::c_types::PublicKey::from_rust(&(ret.unwrap())) } };
261 /// Returns whether the shutdown script is compatible with the features as defined by BOLT #2.
263 /// Specifically, checks for compliance with feature `option_shutdown_anysegwit`.
266 pub extern "C" fn ShutdownScript_is_compatible(this_arg: &crate::lightning::ln::script::ShutdownScript, features: &crate::lightning::ln::features::InitFeatures) -> bool {
267 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.is_compatible(features.get_native_ref());