_ Git - ldk-c-bindings/blob - lightning-c-bindings/src/lightning/ln/script.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history and in the source files from which this was generated.
   3 //
   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.
   8
   9 //! Abstractions for scripts used in the Lightning Network.
  10
  11 use alloc::str::FromStr;
  12 use core::ffi::c_void;
  13 use core::convert::Infallible;
  14 use bitcoin::hashes::Hash;
  15 use crate::c_types::*;
  16 #[cfg(feature="no-std")]
  17 use alloc::{vec::Vec, boxed::Box};
  18
  19
  20 use lightning::ln::script::ShutdownScript as nativeShutdownScriptImport;
  21 pub(crate) type nativeShutdownScript = nativeShutdownScriptImport;
  22
  23 /// A script pubkey for shutting down a channel as defined by [BOLT #2].
  24 ///
  25 /// [BOLT #2]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md
  26 #[must_use]
  27 #[repr(C)]
  28 pub struct ShutdownScript {
  29         /// A pointer to the opaque Rust object.
  30
  31         /// Nearly everywhere, inner must be non-null, however in places where
  32         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
  33         pub inner: *mut nativeShutdownScript,
  34         /// Indicates that this is the only struct which contains the same pointer.
  35
  36         /// Rust functions which take ownership of an object provided via an argument require
  37         /// this to be true and invalidate the object pointed to by inner.
  38         pub is_owned: bool,
  39 }
  40
  41 impl Drop for ShutdownScript {
  42         fn drop(&mut self) {
  43                 if self.is_owned && !<*mut nativeShutdownScript>::is_null(self.inner) {
  44                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
  45                 }
  46         }
  47 }
  48 /// Frees any resources used by the ShutdownScript, if is_owned is set and inner is non-NULL.
  49 #[no_mangle]
  50 pub extern "C" fn ShutdownScript_free(this_obj: ShutdownScript) { }
  51 #[allow(unused)]
  52 /// Used only if an object of this type is returned as a trait impl by a method
  53 pub(crate) extern "C" fn ShutdownScript_free_void(this_ptr: *mut c_void) {
  54         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeShutdownScript); }
  55 }
  56 #[allow(unused)]
  57 impl ShutdownScript {
  58         pub(crate) fn get_native_ref(&self) -> &'static nativeShutdownScript {
  59                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
  60         }
  61         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeShutdownScript {
  62                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
  63         }
  64         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
  65         pub(crate) fn take_inner(mut self) -> *mut nativeShutdownScript {
  66                 assert!(self.is_owned);
  67                 let ret = ObjOps::untweak_ptr(self.inner);
  68                 self.inner = core::ptr::null_mut();
  69                 ret
  70         }
  71 }
  72 impl Clone for ShutdownScript {
  73         fn clone(&self) -> Self {
  74                 Self {
  75                         inner: if <*mut nativeShutdownScript>::is_null(self.inner) { core::ptr::null_mut() } else {
  76                                 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
  77                         is_owned: true,
  78                 }
  79         }
  80 }
  81 #[allow(unused)]
  82 /// Used only if an object of this type is returned as a trait impl by a method
  83 pub(crate) extern "C" fn ShutdownScript_clone_void(this_ptr: *const c_void) -> *mut c_void {
  84         Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeShutdownScript)).clone() })) as *mut c_void
  85 }
  86 #[no_mangle]
  87 /// Creates a copy of the ShutdownScript
  88 pub extern "C" fn ShutdownScript_clone(orig: &ShutdownScript) -> ShutdownScript {
  89         orig.clone()
  90 }
  91 /// Checks if two ShutdownScripts contain equal inner contents.
  92 /// This ignores pointers and is_owned flags and looks at the values in fields.
  93 /// Two objects with NULL inner values will be considered "equal" here.
  94 #[no_mangle]
  95 pub extern "C" fn ShutdownScript_eq(a: &ShutdownScript, b: &ShutdownScript) -> bool {
  96         if a.inner == b.inner { return true; }
  97         if a.inner.is_null() || b.inner.is_null() { return false; }
  98         if a.get_native_ref() == b.get_native_ref() { true } else { false }
  99 }
 100
 101 use lightning::ln::script::InvalidShutdownScript as nativeInvalidShutdownScriptImport;
 102 pub(crate) type nativeInvalidShutdownScript = nativeInvalidShutdownScriptImport;
 103
 104 /// An error occurring when converting from [`Script`] to [`ShutdownScript`].
 105 #[must_use]
 106 #[repr(C)]
 107 pub struct InvalidShutdownScript {
 108         /// A pointer to the opaque Rust object.
 109
 110         /// Nearly everywhere, inner must be non-null, however in places where
 111         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
 112         pub inner: *mut nativeInvalidShutdownScript,
 113         /// Indicates that this is the only struct which contains the same pointer.
 114
 115         /// Rust functions which take ownership of an object provided via an argument require
 116         /// this to be true and invalidate the object pointed to by inner.
 117         pub is_owned: bool,
 118 }
 119
 120 impl Drop for InvalidShutdownScript {
 121         fn drop(&mut self) {
 122                 if self.is_owned && !<*mut nativeInvalidShutdownScript>::is_null(self.inner) {
 123                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
 124                 }
 125         }
 126 }
 127 /// Frees any resources used by the InvalidShutdownScript, if is_owned is set and inner is non-NULL.
 128 #[no_mangle]
 129 pub extern "C" fn InvalidShutdownScript_free(this_obj: InvalidShutdownScript) { }
 130 #[allow(unused)]
 131 /// Used only if an object of this type is returned as a trait impl by a method
 132 pub(crate) extern "C" fn InvalidShutdownScript_free_void(this_ptr: *mut c_void) {
 133         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeInvalidShutdownScript); }
 134 }
 135 #[allow(unused)]
 136 impl InvalidShutdownScript {
 137         pub(crate) fn get_native_ref(&self) -> &'static nativeInvalidShutdownScript {
 138                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
 139         }
 140         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeInvalidShutdownScript {
 141                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
 142         }
 143         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
 144         pub(crate) fn take_inner(mut self) -> *mut nativeInvalidShutdownScript {
 145                 assert!(self.is_owned);
 146                 let ret = ObjOps::untweak_ptr(self.inner);
 147                 self.inner = core::ptr::null_mut();
 148                 ret
 149         }
 150 }
 151 /// The script that did not meet the requirements from [BOLT #2].
 152 ///
 153 /// [BOLT #2]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md
 154 #[no_mangle]
 155 pub extern "C" fn InvalidShutdownScript_get_script(this_ptr: &InvalidShutdownScript) -> crate::c_types::u8slice {
 156         let mut inner_val = &mut this_ptr.get_native_mut_ref().script;
 157         crate::c_types::u8slice::from_slice(&inner_val[..])
 158 }
 159 /// The script that did not meet the requirements from [BOLT #2].
 160 ///
 161 /// [BOLT #2]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md
 162 #[no_mangle]
 163 pub extern "C" fn InvalidShutdownScript_set_script(this_ptr: &mut InvalidShutdownScript, mut val: crate::c_types::derived::CVec_u8Z) {
 164         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.script = ::bitcoin::blockdata::script::Script::from(val.into_rust());
 165 }
 166 /// Constructs a new InvalidShutdownScript given each field
 167 #[must_use]
 168 #[no_mangle]
 169 pub extern "C" fn InvalidShutdownScript_new(mut script_arg: crate::c_types::derived::CVec_u8Z) -> InvalidShutdownScript {
 170         InvalidShutdownScript { inner: ObjOps::heap_alloc(nativeInvalidShutdownScript {
 171                 script: ::bitcoin::blockdata::script::Script::from(script_arg.into_rust()),
 172         }), is_owned: true }
 173 }
 174 impl Clone for InvalidShutdownScript {
 175         fn clone(&self) -> Self {
 176                 Self {
 177                         inner: if <*mut nativeInvalidShutdownScript>::is_null(self.inner) { core::ptr::null_mut() } else {
 178                                 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
 179                         is_owned: true,
 180                 }
 181         }
 182 }
 183 #[allow(unused)]
 184 /// Used only if an object of this type is returned as a trait impl by a method
 185 pub(crate) extern "C" fn InvalidShutdownScript_clone_void(this_ptr: *const c_void) -> *mut c_void {
 186         Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeInvalidShutdownScript)).clone() })) as *mut c_void
 187 }
 188 #[no_mangle]
 189 /// Creates a copy of the InvalidShutdownScript
 190 pub extern "C" fn InvalidShutdownScript_clone(orig: &InvalidShutdownScript) -> InvalidShutdownScript {
 191         orig.clone()
 192 }
 193 #[no_mangle]
 194 /// Serialize the ShutdownScript object into a byte array which can be read by ShutdownScript_read
 195 pub extern "C" fn ShutdownScript_write(obj: &crate::lightning::ln::script::ShutdownScript) -> crate::c_types::derived::CVec_u8Z {
 196         crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
 197 }
 198 #[no_mangle]
 199 pub(crate) extern "C" fn ShutdownScript_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
 200         crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeShutdownScript) })
 201 }
 202 #[no_mangle]
 203 /// Read a ShutdownScript from a byte array, created by ShutdownScript_write
 204 pub extern "C" fn ShutdownScript_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ShutdownScriptDecodeErrorZ {
 205         let res: Result<lightning::ln::script::ShutdownScript, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
 206         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() };
 207         local_res
 208 }
 209 /// Generates a P2WPKH script pubkey from the given [`WPubkeyHash`].
 210 #[must_use]
 211 #[no_mangle]
 212 pub extern "C" fn ShutdownScript_new_p2wpkh(pubkey_hash: *const [u8; 20]) -> crate::lightning::ln::script::ShutdownScript {
 213         let mut ret = lightning::ln::script::ShutdownScript::new_p2wpkh(&bitcoin::hash_types::WPubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *pubkey_hash }.clone())));
 214         crate::lightning::ln::script::ShutdownScript { inner: ObjOps::heap_alloc(ret), is_owned: true }
 215 }
 216
 217 /// Generates a P2WSH script pubkey from the given [`WScriptHash`].
 218 #[must_use]
 219 #[no_mangle]
 220 pub extern "C" fn ShutdownScript_new_p2wsh(script_hash: *const [u8; 32]) -> crate::lightning::ln::script::ShutdownScript {
 221         let mut ret = lightning::ln::script::ShutdownScript::new_p2wsh(&bitcoin::hash_types::WScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *script_hash }.clone())));
 222         crate::lightning::ln::script::ShutdownScript { inner: ObjOps::heap_alloc(ret), is_owned: true }
 223 }
 224
 225 /// Generates a witness script pubkey from the given segwit version and program.
 226 ///
 227 /// Note for version-zero witness scripts you must use [`ShutdownScript::new_p2wpkh`] or
 228 /// [`ShutdownScript::new_p2wsh`] instead.
 229 ///
 230 /// # Errors
 231 ///
 232 /// This function may return an error if `program` is invalid for the segwit `version`.
 233 #[must_use]
 234 #[no_mangle]
 235 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 {
 236         let mut ret = lightning::ln::script::ShutdownScript::new_witness_program(version.into(), program.to_slice());
 237         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() };
 238         local_ret
 239 }
 240
 241 /// Converts the shutdown script into the underlying [`Script`].
 242 #[must_use]
 243 #[no_mangle]
 244 pub extern "C" fn ShutdownScript_into_inner(mut this_arg: crate::lightning::ln::script::ShutdownScript) -> crate::c_types::derived::CVec_u8Z {
 245         let mut ret = (*unsafe { Box::from_raw(this_arg.take_inner()) }).into_inner();
 246         ret.into_bytes().into()
 247 }
 248
 249 /// Returns the [`PublicKey`] used for a P2WPKH shutdown script if constructed directly from it.
 250 ///
 251 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
 252 #[must_use]
 253 #[no_mangle]
 254 pub extern "C" fn ShutdownScript_as_legacy_pubkey(this_arg: &crate::lightning::ln::script::ShutdownScript) -> crate::c_types::PublicKey {
 255         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.as_legacy_pubkey();
 256         let mut local_ret = if ret.is_none() { crate::c_types::PublicKey::null() } else {  { crate::c_types::PublicKey::from_rust(&(ret.unwrap())) } };
 257         local_ret
 258 }
 259
 260 /// Returns whether the shutdown script is compatible with the features as defined by BOLT #2.
 261 ///
 262 /// Specifically, checks for compliance with feature `option_shutdown_anysegwit`.
 263 #[must_use]
 264 #[no_mangle]
 265 pub extern "C" fn ShutdownScript_is_compatible(this_arg: &crate::lightning::ln::script::ShutdownScript, features: &crate::lightning::ln::features::InitFeatures) -> bool {
 266         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.is_compatible(features.get_native_ref());
 267         ret
 268 }
 269