1 package org.ldk.structs;
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
6 import java.util.Arrays;
7 import javax.annotation.Nullable;
11 * A channel descriptor for a hop along a payment path.
13 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
14 public class RouteHintHop extends CommonBase {
15 RouteHintHop(Object _dummy, long ptr) { super(ptr); }
16 @Override @SuppressWarnings("deprecation")
17 protected void finalize() throws Throwable {
19 if (ptr != 0) { bindings.RouteHintHop_free(ptr); }
23 * The node_id of the non-target end of the route
25 public byte[] get_src_node_id() {
26 byte[] ret = bindings.RouteHintHop_get_src_node_id(this.ptr);
31 * The node_id of the non-target end of the route
33 public void set_src_node_id(byte[] val) {
34 bindings.RouteHintHop_set_src_node_id(this.ptr, val);
38 * The short_channel_id of this channel
40 public long get_short_channel_id() {
41 long ret = bindings.RouteHintHop_get_short_channel_id(this.ptr);
46 * The short_channel_id of this channel
48 public void set_short_channel_id(long val) {
49 bindings.RouteHintHop_set_short_channel_id(this.ptr, val);
53 * The fees which must be paid to use this channel
55 public RoutingFees get_fees() {
56 long ret = bindings.RouteHintHop_get_fees(this.ptr);
57 if (ret >= 0 && ret <= 4096) { return null; }
58 RoutingFees ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new RoutingFees(null, ret); }
59 ret_hu_conv.ptrs_to.add(this);
64 * The fees which must be paid to use this channel
66 public void set_fees(RoutingFees val) {
67 bindings.RouteHintHop_set_fees(this.ptr, val == null ? 0 : val.ptr & ~1);
71 * The difference in CLTV values between this node and the next node.
73 public short get_cltv_expiry_delta() {
74 short ret = bindings.RouteHintHop_get_cltv_expiry_delta(this.ptr);
79 * The difference in CLTV values between this node and the next node.
81 public void set_cltv_expiry_delta(short val) {
82 bindings.RouteHintHop_set_cltv_expiry_delta(this.ptr, val);
86 * The minimum value, in msat, which must be relayed to the next hop.
88 public Option_u64Z get_htlc_minimum_msat() {
89 long ret = bindings.RouteHintHop_get_htlc_minimum_msat(this.ptr);
90 if (ret >= 0 && ret <= 4096) { return null; }
91 Option_u64Z ret_hu_conv = Option_u64Z.constr_from_ptr(ret);
92 ret_hu_conv.ptrs_to.add(this);
97 * The minimum value, in msat, which must be relayed to the next hop.
99 public void set_htlc_minimum_msat(Option_u64Z val) {
100 bindings.RouteHintHop_set_htlc_minimum_msat(this.ptr, val.ptr);
104 * The maximum value in msat available for routing with a single HTLC.
106 public Option_u64Z get_htlc_maximum_msat() {
107 long ret = bindings.RouteHintHop_get_htlc_maximum_msat(this.ptr);
108 if (ret >= 0 && ret <= 4096) { return null; }
109 Option_u64Z ret_hu_conv = Option_u64Z.constr_from_ptr(ret);
110 ret_hu_conv.ptrs_to.add(this);
115 * The maximum value in msat available for routing with a single HTLC.
117 public void set_htlc_maximum_msat(Option_u64Z val) {
118 bindings.RouteHintHop_set_htlc_maximum_msat(this.ptr, val.ptr);
122 * Constructs a new RouteHintHop given each field
124 public static RouteHintHop of(byte[] src_node_id_arg, long short_channel_id_arg, RoutingFees fees_arg, short cltv_expiry_delta_arg, Option_u64Z htlc_minimum_msat_arg, Option_u64Z htlc_maximum_msat_arg) {
125 long ret = bindings.RouteHintHop_new(src_node_id_arg, short_channel_id_arg, fees_arg == null ? 0 : fees_arg.ptr & ~1, cltv_expiry_delta_arg, htlc_minimum_msat_arg.ptr, htlc_maximum_msat_arg.ptr);
126 if (ret >= 0 && ret <= 4096) { return null; }
127 RouteHintHop ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new RouteHintHop(null, ret); }
128 ret_hu_conv.ptrs_to.add(ret_hu_conv);
133 * Creates a copy of the RouteHintHop
135 public RouteHintHop clone() {
136 long ret = bindings.RouteHintHop_clone(this.ptr);
137 if (ret >= 0 && ret <= 4096) { return null; }
138 RouteHintHop ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new RouteHintHop(null, ret); }
139 ret_hu_conv.ptrs_to.add(this);
144 * Checks if two RouteHintHops contain equal inner contents.
147 long ret = bindings.RouteHintHop_hash(this.ptr);
152 * Checks if two RouteHintHops contain equal inner contents.
153 * This ignores pointers and is_owned flags and looks at the values in fields.
154 * Two objects with NULL inner values will be considered "equal" here.
156 public boolean eq(RouteHintHop b) {
157 boolean ret = bindings.RouteHintHop_eq(this.ptr, b == null ? 0 : b.ptr & ~1);
163 * Serialize the RouteHintHop object into a byte array which can be read by RouteHintHop_read
165 public byte[] write() {
166 byte[] ret = bindings.RouteHintHop_write(this.ptr);
171 * Read a RouteHintHop from a byte array, created by RouteHintHop_write
173 public static Result_RouteHintHopDecodeErrorZ read(byte[] ser) {
174 long ret = bindings.RouteHintHop_read(ser);
175 if (ret >= 0 && ret <= 4096) { return null; }
176 Result_RouteHintHopDecodeErrorZ ret_hu_conv = Result_RouteHintHopDecodeErrorZ.constr_from_ptr(ret);