X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FUtilMethods.java;h=dac1f32ce06ef0e9da6ea26cc7ecf08f8113daf9;hb=c6bac88847b7c09560af81f00ba8dd3c2ebe3a19;hp=f2a7c07b8961eced7e6da82d3fa0bb7b682d6567;hpb=b6cc0960eaee5a5bbc7fde79a56152d6dcd649d8;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/UtilMethods.java b/src/main/java/org/ldk/structs/UtilMethods.java
index f2a7c07b..dac1f32c 100644
--- a/src/main/java/org/ldk/structs/UtilMethods.java
+++ b/src/main/java/org/ldk/structs/UtilMethods.java
@@ -1,6 +1,7 @@
 package org.ldk.structs;
 import org.ldk.impl.bindings;
 import java.util.Arrays;
+import javax.annotation.Nullable;
 import org.ldk.enums.*;
 
 public class UtilMethods {
@@ -11,6 +12,7 @@ public class UtilMethods {
 	 */
 	public static Result_StringErrorZ sign(byte[] msg, byte[] sk) {
 		long ret = bindings.sign(msg, sk);
+		if (ret >= 0 && ret <= 4096) { return null; }
 		Result_StringErrorZ ret_hu_conv = Result_StringErrorZ.constr_from_ptr(ret);
 		return ret_hu_conv;
 	}
@@ -18,8 +20,9 @@ public class UtilMethods {
 	/**
 	 * Recovers the PublicKey of the signer of the message given the message and the signature.
 	 */
-	public static Result_PublicKeyErrorZ recover_pk(byte[] msg, String sig) {
+	public static Result_PublicKeyErrorZ recover_pk(byte[] msg, java.lang.String sig) {
 		long ret = bindings.recover_pk(msg, sig);
+		if (ret >= 0 && ret <= 4096) { return null; }
 		Result_PublicKeyErrorZ ret_hu_conv = Result_PublicKeyErrorZ.constr_from_ptr(ret);
 		return ret_hu_conv;
 	}
@@ -28,7 +31,7 @@ public class UtilMethods {
 	 * Verifies a message was signed by a PrivateKey that derives to a given PublicKey, given a message, a signature,
 	 * and the PublicKey.
 	 */
-	public static boolean verify(byte[] msg, String sig, byte[] pk) {
+	public static boolean verify(byte[] msg, java.lang.String sig, byte[] pk) {
 		boolean ret = bindings.verify(msg, sig, pk);
 		return ret;
 	}
@@ -36,8 +39,9 @@ public class UtilMethods {
 	/**
 	 * Read a C2Tuple_BlockHashChannelMonitorZ from a byte array, created by C2Tuple_BlockHashChannelMonitorZ_write
 	 */
-	public static Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ BlockHashChannelMonitorZ_read(byte[] ser, KeysInterface arg) {
+	public static Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ C2Tuple_BlockHashChannelMonitorZ_read(byte[] ser, KeysInterface arg) {
 		long ret = bindings.C2Tuple_BlockHashChannelMonitorZ_read(ser, arg == null ? 0 : arg.ptr);
+		if (ret >= 0 && ret <= 4096) { return null; }
 		Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ ret_hu_conv = Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.constr_from_ptr(ret);
 		ret_hu_conv.ptrs_to.add(arg);
 		return ret_hu_conv;
@@ -46,16 +50,17 @@ public class UtilMethods {
 	/**
 	 * Read a C2Tuple_BlockHashChannelManagerZ from a byte array, created by C2Tuple_BlockHashChannelManagerZ_write
 	 */
-	public static Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ BlockHashChannelManagerZ_read(byte[] ser, KeysInterface arg_keys_manager, FeeEstimator arg_fee_estimator, Watch arg_chain_monitor, BroadcasterInterface arg_tx_broadcaster, Logger arg_logger, UserConfig arg_default_config, ChannelMonitor[] arg_channel_monitors) {
-		long ret = bindings.C2Tuple_BlockHashChannelManagerZ_read(ser, bindings.ChannelManagerReadArgs_new(arg_keys_manager == null ? 0 : arg_keys_manager.ptr, arg_fee_estimator == null ? 0 : arg_fee_estimator.ptr, arg_chain_monitor == null ? 0 : arg_chain_monitor.ptr, arg_tx_broadcaster == null ? 0 : arg_tx_broadcaster.ptr, arg_logger == null ? 0 : arg_logger.ptr, arg_default_config == null ? 0 : arg_default_config.ptr & ~1, Arrays.stream(arg_channel_monitors).mapToLong(arg_channel_monitors_conv_16 -> arg_channel_monitors_conv_16 == null ? 0 : arg_channel_monitors_conv_16.ptr & ~1).toArray()));
+	public static Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ C2Tuple_BlockHashChannelManagerZ_read(byte[] ser, KeysInterface arg_keys_manager, FeeEstimator arg_fee_estimator, Watch arg_chain_monitor, BroadcasterInterface arg_tx_broadcaster, Logger arg_logger, UserConfig arg_default_config, ChannelMonitor[] arg_channel_monitors) {
+		long ret = bindings.C2Tuple_BlockHashChannelManagerZ_read(ser, bindings.ChannelManagerReadArgs_new(arg_keys_manager == null ? 0 : arg_keys_manager.ptr, arg_fee_estimator == null ? 0 : arg_fee_estimator.ptr, arg_chain_monitor == null ? 0 : arg_chain_monitor.ptr, arg_tx_broadcaster == null ? 0 : arg_tx_broadcaster.ptr, arg_logger == null ? 0 : arg_logger.ptr, arg_default_config == null ? 0 : arg_default_config.ptr & ~1, arg_channel_monitors != null ? Arrays.stream(arg_channel_monitors).mapToLong(arg_channel_monitors_conv_16 -> arg_channel_monitors_conv_16 == null ? 0 : arg_channel_monitors_conv_16.ptr & ~1).toArray() : null));
+		if (ret >= 0 && ret <= 4096) { return null; }
 		Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ ret_hu_conv = Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.constr_from_ptr(ret);
 		ret_hu_conv.ptrs_to.add(arg_keys_manager);
 		ret_hu_conv.ptrs_to.add(arg_fee_estimator);
 		ret_hu_conv.ptrs_to.add(arg_chain_monitor);
 		ret_hu_conv.ptrs_to.add(arg_tx_broadcaster);
 		ret_hu_conv.ptrs_to.add(arg_logger);
-		ret_hu_conv.ptrs_to.add(arg_default_config);
-		/* TODO 2 ChannelMonitor  */;
+		;
+		for (ChannelMonitor arg_channel_monitors_conv_16: arg_channel_monitors) { ret_hu_conv.ptrs_to.add(arg_channel_monitors_conv_16); };
 		return ret_hu_conv;
 	}
 
@@ -67,6 +72,14 @@ public class UtilMethods {
 		return ret;
 	}
 
+	/**
+	 * Build a closing transaction
+	 */
+	public static byte[] build_closing_transaction(long to_holder_value_sat, long to_counterparty_value_sat, byte[] to_holder_script, byte[] to_counterparty_script, OutPoint funding_outpoint) {
+		byte[] ret = bindings.build_closing_transaction(to_holder_value_sat, to_counterparty_value_sat, to_holder_script, to_counterparty_script, funding_outpoint == null ? 0 : funding_outpoint.ptr & ~1);
+		return ret;
+	}
+
 	/**
 	 * Derives a per-commitment-transaction private key (eg an htlc key or delayed_payment key)
 	 * from the base secret and the per_commitment_point.
@@ -76,6 +89,7 @@ public class UtilMethods {
 	 */
 	public static Result_SecretKeyErrorZ derive_private_key(byte[] per_commitment_point, byte[] base_secret) {
 		long ret = bindings.derive_private_key(per_commitment_point, base_secret);
+		if (ret >= 0 && ret <= 4096) { return null; }
 		Result_SecretKeyErrorZ ret_hu_conv = Result_SecretKeyErrorZ.constr_from_ptr(ret);
 		return ret_hu_conv;
 	}
@@ -90,6 +104,7 @@ public class UtilMethods {
 	 */
 	public static Result_PublicKeyErrorZ derive_public_key(byte[] per_commitment_point, byte[] base_point) {
 		long ret = bindings.derive_public_key(per_commitment_point, base_point);
+		if (ret >= 0 && ret <= 4096) { return null; }
 		Result_PublicKeyErrorZ ret_hu_conv = Result_PublicKeyErrorZ.constr_from_ptr(ret);
 		return ret_hu_conv;
 	}
@@ -107,6 +122,7 @@ public class UtilMethods {
 	 */
 	public static Result_SecretKeyErrorZ derive_private_revocation_key(byte[] per_commitment_secret, byte[] countersignatory_revocation_base_secret) {
 		long ret = bindings.derive_private_revocation_key(per_commitment_secret, countersignatory_revocation_base_secret);
+		if (ret >= 0 && ret <= 4096) { return null; }
 		Result_SecretKeyErrorZ ret_hu_conv = Result_SecretKeyErrorZ.constr_from_ptr(ret);
 		return ret_hu_conv;
 	}
@@ -126,6 +142,7 @@ public class UtilMethods {
 	 */
 	public static Result_PublicKeyErrorZ derive_public_revocation_key(byte[] per_commitment_point, byte[] countersignatory_revocation_base_point) {
 		long ret = bindings.derive_public_revocation_key(per_commitment_point, countersignatory_revocation_base_point);
+		if (ret >= 0 && ret <= 4096) { return null; }
 		Result_PublicKeyErrorZ ret_hu_conv = Result_PublicKeyErrorZ.constr_from_ptr(ret);
 		return ret_hu_conv;
 	}
@@ -189,34 +206,46 @@ public class UtilMethods {
 	}
 
 	/**
-	 * Gets a route from us (payer) to the given target node (payee).
+	 * Finds a route from us (payer) to the given target node (payee).
 	 * 
-	 * If the payee provided features in their invoice, they should be provided via payee_features.
+	 * If the payee provided features in their invoice, they should be provided via `params.payee`.
 	 * Without this, MPP will only be used if the payee's features are available in the network graph.
 	 * 
-	 * Private routing paths between a public node and the target may be included in `last_hops`.
-	 * Currently, only the last hop in each path is considered.
+	 * Private routing paths between a public node and the target may be included in `params.payee`.
+	 * 
+	 * If some channels aren't announced, it may be useful to fill in `first_hops` with the results
+	 * from [`ChannelManager::list_usable_channels`]. If it is filled in, the view of our local
+	 * channels from [`NetworkGraph`] will be ignored, and only those in `first_hops` will be used.
+	 * 
+	 * The fees on channels from us to the next hop are ignored as they are assumed to all be equal.
+	 * However, the enabled/disabled bit on such channels as well as the `htlc_minimum_msat` /
+	 * `htlc_maximum_msat` *are* checked as they may change based on the receiving node.
+	 * 
+	 * # Note
+	 * 
+	 * May be used to re-compute a [`Route`] when handling a [`Event::PaymentPathFailed`]. Any
+	 * adjustments to the [`NetworkGraph`] and channel scores should be made prior to calling this
+	 * function.
+	 * 
+	 * # Panics
 	 * 
-	 * If some channels aren't announced, it may be useful to fill in a first_hops with the
-	 * results from a local ChannelManager::list_usable_channels() call. If it is filled in, our
-	 * view of our local channels (from net_graph_msg_handler) will be ignored, and only those
-	 * in first_hops will be used.
+	 * Panics if first_hops contains channels without short_channel_ids;
+	 * [`ChannelManager::list_usable_channels`] will never include such channels.
 	 * 
-	 * Panics if first_hops contains channels without short_channel_ids
-	 * (ChannelManager::list_usable_channels will never include such channels).
+	 * [`ChannelManager::list_usable_channels`]: crate::ln::channelmanager::ChannelManager::list_usable_channels
+	 * [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
 	 * 
-	 * The fees on channels from us to next-hops are ignored (as they are assumed to all be
-	 * equal), however the enabled/disabled bit on such channels as well as the
-	 * htlc_minimum_msat/htlc_maximum_msat *are* checked as they may change based on the receiving node.
+	 * Note that first_hops (or a relevant inner pointer) may be NULL or all-0s to represent None
 	 */
-	public static Result_RouteLightningErrorZ get_route(byte[] our_node_id, NetworkGraph network, byte[] payee, InvoiceFeatures payee_features, ChannelDetails[] first_hops, RouteHint[] last_hops, long final_value_msat, int final_cltv, Logger logger) {
-		long ret = bindings.get_route(our_node_id, network == null ? 0 : network.ptr & ~1, payee, payee_features == null ? 0 : payee_features.ptr & ~1, Arrays.stream(first_hops).mapToLong(first_hops_conv_16 -> first_hops_conv_16 == null ? 0 : first_hops_conv_16.ptr & ~1).toArray(), Arrays.stream(last_hops).mapToLong(last_hops_conv_11 -> last_hops_conv_11 == null ? 0 : last_hops_conv_11.ptr & ~1).toArray(), final_value_msat, final_cltv, logger == null ? 0 : logger.ptr);
+	public static Result_RouteLightningErrorZ find_route(byte[] our_node_pubkey, RouteParameters params, NetworkGraph network, @Nullable ChannelDetails[] first_hops, Logger logger, Score scorer) {
+		long ret = bindings.find_route(our_node_pubkey, params == null ? 0 : params.ptr & ~1, network == null ? 0 : network.ptr & ~1, first_hops != null ? Arrays.stream(first_hops).mapToLong(first_hops_conv_16 -> first_hops_conv_16 == null ? 0 : first_hops_conv_16.ptr & ~1).toArray() : null, logger == null ? 0 : logger.ptr, scorer == null ? 0 : scorer.ptr);
+		if (ret >= 0 && ret <= 4096) { return null; }
 		Result_RouteLightningErrorZ ret_hu_conv = Result_RouteLightningErrorZ.constr_from_ptr(ret);
+		ret_hu_conv.ptrs_to.add(params);
 		ret_hu_conv.ptrs_to.add(network);
-		ret_hu_conv.ptrs_to.add(payee_features);
-		/* TODO 2 ChannelDetails  */;
-		/* TODO 2 RouteHint  */;
+		for (ChannelDetails first_hops_conv_16: first_hops) { ret_hu_conv.ptrs_to.add(first_hops_conv_16); };
 		ret_hu_conv.ptrs_to.add(logger);
+		ret_hu_conv.ptrs_to.add(scorer);
 		return ret_hu_conv;
 	}
 
@@ -224,8 +253,9 @@ public class UtilMethods {
 	 * Writes the provided `ChannelManager` to the path provided at `FilesystemPersister`
 	 * initialization, within a file called \"manager\".
 	 */
-	public static Result_NoneErrorZ FilesystemPersister_persist_manager(String data_dir, ChannelManager manager) {
+	public static Result_NoneErrorZ FilesystemPersister_persist_manager(java.lang.String data_dir, ChannelManager manager) {
 		long ret = bindings.FilesystemPersister_persist_manager(data_dir, manager == null ? 0 : manager.ptr & ~1);
+		if (ret >= 0 && ret <= 4096) { return null; }
 		Result_NoneErrorZ ret_hu_conv = Result_NoneErrorZ.constr_from_ptr(ret);
 		ret_hu_conv.ptrs_to.add(manager);
 		return ret_hu_conv;
@@ -238,8 +268,9 @@ public class UtilMethods {
 	 * doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
 	 * that the payment secret is valid when the invoice is paid.
 	 */
-	public static Result_InvoiceSignOrCreationErrorZ create_invoice_from_channelmanager(ChannelManager channelmanager, KeysInterface keys_manager, Currency network, Option_u64Z amt_msat, String description) {
+	public static Result_InvoiceSignOrCreationErrorZ create_invoice_from_channelmanager(ChannelManager channelmanager, KeysInterface keys_manager, org.ldk.enums.Currency network, Option_u64Z amt_msat, java.lang.String description) {
 		long ret = bindings.create_invoice_from_channelmanager(channelmanager == null ? 0 : channelmanager.ptr & ~1, keys_manager == null ? 0 : keys_manager.ptr, network, amt_msat.ptr, description);
+		if (ret >= 0 && ret <= 4096) { return null; }
 		Result_InvoiceSignOrCreationErrorZ ret_hu_conv = Result_InvoiceSignOrCreationErrorZ.constr_from_ptr(ret);
 		ret_hu_conv.ptrs_to.add(channelmanager);
 		ret_hu_conv.ptrs_to.add(keys_manager);