Merge pull request #39 from TheBlueMatt/main

v0.0.100.0

Author: TheBlueMatt

.github/workflows/build.yml

@@ -35,7 +35,7 @@ jobs:
           cd ..
           git clone https://github.com/lightningdevkit/ldk-c-bindings
           cd ldk-c-bindings
-          git checkout 0.0.99
+          git checkout 0.0.100
       - name: Rebuild C bindings without STD for WASM
         run: |
           cd ldk-c-bindings
@@ -163,7 +163,7 @@ jobs:
           cd ..
           git clone https://github.com/lightningdevkit/ldk-c-bindings
           cd ldk-c-bindings
-          git checkout 0.0.99
+          git checkout 0.0.100
       - name: Detect current git version
         run: |
           # We assume the top commit is just a bindings update commit, so we
@@ -243,7 +243,7 @@ jobs:
           cd ..
           git clone https://github.com/lightningdevkit/ldk-c-bindings
           cd ldk-c-bindings
-          git checkout 0.0.99
+          git checkout 0.0.100
       - name: Rebuild C bindings with upstream clang, and check the sample app builds + links
         run: |
           cd ldk-c-bindings

gen_type_mapping.py

@@ -297,7 +297,7 @@ def map_type_with_info(self, ty_info, print_void, ret_arr_len, is_free, holds_re
                     if not is_free:
                         needs_full_clone = not is_free and (not ty_info.is_ptr and not holds_ref or ty_info.requires_clone == True) and ty_info.requires_clone != False
                         if needs_full_clone and (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
-                            base_conv = base_conv + "\n" + ty_info.var_name + "_conv = " + ty_info.rust_obj.replace("LDK", "") + "_clone(" + ty_info.var_name + ");"
+                            base_conv = base_conv + "\n" + ty_info.var_name + "_conv = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&" + ty_info.var_name + "_conv);"
                         else:
                             base_conv = base_conv + self.consts.trait_struct_inc_refcnt(ty_info)
                             if needs_full_clone:

java_strings.py

@@ -849,7 +849,7 @@ def native_c_map_trait(self, struct_name, field_vars, flattened_field_vars, fiel
                 elif not fn_line.ret_ty_info.passed_as_ptr:
                     out_c += "\t" + fn_line.ret_ty_info.c_ty + " ret = (*env)->Call" + fn_line.ret_ty_info.java_ty.title() + "Method(env, obj, j_calls->" + fn_line.fn_name + "_meth"
                 else:
-                    out_c = out_c + "\t" + fn_line.ret_ty_info.rust_obj + "* ret = (" + fn_line.ret_ty_info.rust_obj + "*)(*env)->CallLongMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
+                    out_c = out_c + "\tuint64_t ret = (*env)->CallLongMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
 
                 for idx, arg_info in enumerate(fn_line.args_ty):
                     if arg_info.ret_conv is not None:

src/main/java/org/ldk/impl/bindings.java

@@ -36,6 +36,9 @@ static APIError constr_from_ptr(long ptr) {
 		if (raw_val.getClass() == bindings.LDKAPIError.MonitorUpdateFailed.class) {
 			return new MonitorUpdateFailed(ptr, (bindings.LDKAPIError.MonitorUpdateFailed)raw_val);
 		}
+		if (raw_val.getClass() == bindings.LDKAPIError.IncompatibleShutdownScript.class) {
+			return new IncompatibleShutdownScript(ptr, (bindings.LDKAPIError.IncompatibleShutdownScript)raw_val);
+		}
 		assert false; return null; // Unreachable without extending the (internal) bindings interface
 	}
 
@@ -89,6 +92,19 @@ private MonitorUpdateFailed(long ptr, bindings.LDKAPIError.MonitorUpdateFailed o
 			super(null, ptr);
 		}
 	}
+	public final static class IncompatibleShutdownScript extends APIError {
+		/**
+		 * The incompatible shutdown script.
+		*/
+		public final ShutdownScript script;
+		private IncompatibleShutdownScript(long ptr, bindings.LDKAPIError.IncompatibleShutdownScript obj) {
+			super(null, ptr);
+			long script = obj.script;
+			ShutdownScript script_hu_conv = new ShutdownScript(null, script);
+			script_hu_conv.ptrs_to.add(this);
+			this.script = script_hu_conv;
+		}
+	}
 	/**
 	 * Creates a copy of the APIError
 	 */
@@ -155,4 +171,16 @@ public static APIError monitor_update_failed() {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Utility method to constructs a new IncompatibleShutdownScript-variant APIError
+	 */
+	public static APIError incompatible_shutdown_script(ShutdownScript script) {
+		long ret = bindings.APIError_incompatible_shutdown_script(script == null ? 0 : script.ptr & ~1);
+		if (ret < 1024) { return null; }
+		APIError ret_hu_conv = APIError.constr_from_ptr(ret);
+		ret_hu_conv.ptrs_to.add(ret_hu_conv);
+		ret_hu_conv.ptrs_to.add(script);
+		return ret_hu_conv;
+	}
+
 }

src/main/java/org/ldk/structs/APIError.java

@@ -22,6 +22,7 @@
  * then there is a risk of channels force-closing on startup when the manager realizes it's
  * outdated. However, as long as `ChannelMonitor` backups are sound, no funds besides those used
  * for unilateral chain closure fees are at risk.
+ * BackgroundProcessor will immediately stop on drop. It should be stored until shutdown.
  */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class BackgroundProcessor extends CommonBase {
@@ -33,21 +34,25 @@ protected void finalize() throws Throwable {
 	}
 
 	/**
-	 * Start a background thread that takes care of responsibilities enumerated in the top-level
-	 * documentation.
+	 * Start a background thread that takes care of responsibilities enumerated in the [top-level
+	 * documentation].
 	 * 
-	 * If `persist_manager` returns an error, then this thread will return said error (and
-	 * `start()` will need to be called again to restart the `BackgroundProcessor`). Users should
-	 * wait on [`thread_handle`]'s `join()` method to be able to tell if and when an error is
-	 * returned, or implement `persist_manager` such that an error is never returned to the
-	 * `BackgroundProcessor`
+	 * The thread runs indefinitely unless the object is dropped, [`stop`] is called, or
+	 * `persist_manager` returns an error. In case of an error, the error is retrieved by calling
+	 * either [`join`] or [`stop`].
+	 * 
+	 * Typically, users should either implement [`ChannelManagerPersister`] to never return an
+	 * error or call [`join`] and handle any error that may arise. For the latter case, the
+	 * `BackgroundProcessor` must be restarted by calling `start` again after handling the error.
 	 * 
 	 * `persist_manager` is responsible for writing out the [`ChannelManager`] to disk, and/or
 	 * uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
 	 * [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
 	 * provided implementation.
 	 * 
-	 * [`thread_handle`]: BackgroundProcessor::thread_handle
+	 * [top-level documentation]: Self
+	 * [`join`]: Self::join
+	 * [`stop`]: Self::stop
 	 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 	 * [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
 	 * [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
@@ -67,7 +72,42 @@ public static BackgroundProcessor start(ChannelManagerPersister persister, Event
 	}
 
 	/**
-	 * Stop `BackgroundProcessor`'s thread.
+	 * Join `BackgroundProcessor`'s thread, returning any error that occurred while persisting
+	 * [`ChannelManager`].
+	 * 
+	 * # Panics
+	 * 
+	 * This function panics if the background thread has panicked such as while persisting or
+	 * handling events.
+	 * 
+	 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
+	 */
+	public Result_NoneErrorZ join() {
+		long ret = bindings.BackgroundProcessor_join(this.ptr);
+		if (ret < 1024) { return null; }
+		Result_NoneErrorZ ret_hu_conv = Result_NoneErrorZ.constr_from_ptr(ret);
+		this.ptrs_to.add(this);
+		// Due to rust's strict-ownership memory model, in some cases we need to "move"
+		// an object to pass exclusive ownership to the function being called.
+		// In most cases, we avoid this being visible in GC'd languages by cloning the object
+		// at the FFI layer, creating a new object which Rust can claim ownership of
+		// However, in some cases (eg here), there is no way to clone an object, and thus
+		// we actually have to pass full ownership to Rust.
+		// Thus, after this call, this is reset to null and is now a dummy object.
+		this.ptr = 0;
+		return ret_hu_conv;
+	}
+
+	/**
+	 * Stop `BackgroundProcessor`'s thread, returning any error that occurred while persisting
+	 * [`ChannelManager`].
+	 * 
+	 * # Panics
+	 * 
+	 * This function panics if the background thread has panicked such as while persisting or
+	 * handling events.
+	 * 
+	 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 	 */
 	public Result_NoneErrorZ stop() {
 		long ret = bindings.BackgroundProcessor_stop(this.ptr);

src/main/java/org/ldk/structs/BackgroundProcessor.java

@@ -203,11 +203,111 @@ public void set_commit_upfront_shutdown_pubkey(boolean val) {
 		bindings.ChannelConfig_set_commit_upfront_shutdown_pubkey(this.ptr, val);
 	}
 
+	/**
+	 * Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
+	 * small to claim on-chain.
+	 * 
+	 * When an HTLC present in one of our channels is below a \"dust\" threshold, the HTLC will
+	 * not be claimable on-chain, instead being turned into additional miner fees if either
+	 * party force-closes the channel. Because the threshold is per-HTLC, our total exposure
+	 * to such payments may be sustantial if there are many dust HTLCs present when the
+	 * channel is force-closed.
+	 * 
+	 * This limit is applied for sent, forwarded, and received HTLCs and limits the total
+	 * exposure across all three types per-channel. Setting this too low may prevent the
+	 * sending or receipt of low-value HTLCs on high-traffic nodes, and this limit is very
+	 * important to prevent stealing of dust HTLCs by miners.
+	 * 
+	 * Default value: 5_000_000 msat.
+	 */
+	public long get_max_dust_htlc_exposure_msat() {
+		long ret = bindings.ChannelConfig_get_max_dust_htlc_exposure_msat(this.ptr);
+		return ret;
+	}
+
+	/**
+	 * Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
+	 * small to claim on-chain.
+	 * 
+	 * When an HTLC present in one of our channels is below a \"dust\" threshold, the HTLC will
+	 * not be claimable on-chain, instead being turned into additional miner fees if either
+	 * party force-closes the channel. Because the threshold is per-HTLC, our total exposure
+	 * to such payments may be sustantial if there are many dust HTLCs present when the
+	 * channel is force-closed.
+	 * 
+	 * This limit is applied for sent, forwarded, and received HTLCs and limits the total
+	 * exposure across all three types per-channel. Setting this too low may prevent the
+	 * sending or receipt of low-value HTLCs on high-traffic nodes, and this limit is very
+	 * important to prevent stealing of dust HTLCs by miners.
+	 * 
+	 * Default value: 5_000_000 msat.
+	 */
+	public void set_max_dust_htlc_exposure_msat(long val) {
+		bindings.ChannelConfig_set_max_dust_htlc_exposure_msat(this.ptr, val);
+	}
+
+	/**
+	 * The additional fee we're willing to pay to avoid waiting for the counterparty's
+	 * `to_self_delay` to reclaim funds.
+	 * 
+	 * When we close a channel cooperatively with our counterparty, we negotiate a fee for the
+	 * closing transaction which both sides find acceptable, ultimately paid by the channel
+	 * funder/initiator.
+	 * 
+	 * When we are the funder, because we have to pay the channel closing fee, we bound the
+	 * acceptable fee by our [`Background`] and [`Normal`] fees, with the upper bound increased by
+	 * this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
+	 * [`Normal`] feerate during normal operation, this value represents the additional fee we're
+	 * willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
+	 * funds.
+	 * 
+	 * When we are not the funder, we require the closing transaction fee pay at least our
+	 * [`Background`] fee estimate, but allow our counterparty to pay as much fee as they like.
+	 * Thus, this value is ignored when we are not the funder.
+	 * 
+	 * Default value: 1000 satoshis.
+	 * 
+	 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
+	 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
+	 */
+	public long get_force_close_avoidance_max_fee_satoshis() {
+		long ret = bindings.ChannelConfig_get_force_close_avoidance_max_fee_satoshis(this.ptr);
+		return ret;
+	}
+
+	/**
+	 * The additional fee we're willing to pay to avoid waiting for the counterparty's
+	 * `to_self_delay` to reclaim funds.
+	 * 
+	 * When we close a channel cooperatively with our counterparty, we negotiate a fee for the
+	 * closing transaction which both sides find acceptable, ultimately paid by the channel
+	 * funder/initiator.
+	 * 
+	 * When we are the funder, because we have to pay the channel closing fee, we bound the
+	 * acceptable fee by our [`Background`] and [`Normal`] fees, with the upper bound increased by
+	 * this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
+	 * [`Normal`] feerate during normal operation, this value represents the additional fee we're
+	 * willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
+	 * funds.
+	 * 
+	 * When we are not the funder, we require the closing transaction fee pay at least our
+	 * [`Background`] fee estimate, but allow our counterparty to pay as much fee as they like.
+	 * Thus, this value is ignored when we are not the funder.
+	 * 
+	 * Default value: 1000 satoshis.
+	 * 
+	 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
+	 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
+	 */
+	public void set_force_close_avoidance_max_fee_satoshis(long val) {
+		bindings.ChannelConfig_set_force_close_avoidance_max_fee_satoshis(this.ptr, val);
+	}
+
 	/**
 	 * Constructs a new ChannelConfig given each field
 	 */
-	public static ChannelConfig of(int forwarding_fee_proportional_millionths_arg, int forwarding_fee_base_msat_arg, short cltv_expiry_delta_arg, boolean announced_channel_arg, boolean commit_upfront_shutdown_pubkey_arg) {
-		long ret = bindings.ChannelConfig_new(forwarding_fee_proportional_millionths_arg, forwarding_fee_base_msat_arg, cltv_expiry_delta_arg, announced_channel_arg, commit_upfront_shutdown_pubkey_arg);
+	public static ChannelConfig of(int forwarding_fee_proportional_millionths_arg, int forwarding_fee_base_msat_arg, short cltv_expiry_delta_arg, boolean announced_channel_arg, boolean commit_upfront_shutdown_pubkey_arg, long max_dust_htlc_exposure_msat_arg, long force_close_avoidance_max_fee_satoshis_arg) {
+		long ret = bindings.ChannelConfig_new(forwarding_fee_proportional_millionths_arg, forwarding_fee_base_msat_arg, cltv_expiry_delta_arg, announced_channel_arg, commit_upfront_shutdown_pubkey_arg, max_dust_htlc_exposure_msat_arg, force_close_avoidance_max_fee_satoshis_arg);
 		if (ret < 1024) { return null; }
 		ChannelConfig ret_hu_conv = new ChannelConfig(null, ret);
 		ret_hu_conv.ptrs_to.add(ret_hu_conv);