Skip to content

docs(express): lightning state v2 #8419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lokesh-bitgo merged 1 commit into from
Apr 8, 2026
+3 −4
Merged

docs(express): lightning state v2 #8419

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions modules/express/src/typedRoutes/api/v2/lightningState.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ import { WalletState } from '../../../lightning/codecs';
export const LightningStateParams = {
/** A lightning coin name (e.g., lnbtc or tlnbtc) */
coin: t.string,
/** The ID of the lightning self-custody wallet */
/** The wallet ID. */
walletId: t.string,
} as const;

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

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

/**
* Lightning - Get node state
*
* This is only used for self-custody lightning. Get the current state of the lightning node.
*
* @operationId express.lightning.getState
* @tag express
* @tag Express
*/
export const GetLightningState = httpRoute({
method: 'GET',
Expand Down
Loading