Skip to content

Commit 811e097

Browse files
authored
Merge pull request #8472 from BitGo/WCI-125-signerMacaroon-v2
docs(express): signerMacaroon v2
2 parents 8ae8884 + ff724c8 commit 811e097

1 file changed

Lines changed: 4 additions & 9 deletions

File tree

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

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ import { BitgoExpressError } from '../../schemas/error';
88
* @property {string} walletId - The ID of the wallet.
99
*/
1010
export const SignerMacaroonParams = {
11-
/** A lightning coin name (e.g, lnbtc). */
11+
/** A lightning coin name. */
1212
coin: t.string,
13-
/** The ID of the wallet. */
13+
/** The wallet ID. */
1414
walletId: t.string,
1515
} as const;
1616

@@ -41,15 +41,10 @@ export const SignerMacaroonResponse = {
4141
} as const;
4242

4343
/**
44-
* Lightning - Create signer macaroon
45-
*
46-
* This is only used for self-custody lightning.
47-
* Create the signer macaroon for the watch-only Lightning Network Daemon (LND) node.
48-
* This macaroon derives from the signer node admin macaroon and is used by the watch-only node to request signatures from the signer node for operational tasks.
49-
* Returns the updated wallet with the encrypted signer macaroon in the `coinSpecific` response field.
44+
* This is only used for self-custody lightning. Create the signer macaroon for the watch-only Lightning Network Daemon (LND) node. This macaroon derives from the signer node admin macaroon and is used by the watch-only node to request signatures from the signer node for operational tasks. Returns the updated wallet with the encrypted signer macaroon in the coinSpecific response field.
5045
*
5146
* @operationId express.lightning.signerMacaroon
52-
* @tag express
47+
* @tag Express
5348
*/
5449
export const PostSignerMacaroon = httpRoute({
5550
method: 'POST',

0 commit comments

Comments
 (0)