Skip to content

docs(express): signerMacaroon v2 #8472

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

Draft
lokesh-bitgo wants to merge 1 commit into
base: master
Choose a base branch
from
+4 −9
Draft

docs(express): signerMacaroon v2 #8472

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
13 changes: 4 additions & 9 deletions modules/express/src/typedRoutes/api/v2/signerMacaroon.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ import { BitgoExpressError } from '../../schemas/error';
* @property {string} walletId - The ID of the wallet.
*/
export const SignerMacaroonParams = {
/** A lightning coin name (e.g, lnbtc). */
/** A lightning coin name. */
coin: t.string,
/** The ID of the wallet. */
/** The wallet ID. */
walletId: t.string,
} as const;

Expand Down Expand Up @@ -41,15 +41,10 @@ export const SignerMacaroonResponse = {
} as const;

/**
* Lightning - Create signer macaroon
*
* 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.
* 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.
*
* @operationId express.lightning.signerMacaroon
* @tag express
* @tag Express
*/
export const PostSignerMacaroon = httpRoute({
method: 'POST',
Expand Down
Loading