Skip to content

docs(express): create keychain local v2 #8411

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

Merged
lokesh-bitgo merged 1 commit into from
Apr 7, 2026
+5 −4
Merged

docs(express): create keychain local v2 #8411

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
9 changes: 5 additions & 4 deletions modules/express/src/typedRoutes/api/v2/keychainLocal.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@ import { BitgoExpressError } from '../../schemas/error';
* @property {string} coin - Coin identifier (e.g. btc, tbtc, eth)
*/
export const KeychainLocalRequestParams = {
/** Coin identifier (e.g. btc, tbtc, eth) */
/** A cryptocurrency or token ticker symbol. */
coin: t.string,
} as const;

export const KeychainLocalRequestResponse200 = t.type({
/** Private key */
prv: t.string,
/** public part of a key pair */
pub: t.string,
});

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

/**
* Local client-side function to create a new keychain.
* 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.
* 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.
*
* For security reasons, it is highly recommended that you encrypt and destroy the original xprv immediately to prevent theft.
*
* @operationId express.keychain.local
* @tag express
* @tag Express
*/
export const PostKeychainLocal = httpRoute({
path: '/api/v2/{coin}/keychain/local',
Expand Down
Loading