Ctrl+K

Create Wallets

Overview

You can generate or manually create multisignature and MPC wallets with BitGo. Once created, you can configure security policies for your wallets, dictating how transactions can occur.

Generate Wallets

Create a self-custody hot wallet and keys all in one step. When you generate a wallet, BitGo does the following:

  • Creates a user keychain locally on your machine and uploads an encrypted key, using the provided passphrase (skipped if userKey is provided).
  • Creates a backup keychain locally on your machine and uploads the public key.
  • Creates a BitGo keychain on a BitGo hardware-security module (HSM) and a backup key if backupXpubProvider is set to true.
  • Creates a wallet on the blockchain with these 3 public keys.

Manually Create Wallets

Create a custody wallet or a self-custody, hot or cold, wallet. You must create your own keys prior to manually creating a self-custody wallet.

Prerequisites

Steps: Multisig

  • SDK (Generate)
  • SDK (Manual)
  • Express (Generate)
  • API (Manual)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
const { BitGo } = require('bitgo');

// Fill in with actual access token
const accessToken = '<your_actual_access_token>';

// Initialize the SDK
const bitgo = new BitGo({
accessToken: accessToken,
env: 'test',
});

// Generate hot wallet
async function createHotWalletSimple() {
const newWallet = await bitgo.coin('tbtc4').wallets().generateWallet({
    label: 'my hot Wallet',
    passphrase: 'VerySecurePassword1234',
    enterprise: 'enterpriseId'
});

console.log(JSON.stringify(newWallet, undefined, 2));
}

Step Result

  • Generate
  • Manual
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
{
    "wallet": {
        "id": "62f002e7b1440900072b8472fc8a9de8",
        "users": [
            {
                "user": "62ab90e06dfda30007974f0a52a12995",
                "permissions": [
                    "admin",
                    "view",
                    "spend"
                ]
            }
        ],
        "coin": "tbtc4",
        "label": "Generated TBTC4 Wallet",
        "m": 2,
        "n": 3,
        "keys": [
            "62f002e79b12b800077bea85071f633f",
            "62f002e759cafb0007f3002f885697e9",
            "62f002e77bd7400007ee7f10ed8c5af3"
        ],
        "keySignatures": {
            "backupPub": "20f0854d0af1b22fad685a7580a4b8b45fc22a8a35a426f6c86c450faca5bdc9666bc2a88d7961ecdf9724a4247abcdc05bebef679d013ab309c15be9097c64cee",
            "bitgoPub": "1ffdb32d0618b3ef93e0b85f9499d6d4a7a96fb47b2e9851d31e57ff790bb7c49f2c0456ccb666fedfd5f51c2b477456c48fe69c4b171ae7bfbaf8851432b8be45"
        },
        "enterprise": "62c5ae8174ac860007aff138a2d74df7",
        "tags": [
            "62f002e7b1440900072b8472fc8a9de8",
            "62c5ae8174ac860007aff138a2d74df7"
        ],
        "disableTransactionNotifications": false,
        "freeze": {},
        "deleted": false,
        "approvalsRequired": 1,
        "isCold": false,
        "coinSpecific": {},
        "admin": {},
        "clientFlags": [],
        "walletFlags": [],
        "allowBackupKeySigning": false,
        "recoverable": false,
        "startDate": "2022-08-07T18:22:31.000Z",
        "type": "hot",
        "buildDefaults": {},
        "customChangeKeySignatures": {},
        "hasLargeNumberOfAddresses": false,
        "multisigType": "onchain",
        "config": {},
        "balance": 0,
        "confirmedBalance": 0,
        "spendableBalance": 0,
        "balanceString": "0",
        "confirmedBalanceString": "0",
        "spendableBalanceString": "0",
        "receiveAddress": {
            "id": "62f002e7b1440900072b848123196453",
            "address": "2MwMtk2qWsP54LHqBqEk8cbgqtmG2qV5XSi",
            "chain": 10,
            "index": 1,
            "coin": "tbtc4",
            "wallet": "62f002e7b1440900072b8472fc8a9de8",
            "coinSpecific": {
                "redeemScript": "00206ad786997ee4798fcaa70651b041e26b798127aaea3898a6dce306b6de2ce0e4",
                "witnessScript": "522103c6b657f7a39b7a7f956f3b46ab9cc62f9ed0a184549d5ae0b6b54de0052ac7f721034116165f883397724e86f14918031d70231c64187cfacded4aa51a6c658b9bc2210285d4c028327832c85ce57e921500a758038aefb841a542c3775793137295c52e53ae"
            }
        },
        "pendingApprovals": []
    },
    "userKeychain": {
        "id": "62f002e79b12b800077bea85071f633f",
        "pub": "xpub661MyMwAqRbcGqD3oX9sGtEjJZVQrtMYHqWPkDaeVpj8SugdVJwnF5zkiSTZoMo181UNkGDx5HKDtWSxNMZvdxnkrw2aXr19UQKxGiPxmhX",
        "ethAddress": "0x500e9d8a71d51dc0d9e0f0e98d12276dbe177ee4",
        "source": "user",
        "type": "independent",
        "encryptedPrv": "{\"iv\":\"GD26lmXg0os1DLrXYXMMPA==\",\"v\":1,\"iter\":10000,\"ks\":256,\"ts\":64,\"mode\":\"ccm\",\"adata\":\"\",\"cipher\":\"aes\",\"salt\":\"KsRm/x1BTRw=\",\"ct\":\"rqRbdviwV2B6rrqNYEUvUhSdN0acfM+D4fBSVn0BK/LePdCePW1K73QbIWOeYH0KujjGCjJ7eyRLNPokY7jx43a6n6vJlyvKaXZnVyMhVnlI8WipdPiE/jwcXAESqKaTNV2TsZF5X8jGb4jHmE3rdoAvbcDShvo=\"}",
        "prv": "xprv9s21ZrQH143K4M8ahVcrukHzkXevTRdgvcanwqB2wVC9a7MUwmdXhHgGs8SGmt3kZLh7BMKmb8H6ZWEcjUWCyhVk8Vcrs5jPRbJwJBHUAi9"
    },
    "backupKeychain": {
        "id": "62f002e759cafb0007f3002f885697e9",
        "pub": "xpub661MyMwAqRbcGYpcqRc8eafSixRBaEdtpXF1nxEaHuUQoHHs8rJLSSp1bpE3dS4rVC943wBzZqGkzeed91GoaMRXuiJo3evDydLVRsgnQNi",
        "ethAddress": "0xbd0a837c9d01b7d33915059f39793aa4b1391847",
        "source": "backup",
        "type": "independent",
        "prv": "xprv9s21ZrQH143K44k9jQ58HSiiAvahAmv3TJKQzZpxjZwRvUxibJz5teVXkZGaqV4a4HPeJon6QutcFe1pGZ89MDa1HssyGYhEQjag8S8pYPe"
    },
    "bitgoKeychain": {
        "id": "62f002e77bd7400007ee7f10ed8c5af3",
        "pub": "xpub661MyMwAqRbcFZC9odQHUoA8C6AAj8pyHicqCHBjPFuTSygwb4UEeNXugroXVt1ChWKa3XXAo7onCjDWTYoVriVvExQkjiSoET5Fjq6ub32",
        "ethAddress": "0x33b45cabc7251825675880385e862f5b109be96f",
        "source": "bitgo",
        "type": "independent",
        "isBitGo": true
    },
    "warning": "Be sure to backup the backup keychain -- it is not stored anywhere else!"
}

Note: Some networks, such as Ethereum, don't immediately return a new multisignature address, since creating a new address requires a blockchain transaction. The blockchain must confirm this transaction before you can use the address. The parameter pendingChainInitialization identifies if an address is awaiting confirmation.

You can save the wallet ID in the response, then wait for the blockchain to confirm the address before using it.

Steps: MPC

  • SDK (Generate)
  • SDK (Manual)
  • Express (Generate)
  • API (Manual Custody)
  • API (Manual Hot)
1
2
3
4
5
6
7
8
9
10
async function createHotWalletSimple() {
    const newWallet = await bitgo.coin('teth').wallets().generateWallet({
        label: 'ETH MPC Wallet',
        passphrase: 'VerySecurePassword1234',
        multisigType: 'tss',
        passcodeEncryptionCode: 'random string',
        walletVersion: 5, // Required for ECDSA assets, such as ETH, MATIC, and Cosmos SDK assets
    });
    console.log(JSON.stringify(newWallet, undefined,2));
}

Step Result

  • Generate
  • Manual
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
{
  "wallet": {
    "id": "665e33f768f9b4b1cc2ca87a6b87cdfb",
    "users": [
      {
        "user": "660d7c9fa6fbf0d00b415146cf70405a",
        "permissions": ["admin", "spend", "view"]
      }
    ],
    "coin": "hteth",
    "label": "MPCv2-using-settings-api",
    "m": 2,
    "n": 3,
    "keys": [
      "665e33f6fcf87cac817eb3b2ed964042",
      "665e33f6e7331ba062e62c48c6ccaf98",
      "665e33f6fcf87cac817eb3b01c6b4c36"
    ],
    "keySignatures": {},
    "enterprise": "66325011d4b1ff58feae3b311d669aae",
    "organization": "66325011d4b1ff58feae3b76c2d30987",
    "bitgoOrg": "BitGo Trust",
    "tags": [
      "665e33f768f9b4b1cc2ca87a6b87cdfb",
      "66325011d4b1ff58feae3b311d669aae"
    ],
    "disableTransactionNotifications": false,
    "freeze": {},
    "deleted": false,
    "approvalsRequired": 1,
    "isCold": false,
    "coinSpecific": {
      "deployedInBlock": false,
      "lastChainIndex": { "0": -1, "1": -1 },
      "baseAddress": "0x1a52b70e708f4aec9d92260aa035b3c71e51df84",
      "feeAddress": "0x56b269b691f910f1bed53893af099402c2983ea8",
      "pendingChainInitialization": false,
      "pendingEcdsaTssInitialization": false,
      "creationFailure": [],
      "gasPriceTier": "fast",
      "tokenFlushThresholds": {},
      "lowPriorityFeeAddress": "0x56b269b691f910f1bed53893af099402c2983ea8",
      "salt": "0x7",
      "walletVersion": 5,
      "pendingDeployment": false,
      "deployForwardersManually": false,
      "flushForwardersManually": false,
      "enableMMI": false,
      "enableNFT": false
    },
    "admin": {},
    "clientFlags": [],
    "walletFlags": [],
    "allowBackupKeySigning": false,
    "recoverable": false,
    "startDate": "2024-06-03T21:21:59.000Z",
    "type": "hot",
    "buildDefaults": {},
    "customChangeKeySignatures": {},
    "hasLargeNumberOfAddresses": false,
    "multisigType": "tss",
    "multisigTypeVersion": "MPCv2",
    "config": {},
    "balanceString": "0",
    "confirmedBalanceString": "0",
    "spendableBalanceString": "0",
    "receiveAddress": {
      "id": "665e33f768f9b4b1cc2ca88ae9f990fc",
      "address": "0x1a52b70e708f4aec9d92260aa035b3c71e51df84",
      "chain": 0,
      "index": 0,
      "coin": "hteth",
      "wallet": "665e33f768f9b4b1cc2ca87a6b87cdfb",
      "coinSpecific": {
        "nonce": -1,
        "updateTime": "2024-06-03T21:21:59.948Z",
        "txCount": 0,
        "pendingChainInitialization": false,
        "creationFailure": [],
        "pendingDeployment": false,
        "forwarderVersion": 4,
        "isTss": true,
        "isNonceLocked": false
      }
    },
    "pendingApprovals": []
  },
  "userKeychain": {
    "id": "665e33f6fcf87cac817eb3b2ed964042",
    "source": "user",
    "type": "tss",
    "commonKeychain": "0294459a370b9326a8f64a5279bc072329fd6ae7df8257ed3676fe6acb84542bcc2a9c88e000d1f978be4e361a3a2134042019480a5d26e4cc8c28b3c6b447bb35",
    "encryptedPrv": "{\"iv\":\"sFg9U3JGBj+7r/LDiIMC9Q==\",\"v\":1,\"iter\":10000,\"ks\":256,\"ts\":64,\"mode\":\"ccm\",\"adata\":\"\",\"cipher\":\"aes\",\"salt\":\"t6Hxh0ltDyk=\",\"ct\":\"P4EX2aysZFaFVjfNK6/dPI/sCP1TBuBRWEh+0/.../DGtSuMoRWGsTREEsC8CPEdIXQXHtHQFz7suBl4MI1CAJrn\"}",
    "reducedEncryptedPrv": "{\"iv\":\"5I6TxMaZIxxXt4hCSDAYRg==\",\"v\":1,\"iter\":10000,\"ks\":256,\"ts\":64,\"mode\":\"ccm\",\"adata\":\"\",\"cipher\":\"aes\",\"salt\":\"KQyVl16HLXo=\",\"ct\":\"AWhrVQ6VdbGUhVyXmJvVPtzJTHbtL5SRSPoaQFQnB2mVsHCdLb6/.../eJtnkmW0JmY01pGoVOFEQAejvbHslAU3SsjePlntQ==\"}"
  },
  "backupKeychain": {
    "id": "665e33f6e7331ba062e62c48c6ccaf98",
    "source": "backup",
    "type": "tss",
    "commonKeychain": "0294459a370b9326a8f64a5279bc072329fd6ae7df8257ed3676fe6acb84542bcc2a9c88e000d1f978be4e361a3a2134042019480a5d26e4cc8c28b3c6b447bb35",
    "encryptedPrv": "{\"iv\":\"PhOwLdbEsNfVYZ6sYXQJEg==\",\"v\":1,\"iter\":10000,\"ks\":256,\"ts\":64,\"mode\":\"ccm\",\"adata\":\"\",\"cipher\":\"aes\",\"salt\":\"JdFcXK+6WLk=\",\"ct\":\"eK22QoNHhSFmv5g8sfnd0z3lmjv5XvZPjS2C2XJjsPO...wnz0DkZoql8LaiQy3slwC1jIrtYHF3DfELce3LyMtOAx\"}",
    "reducedEncryptedPrv": "{\"iv\":\"Ve8tq+ZYwR4pUcWGYlgwPQ==\",\"v\":1,\"iter\":10000,\"ks\":256,\"ts\":64,\"mode\":\"ccm\",\"adata\":\"\",\"cipher\":\"aes\",\"salt\":\"oFPwODIvtLs=\",\"ct\":\"Rap2+GkxwhHjRJeu+B7lKnEOk6oydbT4bGra7afZuGFyvenNKPI3dYe+...+GXhbKIbv586SxUsZV4ePDeXTcY6P/f3NUPhMfXZ0sS5fCpMrL9Vj5cVmks2zjx8MKbPL9ixgmlq2b3RZvLDoUwJmbD0qWWwGygczCdWFWuuS1qohtFI02E9TnA==\"}"
  },
  "bitgoKeychain": {
    "id": "665e33f6fcf87cac817eb3b01c6b4c36",
    "source": "bitgo",
    "type": "tss",
    "commonKeychain": "0294459a370b9326a8f64a5279bc072329fd6ae7df8257ed3676fe6acb84542bcc2a9c88e000d1f978be4e361a3a2134042019480a5d26e4cc8c28b3c6b447bb35",
    "isBitGo": true
  }
}

Note: If you want your wallet to show up in the UI, please pass in enterprise: <ENTERPRISE_ID> as a parameter to your generateWallet() function.

Next

See Also