X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FKeysManager.java;h=840f8a63162454c007a017b5aaa06a774938e35a;hb=330ca992be304d0eac79bd59b411980dff294b03;hp=16a4a87312f9ae6c98eebf168037c7622930fe49;hpb=fed2245c60159f6c074c9ed5c0f3ce273ad9841b;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/KeysManager.java b/src/main/java/org/ldk/structs/KeysManager.java
index 16a4a873..840f8a63 100644
--- a/src/main/java/org/ldk/structs/KeysManager.java
+++ b/src/main/java/org/ldk/structs/KeysManager.java
@@ -4,7 +4,25 @@ import org.ldk.impl.bindings;
 import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
+import java.lang.ref.Reference;
+import javax.annotation.Nullable;
 
+
+/**
+ * Simple [`KeysInterface`] implementation that takes a 32-byte seed for use as a BIP 32 extended
+ * key and derives keys from that.
+ * 
+ * Your `node_id` is seed/0'.
+ * Unilateral closes may use seed/1'.
+ * Cooperative closes may use seed/2'.
+ * The two close keys may be needed to claim on-chain funds!
+ * 
+ * This struct cannot be used for nodes that wish to support receiving phantom payments;
+ * [`PhantomKeysManager`] must be used instead.
+ * 
+ * Note that switching between this struct and [`PhantomKeysManager`] will invalidate any
+ * previously issued invoices and attempts to pay previous invoices will fail.
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class KeysManager extends CommonBase {
 	KeysManager(Object _dummy, long ptr) { super(ptr); }
@@ -14,24 +32,86 @@ public class KeysManager extends CommonBase {
 		if (ptr != 0) { bindings.KeysManager_free(ptr); }
 	}
 
-	public static KeysManager constructor_new(byte[] seed, LDKNetwork network, long starting_time_secs, int starting_time_nanos) {
-		long ret = bindings.KeysManager_new(seed, network, starting_time_secs, starting_time_nanos);
-		KeysManager ret_hu_conv = new KeysManager(null, ret);
-		ret_hu_conv.ptrs_to.add(ret_hu_conv);
+	/**
+	 * Constructs a [`KeysManager`] from a 32-byte seed. If the seed is in some way biased (e.g.,
+	 * your CSRNG is busted) this may panic (but more importantly, you will possibly lose funds).
+	 * `starting_time` isn't strictly required to actually be a time, but it must absolutely,
+	 * without a doubt, be unique to this instance. ie if you start multiple times with the same
+	 * `seed`, `starting_time` must be unique to each run. Thus, the easiest way to achieve this
+	 * is to simply use the current time (with very high precision).
+	 * 
+	 * The `seed` MUST be backed up safely prior to use so that the keys can be re-created, however,
+	 * obviously, `starting_time` should be unique every time you reload the library - it is only
+	 * used to generate new ephemeral key data (which will be stored by the individual channel if
+	 * necessary).
+	 * 
+	 * Note that the seed is required to recover certain on-chain funds independent of
+	 * [`ChannelMonitor`] data, though a current copy of [`ChannelMonitor`] data is also required
+	 * for any channel, and some on-chain during-closing funds.
+	 * 
+	 * [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
+	 */
+	public static KeysManager of(byte[] seed, long starting_time_secs, int starting_time_nanos) {
+		long ret = bindings.KeysManager_new(InternalUtils.check_arr_len(seed, 32), starting_time_secs, starting_time_nanos);
+		Reference.reachabilityFence(seed);
+		Reference.reachabilityFence(starting_time_secs);
+		Reference.reachabilityFence(starting_time_nanos);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		org.ldk.structs.KeysManager ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.KeysManager(null, ret); }
+		if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+		return ret_hu_conv;
+	}
+
+	/**
+	 * Derive an old [`Sign`] containing per-channel secrets based on a key derivation parameters.
+	 */
+	public InMemorySigner derive_channel_keys(long channel_value_satoshis, byte[] params) {
+		long ret = bindings.KeysManager_derive_channel_keys(this.ptr, channel_value_satoshis, InternalUtils.check_arr_len(params, 32));
+		Reference.reachabilityFence(this);
+		Reference.reachabilityFence(channel_value_satoshis);
+		Reference.reachabilityFence(params);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		org.ldk.structs.InMemorySigner ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.InMemorySigner(null, ret); }
+		if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
 		return ret_hu_conv;
 	}
 
-	public InMemoryChannelKeys derive_channel_keys(long channel_value_satoshis, long params_1, long params_2) {
-		long ret = bindings.KeysManager_derive_channel_keys(this.ptr, channel_value_satoshis, params_1, params_2);
-		InMemoryChannelKeys ret_hu_conv = new InMemoryChannelKeys(null, ret);
-		ret_hu_conv.ptrs_to.add(this);
+	/**
+	 * Creates a [`Transaction`] which spends the given descriptors to the given outputs, plus an
+	 * output to the given change destination (if sufficient change value remains). The
+	 * transaction will have a feerate, at least, of the given value.
+	 * 
+	 * Returns `Err(())` if the output value is greater than the input value minus required fee,
+	 * if a descriptor was duplicated, or if an output descriptor `script_pubkey`
+	 * does not match the one we can spend.
+	 * 
+	 * We do not enforce that outputs meet the dust limit or that any output scripts are standard.
+	 * 
+	 * May panic if the [`SpendableOutputDescriptor`]s were not generated by channels which used
+	 * this [`KeysManager`] or one of the [`InMemorySigner`] created by this [`KeysManager`].
+	 */
+	public Result_TransactionNoneZ spend_spendable_outputs(SpendableOutputDescriptor[] descriptors, TxOut[] outputs, byte[] change_destination_script, int feerate_sat_per_1000_weight) {
+		long ret = bindings.KeysManager_spend_spendable_outputs(this.ptr, descriptors != null ? Arrays.stream(descriptors).mapToLong(descriptors_conv_27 -> descriptors_conv_27.ptr).toArray() : null, outputs != null ? Arrays.stream(outputs).mapToLong(outputs_conv_7 -> outputs_conv_7.ptr).toArray() : null, change_destination_script, feerate_sat_per_1000_weight);
+		Reference.reachabilityFence(this);
+		Reference.reachabilityFence(descriptors);
+		Reference.reachabilityFence(outputs);
+		Reference.reachabilityFence(change_destination_script);
+		Reference.reachabilityFence(feerate_sat_per_1000_weight);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		Result_TransactionNoneZ ret_hu_conv = Result_TransactionNoneZ.constr_from_ptr(ret);
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Constructs a new KeysInterface which calls the relevant methods on this_arg.
+	 * This copies the `inner` pointer in this_arg and thus the returned KeysInterface must be freed before this_arg is
+	 */
 	public KeysInterface as_KeysInterface() {
 		long ret = bindings.KeysManager_as_KeysInterface(this.ptr);
+		Reference.reachabilityFence(this);
+		if (ret >= 0 && ret <= 4096) { return null; }
 		KeysInterface ret_hu_conv = new KeysInterface(null, ret);
-		ret_hu_conv.ptrs_to.add(this);
+		if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
 		return ret_hu_conv;
 	}