channeldb/channel: update IsPending godoc

The pending state definitin in ChannelCloseSummary was slightly changed
in such a way that channels that has had their commitment broadcasted
now is no longer considered "pending close". They now instead stay in
the open chan bucket with the ChanStatus "CommitmentBroadcasted" until
their commitment is confirmed. This commit updates the IsPending godoc
to reflect this.
This commit is contained in:
Johan T. Halseth 2018-05-23 12:07:35 +02:00
parent 74205a64fd
commit 72d9726e7f
No known key found for this signature in database
GPG Key ID: 15BAADA29DA20D26

@ -1673,12 +1673,12 @@ type ChannelCloseSummary struct {
// IsPending indicates whether this channel is in the 'pending close' // IsPending indicates whether this channel is in the 'pending close'
// state, which means the channel closing transaction has been // state, which means the channel closing transaction has been
// broadcast, but not confirmed yet or has not yet been fully resolved. // confirmed, but not yet been fully resolved. In the case of a channel
// In the case of a channel that has been cooperatively closed, it will // that has been cooperatively closed, it will go straight into the
// no longer be considered pending as soon as the closing transaction // fully resolved state as soon as the closing transaction has been
// has been confirmed. However, for channel that have been force // confirmed. However, for channel that have been force closed, they'll
// closed, they'll stay marked as "pending" until _all_ the pending // stay marked as "pending" until _all_ the pending funds have been
// funds have been swept. // swept.
IsPending bool IsPending bool
// RemoteCurrentRevocation is the current revocation for their // RemoteCurrentRevocation is the current revocation for their