6 namespace org { namespace ldk { namespace structs {
10 * A path in a [`Route`] to the payment recipient. Must always be at least length one.
11 * If no [`Path::blinded_tail`] is present, then [`Path::hops`] length may be up to 19.
13 public class Path : CommonBase {
14 internal Path(object _dummy, long ptr) : base(ptr) { }
16 if (ptr != 0) { bindings.Path_free(ptr); }
20 * The list of unblinded hops in this [`Path`]. Must be at least length one.
22 public RouteHop[] get_hops() {
23 long ret = bindings.Path_get_hops(this.ptr);
25 if (ret >= 0 && ret <= 4096) { return null; }
26 int ret_conv_10_len = InternalUtils.getArrayLength(ret);
27 RouteHop[] ret_conv_10_arr = new RouteHop[ret_conv_10_len];
28 for (int k = 0; k < ret_conv_10_len; k++) {
29 long ret_conv_10 = InternalUtils.getU64ArrayElem(ret, k);
30 org.ldk.structs.RouteHop ret_conv_10_hu_conv = null; if (ret_conv_10 < 0 || ret_conv_10 > 4096) { ret_conv_10_hu_conv = new org.ldk.structs.RouteHop(null, ret_conv_10); }
31 if (ret_conv_10_hu_conv != null) { ret_conv_10_hu_conv.ptrs_to.AddLast(this); };
32 ret_conv_10_arr[k] = ret_conv_10_hu_conv;
34 bindings.free_buffer(ret);
35 return ret_conv_10_arr;
39 * The list of unblinded hops in this [`Path`]. Must be at least length one.
41 public void set_hops(RouteHop[] val) {
42 bindings.Path_set_hops(this.ptr, InternalUtils.encodeUint64Array(InternalUtils.mapArray(val, val_conv_10 => val_conv_10.ptr)));
45 foreach (RouteHop val_conv_10 in val) { if (this != null) { this.ptrs_to.AddLast(val_conv_10); }; };
49 * The blinded path at which this path terminates, if we're sending to one, and its metadata.
51 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
53 public BlindedTail get_blinded_tail() {
54 long ret = bindings.Path_get_blinded_tail(this.ptr);
56 if (ret >= 0 && ret <= 4096) { return null; }
57 org.ldk.structs.BlindedTail ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.BlindedTail(null, ret); }
58 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
63 * The blinded path at which this path terminates, if we're sending to one, and its metadata.
65 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
67 public void set_blinded_tail(org.ldk.structs.BlindedTail val) {
68 bindings.Path_set_blinded_tail(this.ptr, val == null ? 0 : val.ptr);
71 if (this != null) { this.ptrs_to.AddLast(val); };
75 * Constructs a new Path given each field
77 * Note that blinded_tail_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
79 public static Path of(RouteHop[] hops_arg, org.ldk.structs.BlindedTail blinded_tail_arg) {
80 long ret = bindings.Path_new(InternalUtils.encodeUint64Array(InternalUtils.mapArray(hops_arg, hops_arg_conv_10 => hops_arg_conv_10.ptr)), blinded_tail_arg == null ? 0 : blinded_tail_arg.ptr);
81 GC.KeepAlive(hops_arg);
82 GC.KeepAlive(blinded_tail_arg);
83 if (ret >= 0 && ret <= 4096) { return null; }
84 org.ldk.structs.Path ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.Path(null, ret); }
85 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(ret_hu_conv); };
86 foreach (RouteHop hops_arg_conv_10 in hops_arg) { if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(hops_arg_conv_10); }; };
87 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(blinded_tail_arg); };
91 internal long clone_ptr() {
92 long ret = bindings.Path_clone_ptr(this.ptr);
98 * Creates a copy of the Path
100 public Path clone() {
101 long ret = bindings.Path_clone(this.ptr);
103 if (ret >= 0 && ret <= 4096) { return null; }
104 org.ldk.structs.Path ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.Path(null, ret); }
105 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
110 * Generates a non-cryptographic 64-bit hash of the Path.
113 long ret = bindings.Path_hash(this.ptr);
118 public override int GetHashCode() {
119 return (int)this.hash();
122 * Checks if two Paths contain equal inner contents.
123 * This ignores pointers and is_owned flags and looks at the values in fields.
124 * Two objects with NULL inner values will be considered "equal" here.
126 public bool eq(org.ldk.structs.Path b) {
127 bool ret = bindings.Path_eq(this.ptr, b.ptr);
130 if (this != null) { this.ptrs_to.AddLast(b); };
134 public override bool Equals(object o) {
135 if (!(o is Path)) return false;
136 return this.eq((Path)o);
139 * Gets the fees for a given path, excluding any excess paid to the recipient.
141 public long fee_msat() {
142 long ret = bindings.Path_fee_msat(this.ptr);
148 * Gets the total amount paid on this [`Path`], excluding the fees.
150 public long final_value_msat() {
151 long ret = bindings.Path_final_value_msat(this.ptr);
157 * Gets the final hop's CLTV expiry delta.
159 public Option_u32Z final_cltv_expiry_delta() {
160 long ret = bindings.Path_final_cltv_expiry_delta(this.ptr);
162 if (ret >= 0 && ret <= 4096) { return null; }
163 org.ldk.structs.Option_u32Z ret_hu_conv = org.ldk.structs.Option_u32Z.constr_from_ptr(ret);
164 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };