_ 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 std::str::FromStr;
  12 use std::ffi::c_void;
  13 use bitcoin::hashes::Hash;
  14 use crate::c_types::*;
  15
  16
  17 use lightning::ln::script::ShutdownScript as nativeShutdownScriptImport;
  18 type nativeShutdownScript = nativeShutdownScriptImport;
  19
  20 /// A script pubkey for shutting down a channel as defined by [BOLT #2].
  21 ///
  22 /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
  23 #[must_use]
  24 #[repr(C)]
  25 pub struct ShutdownScript {
  26         /// A pointer to the opaque Rust object.
  27
  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.
  32
  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.
  35         pub is_owned: bool,
  36 }
  37
  38 impl Drop for ShutdownScript {
  39         fn drop(&mut self) {
  40                 if self.is_owned && !<*mut nativeShutdownScript>::is_null(self.inner) {
  41                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
  42                 }
  43         }
  44 }
  45 /// Frees any resources used by the ShutdownScript, if is_owned is set and inner is non-NULL.
  46 #[no_mangle]
  47 pub extern "C" fn ShutdownScript_free(this_obj: ShutdownScript) { }
  48 #[allow(unused)]
  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); }
  52 }
  53 #[allow(unused)]
  54 impl ShutdownScript {
  55         pub(crate) fn get_native_ref(&self) -> &'static nativeShutdownScript {
  56                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
  57         }
  58         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeShutdownScript {
  59                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
  60         }
  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();
  66                 ret
  67         }
  68 }
  69 impl Clone for ShutdownScript {
  70         fn clone(&self) -> Self {
  71                 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()) },
  74                         is_owned: true,
  75                 }
  76         }
  77 }
  78 #[allow(unused)]
  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
  82 }
  83 #[no_mangle]
  84 /// Creates a copy of the ShutdownScript
  85 pub extern "C" fn ShutdownScript_clone(orig: &ShutdownScript) -> ShutdownScript {
  86         orig.clone()
  87 }
  88
  89 use lightning::ln::script::InvalidShutdownScript as nativeInvalidShutdownScriptImport;
  90 type nativeInvalidShutdownScript = nativeInvalidShutdownScriptImport;
  91
  92 /// An error occurring when converting from [`Script`] to [`ShutdownScript`].
  93 #[must_use]
  94 #[repr(C)]
  95 pub struct InvalidShutdownScript {
  96         /// A pointer to the opaque Rust object.
  97
  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.
 102
 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.
 105         pub is_owned: bool,
 106 }
 107
 108 impl Drop for InvalidShutdownScript {
 109         fn drop(&mut self) {
 110                 if self.is_owned && !<*mut nativeInvalidShutdownScript>::is_null(self.inner) {
 111                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
 112                 }
 113         }
 114 }
 115 /// Frees any resources used by the InvalidShutdownScript, if is_owned is set and inner is non-NULL.
 116 #[no_mangle]
 117 pub extern "C" fn InvalidShutdownScript_free(this_obj: InvalidShutdownScript) { }
 118 #[allow(unused)]
 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); }
 122 }
 123 #[allow(unused)]
 124 impl InvalidShutdownScript {
 125         pub(crate) fn get_native_ref(&self) -> &'static nativeInvalidShutdownScript {
 126                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
 127         }
 128         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeInvalidShutdownScript {
 129                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
 130         }
 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();
 136                 ret
 137         }
 138 }
 139 /// The script that did not meet the requirements from [BOLT #2].
 140 ///
 141 /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
 142 #[no_mangle]
 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[..])
 146 }
 147 /// The script that did not meet the requirements from [BOLT #2].
 148 ///
 149 /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
 150 #[no_mangle]
 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());
 153 }
 154 /// Constructs a new InvalidShutdownScript given each field
 155 #[must_use]
 156 #[no_mangle]
 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()),
 160         }), is_owned: true }
 161 }
 162 #[no_mangle]
 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())
 166 }
 167 #[no_mangle]
 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) })
 170 }
 171 #[no_mangle]
 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() };
 176         local_res
 177 }
 178 /// Generates a P2PKH script pubkey from the given [`PubkeyHash`].
 179 #[must_use]
 180 #[no_mangle]
 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 }
 184 }
 185
 186 /// Generates a P2SH script pubkey from the given [`ScriptHash`].
 187 #[must_use]
 188 #[no_mangle]
 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 }
 192 }
 193
 194 /// Generates a P2WPKH script pubkey from the given [`WPubkeyHash`].
 195 #[must_use]
 196 #[no_mangle]
 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 }
 200 }
 201
 202 /// Generates a P2WSH script pubkey from the given [`WScriptHash`].
 203 #[must_use]
 204 #[no_mangle]
 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 }
 208 }
 209
 210 /// Generates a witness script pubkey from the given segwit version and program.
 211 ///
 212 /// Note for version-zero witness scripts you must use [`ShutdownScript::new_p2wpkh`] or
 213 /// [`ShutdownScript::new_p2wsh`] instead.
 214 ///
 215 /// # Errors
 216 ///
 217 /// This function may return an error if `program` is invalid for the segwit `version`.
 218 #[must_use]
 219 #[no_mangle]
 220 pub extern "C" fn ShutdownScript_new_witness_program(mut version: u8, mut program: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ShutdownScriptInvalidShutdownScriptZ {
 221         let mut ret = lightning::ln::script::ShutdownScript::new_witness_program(core::num::NonZeroU8::new(version).expect("Value must be non-zero"), program.to_slice());
 222         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         local_ret
 224 }
 225
 226 /// Converts the shutdown script into the underlying [`Script`].
 227 #[must_use]
 228 #[no_mangle]
 229 pub extern "C" fn ShutdownScript_into_inner(mut this_arg: ShutdownScript) -> crate::c_types::derived::CVec_u8Z {
 230         let mut ret = (*unsafe { Box::from_raw(this_arg.take_inner()) }).into_inner();
 231         ret.into_bytes().into()
 232 }
 233
 234 /// Returns the [`PublicKey`] used for a P2WPKH shutdown script if constructed directly from it.
 235 ///
 236 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
 237 #[must_use]
 238 #[no_mangle]
 239 pub extern "C" fn ShutdownScript_as_legacy_pubkey(this_arg: &ShutdownScript) -> crate::c_types::PublicKey {
 240         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.as_legacy_pubkey();
 241         let mut local_ret = if ret.is_none() { crate::c_types::PublicKey::null() } else {  { crate::c_types::PublicKey::from_rust(&(ret.unwrap())) } };
 242         local_ret
 243 }
 244
 245 /// Returns whether the shutdown script is compatible with the features as defined by BOLT #2.
 246 ///
 247 /// Specifically, checks for compliance with feature `option_shutdown_anysegwit`.
 248 #[must_use]
 249 #[no_mangle]
 250 pub extern "C" fn ShutdownScript_is_compatible(this_arg: &ShutdownScript, features: &crate::lightning::ln::features::InitFeatures) -> bool {
 251         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.is_compatible(features.get_native_ref());
 252         ret
 253 }
 254