Merge pull request #7285 from BitGo/BTC-2645.passphrase-recovery

docs(examples): add wallet passphrase recovery example script

Author: davidkaplanbitgo

examples/ts/btc/v1/wallet-passphrase-recovery.ts

@@ -0,0 +1,88 @@
+#!/usr/bin/env node
+/**
+ * Wallet Passphrase Recovery Script
+ *
+ * This script takes box D information in the keycard and recovers the wallet passphrase.
+ *
+ * The script will prompt for:
+ * - Environment (test/prod)
+ * - Activation code
+ * - Encrypted wallet passphrase from Box D of keycard
+ * 
+ * You need to install node and BitGoJS SDK to run this script.
+ * 
+ * To install node, you can follow the instructions here: https://nodejs.org/en/download
+ *
+ * To install BitGoJS SDK, you can use the following command:
+ *   npm install @bitgo/sdk-api
+ *
+ * Usage:
+ *   tsx wallet-passphrase-recovery.ts
+ *                  OR
+ *   npx ts-node wallet-passphrase-recovery.ts
+ */
+
+import { BitGoAPI } from '@bitgo/sdk-api';
+import * as readline from 'readline';
+
+// Create readline interface for user input
+const rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout,
+});
+
+// Function to ask questions in the terminal
+function askQuestion(query: string): Promise<string> {
+  return new Promise((resolve) => {
+    rl.question(query, (answer) => {
+      resolve(answer);
+    });
+  });
+}
+
+async function main(): Promise<void> {
+  try {
+    console.log('BitGo V1 Wallet Password Recovery Tool');
+    console.log('====================================\n');
+
+    // Get environment setting
+    const envInput = await askQuestion(
+      'Enter environment (test/prod) [default: test]: ',
+    );
+    const env = envInput.toLowerCase() === 'prod' ? 'prod' : 'test';
+
+    // Initialize BitGo
+    const bitgo = new BitGoAPI({
+      env: env,
+    });
+
+    // Get activation code
+    const activationCode = await askQuestion('Enter activation code: ');
+
+    // Get encrypted wallet passphrase from Box D
+    const encryptedWalletPassphrase = await askQuestion(
+      'Enter encrypted wallet passphrase from Box D: ',
+    );
+
+    // Decrypt the wallet passphrase
+    const walletPassphrase = bitgo.decrypt({
+      input: encryptedWalletPassphrase,
+      password: activationCode,
+    });
+
+    console.log(`\n✅ SUCCESS: the decrypted passphrase is: ${walletPassphrase}`);
+  } catch (error) {
+    console.error(`\nError: ${error.message}`);
+    if (error.status) {
+      console.error(`Status code: ${error.status}`);
+    }
+    console.error('Please check your credentials and try again.');
+  } finally {
+    rl.close();
+  }
+}
+
+main().catch((error) => {
+  console.error(`Fatal error: ${error.message}`);
+  process.exit(1);
+});