Merge pull request #9 from vault12/code-cleanup-2025

Code cleanup and minor improvements

Author: pavlo-liapin

README.md

@@ -7,40 +7,43 @@
   <a href="https://opensource.org/licenses/MIT">
     <img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="MIT License" />
   </a>
-  <img src="https://img.shields.io/david/vault12/recovery-utility" alt="Dependencies" />
   <a href="http://makeapullrequest.com">
     <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome" />
   </a>
-  <a href="https://twitter.com/_Vault12_">
-    <img src="https://img.shields.io/twitter/follow/_Vault12_?label=Follow&style=social" alt="Follow" />
+  <a href="https://x.com/_Vault12_">
+    <img src="https://img.shields.io/twitter/follow/_Vault12_?label=Follow&style=social" alt="Follow us on X" />
   </a>
 </p>
 
 # Overview
 
-A command-line utility for recovering assets from the raw data exported from [Vault12 mobile app](https://vault12.com/download/).
+The Vault12 Recovery Utility is a command-line tool designed to recover assets from raw data exported from the [Vault12 Guard mobile app](https://vault12.com/download/).
 
 ## Installation
 
-1. Install [node](https://nodejs.org/)
-2. Install the package globally:
-```
-$ npm i -g vault12-recovery
-```
+1. Install [Node.js](https://nodejs.org/).
+2. Install the package globally by running:
+   ```bash
+   npm install -g vault12-recovery
+   ```
+
 ## Usage
 
-1. Export the decryption key (`vault12.json`) from the Vault12 app: *Settings > Advanced > Export My Vault’s Decryption Key*.
-2. Collect the raw Vault data from several Guardian devices via *Settings > Advanced > Export Data for External Vault*. You'll need to collect the amount of files equal to the **Number of Confirmations** you selected when creating the Vault.
-3. Place all exported archives and `vault12.json` file in the same directory, e.g. `~/vault12-files`.
-4. In terminal, run
-```
-$ vault12-recovery ~/vault12-files
-```
-5. You should find all recovered assets from the Vault in the directory `~/vault12-files/output`.
+1. Export the decryption key (`vault12.json`) from the Vault12 app:
+   - **Settings > Advanced > Export My Vault’s Decryption Key**.
+2. Collect the raw Vault data from multiple Guardian devices:
+   - Use **Settings > Advanced > Export Data for External Vault**.
+   - Ensure you collect the number of files equal to the **Number of Confirmations** you selected when creating the Vault.
+3. Place all exported archives and the `vault12.json` file in the same directory, e.g., `~/vault12-files`.
+4. Run the recovery utility in the terminal:
+   ```bash
+   vault12-recovery ~/vault12-files
+   ```
+5. The recovered assets will be saved in the `~/vault12-files/output` directory.
 
 ## License
 
-Vault12 Recovery Utility is released under the [MIT License](http://opensource.org/licenses/MIT).
+**Vault12 Recovery Utility** is released under the [MIT License](http://opensource.org/licenses/MIT).
 
 ## Legal Reminder
 

index.ts

@@ -17,18 +17,40 @@ const indexFile = 'index.json';
 console.log(chalk.whiteBright(`Vault12 Recovery Utility ${version}`));
 console.log('-------------------');
 
-const dir = getDirectory();
-const vaultData = getVaultData();
-const zipArchives = getZipArchives();
-findAssetShardsInArchives();
-const workingOutputDir = createDir(path(outputDir));
-restoreAssets();
+let dir: string;
+let vaultData: ExportVaultMetadata;
+let zipArchives: string[];
+let workingOutputDir: string;
+
+function main() {
+  if (process.argv.length < 3) {
+    console.log(chalk.red('Usage: vault12-recovery <directory>'));
+    process.exit(1);
+  }
+
+  try {
+    dir = getDirectory();
+    vaultData = getVaultData();
+    zipArchives = getZipArchives();
+    findAssetShardsInArchives();
+    workingOutputDir = createDir(path(outputDir));
+    restoreAssets();
+  } catch (error) {
+    console.error(chalk.red(error.message));
+    process.exit(1);
+  }
+}
+
+main();
 
 function getDirectory() {
   const dir = process.argv[2];
   if (!dir) {
     throw new Error('First parameter should be a directory');
   }
+  if (!fs.existsSync(dir)) {
+    throw new Error(`Directory ${dir} not found`);
+  }
   if (!fs.lstatSync(dir).isDirectory()) {
     throw new Error(`${dir} expected to be a directory`);
   }
@@ -37,6 +59,9 @@ function getDirectory() {
 
 function getVaultData(): ExportVaultMetadata {
   const keyFilePath = path(keyFile);
+  if (!fs.existsSync(keyFilePath)) {
+    throw new Error(`Key file ${keyFilePath} not found`);
+  }
   if (!fs.lstatSync(keyFilePath).isFile()) {
     throw new Error(`Expected ${dir} to contain ${keyFilePath}`);
   }
@@ -56,27 +81,37 @@ function getZipArchives() {
 function restoreAssets() {
   const masterKey = Buffer.from(vaultData.masterKey, 'base64');
   const assetsCount = vaultData.assetsMetaData.length;
-
+  let hasErrors = false; // Track if any errors occur
   vaultData.assetsMetaData.forEach((asset, i) => {
     process.stdout.write(`${chalk.yellow(`${i+1}/${assetsCount}`)} Unlocking ${chalk.bold(asset.name)}... `);
     let recombinedFile: Buffer;
     try {
-      recombinedFile = recombineAsset(asset)
+      recombinedFile = recombineAsset(asset);
     } catch (error) {
-      console.error(`Failed to recover ${asset.name}`, error);
+      console.error(`Failed to recover ${asset.name}`, error.message);
+      hasErrors = true;
       return;
     }
     let plainText: Uint8Array;
     try {
-      plainText = decryptAsset(asset, recombinedFile, masterKey)
+      plainText = decryptAsset(asset, recombinedFile, masterKey);
     } catch (error) {
-      console.error(`Failed to decrypt ${asset.name}`, error);
+      console.error(`Failed to decrypt ${asset.name}`, error.message);
+      hasErrors = true;
       return;
     }
-    fs.writeFileSync(path(outputDir, asset.name), plainText);
-    process.stdout.write(chalk.green('✓') + '\n');
-  })
-  console.log(chalk.green(`Assets successfully unlocked and stored in ${workingOutputDir}`));
+    try {
+      fs.writeFileSync(path(outputDir, asset.name), plainText);
+      process.stdout.write(chalk.green('✓') + '\n');
+    } catch (error) {
+      console.error(`Failed to write ${asset.name} to disk`, error.message);
+      hasErrors = true;
+    }
+  });
+
+  if (!hasErrors) {
+    console.log(chalk.green(`Assets successfully unlocked and stored in ${workingOutputDir}`));
+  }
 }
 
 function createDir(workingOutputDir: string) {
@@ -87,7 +122,7 @@ function createDir(workingOutputDir: string) {
 }
 
 function findAssetShardsInArchives() {
-  console.log(`Validating Vault...`);
+  console.log(chalk.yellow(`Validating Vault...`));
   zipArchives.forEach(zipArchive => {
     const archiveDirName = pathLib.parse(zipArchive).name;
 
@@ -137,14 +172,13 @@ function recombineAsset(asset: ExportAssetMetadata) {
   const shardPaths = asset.shards.filter(shard => !!shard.path).map(shard => shard.path);
 
   if (shardPaths.length < vaultData.shardsRequiredToUnlock) {
-    console.error(`Only ${shardPaths.length} shards found for asset ${asset.name} when ${vaultData.shardsRequiredToUnlock} needed`);
-    return;
+    throw new Error(`Only ${shardPaths.length} shards found for asset ${asset.name} when ${vaultData.shardsRequiredToUnlock} needed`);
   }
   /**
   * prepare for format required by shamir
   * 1st byte of file is index of shard the rest is data
   */
-  const buffers = shardPaths.map((path) => fs.readFileSync(path));
+  const buffers = shardPaths.filter((path): path is string => !!path).map((path) => fs.readFileSync(path));
   const obj = {};
   buffers.forEach((v) => obj[v[0]] = v.slice(1));
   return join(obj);

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "vault12-recovery",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "A command-line utility for recovering assets from the raw data exported from Vault12 mobile app",
   "main": "index.js",
   "author": "Vault12",
@@ -32,7 +32,7 @@
   "devDependencies": {
     "@types/adm-zip": "0.4.33",
     "@types/node": "14.14.25",
-    "typescript": "4.2.2"
+    "typescript": "5.8.3"
   },
   "dependencies": {
     "adm-zip": "0.5.2",