X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning-c-bindings%2Fsrc%2Flightning%2Fln%2Fscript.rs;fp=lightning-c-bindings%2Fsrc%2Flightning%2Fln%2Fscript.rs;h=7dc4b1d515bc387dc23c69ed163efedf12b4aeaf;hb=68c220f7ee4fa0b6b4a300f56cd30b9b02ebfbdf;hp=0000000000000000000000000000000000000000;hpb=e2145963159417800486d4a12d3e193415a14792;p=ldk-c-bindings

diff --git a/lightning-c-bindings/src/lightning/ln/script.rs b/lightning-c-bindings/src/lightning/ln/script.rs
new file mode 100644
index 0000000..7dc4b1d
--- /dev/null
+++ b/lightning-c-bindings/src/lightning/ln/script.rs
@@ -0,0 +1,239 @@
+// This file is Copyright its original authors, visible in version control
+// history and in the source files from which this was generated.
+//
+// This file is licensed under the license available in the LICENSE or LICENSE.md
+// file in the root of this repository or, if no such file exists, the same
+// license as that which applies to the original source files from which this
+// source was automatically generated.
+
+//! Abstractions for scripts used in the Lightning Network.
+
+use std::str::FromStr;
+use std::ffi::c_void;
+use bitcoin::hashes::Hash;
+use crate::c_types::*;
+
+
+use lightning::ln::script::ShutdownScript as nativeShutdownScriptImport;
+type nativeShutdownScript = nativeShutdownScriptImport;
+
+/// A script pubkey for shutting down a channel as defined by [BOLT #2].
+///
+/// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
+#[must_use]
+#[repr(C)]
+pub struct ShutdownScript {
+	/// A pointer to the opaque Rust object.
+
+	/// Nearly everywhere, inner must be non-null, however in places where
+	/// the Rust equivalent takes an Option, it may be set to null to indicate None.
+	pub inner: *mut nativeShutdownScript,
+	/// Indicates that this is the only struct which contains the same pointer.
+
+	/// Rust functions which take ownership of an object provided via an argument require
+	/// this to be true and invalidate the object pointed to by inner.
+	pub is_owned: bool,
+}
+
+impl Drop for ShutdownScript {
+	fn drop(&mut self) {
+		if self.is_owned && !<*mut nativeShutdownScript>::is_null(self.inner) {
+			let _ = unsafe { Box::from_raw(self.inner) };
+		}
+	}
+}
+/// Frees any resources used by the ShutdownScript, if is_owned is set and inner is non-NULL.
+#[no_mangle]
+pub extern "C" fn ShutdownScript_free(this_obj: ShutdownScript) { }
+#[allow(unused)]
+/// Used only if an object of this type is returned as a trait impl by a method
+extern "C" fn ShutdownScript_free_void(this_ptr: *mut c_void) {
+	unsafe { let _ = Box::from_raw(this_ptr as *mut nativeShutdownScript); }
+}
+#[allow(unused)]
+/// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
+impl ShutdownScript {
+	pub(crate) fn take_inner(mut self) -> *mut nativeShutdownScript {
+		assert!(self.is_owned);
+		let ret = self.inner;
+		self.inner = std::ptr::null_mut();
+		ret
+	}
+}
+impl Clone for ShutdownScript {
+	fn clone(&self) -> Self {
+		Self {
+			inner: if <*mut nativeShutdownScript>::is_null(self.inner) { std::ptr::null_mut() } else {
+				Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
+			is_owned: true,
+		}
+	}
+}
+#[allow(unused)]
+/// Used only if an object of this type is returned as a trait impl by a method
+pub(crate) extern "C" fn ShutdownScript_clone_void(this_ptr: *const c_void) -> *mut c_void {
+	Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeShutdownScript)).clone() })) as *mut c_void
+}
+#[no_mangle]
+/// Creates a copy of the ShutdownScript
+pub extern "C" fn ShutdownScript_clone(orig: &ShutdownScript) -> ShutdownScript {
+	orig.clone()
+}
+
+use lightning::ln::script::InvalidShutdownScript as nativeInvalidShutdownScriptImport;
+type nativeInvalidShutdownScript = nativeInvalidShutdownScriptImport;
+
+/// An error occurring when converting from [`Script`] to [`ShutdownScript`].
+#[must_use]
+#[repr(C)]
+pub struct InvalidShutdownScript {
+	/// A pointer to the opaque Rust object.
+
+	/// Nearly everywhere, inner must be non-null, however in places where
+	/// the Rust equivalent takes an Option, it may be set to null to indicate None.
+	pub inner: *mut nativeInvalidShutdownScript,
+	/// Indicates that this is the only struct which contains the same pointer.
+
+	/// Rust functions which take ownership of an object provided via an argument require
+	/// this to be true and invalidate the object pointed to by inner.
+	pub is_owned: bool,
+}
+
+impl Drop for InvalidShutdownScript {
+	fn drop(&mut self) {
+		if self.is_owned && !<*mut nativeInvalidShutdownScript>::is_null(self.inner) {
+			let _ = unsafe { Box::from_raw(self.inner) };
+		}
+	}
+}
+/// Frees any resources used by the InvalidShutdownScript, if is_owned is set and inner is non-NULL.
+#[no_mangle]
+pub extern "C" fn InvalidShutdownScript_free(this_obj: InvalidShutdownScript) { }
+#[allow(unused)]
+/// Used only if an object of this type is returned as a trait impl by a method
+extern "C" fn InvalidShutdownScript_free_void(this_ptr: *mut c_void) {
+	unsafe { let _ = Box::from_raw(this_ptr as *mut nativeInvalidShutdownScript); }
+}
+#[allow(unused)]
+/// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
+impl InvalidShutdownScript {
+	pub(crate) fn take_inner(mut self) -> *mut nativeInvalidShutdownScript {
+		assert!(self.is_owned);
+		let ret = self.inner;
+		self.inner = std::ptr::null_mut();
+		ret
+	}
+}
+/// The script that did not meet the requirements from [BOLT #2].
+///
+/// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
+#[no_mangle]
+pub extern "C" fn InvalidShutdownScript_get_script(this_ptr: &InvalidShutdownScript) -> crate::c_types::u8slice {
+	let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.script;
+	crate::c_types::u8slice::from_slice(&inner_val[..])
+}
+/// The script that did not meet the requirements from [BOLT #2].
+///
+/// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
+#[no_mangle]
+pub extern "C" fn InvalidShutdownScript_set_script(this_ptr: &mut InvalidShutdownScript, mut val: crate::c_types::derived::CVec_u8Z) {
+	unsafe { &mut *this_ptr.inner }.script = ::bitcoin::blockdata::script::Script::from(val.into_rust());
+}
+/// Constructs a new InvalidShutdownScript given each field
+#[must_use]
+#[no_mangle]
+pub extern "C" fn InvalidShutdownScript_new(mut script_arg: crate::c_types::derived::CVec_u8Z) -> InvalidShutdownScript {
+	InvalidShutdownScript { inner: Box::into_raw(Box::new(nativeInvalidShutdownScript {
+		script: ::bitcoin::blockdata::script::Script::from(script_arg.into_rust()),
+	})), is_owned: true }
+}
+#[no_mangle]
+/// Serialize the ShutdownScript object into a byte array which can be read by ShutdownScript_read
+pub extern "C" fn ShutdownScript_write(obj: &ShutdownScript) -> crate::c_types::derived::CVec_u8Z {
+	crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
+}
+#[no_mangle]
+pub(crate) extern "C" fn ShutdownScript_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
+	crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeShutdownScript) })
+}
+#[no_mangle]
+/// Read a ShutdownScript from a byte array, created by ShutdownScript_write
+pub extern "C" fn ShutdownScript_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ShutdownScriptDecodeErrorZ {
+	let res = crate::c_types::deserialize_obj(ser);
+	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() };
+	local_res
+}
+/// Generates a P2PKH script pubkey from the given [`PubkeyHash`].
+#[must_use]
+#[no_mangle]
+pub extern "C" fn ShutdownScript_new_p2pkh(pubkey_hash: *const [u8; 20]) -> ShutdownScript {
+	let mut ret = lightning::ln::script::ShutdownScript::new_p2pkh(&bitcoin::hash_types::PubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *pubkey_hash }.clone())));
+	ShutdownScript { inner: Box::into_raw(Box::new(ret)), is_owned: true }
+}
+
+/// Generates a P2SH script pubkey from the given [`ScriptHash`].
+#[must_use]
+#[no_mangle]
+pub extern "C" fn ShutdownScript_new_p2sh(script_hash: *const [u8; 20]) -> ShutdownScript {
+	let mut ret = lightning::ln::script::ShutdownScript::new_p2sh(&bitcoin::hash_types::ScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *script_hash }.clone())));
+	ShutdownScript { inner: Box::into_raw(Box::new(ret)), is_owned: true }
+}
+
+/// Generates a P2WPKH script pubkey from the given [`WPubkeyHash`].
+#[must_use]
+#[no_mangle]
+pub extern "C" fn ShutdownScript_new_p2wpkh(pubkey_hash: *const [u8; 20]) -> ShutdownScript {
+	let mut ret = lightning::ln::script::ShutdownScript::new_p2wpkh(&bitcoin::hash_types::WPubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *pubkey_hash }.clone())));
+	ShutdownScript { inner: Box::into_raw(Box::new(ret)), is_owned: true }
+}
+
+/// Generates a P2WSH script pubkey from the given [`WScriptHash`].
+#[must_use]
+#[no_mangle]
+pub extern "C" fn ShutdownScript_new_p2wsh(script_hash: *const [u8; 32]) -> ShutdownScript {
+	let mut ret = lightning::ln::script::ShutdownScript::new_p2wsh(&bitcoin::hash_types::WScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *script_hash }.clone())));
+	ShutdownScript { inner: Box::into_raw(Box::new(ret)), is_owned: true }
+}
+
+/// Generates a P2WSH script pubkey from the given segwit version and program.
+///
+/// # Errors
+///
+/// This function may return an error if `program` is invalid for the segwit `version`.
+#[must_use]
+#[no_mangle]
+pub extern "C" fn ShutdownScript_new_witness_program(mut version: u8, mut program: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ShutdownScriptInvalidShutdownScriptZ {
+	let mut ret = lightning::ln::script::ShutdownScript::new_witness_program(core::num::NonZeroU8::new(version).expect("Value must be non-zero"), program.to_slice());
+	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() };
+	local_ret
+}
+
+/// Converts the shutdown script into the underlying [`Script`].
+#[must_use]
+#[no_mangle]
+pub extern "C" fn ShutdownScript_into_inner(mut this_arg: ShutdownScript) -> crate::c_types::derived::CVec_u8Z {
+	let mut ret = (*unsafe { Box::from_raw(this_arg.take_inner()) }).into_inner();
+	ret.into_bytes().into()
+}
+
+/// Returns the [`PublicKey`] used for a P2WPKH shutdown script if constructed directly from it.
+///
+/// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
+#[must_use]
+#[no_mangle]
+pub extern "C" fn ShutdownScript_as_legacy_pubkey(this_arg: &ShutdownScript) -> crate::c_types::PublicKey {
+	let mut ret = unsafe { &*this_arg.inner }.as_legacy_pubkey();
+	let mut local_ret = if ret.is_none() { crate::c_types::PublicKey::null() } else {  { crate::c_types::PublicKey::from_rust(&(ret.unwrap())) } };
+	local_ret
+}
+
+/// Returns whether the shutdown script is compatible with the features as defined by BOLT #2.
+///
+/// Specifically, checks for compliance with feature `option_shutdown_anysegwit`.
+#[must_use]
+#[no_mangle]
+pub extern "C" fn ShutdownScript_is_compatible(this_arg: &ShutdownScript, features: &crate::lightning::ln::features::InitFeatures) -> bool {
+	let mut ret = unsafe { &*this_arg.inner }.is_compatible(unsafe { &*features.inner });
+	ret
+}
+