Merge pull request #114 from TheBlueMatt/main

0.0.118

Author: TheBlueMatt

.github/workflows/build.yml

@@ -37,7 +37,7 @@ jobs:
         run: |
           git clone https://github.com/rust-bitcoin/rust-lightning
           cd rust-lightning
-          git checkout 0.0.117-bindings
+          git checkout 0.0.118-bindings
           # Pin memchr until we can remove it
           cargo update -p memchr --precise "2.5.0" --verbose
       - name: Fix Github Actions to not be broken
@@ -101,7 +101,7 @@ jobs:
         run: |
           git clone https://github.com/rust-bitcoin/rust-lightning
           cd rust-lightning
-          git checkout 0.0.117-bindings
+          git checkout 0.0.118-bindings
       - name: Fix Github Actions to not be broken
         run: git config --global --add safe.directory /__w/ldk-c-bindings/ldk-c-bindings
       - name: Fetch MacOS SDK
@@ -148,7 +148,7 @@ jobs:
         run: |
           git clone https://github.com/rust-bitcoin/rust-lightning
           cd rust-lightning
-          git checkout 0.0.117-bindings
+          git checkout 0.0.118-bindings
       - name: Rebuild bindings using Apple clang, and check the sample app builds + links
         run: ./genbindings.sh ./rust-lightning true
       - name: Rebuild bindings using upstream clang, and check the sample app builds + links

c-bindings-gen/src/main.rs

@@ -94,12 +94,15 @@ fn maybe_convert_trait_impl<W: std::io::Write>(w: &mut W, trait_path: &syn::Path
 				writeln!(w, ")").unwrap();
 
 				writeln!(w, "}}").unwrap();
+
+				writeln!(w, "#[allow(unused)]").unwrap();
+				writeln!(w, "pub(crate) extern \"C\" fn {}_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {{", for_obj).unwrap();
 				if has_inner {
-					writeln!(w, "#[no_mangle]").unwrap();
-					writeln!(w, "pub(crate) extern \"C\" fn {}_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {{", for_obj).unwrap();
 					writeln!(w, "\tcrate::c_types::serialize_obj(unsafe {{ &*(obj as *const native{}) }})", for_obj).unwrap();
-					writeln!(w, "}}").unwrap();
+				} else {
+					writeln!(w, "\t{}_write(unsafe {{ &*(obj as *const {}) }})", for_obj, for_obj).unwrap();
 				}
+				writeln!(w, "}}").unwrap();
 			},
 			"lightning::util::ser::Readable"|"lightning::util::ser::ReadableArgs"|"lightning::util::ser::MaybeReadable" => {
 				// Create the Result<Object, DecodeError> syn::Type
@@ -554,6 +557,7 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
 	writeln!(w, "unsafe impl Send for {} {{}}", trait_name).unwrap();
 	writeln!(w, "unsafe impl Sync for {} {{}}", trait_name).unwrap();
 
+	writeln!(w, "#[allow(unused)]").unwrap();
 	writeln!(w, "pub(crate) fn {}_clone_fields(orig: &{}) -> {} {{", trait_name, trait_name, trait_name).unwrap();
 	writeln!(w, "\t{} {{", trait_name).unwrap();
 	writeln!(w, "\t\tthis_arg: orig.this_arg,").unwrap();
@@ -1023,10 +1027,14 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, w_uses: &mut HashSet<String, NonRa
 						if is_type_unconstructable(&resolved_path) {
 							writeln!(w, "\t\tunreachable!();").unwrap();
 						} else {
-							writeln!(w, "\t\tlet mut rust_obj = {} {{ inner: ObjOps::heap_alloc(obj), is_owned: true }};", ident).unwrap();
-							writeln!(w, "\t\tlet mut ret = {}_as_{}(&rust_obj);", ident, trait_obj.ident).unwrap();
-							writeln!(w, "\t\t// We want to free rust_obj when ret gets drop()'d, not rust_obj, so wipe rust_obj's pointer and set ret's free() fn").unwrap();
-							writeln!(w, "\t\trust_obj.inner = core::ptr::null_mut();").unwrap();
+							types.write_to_c_conversion_new_var(w, &format_ident!("obj"), &*i.self_ty, Some(&gen_types), false);
+							write!(w, "\t\tlet rust_obj = ").unwrap();
+							types.write_to_c_conversion_inline_prefix(w, &*i.self_ty, Some(&gen_types), false);
+							write!(w, "obj").unwrap();
+							types.write_to_c_conversion_inline_suffix(w, &*i.self_ty, Some(&gen_types), false);
+							writeln!(w, ";\n\t\tlet mut ret = {}_as_{}(&rust_obj);", ident, trait_obj.ident).unwrap();
+							writeln!(w, "\t\t// We want to free rust_obj when ret gets drop()'d, not rust_obj, so forget it and set ret's free() fn").unwrap();
+							writeln!(w, "\t\tcore::mem::forget(rust_obj);").unwrap();
 							writeln!(w, "\t\tret.free = Some({}_free_void);", ident).unwrap();
 							writeln!(w, "\t\tret").unwrap();
 						}
@@ -1041,7 +1049,11 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, w_uses: &mut HashSet<String, NonRa
 						writeln!(w, "/// This copies the `inner` pointer in this_arg and thus the returned {} must be freed before this_arg is", trait_obj.ident).unwrap();
 						write!(w, "#[no_mangle]\npub extern \"C\" fn {}_as_{}(this_arg: &{}) -> crate::{} {{\n", ident, trait_obj.ident, ident, full_trait_path).unwrap();
 						writeln!(w, "\tcrate::{} {{", full_trait_path).unwrap();
-						writeln!(w, "\t\tthis_arg: unsafe {{ ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void }},").unwrap();
+						if types.c_type_has_inner_from_path(&resolved_path) {
+							writeln!(w, "\t\tthis_arg: unsafe {{ ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void }},").unwrap();
+						} else {
+							writeln!(w, "\t\tthis_arg: unsafe {{ ObjOps::untweak_ptr(this_arg as *const {} as *mut {}) as *mut c_void }},", ident, ident).unwrap();
+						}
 						writeln!(w, "\t\tfree: None,").unwrap();
 
 						macro_rules! write_meth {
@@ -1345,7 +1357,7 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, w_uses: &mut HashSet<String, NonRa
 						writeln!(w, "#[allow(unused)]").unwrap();
 						writeln!(w, "/// Used only if an object of this type is returned as a trait impl by a method").unwrap();
 						writeln!(w, "pub(crate) extern \"C\" fn {}_clone_void(this_ptr: *const c_void) -> *mut c_void {{", ident).unwrap();
-						writeln!(w, "\tBox::into_raw(Box::new(unsafe {{ (*(this_ptr as *mut native{})).clone() }})) as *mut c_void", ident).unwrap();
+						writeln!(w, "\tBox::into_raw(Box::new(unsafe {{ (*(this_ptr as *const native{})).clone() }})) as *mut c_void", ident).unwrap();
 						writeln!(w, "}}").unwrap();
 						writeln!(w, "#[no_mangle]").unwrap();
 						writeln!(w, "/// Creates a copy of the {}", ident).unwrap();
@@ -1936,7 +1948,18 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
 		writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", e.ident, e.ident, e.ident).unwrap();
 		writeln!(w, "\torig.clone()").unwrap();
 		writeln!(w, "}}").unwrap();
+		writeln!(w, "#[allow(unused)]").unwrap();
+		writeln!(w, "/// Used only if an object of this type is returned as a trait impl by a method").unwrap();
+		writeln!(w, "pub(crate) extern \"C\" fn {}_clone_void(this_ptr: *const c_void) -> *mut c_void {{", e.ident).unwrap();
+		writeln!(w, "\tBox::into_raw(Box::new(unsafe {{ (*(this_ptr as *const {})).clone() }})) as *mut c_void", e.ident).unwrap();
+		writeln!(w, "}}").unwrap();
 	}
+
+	writeln!(w, "#[allow(unused)]").unwrap();
+	writeln!(w, "/// Used only if an object of this type is returned as a trait impl by a method").unwrap();
+	writeln!(w, "pub(crate) extern \"C\" fn {}_free_void(this_ptr: *mut c_void) {{", e.ident).unwrap();
+	writeln!(w, "\tlet _ = unsafe {{ Box::from_raw(this_ptr as *mut {}) }};\n}}", e.ident).unwrap();
+
 	w.write_all(&constr).unwrap();
 	write_cpp_wrapper(cpp_headers, &format!("{}", e.ident), needs_free, None);
 }

c-bindings-gen/src/types.rs

@@ -1534,7 +1534,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
 				if is_ref => Some(".as_inner()"),
 			"bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
 				if !is_ref => Some(".into_inner() }"),
-			"bitcoin::blockdata::constants::ChainHash" if is_ref => Some(".as_bytes() }"),
+			"bitcoin::blockdata::constants::ChainHash" if is_ref => Some(".as_bytes()"),
 			"bitcoin::blockdata::constants::ChainHash" if !is_ref => Some(".to_bytes() }"),
 			"bitcoin::secp256k1::Message" if !is_ref => Some(".as_ref().clone() }"),
 			"lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"

lightning-c-bindings/Cargo.toml

@@ -22,11 +22,11 @@ std = ["bitcoin/std", "lightning/std", "lightning-invoice/std", "lightning-backg
 bitcoin = { version = "0.29", default-features = false }
 secp256k1 = { version = "0.24", features = ["global-context", "recovery"] }
 # Note that the following line is matched by genbindings to update the path
-lightning = { git = "https://github.com/lightningdevkit/rust-lightning", branch = "0.0.117-bindings", default-features = false }
-lightning-persister = { git = "https://github.com/lightningdevkit/rust-lightning", branch = "0.0.117-bindings", default-features = false }
-lightning-invoice = { git = "https://github.com/lightningdevkit/rust-lightning", branch = "0.0.117-bindings", default-features = false }
-lightning-background-processor = { git = "https://github.com/lightningdevkit/rust-lightning", branch = "0.0.117-bindings", default-features = false }
-lightning-rapid-gossip-sync = { git = "https://github.com/lightningdevkit/rust-lightning", branch = "0.0.117-bindings", default-features = false }
+lightning = { git = "https://github.com/lightningdevkit/rust-lightning", branch = "0.0.118-bindings", default-features = false }
+lightning-persister = { git = "https://github.com/lightningdevkit/rust-lightning", branch = "0.0.118-bindings", default-features = false }
+lightning-invoice = { git = "https://github.com/lightningdevkit/rust-lightning", branch = "0.0.118-bindings", default-features = false }
+lightning-background-processor = { git = "https://github.com/lightningdevkit/rust-lightning", branch = "0.0.118-bindings", default-features = false }
+lightning-rapid-gossip-sync = { git = "https://github.com/lightningdevkit/rust-lightning", branch = "0.0.118-bindings", default-features = false }
 
 core2 = { version = "0.3.0", optional = true, default-features = false }
 

lightning-c-bindings/demo.c

@@ -13,7 +13,7 @@ void print_log(const void *this_arg, const LDKRecord *record) {
 }
 
 uint32_t get_fee(const void *this_arg, LDKConfirmationTarget target) {
-	if (target == LDKConfirmationTarget_Background) {
+	if (target == LDKConfirmationTarget_AnchorChannelFee || target == LDKConfirmationTarget_MinAllowedAnchorChannelRemoteFee) {
 		return 253;
 	} else {
 		return 507;

lightning-c-bindings/demo.cpp

@@ -104,7 +104,7 @@ void print_log(const void *this_arg, const LDKRecord *record) {
 }
 
 uint32_t get_fee(const void *this_arg, LDKConfirmationTarget target) {
-	if (target == LDKConfirmationTarget_Background) {
+	if (target == LDKConfirmationTarget_AnchorChannelFee || target == LDKConfirmationTarget_MinAllowedAnchorChannelRemoteFee) {
 		return 253;
 	} else {
 		return 507;
@@ -386,7 +386,7 @@ class PeersConnection {
 
 struct CustomOnionMsgQueue {
 	std::mutex mtx;
-	std::vector<LDK::CustomOnionMessageContents> msgs;
+	std::vector<LDK::OnionMessageContents> msgs;
 };
 
 uint64_t custom_onion_msg_type_id(const void *this_arg) {
@@ -400,31 +400,35 @@ LDKCVec_u8Z custom_onion_msg_bytes(const void *this_arg) {
 	};
 }
 
-LDKCOption_CustomOnionMessageContentsZ handle_custom_onion_message(const void* this_arg, struct LDKCustomOnionMessageContents msg) {
+LDKCOption_OnionMessageContentsZ handle_custom_onion_message(const void* this_arg, struct LDKOnionMessageContents msg) {
 	CustomOnionMsgQueue* arg = (CustomOnionMsgQueue*) this_arg;
 	std::unique_lock<std::mutex> lck(arg->mtx);
 	arg->msgs.push_back(std::move(msg));
-	return COption_CustomOnionMessageContentsZ_none();
+	return COption_OnionMessageContentsZ_none();
 }
 
-LDKCustomOnionMessageContents build_custom_onion_message() {
-	return LDKCustomOnionMessageContents {
+LDKOnionMessageContents build_custom_onion_message() {
+	return LDKOnionMessageContents {
 		.this_arg = NULL,
 		.tlv_type = custom_onion_msg_type_id,
 		.write = custom_onion_msg_bytes,
 		.free = NULL,
 	};
 }
 
-LDKCResult_COption_CustomOnionMessageContentsZDecodeErrorZ read_custom_onion_message(const void* this_arg, uint64_t type, LDKu8slice buf) {
+LDKCResult_COption_OnionMessageContentsZDecodeErrorZ read_custom_onion_message(const void* this_arg, uint64_t type, LDKu8slice buf) {
 	assert(type == 8888);
 	assert(buf.datalen == 1024);
 	uint8_t cmp[1024];
 	memset(cmp, 43, 1024);
 	assert(!memcmp(cmp, buf.data, 1024));
-	return CResult_COption_CustomOnionMessageContentsZDecodeErrorZ_ok(COption_CustomOnionMessageContentsZ_some(build_custom_onion_message()));
+	return CResult_COption_OnionMessageContentsZDecodeErrorZ_ok(COption_OnionMessageContentsZ_some(build_custom_onion_message()));
 }
 
+LDKCVec_C3Tuple_OnionMessageContentsDestinationBlindedPathZZ release_no_messages(const void* this_arg) {
+	return LDKCVec_C3Tuple_OnionMessageContentsDestinationBlindedPathZZ {
+		.data = NULL, .datalen = 0 };
+}
 
 struct CustomMsgQueue {
 	std::vector<LDK::Type> msgs;
@@ -991,6 +995,7 @@ int main() {
 		.this_arg = NULL,
 		.handle_custom_message = NULL, // We only create custom messages, not handle them
 		.read_custom_message = NULL, // We only create custom messages, not handle them
+		.release_pending_custom_messages = release_no_messages,
 		.free = NULL,
 	};
 	LDK::DefaultMessageRouter mr1 = DefaultMessageRouter_new();
@@ -1018,6 +1023,7 @@ int main() {
 		.this_arg = &peer_2_custom_onion_messages,
 		.handle_custom_message = handle_custom_onion_message,
 		.read_custom_message = read_custom_onion_message,
+		.release_pending_custom_messages = release_no_messages,
 		.free = NULL,
 	};
 	LDK::DefaultMessageRouter mr2 = DefaultMessageRouter_new();
@@ -1178,10 +1184,8 @@ int main() {
 				LDKCVec_PublicKeyZ { .data = NULL, .datalen = 0, },
 				Destination_node(ChannelManager_get_our_node_id(&cm2))
 			),
-			LDKOnionMessageContents {
-				.tag = LDKOnionMessageContents_Custom,
-				.custom = build_custom_onion_message()
-			}, LDKBlindedPath { .inner = NULL, .is_owned = true })
+			build_custom_onion_message(),
+			LDKBlindedPath { .inner = NULL, .is_owned = true })
 		.result_ok);
 	PeerManager_process_events(&net1);
 	std::cout << __FILE__ << ":" << __LINE__ << " - " << "Awaiting onion message..." << std::endl;

lightning-c-bindings/include/ldk_rust_types.h

@@ -24,6 +24,10 @@ struct nativeDelayedPaymentOutputDescriptorOpaque;
 typedef struct nativeDelayedPaymentOutputDescriptorOpaque LDKnativeDelayedPaymentOutputDescriptor;
 struct nativeStaticPaymentOutputDescriptorOpaque;
 typedef struct nativeStaticPaymentOutputDescriptorOpaque LDKnativeStaticPaymentOutputDescriptor;
+struct nativeChannelDerivationParametersOpaque;
+typedef struct nativeChannelDerivationParametersOpaque LDKnativeChannelDerivationParameters;
+struct nativeHTLCDescriptorOpaque;
+typedef struct nativeHTLCDescriptorOpaque LDKnativeHTLCDescriptor;
 struct LDKChannelSigner;
 struct nativeInMemorySignerOpaque;
 typedef struct nativeInMemorySignerOpaque LDKnativeInMemorySigner;
@@ -121,12 +125,8 @@ struct nativeNodeAliasOpaque;
 typedef struct nativeNodeAliasOpaque LDKnativeNodeAlias;
 struct nativeNodeInfoOpaque;
 typedef struct nativeNodeInfoOpaque LDKnativeNodeInfo;
-struct nativeChannelDerivationParametersOpaque;
-typedef struct nativeChannelDerivationParametersOpaque LDKnativeChannelDerivationParameters;
 struct nativeAnchorDescriptorOpaque;
 typedef struct nativeAnchorDescriptorOpaque LDKnativeAnchorDescriptor;
-struct nativeHTLCDescriptorOpaque;
-typedef struct nativeHTLCDescriptorOpaque LDKnativeHTLCDescriptor;
 struct nativeInputOpaque;
 typedef struct nativeInputOpaque LDKnativeInput;
 struct nativeUtxoOpaque;