Package org.ldk.structs
Class OpenChannel
- java.lang.Object
-
- org.ldk.structs.OpenChannel
-
public class OpenChannel extends Object
An open_channel message to be sent or received from a peer
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description OpenChannelclone()Creates a copy of the OpenChannelprotected voidfinalize()byte[]get_chain_hash()The genesis hash of the blockchain where the channel is to be openedbyteget_channel_flags()Channel flagslongget_channel_reserve_satoshis()The minimum value unencumbered by HTLCs for the counterparty to keep in the channelChannelTypeFeaturesget_channel_type()The channel type that this channel will represent.byte[]get_delayed_payment_basepoint()Used to derive a payment key to sender for transactions broadcast by senderlongget_dust_limit_satoshis()The threshold below which outputs on transactions broadcast by sender will be omittedintget_feerate_per_kw()The feerate per 1000-weight of sender generated transactions, until updated by update_feebyte[]get_first_per_commitment_point()The first to-be-broadcast-by-sender transaction's per commitment pointbyte[]get_funding_pubkey()The sender's key controlling the funding transactionlongget_funding_satoshis()The channel valuebyte[]get_htlc_basepoint()Used to derive an HTLC payment key to senderlongget_htlc_minimum_msat()The minimum HTLC size incoming to sender, in milli-satoshishortget_max_accepted_htlcs()The maximum number of inbound HTLCs towards senderlongget_max_htlc_value_in_flight_msat()The maximum inbound HTLC value in flight towards sender, in milli-satoshibyte[]get_payment_point()A payment key to sender for transactions broadcast by counterpartylongget_push_msat()The amount to push to the counterparty as part of the open, in milli-satoshibyte[]get_revocation_basepoint()Used to derive a revocation key for transactions broadcast by counterpartybyte[]get_temporary_channel_id()A temporary channel ID, until the funding outpoint is announcedshortget_to_self_delay()The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transactionstatic Result_OpenChannelDecodeErrorZread(byte[] ser)Read a OpenChannel from a byte array, created by OpenChannel_writevoidset_chain_hash(byte[] val)The genesis hash of the blockchain where the channel is to be openedvoidset_channel_flags(byte val)Channel flagsvoidset_channel_reserve_satoshis(long val)The minimum value unencumbered by HTLCs for the counterparty to keep in the channelvoidset_channel_type(ChannelTypeFeatures val)The channel type that this channel will represent.voidset_delayed_payment_basepoint(byte[] val)Used to derive a payment key to sender for transactions broadcast by sendervoidset_dust_limit_satoshis(long val)The threshold below which outputs on transactions broadcast by sender will be omittedvoidset_feerate_per_kw(int val)The feerate per 1000-weight of sender generated transactions, until updated by update_feevoidset_first_per_commitment_point(byte[] val)The first to-be-broadcast-by-sender transaction's per commitment pointvoidset_funding_pubkey(byte[] val)The sender's key controlling the funding transactionvoidset_funding_satoshis(long val)The channel valuevoidset_htlc_basepoint(byte[] val)Used to derive an HTLC payment key to sendervoidset_htlc_minimum_msat(long val)The minimum HTLC size incoming to sender, in milli-satoshivoidset_max_accepted_htlcs(short val)The maximum number of inbound HTLCs towards sendervoidset_max_htlc_value_in_flight_msat(long val)The maximum inbound HTLC value in flight towards sender, in milli-satoshivoidset_payment_point(byte[] val)A payment key to sender for transactions broadcast by counterpartyvoidset_push_msat(long val)The amount to push to the counterparty as part of the open, in milli-satoshivoidset_revocation_basepoint(byte[] val)Used to derive a revocation key for transactions broadcast by counterpartyvoidset_temporary_channel_id(byte[] val)A temporary channel ID, until the funding outpoint is announcedvoidset_to_self_delay(short val)The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transactionbyte[]write()Serialize the OpenChannel object into a byte array which can be read by OpenChannel_read
-
-
-
Method Detail
-
finalize
protected void finalize() throws Throwable
-
get_chain_hash
public byte[] get_chain_hash()
The genesis hash of the blockchain where the channel is to be opened
-
set_chain_hash
public void set_chain_hash(byte[] val)
The genesis hash of the blockchain where the channel is to be opened
-
get_temporary_channel_id
public byte[] get_temporary_channel_id()
A temporary channel ID, until the funding outpoint is announced
-
set_temporary_channel_id
public void set_temporary_channel_id(byte[] val)
A temporary channel ID, until the funding outpoint is announced
-
get_funding_satoshis
public long get_funding_satoshis()
The channel value
-
set_funding_satoshis
public void set_funding_satoshis(long val)
The channel value
-
get_push_msat
public long get_push_msat()
The amount to push to the counterparty as part of the open, in milli-satoshi
-
set_push_msat
public void set_push_msat(long val)
The amount to push to the counterparty as part of the open, in milli-satoshi
-
get_dust_limit_satoshis
public long get_dust_limit_satoshis()
The threshold below which outputs on transactions broadcast by sender will be omitted
-
set_dust_limit_satoshis
public void set_dust_limit_satoshis(long val)
The threshold below which outputs on transactions broadcast by sender will be omitted
-
get_max_htlc_value_in_flight_msat
public long get_max_htlc_value_in_flight_msat()
The maximum inbound HTLC value in flight towards sender, in milli-satoshi
-
set_max_htlc_value_in_flight_msat
public void set_max_htlc_value_in_flight_msat(long val)
The maximum inbound HTLC value in flight towards sender, in milli-satoshi
-
get_channel_reserve_satoshis
public long get_channel_reserve_satoshis()
The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
-
set_channel_reserve_satoshis
public void set_channel_reserve_satoshis(long val)
The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
-
get_htlc_minimum_msat
public long get_htlc_minimum_msat()
The minimum HTLC size incoming to sender, in milli-satoshi
-
set_htlc_minimum_msat
public void set_htlc_minimum_msat(long val)
The minimum HTLC size incoming to sender, in milli-satoshi
-
get_feerate_per_kw
public int get_feerate_per_kw()
The feerate per 1000-weight of sender generated transactions, until updated by update_fee
-
set_feerate_per_kw
public void set_feerate_per_kw(int val)
The feerate per 1000-weight of sender generated transactions, until updated by update_fee
-
get_to_self_delay
public short get_to_self_delay()
The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
-
set_to_self_delay
public void set_to_self_delay(short val)
The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
-
get_max_accepted_htlcs
public short get_max_accepted_htlcs()
The maximum number of inbound HTLCs towards sender
-
set_max_accepted_htlcs
public void set_max_accepted_htlcs(short val)
The maximum number of inbound HTLCs towards sender
-
get_funding_pubkey
public byte[] get_funding_pubkey()
The sender's key controlling the funding transaction
-
set_funding_pubkey
public void set_funding_pubkey(byte[] val)
The sender's key controlling the funding transaction
-
get_revocation_basepoint
public byte[] get_revocation_basepoint()
Used to derive a revocation key for transactions broadcast by counterparty
-
set_revocation_basepoint
public void set_revocation_basepoint(byte[] val)
Used to derive a revocation key for transactions broadcast by counterparty
-
get_payment_point
public byte[] get_payment_point()
A payment key to sender for transactions broadcast by counterparty
-
set_payment_point
public void set_payment_point(byte[] val)
A payment key to sender for transactions broadcast by counterparty
-
get_delayed_payment_basepoint
public byte[] get_delayed_payment_basepoint()
Used to derive a payment key to sender for transactions broadcast by sender
-
set_delayed_payment_basepoint
public void set_delayed_payment_basepoint(byte[] val)
Used to derive a payment key to sender for transactions broadcast by sender
-
get_htlc_basepoint
public byte[] get_htlc_basepoint()
Used to derive an HTLC payment key to sender
-
set_htlc_basepoint
public void set_htlc_basepoint(byte[] val)
Used to derive an HTLC payment key to sender
-
get_first_per_commitment_point
public byte[] get_first_per_commitment_point()
The first to-be-broadcast-by-sender transaction's per commitment point
-
set_first_per_commitment_point
public void set_first_per_commitment_point(byte[] val)
The first to-be-broadcast-by-sender transaction's per commitment point
-
get_channel_flags
public byte get_channel_flags()
Channel flags
-
set_channel_flags
public void set_channel_flags(byte val)
Channel flags
-
get_channel_type
@Nullable public ChannelTypeFeatures get_channel_type()
The channel type that this channel will represent. If none is set, we derive the channel type from the intersection of our feature bits with our counterparty's feature bits from the Init message. Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
-
set_channel_type
public void set_channel_type(@Nullable ChannelTypeFeatures val)
The channel type that this channel will represent. If none is set, we derive the channel type from the intersection of our feature bits with our counterparty's feature bits from the Init message. Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
-
clone
public OpenChannel clone()
Creates a copy of the OpenChannel
-
write
public byte[] write()
Serialize the OpenChannel object into a byte array which can be read by OpenChannel_read
-
read
public static Result_OpenChannelDecodeErrorZ read(byte[] ser)
Read a OpenChannel from a byte array, created by OpenChannel_write
-
-