X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FOpenChannel.java;h=f0e80ebade5afa8d156c24dd50ec4acdac798f7b;hb=b6cc0960eaee5a5bbc7fde79a56152d6dcd649d8;hp=8c550ed82828767317e8aea9bb2537e27011c5c5;hpb=592c4f92dd3011a2f2a7988ce66ed166c3a8f58c;p=ldk-java diff --git a/src/main/java/org/ldk/structs/OpenChannel.java b/src/main/java/org/ldk/structs/OpenChannel.java index 8c550ed8..f0e80eba 100644 --- a/src/main/java/org/ldk/structs/OpenChannel.java +++ b/src/main/java/org/ldk/structs/OpenChannel.java @@ -2,226 +2,317 @@ package org.ldk.structs; import org.ldk.impl.bindings; import org.ldk.enums.*; +import org.ldk.util.*; +import java.util.Arrays; + +/** + * An open_channel message to be sent or received from a peer + */ +@SuppressWarnings("unchecked") // We correctly assign various generic arrays public class OpenChannel extends CommonBase { OpenChannel(Object _dummy, long ptr) { super(ptr); } @Override @SuppressWarnings("deprecation") protected void finalize() throws Throwable { super.finalize(); - bindings.OpenChannel_free(ptr); - } - - public OpenChannel(OpenChannel orig) { - super(bindings.OpenChannel_clone(orig == null ? 0 : orig.ptr & ~1)); - this.ptrs_to.add(orig); + if (ptr != 0) { bindings.OpenChannel_free(ptr); } } - public byte[] get_chain_hash(OpenChannel this_ptr) { - byte[] ret = bindings.OpenChannel_get_chain_hash(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * The genesis hash of the blockchain where the channel is to be opened + */ + public byte[] get_chain_hash() { + byte[] ret = bindings.OpenChannel_get_chain_hash(this.ptr); return ret; } - public void set_chain_hash(OpenChannel this_ptr, byte[] val) { - bindings.OpenChannel_set_chain_hash(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * The genesis hash of the blockchain where the channel is to be opened + */ + public void set_chain_hash(byte[] val) { + bindings.OpenChannel_set_chain_hash(this.ptr, val); } - public byte[] get_temporary_channel_id(OpenChannel this_ptr) { - byte[] ret = bindings.OpenChannel_get_temporary_channel_id(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * A temporary channel ID, until the funding outpoint is announced + */ + public byte[] get_temporary_channel_id() { + byte[] ret = bindings.OpenChannel_get_temporary_channel_id(this.ptr); return ret; } - public void set_temporary_channel_id(OpenChannel this_ptr, byte[] val) { - bindings.OpenChannel_set_temporary_channel_id(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * A temporary channel ID, until the funding outpoint is announced + */ + public void set_temporary_channel_id(byte[] val) { + bindings.OpenChannel_set_temporary_channel_id(this.ptr, val); } - public long get_funding_satoshis(OpenChannel this_ptr) { - long ret = bindings.OpenChannel_get_funding_satoshis(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * The channel value + */ + public long get_funding_satoshis() { + long ret = bindings.OpenChannel_get_funding_satoshis(this.ptr); return ret; } - public void set_funding_satoshis(OpenChannel this_ptr, long val) { - bindings.OpenChannel_set_funding_satoshis(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * The channel value + */ + public void set_funding_satoshis(long val) { + bindings.OpenChannel_set_funding_satoshis(this.ptr, val); } - public long get_push_msat(OpenChannel this_ptr) { - long ret = bindings.OpenChannel_get_push_msat(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * The amount to push to the counterparty as part of the open, in milli-satoshi + */ + public long get_push_msat() { + long ret = bindings.OpenChannel_get_push_msat(this.ptr); return ret; } - public void set_push_msat(OpenChannel this_ptr, long val) { - bindings.OpenChannel_set_push_msat(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * The amount to push to the counterparty as part of the open, in milli-satoshi + */ + public void set_push_msat(long val) { + bindings.OpenChannel_set_push_msat(this.ptr, val); } - public long get_dust_limit_satoshis(OpenChannel this_ptr) { - long ret = bindings.OpenChannel_get_dust_limit_satoshis(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * The threshold below which outputs on transactions broadcast by sender will be omitted + */ + public long get_dust_limit_satoshis() { + long ret = bindings.OpenChannel_get_dust_limit_satoshis(this.ptr); return ret; } - public void set_dust_limit_satoshis(OpenChannel this_ptr, long val) { - bindings.OpenChannel_set_dust_limit_satoshis(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * The threshold below which outputs on transactions broadcast by sender will be omitted + */ + public void set_dust_limit_satoshis(long val) { + bindings.OpenChannel_set_dust_limit_satoshis(this.ptr, val); } - public long get_max_htlc_value_in_flight_msat(OpenChannel this_ptr) { - long ret = bindings.OpenChannel_get_max_htlc_value_in_flight_msat(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * The maximum inbound HTLC value in flight towards sender, in milli-satoshi + */ + public long get_max_htlc_value_in_flight_msat() { + long ret = bindings.OpenChannel_get_max_htlc_value_in_flight_msat(this.ptr); return ret; } - public void set_max_htlc_value_in_flight_msat(OpenChannel this_ptr, long val) { - bindings.OpenChannel_set_max_htlc_value_in_flight_msat(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * The maximum inbound HTLC value in flight towards sender, in milli-satoshi + */ + public void set_max_htlc_value_in_flight_msat(long val) { + bindings.OpenChannel_set_max_htlc_value_in_flight_msat(this.ptr, val); } - public long get_channel_reserve_satoshis(OpenChannel this_ptr) { - long ret = bindings.OpenChannel_get_channel_reserve_satoshis(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel + */ + public long get_channel_reserve_satoshis() { + long ret = bindings.OpenChannel_get_channel_reserve_satoshis(this.ptr); return ret; } - public void set_channel_reserve_satoshis(OpenChannel this_ptr, long val) { - bindings.OpenChannel_set_channel_reserve_satoshis(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel + */ + public void set_channel_reserve_satoshis(long val) { + bindings.OpenChannel_set_channel_reserve_satoshis(this.ptr, val); } - public long get_htlc_minimum_msat(OpenChannel this_ptr) { - long ret = bindings.OpenChannel_get_htlc_minimum_msat(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * The minimum HTLC size incoming to sender, in milli-satoshi + */ + public long get_htlc_minimum_msat() { + long ret = bindings.OpenChannel_get_htlc_minimum_msat(this.ptr); return ret; } - public void set_htlc_minimum_msat(OpenChannel this_ptr, long val) { - bindings.OpenChannel_set_htlc_minimum_msat(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * The minimum HTLC size incoming to sender, in milli-satoshi + */ + public void set_htlc_minimum_msat(long val) { + bindings.OpenChannel_set_htlc_minimum_msat(this.ptr, val); } - public int get_feerate_per_kw(OpenChannel this_ptr) { - int ret = bindings.OpenChannel_get_feerate_per_kw(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * The feerate per 1000-weight of sender generated transactions, until updated by update_fee + */ + public int get_feerate_per_kw() { + int ret = bindings.OpenChannel_get_feerate_per_kw(this.ptr); return ret; } - public void set_feerate_per_kw(OpenChannel this_ptr, int val) { - bindings.OpenChannel_set_feerate_per_kw(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * The feerate per 1000-weight of sender generated transactions, until updated by update_fee + */ + public void set_feerate_per_kw(int val) { + bindings.OpenChannel_set_feerate_per_kw(this.ptr, val); } - public short get_to_self_delay(OpenChannel this_ptr) { - short ret = bindings.OpenChannel_get_to_self_delay(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction + */ + public short get_to_self_delay() { + short ret = bindings.OpenChannel_get_to_self_delay(this.ptr); return ret; } - public void set_to_self_delay(OpenChannel this_ptr, short val) { - bindings.OpenChannel_set_to_self_delay(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction + */ + public void set_to_self_delay(short val) { + bindings.OpenChannel_set_to_self_delay(this.ptr, val); } - public short get_max_accepted_htlcs(OpenChannel this_ptr) { - short ret = bindings.OpenChannel_get_max_accepted_htlcs(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * The maximum number of inbound HTLCs towards sender + */ + public short get_max_accepted_htlcs() { + short ret = bindings.OpenChannel_get_max_accepted_htlcs(this.ptr); return ret; } - public void set_max_accepted_htlcs(OpenChannel this_ptr, short val) { - bindings.OpenChannel_set_max_accepted_htlcs(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * The maximum number of inbound HTLCs towards sender + */ + public void set_max_accepted_htlcs(short val) { + bindings.OpenChannel_set_max_accepted_htlcs(this.ptr, val); } - public byte[] get_funding_pubkey(OpenChannel this_ptr) { - byte[] ret = bindings.OpenChannel_get_funding_pubkey(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * The sender's key controlling the funding transaction + */ + public byte[] get_funding_pubkey() { + byte[] ret = bindings.OpenChannel_get_funding_pubkey(this.ptr); return ret; } - public void set_funding_pubkey(OpenChannel this_ptr, byte[] val) { - bindings.OpenChannel_set_funding_pubkey(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * The sender's key controlling the funding transaction + */ + public void set_funding_pubkey(byte[] val) { + bindings.OpenChannel_set_funding_pubkey(this.ptr, val); } - public byte[] get_revocation_basepoint(OpenChannel this_ptr) { - byte[] ret = bindings.OpenChannel_get_revocation_basepoint(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * Used to derive a revocation key for transactions broadcast by counterparty + */ + public byte[] get_revocation_basepoint() { + byte[] ret = bindings.OpenChannel_get_revocation_basepoint(this.ptr); return ret; } - public void set_revocation_basepoint(OpenChannel this_ptr, byte[] val) { - bindings.OpenChannel_set_revocation_basepoint(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * Used to derive a revocation key for transactions broadcast by counterparty + */ + public void set_revocation_basepoint(byte[] val) { + bindings.OpenChannel_set_revocation_basepoint(this.ptr, val); } - public byte[] get_payment_point(OpenChannel this_ptr) { - byte[] ret = bindings.OpenChannel_get_payment_point(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * A payment key to sender for transactions broadcast by counterparty + */ + public byte[] get_payment_point() { + byte[] ret = bindings.OpenChannel_get_payment_point(this.ptr); return ret; } - public void set_payment_point(OpenChannel this_ptr, byte[] val) { - bindings.OpenChannel_set_payment_point(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * A payment key to sender for transactions broadcast by counterparty + */ + public void set_payment_point(byte[] val) { + bindings.OpenChannel_set_payment_point(this.ptr, val); } - public byte[] get_delayed_payment_basepoint(OpenChannel this_ptr) { - byte[] ret = bindings.OpenChannel_get_delayed_payment_basepoint(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * Used to derive a payment key to sender for transactions broadcast by sender + */ + public byte[] get_delayed_payment_basepoint() { + byte[] ret = bindings.OpenChannel_get_delayed_payment_basepoint(this.ptr); return ret; } - public void set_delayed_payment_basepoint(OpenChannel this_ptr, byte[] val) { - bindings.OpenChannel_set_delayed_payment_basepoint(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * Used to derive a payment key to sender for transactions broadcast by sender + */ + public void set_delayed_payment_basepoint(byte[] val) { + bindings.OpenChannel_set_delayed_payment_basepoint(this.ptr, val); } - public byte[] get_htlc_basepoint(OpenChannel this_ptr) { - byte[] ret = bindings.OpenChannel_get_htlc_basepoint(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * Used to derive an HTLC payment key to sender + */ + public byte[] get_htlc_basepoint() { + byte[] ret = bindings.OpenChannel_get_htlc_basepoint(this.ptr); return ret; } - public void set_htlc_basepoint(OpenChannel this_ptr, byte[] val) { - bindings.OpenChannel_set_htlc_basepoint(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * Used to derive an HTLC payment key to sender + */ + public void set_htlc_basepoint(byte[] val) { + bindings.OpenChannel_set_htlc_basepoint(this.ptr, val); } - public byte[] get_first_per_commitment_point(OpenChannel this_ptr) { - byte[] ret = bindings.OpenChannel_get_first_per_commitment_point(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * The first to-be-broadcast-by-sender transaction's per commitment point + */ + public byte[] get_first_per_commitment_point() { + byte[] ret = bindings.OpenChannel_get_first_per_commitment_point(this.ptr); return ret; } - public void set_first_per_commitment_point(OpenChannel this_ptr, byte[] val) { - bindings.OpenChannel_set_first_per_commitment_point(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * The first to-be-broadcast-by-sender transaction's per commitment point + */ + public void set_first_per_commitment_point(byte[] val) { + bindings.OpenChannel_set_first_per_commitment_point(this.ptr, val); } - public byte get_channel_flags(OpenChannel this_ptr) { - byte ret = bindings.OpenChannel_get_channel_flags(this_ptr == null ? 0 : this_ptr.ptr & ~1); - this.ptrs_to.add(this_ptr); + /** + * Channel flags + */ + public byte get_channel_flags() { + byte ret = bindings.OpenChannel_get_channel_flags(this.ptr); return ret; } - public void set_channel_flags(OpenChannel this_ptr, byte val) { - bindings.OpenChannel_set_channel_flags(this_ptr == null ? 0 : this_ptr.ptr & ~1, val); - this.ptrs_to.add(this_ptr); + /** + * Channel flags + */ + public void set_channel_flags(byte val) { + bindings.OpenChannel_set_channel_flags(this.ptr, val); + } + + /** + * Creates a copy of the OpenChannel + */ + public OpenChannel clone() { + long ret = bindings.OpenChannel_clone(this.ptr); + OpenChannel ret_hu_conv = new OpenChannel(null, ret); + ret_hu_conv.ptrs_to.add(this); + return ret_hu_conv; } - public byte[] write(OpenChannel obj) { - byte[] ret = bindings.OpenChannel_write(obj == null ? 0 : obj.ptr & ~1); - this.ptrs_to.add(obj); + /** + * Serialize the OpenChannel object into a byte array which can be read by OpenChannel_read + */ + public byte[] write() { + byte[] ret = bindings.OpenChannel_write(this.ptr); return ret; } - public OpenChannel(byte[] ser) { - super(bindings.OpenChannel_read(ser)); + /** + * Read a OpenChannel from a byte array, created by OpenChannel_write + */ + public static Result_OpenChannelDecodeErrorZ read(byte[] ser) { + long ret = bindings.OpenChannel_read(ser); + Result_OpenChannelDecodeErrorZ ret_hu_conv = Result_OpenChannelDecodeErrorZ.constr_from_ptr(ret); + return ret_hu_conv; } }