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