Skip to content

Commit 4d0c656

Browse files
authored
docs(express): lightning state v2
2 parents 0818335 + 2168612 commit 4d0c656

1 file changed

Lines changed: 3 additions & 4 deletions

File tree

modules/express/src/typedRoutes/api/v2/lightningState.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@ import { WalletState } from '../../../lightning/codecs';
99
export const LightningStateParams = {
1010
/** A lightning coin name (e.g., lnbtc or tlnbtc) */
1111
coin: t.string,
12-
/** The ID of the lightning self-custody wallet */
12+
/** The wallet ID. */
1313
walletId: t.string,
1414
} as const;
1515

1616
export const LightningStateResponse200 = t.type({
17+
/** NON_EXISTING LOCKED UNLOCKED RPC_ACTIVE SERVER_ACTIVE WAITING_TO_START */
1718
state: WalletState,
1819
});
1920

@@ -28,12 +29,10 @@ export const LightningStateResponse = {
2829
} as const;
2930

3031
/**
31-
* Lightning - Get node state
32-
*
3332
* This is only used for self-custody lightning. Get the current state of the lightning node.
3433
*
3534
* @operationId express.lightning.getState
36-
* @tag express
35+
* @tag Express
3736
*/
3837
export const GetLightningState = httpRoute({
3938
method: 'GET',

0 commit comments

Comments
 (0)