You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* This determines the blockchain and wallet type that will be created
359
+
* @example "btc"
360
+
* @example "eth"
361
+
* @example "ltc"
362
+
*/
309
363
coin: t.string,
310
364
},
311
365
body: GenerateWalletRequest,
312
366
}),
313
367
response: GenerateWalletResponse,
314
-
description: 'Generate a new wallet',
368
+
description: `
369
+
# Generate a New Wallet
370
+
371
+
This endpoint creates a new cryptocurrency wallet with the specified configuration. The wallet creation process involves several steps that happen automatically:
372
+
373
+
## Wallet Creation Process
374
+
375
+
1. **User Keychain Creation**: Creates the user keychain locally on the machine and encrypts it with the provided passphrase (skipped if userKey is provided)
376
+
2. **Backup Keychain Creation**: Creates the backup keychain locally on the machine
377
+
3. **Keychain Upload**: Uploads the encrypted user keychain and public backup keychain to BitGo
378
+
4. **BitGo Key Creation**: Creates the BitGo key (and backup key if backupXpubProvider is set) on the service
379
+
5. **Wallet Creation**: Creates the wallet on BitGo with the 3 public keys above
380
+
381
+
## Important Notes
382
+
383
+
### Ethereum Wallets
384
+
- Ethereum wallets can only be created under an enterprise
385
+
- Pass in the ID of the enterprise to associate the wallet with
386
+
- Your enterprise ID can be seen by clicking on the "Manage Organization" link on the enterprise dropdown
387
+
- Each enterprise has a fee address which will be used to pay for transaction fees on all Ethereum wallets in that enterprise
388
+
- The fee address is displayed in the dashboard of the website - please fund it before creating a wallet
389
+
390
+
### Subtokens
391
+
- You cannot generate a wallet by passing in a subtoken as the coin
392
+
- Subtokens share wallets with their parent coin and it is not possible to create a wallet specific to one token
393
+
394
+
### Usage
395
+
- This endpoint should be called through BitGo Express if used without the SDK, such as when using cURL
396
+
- For SDK usage, the wallet creation process is handled automatically by the SDK
397
+
398
+
## Query Parameters
399
+
400
+
- **includeKeychains** (boolean, default: false): Include user, backup and bitgo keychains along with generated wallet
401
+
402
+
## Response
403
+
404
+
Returns a wallet object containing the wallet ID, label, coin type, and other configuration details. If includeKeychains is true, the response will also include the keychain information.
0 commit comments