Skip to content

Commit 36a6893

Browse files
committed
docs: clarified default multisigtype dx-2273
1 parent 4e3cdad commit 36a6893

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

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

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export const GenerateWalletBody = {
1313
label: t.string,
1414
/** Enterprise id. Required for Ethereum wallets since they can only be created as part of an enterprise. Optional for other coins. */
1515
enterprise: optional(t.string),
16-
/** If absent, BitGo uses the default wallet type for the asset */
16+
/** If absent, BitGo uses the default wallet type for the asset. This is relevant only for assets that support both multisignature (`onchain`) and MPC (`tss`) on the BitGo platform. These assets are: `arbeth`, `eth`, `opeth`, `polygon`, and `soneium`. These assets all default to `tss`. */
1717
multisigType: optional(multisigType),
1818
/** The type of wallet, defined by key management and signing protocols. 'hot' and 'cold' are both self-managed wallets. If absent, defaults to 'hot' */
1919
type: optional(walletType),
@@ -87,21 +87,20 @@ export const GenerateWalletV2Query = {
8787
/**
8888
* Generate Wallet
8989
*
90-
* This API call creates a new wallet. Under the hood, the SDK (or BitGo Express) does the following:
90+
* Generate a new wallet for a coin. If you want a wallet to hold tokens, generate a wallet for the native coin of the blockchain (e.g. generate an ETH wallet to hold ERC20 tokens).
9191
*
92-
* 1. Creates the user keychain locally on the machine, and encrypts it with the provided passphrase (skipped if userKey is provided).
93-
* 2. Creates the backup keychain locally on the machine.
94-
* 3. Uploads the encrypted user keychain and public backup keychain.
95-
* 4. Creates the BitGo key (and the backup key if backupXpubProvider is set) on the service.
96-
* 5. Creates the wallet on BitGo with the 3 public keys above.
97-
*
98-
* ⓘ Ethereum wallets can only be created under an enterprise. Pass in the id of the enterprise to associate the wallet with. Your enterprise id can be seen by clicking on the "Manage Organization" link on the enterprise dropdown. Each enterprise has a fee address which will be used to pay for transaction fees on all Ethereum wallets in that enterprise. The fee address is displayed in the dashboard of the website, please fund it before creating a wallet.
92+
* Calling this endpoint does all of the following:
9993
*
100-
* ⓘ You cannot generate a wallet by passing in a subtoken as the coin. Subtokens share wallets with their parent coin and it is not possible to create a wallet specific to one token.
94+
* 1. Creates the user keychain locally on your machine and encrypts it with the provided passphrase (skipped if you pass a `userKey`).
95+
* 2. Creates the backup keychain locally on your machine.
96+
* 3. Uploads the encrypted user keychain and public backup keychain to BitGo.
97+
* 4. Creates the BitGo key (and the backup key if you pass `backupXpubProvider`) on the service.
98+
* 5. Creates the wallet on BitGo with the 3 public keys above.
10199
*
102-
* ⓘ This endpoint should be called through BitGo Express if used without the SDK, such as when using cURL.
100+
* ⓘ Many account-based assets, including Ethereum, require you to [Fund Gas Tanks](https://developers.bitgo.com/docs/get-started-gas-tanks#/) to initialize a new wallets on chain. Ensure your gas tank has a sufficient balance to cover this cost before generating a new wallet.
103101
*
104102
* @operationId express.wallet.generate
103+
* @tag Express
105104
*/
106105
export const PostGenerateWallet = httpRoute({
107106
path: '/api/v2/:coin/wallet/generate',

0 commit comments

Comments
 (0)