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