lnrpc: add comment for AnchorState [skip ci]

This commit is contained in:
ueno 2022-09-26 20:38:58 +09:00
parent 2dee112fe9
commit 1384366994
3 changed files with 18 additions and 3 deletions

View File

@ -898,12 +898,18 @@ func (PeerEvent_EventType) EnumDescriptor() ([]byte, []int) {
return file_lightning_proto_rawDescGZIP(), []int{54, 0} return file_lightning_proto_rawDescGZIP(), []int{54, 0}
} }
// There are three resolution states for the anchor:
// limbo, lost and recovered. Derive the current state
// from the limbo and recovered balances.
type PendingChannelsResponse_ForceClosedChannel_AnchorState int32 type PendingChannelsResponse_ForceClosedChannel_AnchorState int32
const ( const (
PendingChannelsResponse_ForceClosedChannel_LIMBO PendingChannelsResponse_ForceClosedChannel_AnchorState = 0 // The recovered_balance is zero and limbo_balance is non-zero.
PendingChannelsResponse_ForceClosedChannel_LIMBO PendingChannelsResponse_ForceClosedChannel_AnchorState = 0
// The recovered_balance is non-zero.
PendingChannelsResponse_ForceClosedChannel_RECOVERED PendingChannelsResponse_ForceClosedChannel_AnchorState = 1 PendingChannelsResponse_ForceClosedChannel_RECOVERED PendingChannelsResponse_ForceClosedChannel_AnchorState = 1
PendingChannelsResponse_ForceClosedChannel_LOST PendingChannelsResponse_ForceClosedChannel_AnchorState = 2 // A state that is neither LIMBO nor RECOVERED.
PendingChannelsResponse_ForceClosedChannel_LOST PendingChannelsResponse_ForceClosedChannel_AnchorState = 2
) )
// Enum value maps for PendingChannelsResponse_ForceClosedChannel_AnchorState. // Enum value maps for PendingChannelsResponse_ForceClosedChannel_AnchorState.

View File

@ -2564,9 +2564,17 @@ message PendingChannelsResponse {
repeated PendingHTLC pending_htlcs = 8; repeated PendingHTLC pending_htlcs = 8;
/*
There are three resolution states for the anchor:
limbo, lost and recovered. Derive the current state
from the limbo and recovered balances.
*/
enum AnchorState { enum AnchorState {
// The recovered_balance is zero and limbo_balance is non-zero.
LIMBO = 0; LIMBO = 0;
// The recovered_balance is non-zero.
RECOVERED = 1; RECOVERED = 1;
// A state that is neither LIMBO nor RECOVERED.
LOST = 2; LOST = 2;
} }

View File

@ -2760,7 +2760,8 @@
"RECOVERED", "RECOVERED",
"LOST" "LOST"
], ],
"default": "LIMBO" "default": "LIMBO",
"description": "There are three resolution states for the anchor:\nlimbo, lost and recovered. Derive the current state\nfrom the limbo and recovered balances.\n\n - LIMBO: The recovered_balance is zero and limbo_balance is non-zero.\n - RECOVERED: The recovered_balance is non-zero.\n - LOST: A state that is neither LIMBO nor RECOVERED."
}, },
"HTLCAttemptHTLCStatus": { "HTLCAttemptHTLCStatus": {
"type": "string", "type": "string",