mirrors/lnd
1
0
Fork 0
mirror of https://github.com/lightningnetwork/lnd.git synced 2025-02-22 22:25:24 +01:00
Code Issues Projects Releases Wiki Activity

Add comments for all wallet states [skip ci]

Browse source
This commit is contained in:
benthecarman 2022-09-14 13:26:47 -05:00
parent 89ebd03ff8
commit 96326e045a
No known key found for this signature in database
GPG key ID: D7CC770B81FD22A8
3 changed files with 24 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
lnrpc/stateservice.pb.go
View file

@ -23,12 +23,20 @@ const (
type WalletState int32 type WalletState int32
const ( const (
// NON_EXISTING means that the wallet has not yet been initialized.
WalletState_NON_EXISTING WalletState = 0 WalletState_NON_EXISTING WalletState = 0
WalletState_LOCKED WalletState = 1 // LOCKED means that the wallet is locked and requires a password to unlock.
WalletState_UNLOCKED WalletState = 2 WalletState_LOCKED WalletState = 1
WalletState_RPC_ACTIVE WalletState = 3 // UNLOCKED means that the wallet was unlocked successfully, but RPC server
// isn't ready.
WalletState_UNLOCKED WalletState = 2
// RPC_ACTIVE means that the lnd server is active but not fully ready for
// calls.
WalletState_RPC_ACTIVE WalletState = 3
// SERVER_ACTIVE means that the lnd server is ready to accept calls. // SERVER_ACTIVE means that the lnd server is ready to accept calls.
WalletState_SERVER_ACTIVE WalletState = 4 WalletState_SERVER_ACTIVE WalletState = 4
// WAITING_TO_START means that node is waiting to become the leader in a
// cluster and is not started yet.
WalletState_WAITING_TO_START WalletState = 255 WalletState_WAITING_TO_START WalletState = 255
) )

11
lnrpc/stateservice.proto
View file

@ -36,14 +36,25 @@ service State {
} }
enum WalletState { enum WalletState {
// NON_EXISTING means that the wallet has not yet been initialized.
NON_EXISTING = 0; NON_EXISTING = 0;
// LOCKED means that the wallet is locked and requires a password to unlock.
LOCKED = 1; LOCKED = 1;
// UNLOCKED means that the wallet was unlocked successfully, but RPC server
// isn't ready.
UNLOCKED = 2; UNLOCKED = 2;
// RPC_ACTIVE means that the lnd server is active but not fully ready for
// calls.
RPC_ACTIVE = 3; RPC_ACTIVE = 3;
// SERVER_ACTIVE means that the lnd server is ready to accept calls. // SERVER_ACTIVE means that the lnd server is ready to accept calls.
SERVER_ACTIVE = 4; SERVER_ACTIVE = 4;
// WAITING_TO_START means that node is waiting to become the leader in a
// cluster and is not started yet.
WAITING_TO_START = 255; WAITING_TO_START = 255;
} }

2
lnrpc/stateservice.swagger.json
View file

@ -100,7 +100,7 @@
"WAITING_TO_START" "WAITING_TO_START"
], ],
"default": "NON_EXISTING", "default": "NON_EXISTING",
"description": " - SERVER_ACTIVE: SERVER_ACTIVE means that the lnd server is ready to accept calls." "description": " - NON_EXISTING: NON_EXISTING means that the wallet has not yet been initialized.\n - LOCKED: LOCKED means that the wallet is locked and requires a password to unlock.\n - UNLOCKED: UNLOCKED means that the wallet was unlocked successfully, but RPC server\nisn't ready.\n - RPC_ACTIVE: RPC_ACTIVE means that the lnd server is active but not fully ready for\ncalls.\n - SERVER_ACTIVE: SERVER_ACTIVE means that the lnd server is ready to accept calls.\n - WAITING_TO_START: WAITING_TO_START means that node is waiting to become the leader in a\ncluster and is not started yet."
}, },
"protobufAny": { "protobufAny": {
"type": "object", "type": "object",