|
| 1 | +/** |
| 2 | + * Verify a BIP322 proof of address ownership from a BitGo multi-sig wallet. |
| 3 | + * |
| 4 | + * This example demonstrates how to: |
| 5 | + * 1. Get a wallet by ID |
| 6 | + * 2. Read address/message pairs from messages.json |
| 7 | + * 3. Get address information to obtain chain and index for pubkey derivation |
| 8 | + * 4. Create a BIP322 proof using sendMany with type 'bip322' |
| 9 | + * 5. Verify the proof using bip322.assertBip322TxProof |
| 10 | + * |
| 11 | + * IMPORTANT: This example does NOT work with descriptor wallets. |
| 12 | + * Only use this with traditional BitGo multi-sig wallets. |
| 13 | + * |
| 14 | + * Copyright 2025, BitGo, Inc. All Rights Reserved. |
| 15 | + */ |
| 16 | + |
| 17 | +import * as fs from 'fs'; |
| 18 | +import * as path from 'path'; |
| 19 | +import { BitGo } from 'bitgo'; |
| 20 | +import { AbstractUtxoCoin } from '@bitgo/abstract-utxo'; |
| 21 | +import * as utxolib from '@bitgo/utxo-lib'; |
| 22 | +import { bip322 } from '@bitgo/utxo-core'; |
| 23 | +import { BIP32Factory, ecc } from '@bitgo/secp256k1'; |
| 24 | + |
| 25 | +// ============================================================================ |
| 26 | +// CONFIGURATION - Set these values before running |
| 27 | +// ============================================================================ |
| 28 | + |
| 29 | +// Set your environment: 'prod' for mainnet, 'test' for testnet |
| 30 | +const environment: 'prod' | 'test' = 'test'; |
| 31 | + |
| 32 | +// Set the coin: 'btc' for mainnet, 'tbtc4' for testnet |
| 33 | +const coin = 'tbtc4'; |
| 34 | + |
| 35 | +// Set your BitGo access token |
| 36 | +const accessToken = ''; |
| 37 | + |
| 38 | +// Set your wallet ID |
| 39 | +const walletId = ''; |
| 40 | + |
| 41 | +// Set your wallet passphrase for signing |
| 42 | +const walletPassphrase = ''; |
| 43 | + |
| 44 | +// Set the OTP code. If you dont need one, set it to undefined. |
| 45 | +const otp: string | undefined = undefined; |
| 46 | + |
| 47 | +// ============================================================================ |
| 48 | +// TYPES |
| 49 | +// ============================================================================ |
| 50 | + |
| 51 | +interface MessageEntry { |
| 52 | + address: string; |
| 53 | + message: string; |
| 54 | +} |
| 55 | + |
| 56 | +async function main(): Promise<void> { |
| 57 | + // Validate configuration |
| 58 | + if (!accessToken) { |
| 59 | + throw new Error('Please set your accessToken in the configuration section'); |
| 60 | + } |
| 61 | + if (!walletId) { |
| 62 | + throw new Error('Please set your walletId in the configuration section'); |
| 63 | + } |
| 64 | + if (!walletPassphrase) { |
| 65 | + throw new Error('Please set your walletPassphrase in the configuration section'); |
| 66 | + } |
| 67 | + |
| 68 | + // Initialize BitGo SDK |
| 69 | + const bitgo = new BitGo({ env: environment }); |
| 70 | + bitgo.authenticateWithAccessToken({ accessToken }); |
| 71 | + if (otp) { |
| 72 | + const unlock = await bitgo.unlock({ otp, duration: 3600 }); |
| 73 | + if (!unlock) { |
| 74 | + console.log('We did not unlock.'); |
| 75 | + throw new Error(); |
| 76 | + } |
| 77 | + } |
| 78 | + |
| 79 | + const baseCoin = bitgo.coin(coin); |
| 80 | + |
| 81 | + console.log(`Environment: ${environment}`); |
| 82 | + console.log(`Coin: ${coin}`); |
| 83 | + console.log(`Wallet ID: ${walletId}`); |
| 84 | + |
| 85 | + // Read messages from JSON file |
| 86 | + const messagesPath = path.join(__dirname, 'messages.json'); |
| 87 | + const messagesContent = fs.readFileSync(messagesPath, 'utf-8'); |
| 88 | + const messages: MessageEntry[] = JSON.parse(messagesContent); |
| 89 | + |
| 90 | + if (!Array.isArray(messages) || messages.length === 0) { |
| 91 | + throw new Error('messages.json must contain an array of {address, message} objects'); |
| 92 | + } |
| 93 | + |
| 94 | + console.log(`\nLoaded ${messages.length} message(s) to prove:`); |
| 95 | + messages.forEach((m, i) => { |
| 96 | + console.log(` ${i + 1}. Address: ${m.address}`); |
| 97 | + console.log(` Message: ${m.message}`); |
| 98 | + }); |
| 99 | + |
| 100 | + // Get the wallet |
| 101 | + console.log('\nFetching wallet...'); |
| 102 | + const wallet = await baseCoin.wallets().get({ id: walletId }); |
| 103 | + console.log(`Wallet label: ${wallet.label()}`); |
| 104 | + |
| 105 | + // Get keychains for the wallet (needed for deriving pubkeys) |
| 106 | + console.log('\nFetching keychains...'); |
| 107 | + const keychains = await baseCoin.keychains().getKeysForSigning({ wallet }); |
| 108 | + const xpubs = keychains.map((k) => { |
| 109 | + if (!k.pub) { |
| 110 | + throw new Error('Keychain missing public key'); |
| 111 | + } |
| 112 | + return k.pub; |
| 113 | + }); |
| 114 | + console.log('Retrieved wallet public keys'); |
| 115 | + |
| 116 | + // Create RootWalletKeys from xpubs for derivation |
| 117 | + const bip32 = BIP32Factory(ecc); |
| 118 | + const rootWalletKeys = new utxolib.bitgo.RootWalletKeys( |
| 119 | + xpubs.map((xpub) => bip32.fromBase58(xpub)) as utxolib.bitgo.Triple<utxolib.BIP32Interface> |
| 120 | + ); |
| 121 | + |
| 122 | + // Build messageInfo array by getting address details for each message |
| 123 | + console.log('\nBuilding message info from address data...'); |
| 124 | + const messageInfo: bip322.MessageInfo[] = []; |
| 125 | + |
| 126 | + for (const entry of messages) { |
| 127 | + // Get address information from wallet to obtain chain and index |
| 128 | + console.log(` Getting address info for: ${entry.address}`); |
| 129 | + const addressInfo = await wallet.getAddress({ address: entry.address }); |
| 130 | + |
| 131 | + if (addressInfo.chain === undefined || addressInfo.index === undefined) { |
| 132 | + throw new Error(`Address ${entry.address} is missing chain or index information`); |
| 133 | + } |
| 134 | + |
| 135 | + const chain = addressInfo.chain as utxolib.bitgo.ChainCode; |
| 136 | + const index = addressInfo.index; |
| 137 | + |
| 138 | + // Derive scriptType from chain |
| 139 | + const scriptType = utxolib.bitgo.scriptTypeForChain(chain); |
| 140 | + |
| 141 | + // Derive pubkeys for this address using chain and index |
| 142 | + const derivedKeys = rootWalletKeys.deriveForChainAndIndex(chain, index); |
| 143 | + const pubkeys = derivedKeys.publicKeys.map((pk) => pk.toString('hex')); |
| 144 | + |
| 145 | + console.log(` Chain: ${chain}, Index: ${index}, ScriptType: ${scriptType}`); |
| 146 | + |
| 147 | + messageInfo.push({ |
| 148 | + address: entry.address, |
| 149 | + message: entry.message, |
| 150 | + pubkeys, |
| 151 | + scriptType, |
| 152 | + }); |
| 153 | + } |
| 154 | + |
| 155 | + console.log('\nCreating BIP322 proof via sendMany...'); |
| 156 | + const sendManyResult = await wallet.sendMany({ |
| 157 | + recipients: [], |
| 158 | + messages: messages, |
| 159 | + walletPassphrase, |
| 160 | + }); |
| 161 | + |
| 162 | + console.log('BIP322 proof created successfully'); |
| 163 | + |
| 164 | + // Extract the signed transaction from the result |
| 165 | + // The result should contain the fully signed PSBT or transaction hex |
| 166 | + const txHex = sendManyResult.txHex || sendManyResult.tx; |
| 167 | + if (!txHex) { |
| 168 | + throw new Error('No transaction hex found in sendMany result'); |
| 169 | + } |
| 170 | + |
| 171 | + console.log('\nVerifying BIP322 proof...'); |
| 172 | + |
| 173 | + // Parse the transaction and verify |
| 174 | + const network = (baseCoin as AbstractUtxoCoin).network; |
| 175 | + |
| 176 | + // Check if it's a PSBT or raw transaction |
| 177 | + if (utxolib.bitgo.isPsbt(txHex)) { |
| 178 | + // Parse as PSBT |
| 179 | + const psbt = utxolib.bitgo.createPsbtFromHex(txHex, network); |
| 180 | + bip322.assertBip322PsbtProof(psbt, messageInfo); |
| 181 | + console.log('PSBT proof verified successfully!'); |
| 182 | + } else { |
| 183 | + // Parse as raw transaction |
| 184 | + const tx = utxolib.bitgo.createTransactionFromHex<bigint>(txHex, network, { amountType: 'bigint' }); |
| 185 | + bip322.assertBip322TxProof(tx, messageInfo); |
| 186 | + console.log('Transaction proof verified successfully!'); |
| 187 | + } |
| 188 | + |
| 189 | + // Display summary |
| 190 | + console.log('\n============================================'); |
| 191 | + console.log('BIP322 PROOF VERIFICATION COMPLETE'); |
| 192 | + console.log('============================================'); |
| 193 | + console.log(`Verified ${messageInfo.length} address/message pair(s):`); |
| 194 | + messageInfo.forEach((info, i) => { |
| 195 | + console.log(`\n${i + 1}. Address: ${info.address}`); |
| 196 | + console.log(` Message: "${info.message}"`); |
| 197 | + console.log(` Script Type: ${info.scriptType}`); |
| 198 | + }); |
| 199 | + console.log('\nAll proofs are valid. The wallet controls the specified addresses.'); |
| 200 | +} |
| 201 | + |
| 202 | +// Run the example |
| 203 | +main() |
| 204 | + .then(() => { |
| 205 | + console.log('\nExample completed successfully.'); |
| 206 | + process.exit(0); |
| 207 | + }) |
| 208 | + .catch((e) => { |
| 209 | + console.error('\nExample failed with error:', e.message); |
| 210 | + if (e.result) { |
| 211 | + console.error('API Error details:', JSON.stringify(e.result, null, 2)); |
| 212 | + } |
| 213 | + process.exit(1); |
| 214 | + }); |
0 commit comments