Interface Channel

Hierarchy

  • Channel

Properties

active: boolean

Whether this channel is active or not

capacity: string | number

The total amount of funds held in this channel

chanId: string | number

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.

chanStatusFlags: string

A set of flags showing the current state of the channel.

channelPoint: string

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.

closeAddress: string

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.

commitFee: string | number

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: string | number

The weight of the commitment transaction

commitmentType: CommitmentType

The commitment type used by this channel.

feePerKw: string | number

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.

initiator: boolean

True if we were the ones that created the channel.

lifetime: string | number

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].

localBalance: string | number

This node's current balance in this channel

localConstraints: undefined | ChannelConstraints

List constraints for the local node.

numUpdates: string | number

The total number of updates conducted within this channel.

pendingHtlcs: HTLC[]

The list of active, uncleared HTLCs currently pending within the channel.

private: boolean

Whether this channel is advertised to the network or not.

pushAmountSat: string | number

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.

remoteBalance: string | number

The counterparty's current balance in this channel

remoteConstraints: undefined | ChannelConstraints

List constraints for the remote node.

remotePubkey: string

The identity pubkey of the remote node

thawHeight: string | number

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.

totalSatoshisReceived: string | number

The total number of satoshis we've received within this channel.

totalSatoshisSent: string | number

The total number of satoshis we've sent within this channel.

unsettledBalance: string | number

The unsettled balance in this channel

uptime: string | number

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].

Generated using TypeDoc