Skip to content

Commit fb05d42

Browse files
Merge pull request #8576 from BitGo/WCI-208
docs(express): update wallet V2
2 parents 304f5dd + b01d34c commit fb05d42

1 file changed

Lines changed: 7 additions & 10 deletions

File tree

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

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,23 @@ import { WalletResponse } from '../../schemas/wallet';
77
* Parameters for Express Wallet Update
88
*/
99
export const ExpressWalletUpdateParams = {
10-
/** Coin ticker / chain identifier */
10+
/** A cryptocurrency or token ticker symbol */
1111
coin: t.string,
12-
/** Wallet ID */
12+
/** The wallet ID */
1313
id: t.string,
1414
} as const;
1515

1616
/**
1717
* Request body for Express Wallet Update
1818
*/
1919
export const ExpressWalletUpdateBody = {
20-
/** The host address of the lightning signer node. */
20+
/** The host address of the lightning signer node */
2121
signerHost: t.string,
22-
/** The TLS certificate for the lighting signer node encoded to base64. */
22+
/** The TLS certificate for the lighting signer node encoded to base64 */
2323
signerTlsCert: t.string,
24-
/** (Optional) The signer macaroon for the lighting signer node. */
24+
/** (Optional) The signer macaroon for the lighting signer node */
2525
signerMacaroon: optional(t.string),
26-
/** The wallet passphrase. This is not uploaded to BitGo, but used to decrypt userAuthKey used to sign the request before sending to BitGo. */
26+
/** The wallet passphrase. This is not uploaded to BitGo, but used to decrypt userAuthKey used to sign the request before sending to BitGo */
2727
passphrase: t.string,
2828
} as const;
2929

@@ -42,10 +42,7 @@ export const ExpressWalletUpdateResponse = {
4242
} as const;
4343

4444
/**
45-
* Express - Update Wallet
46-
* The express update wallet route is meant to be used for lightning (lnbtc/tlnbtc).
47-
* It will produced a signed wallet update request that can be used to update the wallet.
48-
* For other coins, use the standard wallet update endpoint.
45+
* The express update wallet route is meant to be used for lightning (lnbtc/tlnbtc). It will produced a signed wallet update request that can be used to update the wallet. For other coins, use the standard wallet update endpoint.
4946
*
5047
* @operationId express.wallet.update
5148
* @tag Express

0 commit comments

Comments
 (0)