Skip to content

Commit 1b717f3

Browse files
committed
docs: updated documentation
TICKET: WP-5444
1 parent 9352c72 commit 1b717f3

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

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

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,18 @@ import * as t from 'io-ts';
22
import { httpRoute, httpRequest, optional } from '@api-ts/io-ts-http';
33
import { BitgoExpressError } from '../../schemas/error';
44

5-
// Params: coin (lightning coin), walletId path parameter
5+
/**
6+
*
7+
*/
68
export const LightningInitWalletParams = {
79
coin: t.string,
810
walletId: t.string,
911
};
1012

11-
// Body shape (required + optional). We intentionally do NOT reuse the composite
12-
// InitLightningWalletRequest intersection codec here because httpRequest expects
13-
// a plain object mapping of field -> codec, not an io-ts Type instance.
13+
/**
14+
* Request body for initializing a Lightning wallet
15+
* @property passphrase - Passphrase to encrypt the admin macaroon of the signer node.
16+
*/
1417
export const LightningInitWalletBody = {
1518
passphrase: t.string,
1619
expressHost: optional(t.string),

0 commit comments

Comments
 (0)