X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FChannelDetails.java;h=0a2fbb4801b7c8ae8acc59f1af9308ee7b39dc43;hb=c3ae2d6897e5a809459c8d9a72a4b3aa0052c8c8;hp=740cb20c1a4f6f0cefe84c04b7575381166affda;hpb=2ed9081562d00a8645604b07629e963231d49e0f;p=ldk-java diff --git a/src/main/java/org/ldk/structs/ChannelDetails.java b/src/main/java/org/ldk/structs/ChannelDetails.java index 740cb20c..0a2fbb48 100644 --- a/src/main/java/org/ldk/structs/ChannelDetails.java +++ b/src/main/java/org/ldk/structs/ChannelDetails.java @@ -2,106 +2,198 @@ package org.ldk.structs; import org.ldk.impl.bindings; import org.ldk.enums.*; +import org.ldk.util.*; +import java.util.Arrays; + +/** + * Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels + */ +@SuppressWarnings("unchecked") // We correctly assign various generic arrays public class ChannelDetails extends CommonBase { ChannelDetails(Object _dummy, long ptr) { super(ptr); } @Override @SuppressWarnings("deprecation") protected void finalize() throws Throwable { - bindings.ChannelDetails_free(ptr); super.finalize(); - } - - public ChannelDetails(ChannelDetails orig) { - super(bindings.ChannelDetails_clone(orig == null ? 0 : orig.ptr & ~1)); - this.ptrs_to.add(orig); - } - - public byte[] get_channel_id(ChannelDetails this_ptr) { - byte[] ret = bindings.ChannelDetails_get_channel_id(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + super.finalize(); + if (ptr != 0) { bindings.ChannelDetails_free(ptr); } + } + + /** + * The channel's ID (prior to funding transaction generation, this is a random 32 bytes, + * thereafter this is the txid of the funding transaction xor the funding transaction output). + * Note that this means this value is *not* persistent - it can change once during the + * lifetime of the channel. + */ + public byte[] get_channel_id() { + byte[] ret = bindings.ChannelDetails_get_channel_id(this.ptr); return ret; } - public void set_channel_id(ChannelDetails this_ptr, byte[] val) { - bindings.ChannelDetails_set_channel_id(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); - } - - public byte[] get_remote_network_id(ChannelDetails this_ptr) { - byte[] ret = bindings.ChannelDetails_get_remote_network_id(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * The channel's ID (prior to funding transaction generation, this is a random 32 bytes, + * thereafter this is the txid of the funding transaction xor the funding transaction output). + * Note that this means this value is *not* persistent - it can change once during the + * lifetime of the channel. + */ + public void set_channel_id(byte[] val) { + bindings.ChannelDetails_set_channel_id(this.ptr, val); + } + + /** + * The position of the funding transaction in the chain. None if the funding transaction has + * not yet been confirmed and the channel fully opened. + */ + public Option_u64Z get_short_channel_id() { + long ret = bindings.ChannelDetails_get_short_channel_id(this.ptr); + Option_u64Z ret_hu_conv = Option_u64Z.constr_from_ptr(ret); + ret_hu_conv.ptrs_to.add(this); + return ret_hu_conv; + } + + /** + * The position of the funding transaction in the chain. None if the funding transaction has + * not yet been confirmed and the channel fully opened. + */ + public void set_short_channel_id(Option_u64Z val) { + bindings.ChannelDetails_set_short_channel_id(this.ptr, val.ptr); + } + + /** + * The node_id of our counterparty + */ + public byte[] get_remote_network_id() { + byte[] ret = bindings.ChannelDetails_get_remote_network_id(this.ptr); return ret; } - public void set_remote_network_id(ChannelDetails this_ptr, byte[] val) { - bindings.ChannelDetails_set_remote_network_id(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * The node_id of our counterparty + */ + public void set_remote_network_id(byte[] val) { + bindings.ChannelDetails_set_remote_network_id(this.ptr, val); + } + + /** + * The Features the channel counterparty provided upon last connection. + * Useful for routing as it is the most up-to-date copy of the counterparty's features and + * many routing-relevant features are present in the init context. + */ + public InitFeatures get_counterparty_features() { + long ret = bindings.ChannelDetails_get_counterparty_features(this.ptr); + InitFeatures ret_hu_conv = new InitFeatures(null, ret); + ret_hu_conv.ptrs_to.add(this); + return ret_hu_conv; + } + + /** + * The Features the channel counterparty provided upon last connection. + * Useful for routing as it is the most up-to-date copy of the counterparty's features and + * many routing-relevant features are present in the init context. + */ + public void set_counterparty_features(InitFeatures val) { + bindings.ChannelDetails_set_counterparty_features(this.ptr, val == null ? 0 : val.ptr & ~1); + this.ptrs_to.add(val); } - public InitFeatures get_counterparty_features(ChannelDetails this_ptr) { - InitFeatures ret = new InitFeatures(null, bindings.ChannelDetails_get_counterparty_features(this_ptr == null ? 0 : this_ptr.ptr & ~1)); - this.ptrs_to.add(this_ptr); + /** + * The value, in satoshis, of this channel as appears in the funding output + */ + public long get_channel_value_satoshis() { + long ret = bindings.ChannelDetails_get_channel_value_satoshis(this.ptr); return ret; } - public void set_counterparty_features(ChannelDetails this_ptr, InitFeatures val) { - bindings.ChannelDetails_set_counterparty_features(this_ptr == null ? 0 : this_ptr.ptr & ~1, val == null ? 0 : val.ptr & ~1); - this.ptrs_to.add(this_ptr); - this.ptrs_to.add(val); + /** + * The value, in satoshis, of this channel as appears in the funding output + */ + public void set_channel_value_satoshis(long val) { + bindings.ChannelDetails_set_channel_value_satoshis(this.ptr, val); } - public long get_channel_value_satoshis(ChannelDetails this_ptr) { - long ret = bindings.ChannelDetails_get_channel_value_satoshis(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * The user_id passed in to create_channel, or 0 if the channel was inbound. + */ + public long get_user_id() { + long ret = bindings.ChannelDetails_get_user_id(this.ptr); return ret; } - public void set_channel_value_satoshis(ChannelDetails this_ptr, long val) { - bindings.ChannelDetails_set_channel_value_satoshis(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * The user_id passed in to create_channel, or 0 if the channel was inbound. + */ + public void set_user_id(long val) { + bindings.ChannelDetails_set_user_id(this.ptr, val); } - public long get_user_id(ChannelDetails this_ptr) { - long ret = bindings.ChannelDetails_get_user_id(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * The available outbound capacity for sending HTLCs to the remote peer. This does not include + * any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not + * available for inclusion in new outbound HTLCs). This further does not include any pending + * outgoing HTLCs which are awaiting some other resolution to be sent. + */ + public long get_outbound_capacity_msat() { + long ret = bindings.ChannelDetails_get_outbound_capacity_msat(this.ptr); return ret; } - public void set_user_id(ChannelDetails this_ptr, long val) { - bindings.ChannelDetails_set_user_id(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); - } - - public long get_outbound_capacity_msat(ChannelDetails this_ptr) { - long ret = bindings.ChannelDetails_get_outbound_capacity_msat(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * The available outbound capacity for sending HTLCs to the remote peer. This does not include + * any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not + * available for inclusion in new outbound HTLCs). This further does not include any pending + * outgoing HTLCs which are awaiting some other resolution to be sent. + */ + public void set_outbound_capacity_msat(long val) { + bindings.ChannelDetails_set_outbound_capacity_msat(this.ptr, val); + } + + /** + * The available inbound capacity for the remote peer to send HTLCs to us. This does not + * include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not + * available for inclusion in new inbound HTLCs). + * Note that there are some corner cases not fully handled here, so the actual available + * inbound capacity may be slightly higher than this. + */ + public long get_inbound_capacity_msat() { + long ret = bindings.ChannelDetails_get_inbound_capacity_msat(this.ptr); return ret; } - public void set_outbound_capacity_msat(ChannelDetails this_ptr, long val) { - bindings.ChannelDetails_set_outbound_capacity_msat(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * The available inbound capacity for the remote peer to send HTLCs to us. This does not + * include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not + * available for inclusion in new inbound HTLCs). + * Note that there are some corner cases not fully handled here, so the actual available + * inbound capacity may be slightly higher than this. + */ + public void set_inbound_capacity_msat(long val) { + bindings.ChannelDetails_set_inbound_capacity_msat(this.ptr, val); } - public long get_inbound_capacity_msat(ChannelDetails this_ptr) { - long ret = bindings.ChannelDetails_get_inbound_capacity_msat(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b) + * the peer is connected, and (c) no monitor update failure is pending resolution. + */ + public boolean get_is_live() { + boolean ret = bindings.ChannelDetails_get_is_live(this.ptr); return ret; } - public void set_inbound_capacity_msat(ChannelDetails this_ptr, long val) { - bindings.ChannelDetails_set_inbound_capacity_msat(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); - } - - public boolean get_is_live(ChannelDetails this_ptr) { - boolean ret = bindings.ChannelDetails_get_is_live(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); - return ret; + /** + * True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b) + * the peer is connected, and (c) no monitor update failure is pending resolution. + */ + public void set_is_live(boolean val) { + bindings.ChannelDetails_set_is_live(this.ptr, val); } - public void set_is_live(ChannelDetails this_ptr, boolean val) { - bindings.ChannelDetails_set_is_live(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * Creates a copy of the ChannelDetails + */ + public ChannelDetails clone() { + long ret = bindings.ChannelDetails_clone(this.ptr); + ChannelDetails ret_hu_conv = new ChannelDetails(null, ret); + ret_hu_conv.ptrs_to.add(this); + return ret_hu_conv; } }