import org.ldk.impl.bindings;
import org.ldk.enums.*;
+import org.ldk.util.*;
+import java.util.Arrays;
+
+/**
+ * A hop in a route
+ */
+@SuppressWarnings("unchecked") // We correctly assign various generic arrays
public class RouteHop extends CommonBase {
RouteHop(Object _dummy, long ptr) { super(ptr); }
@Override @SuppressWarnings("deprecation")
protected void finalize() throws Throwable {
- bindings.RouteHop_free(ptr); super.finalize();
- }
-
- public RouteHop(RouteHop orig) {
- super(bindings.RouteHop_clone(orig.ptr & ~1));
- this.ptrs_to.add(orig);
+ super.finalize();
+ if (ptr != 0) { bindings.RouteHop_free(ptr); }
}
- public byte[] get_pubkey(RouteHop this_ptr) {
- byte[] ret = bindings.RouteHop_get_pubkey(this_ptr.ptr & ~1);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The node_id of the node at this hop.
+ */
+ public byte[] get_pubkey() {
+ byte[] ret = bindings.RouteHop_get_pubkey(this.ptr);
return ret;
}
- public void set_pubkey(RouteHop this_ptr, byte[] val) {
- bindings.RouteHop_set_pubkey(this_ptr.ptr & ~1, val);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The node_id of the node at this hop.
+ */
+ public void set_pubkey(byte[] val) {
+ bindings.RouteHop_set_pubkey(this.ptr, val);
}
- public NodeFeatures get_node_features(RouteHop this_ptr) {
- NodeFeatures ret = new NodeFeatures(null, bindings.RouteHop_get_node_features(this_ptr.ptr & ~1));
- this.ptrs_to.add(this_ptr);
- return ret;
+ /**
+ * The node_announcement features of the node at this hop. For the last hop, these may be
+ * amended to match the features present in the invoice this node generated.
+ */
+ public NodeFeatures get_node_features() {
+ long ret = bindings.RouteHop_get_node_features(this.ptr);
+ NodeFeatures ret_hu_conv = new NodeFeatures(null, ret);
+ ret_hu_conv.ptrs_to.add(this);
+ return ret_hu_conv;
}
- public void set_node_features(RouteHop this_ptr, NodeFeatures val) {
- bindings.RouteHop_set_node_features(this_ptr.ptr & ~1, val.ptr & ~1);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The node_announcement features of the node at this hop. For the last hop, these may be
+ * amended to match the features present in the invoice this node generated.
+ */
+ public void set_node_features(NodeFeatures val) {
+ bindings.RouteHop_set_node_features(this.ptr, val == null ? 0 : val.ptr & ~1);
this.ptrs_to.add(val);
}
- public long get_short_channel_id(RouteHop this_ptr) {
- long ret = bindings.RouteHop_get_short_channel_id(this_ptr.ptr & ~1);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The channel that should be used from the previous hop to reach this node.
+ */
+ public long get_short_channel_id() {
+ long ret = bindings.RouteHop_get_short_channel_id(this.ptr);
return ret;
}
- public void set_short_channel_id(RouteHop this_ptr, long val) {
- bindings.RouteHop_set_short_channel_id(this_ptr.ptr & ~1, val);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The channel that should be used from the previous hop to reach this node.
+ */
+ public void set_short_channel_id(long val) {
+ bindings.RouteHop_set_short_channel_id(this.ptr, val);
}
- public ChannelFeatures get_channel_features(RouteHop this_ptr) {
- ChannelFeatures ret = new ChannelFeatures(null, bindings.RouteHop_get_channel_features(this_ptr.ptr & ~1));
- this.ptrs_to.add(this_ptr);
- return ret;
+ /**
+ * The channel_announcement features of the channel that should be used from the previous hop
+ * to reach this node.
+ */
+ public ChannelFeatures get_channel_features() {
+ long ret = bindings.RouteHop_get_channel_features(this.ptr);
+ ChannelFeatures ret_hu_conv = new ChannelFeatures(null, ret);
+ ret_hu_conv.ptrs_to.add(this);
+ return ret_hu_conv;
}
- public void set_channel_features(RouteHop this_ptr, ChannelFeatures val) {
- bindings.RouteHop_set_channel_features(this_ptr.ptr & ~1, val.ptr & ~1);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The channel_announcement features of the channel that should be used from the previous hop
+ * to reach this node.
+ */
+ public void set_channel_features(ChannelFeatures val) {
+ bindings.RouteHop_set_channel_features(this.ptr, val == null ? 0 : val.ptr & ~1);
this.ptrs_to.add(val);
}
- public long get_fee_msat(RouteHop this_ptr) {
- long ret = bindings.RouteHop_get_fee_msat(this_ptr.ptr & ~1);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The fee taken on this hop (for paying for the use of the *next* channel in the path).
+ * For the last hop, this should be the full value of the payment (might be more than
+ * requested if we had to match htlc_minimum_msat).
+ */
+ public long get_fee_msat() {
+ long ret = bindings.RouteHop_get_fee_msat(this.ptr);
return ret;
}
- public void set_fee_msat(RouteHop this_ptr, long val) {
- bindings.RouteHop_set_fee_msat(this_ptr.ptr & ~1, val);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The fee taken on this hop (for paying for the use of the *next* channel in the path).
+ * For the last hop, this should be the full value of the payment (might be more than
+ * requested if we had to match htlc_minimum_msat).
+ */
+ public void set_fee_msat(long val) {
+ bindings.RouteHop_set_fee_msat(this.ptr, val);
}
- public int get_cltv_expiry_delta(RouteHop this_ptr) {
- int ret = bindings.RouteHop_get_cltv_expiry_delta(this_ptr.ptr & ~1);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
+ * expected at the destination, in excess of the current block height.
+ */
+ public int get_cltv_expiry_delta() {
+ int ret = bindings.RouteHop_get_cltv_expiry_delta(this.ptr);
return ret;
}
- public void set_cltv_expiry_delta(RouteHop this_ptr, int val) {
- bindings.RouteHop_set_cltv_expiry_delta(this_ptr.ptr & ~1, val);
- this.ptrs_to.add(this_ptr);
+ /**
+ * The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
+ * expected at the destination, in excess of the current block height.
+ */
+ public void set_cltv_expiry_delta(int val) {
+ bindings.RouteHop_set_cltv_expiry_delta(this.ptr, val);
+ }
+
+ /**
+ * Constructs a new RouteHop given each field
+ */
+ public static RouteHop constructor_new(byte[] pubkey_arg, NodeFeatures node_features_arg, long short_channel_id_arg, ChannelFeatures channel_features_arg, long fee_msat_arg, int cltv_expiry_delta_arg) {
+ long ret = bindings.RouteHop_new(pubkey_arg, node_features_arg == null ? 0 : node_features_arg.ptr & ~1, short_channel_id_arg, channel_features_arg == null ? 0 : channel_features_arg.ptr & ~1, fee_msat_arg, cltv_expiry_delta_arg);
+ RouteHop ret_hu_conv = new RouteHop(null, ret);
+ ret_hu_conv.ptrs_to.add(ret_hu_conv);
+ ret_hu_conv.ptrs_to.add(node_features_arg);
+ ret_hu_conv.ptrs_to.add(channel_features_arg);
+ return ret_hu_conv;
}
- public RouteHop(byte[] pubkey_arg, NodeFeatures node_features_arg, long short_channel_id_arg, ChannelFeatures channel_features_arg, long fee_msat_arg, int cltv_expiry_delta_arg) {
- super(bindings.RouteHop_new(pubkey_arg, node_features_arg.ptr & ~1, short_channel_id_arg, channel_features_arg.ptr & ~1, fee_msat_arg, cltv_expiry_delta_arg));
- this.ptrs_to.add(node_features_arg);
- this.ptrs_to.add(channel_features_arg);
+ /**
+ * Creates a copy of the RouteHop
+ */
+ public RouteHop clone() {
+ long ret = bindings.RouteHop_clone(this.ptr);
+ RouteHop ret_hu_conv = new RouteHop(null, ret);
+ ret_hu_conv.ptrs_to.add(this);
+ return ret_hu_conv;
}
}