_ 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/lightningnetwork/lightning-rfc/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
  92 use lightning::ln::script::InvalidShutdownScript as nativeInvalidShutdownScriptImport;
  93 pub(crate) type nativeInvalidShutdownScript = nativeInvalidShutdownScriptImport;
  94
  95 /// An error occurring when converting from [`Script`] to [`ShutdownScript`].
  96 #[must_use]
  97 #[repr(C)]
  98 pub struct InvalidShutdownScript {
  99         /// A pointer to the opaque Rust object.
 100
 101         /// Nearly everywhere, inner must be non-null, however in places where
 102         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
 103         pub inner: *mut nativeInvalidShutdownScript,
 104         /// Indicates that this is the only struct which contains the same pointer.
 105
 106         /// Rust functions which take ownership of an object provided via an argument require
 107         /// this to be true and invalidate the object pointed to by inner.
 108         pub is_owned: bool,
 109 }
 110
 111 impl Drop for InvalidShutdownScript {
 112         fn drop(&mut self) {
 113                 if self.is_owned && !<*mut nativeInvalidShutdownScript>::is_null(self.inner) {
 114                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
 115                 }
 116         }
 117 }
 118 /// Frees any resources used by the InvalidShutdownScript, if is_owned is set and inner is non-NULL.
 119 #[no_mangle]
 120 pub extern "C" fn InvalidShutdownScript_free(this_obj: InvalidShutdownScript) { }
 121 #[allow(unused)]
 122 /// Used only if an object of this type is returned as a trait impl by a method
 123 pub(crate) extern "C" fn InvalidShutdownScript_free_void(this_ptr: *mut c_void) {
 124         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeInvalidShutdownScript); }
 125 }
 126 #[allow(unused)]
 127 impl InvalidShutdownScript {
 128         pub(crate) fn get_native_ref(&self) -> &'static nativeInvalidShutdownScript {
 129                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
 130         }
 131         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeInvalidShutdownScript {
 132                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
 133         }
 134         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
 135         pub(crate) fn take_inner(mut self) -> *mut nativeInvalidShutdownScript {
 136                 assert!(self.is_owned);
 137                 let ret = ObjOps::untweak_ptr(self.inner);
 138                 self.inner = core::ptr::null_mut();
 139                 ret
 140         }
 141 }
 142 /// The script that did not meet the requirements from [BOLT #2].
 143 ///
 144 /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
 145 #[no_mangle]
 146 pub extern "C" fn InvalidShutdownScript_get_script(this_ptr: &InvalidShutdownScript) -> crate::c_types::u8slice {
 147         let mut inner_val = &mut this_ptr.get_native_mut_ref().script;
 148         crate::c_types::u8slice::from_slice(&inner_val[..])
 149 }
 150 /// The script that did not meet the requirements from [BOLT #2].
 151 ///
 152 /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
 153 #[no_mangle]
 154 pub extern "C" fn InvalidShutdownScript_set_script(this_ptr: &mut InvalidShutdownScript, mut val: crate::c_types::derived::CVec_u8Z) {
 155         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.script = ::bitcoin::blockdata::script::Script::from(val.into_rust());
 156 }
 157 /// Constructs a new InvalidShutdownScript given each field
 158 #[must_use]
 159 #[no_mangle]
 160 pub extern "C" fn InvalidShutdownScript_new(mut script_arg: crate::c_types::derived::CVec_u8Z) -> InvalidShutdownScript {
 161         InvalidShutdownScript { inner: ObjOps::heap_alloc(nativeInvalidShutdownScript {
 162                 script: ::bitcoin::blockdata::script::Script::from(script_arg.into_rust()),
 163         }), is_owned: true }
 164 }
 165 impl Clone for InvalidShutdownScript {
 166         fn clone(&self) -> Self {
 167                 Self {
 168                         inner: if <*mut nativeInvalidShutdownScript>::is_null(self.inner) { core::ptr::null_mut() } else {
 169                                 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
 170                         is_owned: true,
 171                 }
 172         }
 173 }
 174 #[allow(unused)]
 175 /// Used only if an object of this type is returned as a trait impl by a method
 176 pub(crate) extern "C" fn InvalidShutdownScript_clone_void(this_ptr: *const c_void) -> *mut c_void {
 177         Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeInvalidShutdownScript)).clone() })) as *mut c_void
 178 }
 179 #[no_mangle]
 180 /// Creates a copy of the InvalidShutdownScript
 181 pub extern "C" fn InvalidShutdownScript_clone(orig: &InvalidShutdownScript) -> InvalidShutdownScript {
 182         orig.clone()
 183 }
 184 #[no_mangle]
 185 /// Serialize the ShutdownScript object into a byte array which can be read by ShutdownScript_read
 186 pub extern "C" fn ShutdownScript_write(obj: &ShutdownScript) -> crate::c_types::derived::CVec_u8Z {
 187         crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
 188 }
 189 #[no_mangle]
 190 pub(crate) extern "C" fn ShutdownScript_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
 191         crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeShutdownScript) })
 192 }
 193 #[no_mangle]
 194 /// Read a ShutdownScript from a byte array, created by ShutdownScript_write
 195 pub extern "C" fn ShutdownScript_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ShutdownScriptDecodeErrorZ {
 196         let res: Result<lightning::ln::script::ShutdownScript, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
 197         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() };
 198         local_res
 199 }
 200 /// Generates a P2WPKH script pubkey from the given [`WPubkeyHash`].
 201 #[must_use]
 202 #[no_mangle]
 203 pub extern "C" fn ShutdownScript_new_p2wpkh(pubkey_hash: *const [u8; 20]) -> ShutdownScript {
 204         let mut ret = lightning::ln::script::ShutdownScript::new_p2wpkh(&bitcoin::hash_types::WPubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *pubkey_hash }.clone())));
 205         ShutdownScript { inner: ObjOps::heap_alloc(ret), is_owned: true }
 206 }
 207
 208 /// Generates a P2WSH script pubkey from the given [`WScriptHash`].
 209 #[must_use]
 210 #[no_mangle]
 211 pub extern "C" fn ShutdownScript_new_p2wsh(script_hash: *const [u8; 32]) -> ShutdownScript {
 212         let mut ret = lightning::ln::script::ShutdownScript::new_p2wsh(&bitcoin::hash_types::WScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *script_hash }.clone())));
 213         ShutdownScript { inner: ObjOps::heap_alloc(ret), is_owned: true }
 214 }
 215
 216 /// Generates a witness script pubkey from the given segwit version and program.
 217 ///
 218 /// Note for version-zero witness scripts you must use [`ShutdownScript::new_p2wpkh`] or
 219 /// [`ShutdownScript::new_p2wsh`] instead.
 220 ///
 221 /// # Errors
 222 ///
 223 /// This function may return an error if `program` is invalid for the segwit `version`.
 224 #[must_use]
 225 #[no_mangle]
 226 pub extern "C" fn ShutdownScript_new_witness_program(mut version: u8, mut program: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ShutdownScriptInvalidShutdownScriptZ {
 227         let mut ret = lightning::ln::script::ShutdownScript::new_witness_program(core::num::NonZeroU8::new(version).expect("Value must be non-zero"), program.to_slice());
 228         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() };
 229         local_ret
 230 }
 231
 232 /// Converts the shutdown script into the underlying [`Script`].
 233 #[must_use]
 234 #[no_mangle]
 235 pub extern "C" fn ShutdownScript_into_inner(mut this_arg: ShutdownScript) -> crate::c_types::derived::CVec_u8Z {
 236         let mut ret = (*unsafe { Box::from_raw(this_arg.take_inner()) }).into_inner();
 237         ret.into_bytes().into()
 238 }
 239
 240 /// Returns the [`PublicKey`] used for a P2WPKH shutdown script if constructed directly from it.
 241 ///
 242 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
 243 #[must_use]
 244 #[no_mangle]
 245 pub extern "C" fn ShutdownScript_as_legacy_pubkey(this_arg: &ShutdownScript) -> crate::c_types::PublicKey {
 246         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.as_legacy_pubkey();
 247         let mut local_ret = if ret.is_none() { crate::c_types::PublicKey::null() } else {  { crate::c_types::PublicKey::from_rust(&(ret.unwrap())) } };
 248         local_ret
 249 }
 250
 251 /// Returns whether the shutdown script is compatible with the features as defined by BOLT #2.
 252 ///
 253 /// Specifically, checks for compliance with feature `option_shutdown_anysegwit`.
 254 #[must_use]
 255 #[no_mangle]
 256 pub extern "C" fn ShutdownScript_is_compatible(this_arg: &ShutdownScript, features: &crate::lightning::ln::features::InitFeatures) -> bool {
 257         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.is_compatible(features.get_native_ref());
 258         ret
 259 }
 260