X-Git-Url: http://git.bitcoin.ninja/index.cgi?p=ldk-java;a=blobdiff_plain;f=ts%2Fstructs%2FKeysManager.mts;h=8a1524cc7bb27012248e1b6e7a792a29a1e08ad0;hp=15eee002334ac806b6c29242a4dfa4e214592344;hb=c629a01650402c8e2f9b9db8ced9ed63ce687727;hpb=d1d0121c000b713c10fd0bedd249eb8dda2e4db7

diff --git a/ts/structs/KeysManager.mts b/ts/structs/KeysManager.mts
index 15eee002..8a1524cc 100644
--- a/ts/structs/KeysManager.mts
+++ b/ts/structs/KeysManager.mts
@@ -281,12 +281,42 @@ import CommonBase from './CommonBase.mjs';
 import * as bindings from '../bindings.mjs'
 
 
+/**
+ * Simple KeysInterface implementor 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'
+ * The two close keys may be needed to claim on-chain funds!
+ */
 export class KeysManager extends CommonBase {
 	/* @internal */
 	public constructor(_dummy: object, ptr: number) {
 		super(ptr, bindings.KeysManager_free);
 	}
 
+	/**
+	 * 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,
+	 * 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.
+	 * 
+	 * 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.
+	 */
 	public static constructor_new(seed: Uint8Array, starting_time_secs: bigint, starting_time_nanos: number): KeysManager {
 		const ret: number = bindings.KeysManager_new(bindings.encodeUint8Array(bindings.check_arr_len(seed, 32)), starting_time_secs, starting_time_nanos);
 		const ret_hu_conv: KeysManager = new KeysManager(null, ret);
@@ -294,6 +324,13 @@ export class KeysManager extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * 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.
+	 */
 	public derive_channel_keys(channel_value_satoshis: bigint, params: Uint8Array): InMemorySigner {
 		const ret: number = bindings.KeysManager_derive_channel_keys(this.ptr, channel_value_satoshis, bindings.encodeUint8Array(bindings.check_arr_len(params, 32)));
 		const ret_hu_conv: InMemorySigner = new InMemorySigner(null, ret);
@@ -301,12 +338,29 @@ export class KeysManager extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * 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 or
+	 * if a descriptor was duplicated.
+	 * 
+	 * 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 spend_spendable_outputs(descriptors: SpendableOutputDescriptor[], outputs: TxOut[], change_destination_script: Uint8Array, feerate_sat_per_1000_weight: number): Result_TransactionNoneZ {
 		const ret: number = bindings.KeysManager_spend_spendable_outputs(this.ptr, bindings.encodeUint32Array(descriptors != null ? descriptors.map(descriptors_conv_27 => CommonBase.get_ptr_of(descriptors_conv_27)) : null), bindings.encodeUint32Array(outputs != null ? outputs.map(outputs_conv_7 => CommonBase.get_ptr_of(outputs_conv_7)) : null), bindings.encodeUint8Array(change_destination_script), feerate_sat_per_1000_weight);
 		const ret_hu_conv: Result_TransactionNoneZ = 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 as_KeysInterface(): KeysInterface {
 		const ret: number = bindings.KeysManager_as_KeysInterface(this.ptr);
 		const ret_hu_conv: KeysInterface = new KeysInterface(null, ret);