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=d92016a7adc00ffedda263a53974efb7fd1d9bd6;hpb=1852c471e433c02edcae4803ba52bfec05c5631c;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/KeysManager.java b/src/main/java/org/ldk/structs/KeysManager.java
index d92016a7..840f8a63 100644
--- a/src/main/java/org/ldk/structs/KeysManager.java
+++ b/src/main/java/org/ldk/structs/KeysManager.java
@@ -9,12 +9,12 @@ import javax.annotation.Nullable;
 
 
 /**
- * Simple KeysInterface implementor that takes a 32-byte seed for use as a BIP 32 extended key
- * and derives keys from that.
+ * 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'
- * ChannelMonitor closes may use seed/1'
- * Cooperative closes may use seed/2'
+ * 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;
@@ -33,25 +33,23 @@ public class KeysManager extends CommonBase {
 	}
 
 	/**
-	 * Constructs a KeysManager from a 32-byte seed. If the seed is in some way biased (eg 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,
+	 * 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).
+	 * `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
+	 * 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`] data, though a current copy of [`ChannelMonitor`] data is also required
+	 * for any channel, and some on-chain during-closing funds.
 	 * 
-	 * Note that until the 0.1 release there is no guarantee of backward compatibility between
-	 * versions. Once the library is more fully supported, the docs will be updated to include a
-	 * detailed description of the guarantee.
+	 * [`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);
@@ -65,11 +63,7 @@ public class KeysManager extends CommonBase {
 	}
 
 	/**
-	 * Derive an old Sign containing per-channel secrets based on a key derivation parameters.
-	 * 
-	 * Key derivation parameters are accessible through a per-channel secrets
-	 * Sign::channel_keys_id and is provided inside DynamicOuputP2WSH in case of
-	 * onchain output detection for which a corresponding delayed_payment_key must be derived.
+	 * 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));
@@ -83,7 +77,7 @@ public class KeysManager extends CommonBase {
 	}
 
 	/**
-	 * Creates a Transaction which spends the given descriptors to the given outputs, plus an
+	 * 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.
 	 * 
@@ -93,8 +87,8 @@ public class KeysManager extends CommonBase {
 	 * 
 	 * 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.
+	 * 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);