final case class Channel(active: Boolean = false, remotePubkey: String = "", channelPoint: String = "", chanId: Long = 0L, capacity: Long = 0L, localBalance: Long = 0L, remoteBalance: Long = 0L, commitFee: Long = 0L, commitWeight: Long = 0L, feePerKw: Long = 0L, unsettledBalance: Long = 0L, totalSatoshisSent: Long = 0L, totalSatoshisReceived: Long = 0L, numUpdates: Long = 0L, pendingHtlcs: Seq[HTLC] = _root_.scala.Seq.empty, csvDelay: Int = 0, private: Boolean = false, initiator: Boolean = false, chanStatusFlags: String = "", localChanReserveSat: Long = 0L, remoteChanReserveSat: Long = 0L, staticRemoteKey: Boolean = false, commitmentType: CommitmentType = lnrpc.CommitmentType.LEGACY, lifetime: Long = 0L, uptime: Long = 0L, closeAddress: String = "", pushAmountSat: Long = 0L, thawHeight: Int = 0, localConstraints: Option[ChannelConstraints] = _root_.scala.None, remoteConstraints: Option[ChannelConstraints] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Channel] with Product with Serializable
- active
Whether this channel is active or not
- remotePubkey
The identity pubkey of the remote node
- channelPoint
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.
- chanId
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.
- capacity
The total amount of funds held in this channel
- localBalance
This node's current balance in this channel
- remoteBalance
The counterparty's current balance in this channel
- commitFee
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.
- commitWeight
The weight of the commitment transaction
- feePerKw
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.
- unsettledBalance
The unsettled balance in this channel
- totalSatoshisSent
The total number of satoshis we've sent within this channel.
- totalSatoshisReceived
The total number of satoshis we've received within this channel.
- numUpdates
The total number of updates conducted within this channel.
- pendingHtlcs
The list of active, uncleared HTLCs currently pending within the channel.
- csvDelay
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.
- private
Whether this channel is advertised to the network or not.
- initiator
True if we were the ones that created the channel.
- chanStatusFlags
A set of flags showing the current state of the channel.
- localChanReserveSat
Deprecated. The minimum satoshis this node is required to reserve in its balance.
- remoteChanReserveSat
Deprecated. The minimum satoshis the other node is required to reserve in its balance.
- staticRemoteKey
Deprecated. Use commitment_type.
- commitmentType
The commitment type used by this channel.
- lifetime
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].
- uptime
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].
- closeAddress
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.
- pushAmountSat
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.
- thawHeight
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.
- localConstraints
List constraints for the local node.
- remoteConstraints
List constraints for the remote node.
- Annotations
- @SerialVersionUID()
- Alphabetic
- By Inheritance
- Channel
- Updatable
- GeneratedMessage
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
Channel(active: Boolean = false, remotePubkey: String = "", channelPoint: String = "", chanId: Long = 0L, capacity: Long = 0L, localBalance: Long = 0L, remoteBalance: Long = 0L, commitFee: Long = 0L, commitWeight: Long = 0L, feePerKw: Long = 0L, unsettledBalance: Long = 0L, totalSatoshisSent: Long = 0L, totalSatoshisReceived: Long = 0L, numUpdates: Long = 0L, pendingHtlcs: Seq[HTLC] = _root_.scala.Seq.empty, csvDelay: Int = 0, private: Boolean = false, initiator: Boolean = false, chanStatusFlags: String = "", localChanReserveSat: Long = 0L, remoteChanReserveSat: Long = 0L, staticRemoteKey: Boolean = false, commitmentType: CommitmentType = lnrpc.CommitmentType.LEGACY, lifetime: Long = 0L, uptime: Long = 0L, closeAddress: String = "", pushAmountSat: Long = 0L, thawHeight: Int = 0, localConstraints: Option[ChannelConstraints] = _root_.scala.None, remoteConstraints: Option[ChannelConstraints] = _root_.scala.None, unknownFields: UnknownFieldSet = ...)
- active
Whether this channel is active or not
- remotePubkey
The identity pubkey of the remote node
- channelPoint
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.
- chanId
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.
- capacity
The total amount of funds held in this channel
- localBalance
This node's current balance in this channel
- remoteBalance
The counterparty's current balance in this channel
- commitFee
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.
- commitWeight
The weight of the commitment transaction
- feePerKw
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.
- unsettledBalance
The unsettled balance in this channel
- totalSatoshisSent
The total number of satoshis we've sent within this channel.
- totalSatoshisReceived
The total number of satoshis we've received within this channel.
- numUpdates
The total number of updates conducted within this channel.
- pendingHtlcs
The list of active, uncleared HTLCs currently pending within the channel.
- csvDelay
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.
- private
Whether this channel is advertised to the network or not.
- initiator
True if we were the ones that created the channel.
- chanStatusFlags
A set of flags showing the current state of the channel.
- localChanReserveSat
Deprecated. The minimum satoshis this node is required to reserve in its balance.
- remoteChanReserveSat
Deprecated. The minimum satoshis the other node is required to reserve in its balance.
- staticRemoteKey
Deprecated. Use commitment_type.
- commitmentType
The commitment type used by this channel.
- lifetime
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].
- uptime
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].
- closeAddress
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.
- pushAmountSat
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.
- thawHeight
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.
- localConstraints
List constraints for the local node.
- remoteConstraints
List constraints for the remote node.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val active: Boolean
- def addAllPendingHtlcs(__vs: Iterable[HTLC]): Channel
- def addPendingHtlcs(__vs: HTLC*): Channel
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val capacity: Long
- val chanId: Long
- val chanStatusFlags: String
- val channelPoint: String
- def clearLocalConstraints: Channel
- def clearPendingHtlcs: Channel
- def clearRemoteConstraints: Channel
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- val closeAddress: String
- val commitFee: Long
- val commitWeight: Long
- val commitmentType: CommitmentType
-
def
companion: Channel.type
- Definition Classes
- Channel → GeneratedMessage
- def discardUnknownFields: Channel
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val feePerKw: Long
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getField(__field: FieldDescriptor): PValue
- Definition Classes
- Channel → GeneratedMessage
-
def
getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- Channel → GeneratedMessage
- def getLocalConstraints: ChannelConstraints
- def getRemoteConstraints: ChannelConstraints
- val initiator: Boolean
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val lifetime: Long
- val localBalance: Long
- val localConstraints: Option[ChannelConstraints]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val numUpdates: Long
- val pendingHtlcs: Seq[HTLC]
- val private: Boolean
- val pushAmountSat: Long
- val remoteBalance: Long
- val remoteConstraints: Option[ChannelConstraints]
- val remotePubkey: String
-
def
serializedSize: Int
- Definition Classes
- Channel → GeneratedMessage
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val thawHeight: Int
-
final
def
toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
-
final
def
toByteString: ByteString
- Definition Classes
- GeneratedMessage
-
final
def
toPMessage: PMessage
- Definition Classes
- GeneratedMessage
-
def
toProtoString: String
- Definition Classes
- Channel → GeneratedMessage
- val totalSatoshisReceived: Long
- val totalSatoshisSent: Long
- val unknownFields: UnknownFieldSet
- val unsettledBalance: Long
-
def
update(ms: (Lens[Channel, Channel]) ⇒ Mutation[Channel]*): Channel
- Definition Classes
- Updatable
- val uptime: Long
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def withActive(__v: Boolean): Channel
- def withCapacity(__v: Long): Channel
- def withChanId(__v: Long): Channel
- def withChanStatusFlags(__v: String): Channel
- def withChannelPoint(__v: String): Channel
- def withCloseAddress(__v: String): Channel
- def withCommitFee(__v: Long): Channel
- def withCommitWeight(__v: Long): Channel
- def withCommitmentType(__v: CommitmentType): Channel
- def withCsvDelay(__v: Int): Channel
- def withFeePerKw(__v: Long): Channel
- def withInitiator(__v: Boolean): Channel
- def withLifetime(__v: Long): Channel
- def withLocalBalance(__v: Long): Channel
- def withLocalChanReserveSat(__v: Long): Channel
- def withLocalConstraints(__v: ChannelConstraints): Channel
- def withNumUpdates(__v: Long): Channel
- def withPendingHtlcs(__v: Seq[HTLC]): Channel
- def withPrivate(__v: Boolean): Channel
- def withPushAmountSat(__v: Long): Channel
- def withRemoteBalance(__v: Long): Channel
- def withRemoteChanReserveSat(__v: Long): Channel
- def withRemoteConstraints(__v: ChannelConstraints): Channel
- def withRemotePubkey(__v: String): Channel
- def withStaticRemoteKey(__v: Boolean): Channel
- def withThawHeight(__v: Int): Channel
- def withTotalSatoshisReceived(__v: Long): Channel
- def withTotalSatoshisSent(__v: Long): Channel
- def withUnknownFields(__v: UnknownFieldSet): Channel
- def withUnsettledBalance(__v: Long): Channel
- def withUptime(__v: Long): Channel
-
final
def
writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
-
def
writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- Channel → GeneratedMessage
-
final
def
writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
Deprecated Value Members
-
val
csvDelay: Int
- Annotations
- @deprecated
- Deprecated
(Since version ) Marked as deprecated in proto file
-
val
localChanReserveSat: Long
- Annotations
- @deprecated
- Deprecated
(Since version ) Marked as deprecated in proto file
-
val
remoteChanReserveSat: Long
- Annotations
- @deprecated
- Deprecated
(Since version ) Marked as deprecated in proto file
-
val
staticRemoteKey: Boolean
- Annotations
- @deprecated
- Deprecated
(Since version ) Marked as deprecated in proto file