Instance Constructors

1.  new Channel(active: Boolean = false, remotePubkey: String = "", channelPoint: String = "", chanId: UInt64 = lnrpc.Channel._typemapper_chanId.toCustom(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: UInt64 = lnrpc.Channel._typemapper_numUpdates.toCustom(0L), pendingHtlcs: Seq[HTLC] = _root_.scala.Seq.empty, csvDelay: UInt32 = lnrpc.Channel._typemapper_csvDelay.toCustom(0), private: Boolean = false, initiator: Boolean = false, chanStatusFlags: String = "", localChanReserveSat: Long = 0L, remoteChanReserveSat: Long = 0L, staticRemoteKey: Boolean = false, commitmentType: CommitmentType = lnrpc.CommitmentType.UNKNOWN_COMMITMENT_TYPE, lifetime: Long = 0L, uptime: Long = 0L, closeAddress: String = "", pushAmountSat: UInt64 = lnrpc.Channel._typemapper_pushAmountSat.toCustom(0L), thawHeight: UInt32 = lnrpc.Channel._typemapper_thawHeight.toCustom(0), localConstraints: Option[ChannelConstraints] = _root_.scala.None, remoteConstraints: Option[ChannelConstraints] = _root_.scala.None, aliasScids: Seq[UInt64] = _root_.scala.Seq.empty, zeroConf: Boolean = false, zeroConfConfirmedScid: UInt64 = lnrpc.Channel._typemapper_zeroConfConfirmedScid.toCustom(0L), peerAlias: String = "", peerScidAlias: UInt64 = lnrpc.Channel._typemapper_peerScidAlias.toCustom(0L), memo: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)
   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.

   aliasScids

   This lists out the set of alias short channel ids that exist for a channel. This may be empty.

   zeroConf

   Whether or not this is a zero-conf channel.

   zeroConfConfirmedScid

   This is the confirmed / on-chain zero-conf SCID.

   peerAlias

   The configured alias name of our peer.

   peerScidAlias

   This is the peer SCID alias.

   memo

   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.