X-Git-Url: http://git.bitcoin.ninja/index.cgi?p=ldk-java;a=blobdiff_plain;f=ts%2Fstructs%2FAcceptChannel.mts;h=eacde00e3be225707dd48f7fbe0365d03adc49d1;hp=1d6e3c602277ee4dca680fed9ba8df3e2cffe81a;hb=c629a01650402c8e2f9b9db8ced9ed63ce687727;hpb=d1d0121c000b713c10fd0bedd249eb8dda2e4db7

diff --git a/ts/structs/AcceptChannel.mts b/ts/structs/AcceptChannel.mts
index 1d6e3c60..eacde00e 100644
--- a/ts/structs/AcceptChannel.mts
+++ b/ts/structs/AcceptChannel.mts
@@ -281,141 +281,228 @@ import CommonBase from './CommonBase.mjs';
 import * as bindings from '../bindings.mjs'
 
 
+/**
+ * An accept_channel message to be sent or received from a peer
+ */
 export class AcceptChannel extends CommonBase {
 	/* @internal */
 	public constructor(_dummy: object, ptr: number) {
 		super(ptr, bindings.AcceptChannel_free);
 	}
 
+	/**
+	 * A temporary channel ID, until the funding outpoint is announced
+	 */
 	public get_temporary_channel_id(): Uint8Array {
 		const ret: number = bindings.AcceptChannel_get_temporary_channel_id(this.ptr);
 		const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
 		return ret_conv;
 	}
 
+	/**
+	 * A temporary channel ID, until the funding outpoint is announced
+	 */
 	public set_temporary_channel_id(val: Uint8Array): void {
 		bindings.AcceptChannel_set_temporary_channel_id(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(val, 32)));
 	}
 
+	/**
+	 * The threshold below which outputs on transactions broadcast by sender will be omitted
+	 */
 	public get_dust_limit_satoshis(): bigint {
 		const ret: bigint = bindings.AcceptChannel_get_dust_limit_satoshis(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The threshold below which outputs on transactions broadcast by sender will be omitted
+	 */
 	public set_dust_limit_satoshis(val: bigint): void {
 		bindings.AcceptChannel_set_dust_limit_satoshis(this.ptr, val);
 	}
 
+	/**
+	 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
+	 */
 	public get_max_htlc_value_in_flight_msat(): bigint {
 		const ret: bigint = bindings.AcceptChannel_get_max_htlc_value_in_flight_msat(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
+	 */
 	public set_max_htlc_value_in_flight_msat(val: bigint): void {
 		bindings.AcceptChannel_set_max_htlc_value_in_flight_msat(this.ptr, val);
 	}
 
+	/**
+	 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
+	 */
 	public get_channel_reserve_satoshis(): bigint {
 		const ret: bigint = bindings.AcceptChannel_get_channel_reserve_satoshis(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
+	 */
 	public set_channel_reserve_satoshis(val: bigint): void {
 		bindings.AcceptChannel_set_channel_reserve_satoshis(this.ptr, val);
 	}
 
+	/**
+	 * The minimum HTLC size incoming to sender, in milli-satoshi
+	 */
 	public get_htlc_minimum_msat(): bigint {
 		const ret: bigint = bindings.AcceptChannel_get_htlc_minimum_msat(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The minimum HTLC size incoming to sender, in milli-satoshi
+	 */
 	public set_htlc_minimum_msat(val: bigint): void {
 		bindings.AcceptChannel_set_htlc_minimum_msat(this.ptr, val);
 	}
 
+	/**
+	 * Minimum depth of the funding transaction before the channel is considered open
+	 */
 	public get_minimum_depth(): number {
 		const ret: number = bindings.AcceptChannel_get_minimum_depth(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * Minimum depth of the funding transaction before the channel is considered open
+	 */
 	public set_minimum_depth(val: number): void {
 		bindings.AcceptChannel_set_minimum_depth(this.ptr, val);
 	}
 
+	/**
+	 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
+	 */
 	public get_to_self_delay(): number {
 		const ret: number = bindings.AcceptChannel_get_to_self_delay(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
+	 */
 	public set_to_self_delay(val: number): void {
 		bindings.AcceptChannel_set_to_self_delay(this.ptr, val);
 	}
 
+	/**
+	 * The maximum number of inbound HTLCs towards sender
+	 */
 	public get_max_accepted_htlcs(): number {
 		const ret: number = bindings.AcceptChannel_get_max_accepted_htlcs(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The maximum number of inbound HTLCs towards sender
+	 */
 	public set_max_accepted_htlcs(val: number): void {
 		bindings.AcceptChannel_set_max_accepted_htlcs(this.ptr, val);
 	}
 
+	/**
+	 * The sender's key controlling the funding transaction
+	 */
 	public get_funding_pubkey(): Uint8Array {
 		const ret: number = bindings.AcceptChannel_get_funding_pubkey(this.ptr);
 		const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
 		return ret_conv;
 	}
 
+	/**
+	 * The sender's key controlling the funding transaction
+	 */
 	public set_funding_pubkey(val: Uint8Array): void {
 		bindings.AcceptChannel_set_funding_pubkey(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(val, 33)));
 	}
 
+	/**
+	 * Used to derive a revocation key for transactions broadcast by counterparty
+	 */
 	public get_revocation_basepoint(): Uint8Array {
 		const ret: number = bindings.AcceptChannel_get_revocation_basepoint(this.ptr);
 		const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
 		return ret_conv;
 	}
 
+	/**
+	 * Used to derive a revocation key for transactions broadcast by counterparty
+	 */
 	public set_revocation_basepoint(val: Uint8Array): void {
 		bindings.AcceptChannel_set_revocation_basepoint(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(val, 33)));
 	}
 
+	/**
+	 * A payment key to sender for transactions broadcast by counterparty
+	 */
 	public get_payment_point(): Uint8Array {
 		const ret: number = bindings.AcceptChannel_get_payment_point(this.ptr);
 		const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
 		return ret_conv;
 	}
 
+	/**
+	 * A payment key to sender for transactions broadcast by counterparty
+	 */
 	public set_payment_point(val: Uint8Array): void {
 		bindings.AcceptChannel_set_payment_point(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(val, 33)));
 	}
 
+	/**
+	 * Used to derive a payment key to sender for transactions broadcast by sender
+	 */
 	public get_delayed_payment_basepoint(): Uint8Array {
 		const ret: number = bindings.AcceptChannel_get_delayed_payment_basepoint(this.ptr);
 		const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
 		return ret_conv;
 	}
 
+	/**
+	 * Used to derive a payment key to sender for transactions broadcast by sender
+	 */
 	public set_delayed_payment_basepoint(val: Uint8Array): void {
 		bindings.AcceptChannel_set_delayed_payment_basepoint(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(val, 33)));
 	}
 
+	/**
+	 * Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
+	 */
 	public get_htlc_basepoint(): Uint8Array {
 		const ret: number = bindings.AcceptChannel_get_htlc_basepoint(this.ptr);
 		const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
 		return ret_conv;
 	}
 
+	/**
+	 * Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
+	 */
 	public set_htlc_basepoint(val: Uint8Array): void {
 		bindings.AcceptChannel_set_htlc_basepoint(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(val, 33)));
 	}
 
+	/**
+	 * The first to-be-broadcast-by-sender transaction's per commitment point
+	 */
 	public get_first_per_commitment_point(): Uint8Array {
 		const ret: number = bindings.AcceptChannel_get_first_per_commitment_point(this.ptr);
 		const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
 		return ret_conv;
 	}
 
+	/**
+	 * The first to-be-broadcast-by-sender transaction's per commitment point
+	 */
 	public set_first_per_commitment_point(val: Uint8Array): void {
 		bindings.AcceptChannel_set_first_per_commitment_point(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(val, 33)));
 	}
@@ -425,6 +512,9 @@ export class AcceptChannel extends CommonBase {
 		return ret;
 	}
 
+	/**
+	 * Creates a copy of the AcceptChannel
+	 */
 	public clone(): AcceptChannel {
 		const ret: number = bindings.AcceptChannel_clone(this.ptr);
 		const ret_hu_conv: AcceptChannel = new AcceptChannel(null, ret);
@@ -432,12 +522,18 @@ export class AcceptChannel extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Serialize the AcceptChannel object into a byte array which can be read by AcceptChannel_read
+	 */
 	public write(): Uint8Array {
 		const ret: number = bindings.AcceptChannel_write(this.ptr);
 		const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
 		return ret_conv;
 	}
 
+	/**
+	 * Read a AcceptChannel from a byte array, created by AcceptChannel_write
+	 */
 	public static constructor_read(ser: Uint8Array): Result_AcceptChannelDecodeErrorZ {
 		const ret: number = bindings.AcceptChannel_read(bindings.encodeUint8Array(ser));
 		const ret_hu_conv: Result_AcceptChannelDecodeErrorZ = Result_AcceptChannelDecodeErrorZ.constr_from_ptr(ret);