Skip to content

Commit 7886f7f

Browse files
committed
docs(express): create keychain local v2
Ticket: WP-7001
1 parent befb86e commit 7886f7f

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,14 @@ import { BitgoExpressError } from '../../schemas/error';
77
* @property {string} coin - Coin identifier (e.g. btc, tbtc, eth)
88
*/
99
export const KeychainLocalRequestParams = {
10-
/** Coin identifier (e.g. btc, tbtc, eth) */
10+
/** A cryptocurrency or token ticker symbol. */
1111
coin: t.string,
1212
} as const;
1313

1414
export const KeychainLocalRequestResponse200 = t.type({
15+
/** Private key */
1516
prv: t.string,
17+
/** public part of a key pair */
1618
pub: t.string,
1719
});
1820

@@ -28,13 +30,12 @@ export const KeychainLocalResponse = {
2830

2931
/**
3032
* Local client-side function to create a new keychain.
31-
* Creating your keychains is a critical step for safely securing your Bitcoin. When generating new keychains, this API uses a random number generator that adheres to industry standards. If you provide your own seed, you must take extreme caution when creating it.
32-
* Returns an object containing the xprv and xpub for the new chain. The created keychain is not known to the BitGo service. To use it with the BitGo service, use the ‘Store Keychain’ API call.
33+
* Creating your keychains is a critical step for safely securing your Bitcoin. When generating new keychains, this API uses a random number generator that adheres to industry standards. If you provide your own seed, you must take extreme caution when creating it. Returns an object containing the xprv and xpub for the new chain. The created keychain is not known to the BitGo service. To use it with the BitGo service, use the ‘Store Keychain’ API call.
3334
*
3435
* For security reasons, it is highly recommended that you encrypt and destroy the original xprv immediately to prevent theft.
3536
*
3637
* @operationId express.keychain.local
37-
* @tag express
38+
* @tag Express
3839
*/
3940
export const PostKeychainLocal = httpRoute({
4041
path: '/api/v2/{coin}/keychain/local',

0 commit comments

Comments
 (0)