public static interface LightningApi.ChannelOrBuilder
extends com.google.protobuf.MessageOrBuilder
Modifier and Type | Method and Description |
---|---|
boolean |
getActive()
Whether this channel is active or not
|
long |
getAliasScids(int index)
This lists out the set of alias short channel ids that exist for a channel.
|
int |
getAliasScidsCount()
This lists out the set of alias short channel ids that exist for a channel.
|
java.util.List<java.lang.Long> |
getAliasScidsList()
This lists out the set of alias short channel ids that exist for a channel.
|
long |
getCapacity()
The total amount of funds held in this channel
|
long |
getChanId()
The unique channel ID for the channel.
|
java.lang.String |
getChannelPoint()
The outpoint (txid:index) of the funding transaction.
|
com.google.protobuf.ByteString |
getChannelPointBytes()
The outpoint (txid:index) of the funding transaction.
|
java.lang.String |
getChanStatusFlags()
A set of flags showing the current state of the channel.
|
com.google.protobuf.ByteString |
getChanStatusFlagsBytes()
A set of flags showing the current state of the channel.
|
java.lang.String |
getCloseAddress()
Close address is the address that we will enforce payout to on cooperative
close if the channel was opened utilizing option upfront shutdown.
|
com.google.protobuf.ByteString |
getCloseAddressBytes()
Close address is the address that we will enforce payout to on cooperative
close if the channel was opened utilizing option upfront shutdown.
|
long |
getCommitFee()
The amount calculated to be paid in fees for the current set of commitment
transactions.
|
LightningApi.CommitmentType |
getCommitmentType()
The commitment type used by this channel.
|
int |
getCommitmentTypeValue()
The commitment type used by this channel.
|
long |
getCommitWeight()
The weight of the commitment transaction
|
int |
getCsvDelay()
Deprecated.
lnrpc.Channel.csv_delay is deprecated.
See lightning.api.proto;l=1470
|
long |
getFeePerKw()
The required number of satoshis per kilo-weight that the requester will pay
at all times, for both the funding transaction and commitment transaction.
|
boolean |
getInitiator()
True if we were the ones that created the channel.
|
long |
getLifetime()
The number of seconds that the channel has been monitored by the channel
scoring system.
|
long |
getLocalBalance()
This node's current balance in this channel
|
long |
getLocalChanReserveSat()
Deprecated.
lnrpc.Channel.local_chan_reserve_sat is deprecated.
See lightning.api.proto;l=1483
|
LightningApi.ChannelConstraints |
getLocalConstraints()
List constraints for the local node.
|
LightningApi.ChannelConstraintsOrBuilder |
getLocalConstraintsOrBuilder()
List constraints for the local node.
|
java.lang.String |
getMemo()
An optional note-to-self to go along with the channel containing some
useful information.
|
com.google.protobuf.ByteString |
getMemoBytes()
An optional note-to-self to go along with the channel containing some
useful information.
|
long |
getNumUpdates()
The total number of updates conducted within this channel.
|
java.lang.String |
getPeerAlias()
The configured alias name of our peer.
|
com.google.protobuf.ByteString |
getPeerAliasBytes()
The configured alias name of our peer.
|
long |
getPeerScidAlias()
This is the peer SCID alias.
|
LightningApi.HTLC |
getPendingHtlcs(int index)
The list of active, uncleared HTLCs currently pending within the channel.
|
int |
getPendingHtlcsCount()
The list of active, uncleared HTLCs currently pending within the channel.
|
java.util.List<LightningApi.HTLC> |
getPendingHtlcsList()
The list of active, uncleared HTLCs currently pending within the channel.
|
LightningApi.HTLCOrBuilder |
getPendingHtlcsOrBuilder(int index)
The list of active, uncleared HTLCs currently pending within the channel.
|
java.util.List<? extends LightningApi.HTLCOrBuilder> |
getPendingHtlcsOrBuilderList()
The list of active, uncleared HTLCs currently pending within the channel.
|
boolean |
getPrivate()
Whether this channel is advertised to the network or not.
|
long |
getPushAmountSat()
The amount that the initiator of the channel optionally pushed to the remote
party on channel open.
|
long |
getRemoteBalance()
The counterparty's current balance in this channel
|
long |
getRemoteChanReserveSat()
Deprecated.
lnrpc.Channel.remote_chan_reserve_sat is deprecated.
See lightning.api.proto;l=1489
|
LightningApi.ChannelConstraints |
getRemoteConstraints()
List constraints for the remote node.
|
LightningApi.ChannelConstraintsOrBuilder |
getRemoteConstraintsOrBuilder()
List constraints for the remote node.
|
java.lang.String |
getRemotePubkey()
The identity pubkey of the remote node
|
com.google.protobuf.ByteString |
getRemotePubkeyBytes()
The identity pubkey of the remote node
|
boolean |
getStaticRemoteKey()
Deprecated.
lnrpc.Channel.static_remote_key is deprecated.
See lightning.api.proto;l=1492
|
int |
getThawHeight()
This uint32 indicates if this channel is to be considered 'frozen'.
|
long |
getTotalSatoshisReceived()
The total number of satoshis we've received within this channel.
|
long |
getTotalSatoshisSent()
The total number of satoshis we've sent within this channel.
|
long |
getUnsettledBalance()
The unsettled balance in this channel
|
long |
getUptime()
The number of seconds that the remote peer has been observed as being online
by the channel scoring system over the lifetime of the channel
[EXPERIMENTAL].
|
boolean |
getZeroConf()
Whether or not this is a zero-conf channel.
|
long |
getZeroConfConfirmedScid()
This is the confirmed / on-chain zero-conf SCID.
|
boolean |
hasLocalConstraints()
List constraints for the local node.
|
boolean |
hasRemoteConstraints()
List constraints for the remote node.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
boolean getActive()
Whether this channel is active or not
bool active = 1;
java.lang.String getRemotePubkey()
The identity pubkey of the remote node
string remote_pubkey = 2;
com.google.protobuf.ByteString getRemotePubkeyBytes()
The identity pubkey of the remote node
string remote_pubkey = 2;
java.lang.String getChannelPoint()
The outpoint (txid:index) of the funding transaction. With this value, Bob will be able to generate a signature for Alice's version of the commitment transaction.
string channel_point = 3;
com.google.protobuf.ByteString getChannelPointBytes()
The outpoint (txid:index) of the funding transaction. With this value, Bob will be able to generate a signature for Alice's version of the commitment transaction.
string channel_point = 3;
long getChanId()
The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.
uint64 chan_id = 4 [jstype = JS_STRING];
long getCapacity()
The total amount of funds held in this channel
int64 capacity = 5;
long getLocalBalance()
This node's current balance in this channel
int64 local_balance = 6;
long getRemoteBalance()
The counterparty's current balance in this channel
int64 remote_balance = 7;
long getCommitFee()
The amount calculated to be paid in fees for the current set of commitment transactions. The fee amount is persisted with the channel in order to allow the fee amount to be removed and recalculated with each channel state update, including updates that happen after a system restart.
int64 commit_fee = 8;
long getCommitWeight()
The weight of the commitment transaction
int64 commit_weight = 9;
long getFeePerKw()
The required number of satoshis per kilo-weight that the requester will pay at all times, for both the funding transaction and commitment transaction. This value can later be updated once the channel is open.
int64 fee_per_kw = 10;
long getUnsettledBalance()
The unsettled balance in this channel
int64 unsettled_balance = 11;
long getTotalSatoshisSent()
The total number of satoshis we've sent within this channel.
int64 total_satoshis_sent = 12;
long getTotalSatoshisReceived()
The total number of satoshis we've received within this channel.
int64 total_satoshis_received = 13;
long getNumUpdates()
The total number of updates conducted within this channel.
uint64 num_updates = 14;
java.util.List<LightningApi.HTLC> getPendingHtlcsList()
The list of active, uncleared HTLCs currently pending within the channel.
repeated .lnrpc.HTLC pending_htlcs = 15;
LightningApi.HTLC getPendingHtlcs(int index)
The list of active, uncleared HTLCs currently pending within the channel.
repeated .lnrpc.HTLC pending_htlcs = 15;
int getPendingHtlcsCount()
The list of active, uncleared HTLCs currently pending within the channel.
repeated .lnrpc.HTLC pending_htlcs = 15;
java.util.List<? extends LightningApi.HTLCOrBuilder> getPendingHtlcsOrBuilderList()
The list of active, uncleared HTLCs currently pending within the channel.
repeated .lnrpc.HTLC pending_htlcs = 15;
LightningApi.HTLCOrBuilder getPendingHtlcsOrBuilder(int index)
The list of active, uncleared HTLCs currently pending within the channel.
repeated .lnrpc.HTLC pending_htlcs = 15;
@Deprecated int getCsvDelay()
Deprecated. The CSV delay expressed in relative blocks. If the channel is force closed, we will need to wait for this many blocks before we can regain our funds.
uint32 csv_delay = 16 [deprecated = true];
boolean getPrivate()
Whether this channel is advertised to the network or not.
bool private = 17;
boolean getInitiator()
True if we were the ones that created the channel.
bool initiator = 18;
java.lang.String getChanStatusFlags()
A set of flags showing the current state of the channel.
string chan_status_flags = 19;
com.google.protobuf.ByteString getChanStatusFlagsBytes()
A set of flags showing the current state of the channel.
string chan_status_flags = 19;
@Deprecated long getLocalChanReserveSat()
Deprecated. The minimum satoshis this node is required to reserve in its balance.
int64 local_chan_reserve_sat = 20 [deprecated = true];
@Deprecated long getRemoteChanReserveSat()
Deprecated. The minimum satoshis the other node is required to reserve in its balance.
int64 remote_chan_reserve_sat = 21 [deprecated = true];
@Deprecated boolean getStaticRemoteKey()
Deprecated. Use commitment_type.
bool static_remote_key = 22 [deprecated = true];
int getCommitmentTypeValue()
The commitment type used by this channel.
.lnrpc.CommitmentType commitment_type = 26;
LightningApi.CommitmentType getCommitmentType()
The commitment type used by this channel.
.lnrpc.CommitmentType commitment_type = 26;
long getLifetime()
The number of seconds that the channel has been monitored by the channel scoring system. Scores are currently not persisted, so this value may be less than the lifetime of the channel [EXPERIMENTAL].
int64 lifetime = 23;
long getUptime()
The number of seconds that the remote peer has been observed as being online by the channel scoring system over the lifetime of the channel [EXPERIMENTAL].
int64 uptime = 24;
java.lang.String getCloseAddress()
Close address is the address that we will enforce payout to on cooperative close if the channel was opened utilizing option upfront shutdown. This value can be set on channel open by setting close_address in an open channel request. If this value is not set, you can still choose a payout address by cooperatively closing with the delivery_address field set.
string close_address = 25;
com.google.protobuf.ByteString getCloseAddressBytes()
Close address is the address that we will enforce payout to on cooperative close if the channel was opened utilizing option upfront shutdown. This value can be set on channel open by setting close_address in an open channel request. If this value is not set, you can still choose a payout address by cooperatively closing with the delivery_address field set.
string close_address = 25;
long getPushAmountSat()
The amount that the initiator of the channel optionally pushed to the remote party on channel open. This amount will be zero if the channel initiator did not push any funds to the remote peer. If the initiator field is true, we pushed this amount to our peer, if it is false, the remote peer pushed this amount to us.
uint64 push_amount_sat = 27;
int getThawHeight()
This uint32 indicates if this channel is to be considered 'frozen'. A frozen channel doest not allow a cooperative channel close by the initiator. The thaw_height is the height that this restriction stops applying to the channel. This field is optional, not setting it or using a value of zero will mean the channel has no additional restrictions. The height can be interpreted in two ways: as a relative height if the value is less than 500,000, or as an absolute height otherwise.
uint32 thaw_height = 28;
boolean hasLocalConstraints()
List constraints for the local node.
.lnrpc.ChannelConstraints local_constraints = 29;
LightningApi.ChannelConstraints getLocalConstraints()
List constraints for the local node.
.lnrpc.ChannelConstraints local_constraints = 29;
LightningApi.ChannelConstraintsOrBuilder getLocalConstraintsOrBuilder()
List constraints for the local node.
.lnrpc.ChannelConstraints local_constraints = 29;
boolean hasRemoteConstraints()
List constraints for the remote node.
.lnrpc.ChannelConstraints remote_constraints = 30;
LightningApi.ChannelConstraints getRemoteConstraints()
List constraints for the remote node.
.lnrpc.ChannelConstraints remote_constraints = 30;
LightningApi.ChannelConstraintsOrBuilder getRemoteConstraintsOrBuilder()
List constraints for the remote node.
.lnrpc.ChannelConstraints remote_constraints = 30;
java.util.List<java.lang.Long> getAliasScidsList()
This lists out the set of alias short channel ids that exist for a channel. This may be empty.
repeated uint64 alias_scids = 31;
int getAliasScidsCount()
This lists out the set of alias short channel ids that exist for a channel. This may be empty.
repeated uint64 alias_scids = 31;
long getAliasScids(int index)
This lists out the set of alias short channel ids that exist for a channel. This may be empty.
repeated uint64 alias_scids = 31;
index
- The index of the element to return.boolean getZeroConf()
Whether or not this is a zero-conf channel.
bool zero_conf = 32;
long getZeroConfConfirmedScid()
This is the confirmed / on-chain zero-conf SCID.
uint64 zero_conf_confirmed_scid = 33;
java.lang.String getPeerAlias()
The configured alias name of our peer.
string peer_alias = 34;
com.google.protobuf.ByteString getPeerAliasBytes()
The configured alias name of our peer.
string peer_alias = 34;
long getPeerScidAlias()
This is the peer SCID alias.
uint64 peer_scid_alias = 35 [jstype = JS_STRING];
java.lang.String getMemo()
An optional note-to-self to go along with the channel containing some useful information. This is only ever stored locally and in no way impacts the channel's operation.
string memo = 36;
com.google.protobuf.ByteString getMemoBytes()
An optional note-to-self to go along with the channel containing some useful information. This is only ever stored locally and in no way impacts the channel's operation.
string memo = 36;