X-Git-Url: http://git.bitcoin.ninja/index.cgi?p=ldk-java;a=blobdiff_plain;f=ts%2Fstructs%2FCounterpartyForwardingInfo.mts;h=6c0fb474c908f1201f655311168fdbfc1f0d95c8;hp=48233820c3b243201a6d4e7925533a3e96623b56;hb=c629a01650402c8e2f9b9db8ced9ed63ce687727;hpb=d1d0121c000b713c10fd0bedd249eb8dda2e4db7

diff --git a/ts/structs/CounterpartyForwardingInfo.mts b/ts/structs/CounterpartyForwardingInfo.mts
index 48233820..6c0fb474 100644
--- a/ts/structs/CounterpartyForwardingInfo.mts
+++ b/ts/structs/CounterpartyForwardingInfo.mts
@@ -281,39 +281,67 @@ import CommonBase from './CommonBase.mjs';
 import * as bindings from '../bindings.mjs'
 
 
+/**
+ * Information needed for constructing an invoice route hint for this channel.
+ */
 export class CounterpartyForwardingInfo extends CommonBase {
 	/* @internal */
 	public constructor(_dummy: object, ptr: number) {
 		super(ptr, bindings.CounterpartyForwardingInfo_free);
 	}
 
+	/**
+	 * Base routing fee in millisatoshis.
+	 */
 	public get_fee_base_msat(): number {
 		const ret: number = bindings.CounterpartyForwardingInfo_get_fee_base_msat(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * Base routing fee in millisatoshis.
+	 */
 	public set_fee_base_msat(val: number): void {
 		bindings.CounterpartyForwardingInfo_set_fee_base_msat(this.ptr, val);
 	}
 
+	/**
+	 * Amount in millionths of a satoshi the channel will charge per transferred satoshi.
+	 */
 	public get_fee_proportional_millionths(): number {
 		const ret: number = bindings.CounterpartyForwardingInfo_get_fee_proportional_millionths(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * Amount in millionths of a satoshi the channel will charge per transferred satoshi.
+	 */
 	public set_fee_proportional_millionths(val: number): void {
 		bindings.CounterpartyForwardingInfo_set_fee_proportional_millionths(this.ptr, val);
 	}
 
+	/**
+	 * The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
+	 * such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
+	 * `cltv_expiry_delta` for more details.
+	 */
 	public get_cltv_expiry_delta(): number {
 		const ret: number = bindings.CounterpartyForwardingInfo_get_cltv_expiry_delta(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
+	 * such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
+	 * `cltv_expiry_delta` for more details.
+	 */
 	public set_cltv_expiry_delta(val: number): void {
 		bindings.CounterpartyForwardingInfo_set_cltv_expiry_delta(this.ptr, val);
 	}
 
+	/**
+	 * Constructs a new CounterpartyForwardingInfo given each field
+	 */
 	public static constructor_new(fee_base_msat_arg: number, fee_proportional_millionths_arg: number, cltv_expiry_delta_arg: number): CounterpartyForwardingInfo {
 		const ret: number = bindings.CounterpartyForwardingInfo_new(fee_base_msat_arg, fee_proportional_millionths_arg, cltv_expiry_delta_arg);
 		const ret_hu_conv: CounterpartyForwardingInfo = new CounterpartyForwardingInfo(null, ret);
@@ -326,6 +354,9 @@ export class CounterpartyForwardingInfo extends CommonBase {
 		return ret;
 	}
 
+	/**
+	 * Creates a copy of the CounterpartyForwardingInfo
+	 */
 	public clone(): CounterpartyForwardingInfo {
 		const ret: number = bindings.CounterpartyForwardingInfo_clone(this.ptr);
 		const ret_hu_conv: CounterpartyForwardingInfo = new CounterpartyForwardingInfo(null, ret);