Merge pull request #6196 from BitGo/WP-4242/audit-key-follow-ups

chore(root): follow up comments on auditKey

Author: davidkaplanbitgo

modules/abstract-lightning/src/abstractLightningCoin.ts

@@ -65,6 +65,7 @@ export abstract class AbstractLightningCoin extends BaseCoin {
 
   /** @inheritDoc */
   auditDecryptedKey(params: AuditDecryptedKeyParams) {
+    /** https://bitgoinc.atlassian.net/browse/BTC-2149 */
     throw new Error('Method not implemented.');
   }
 }

modules/sdk-coin-algo/src/algo.ts

@@ -858,7 +858,7 @@ export class Algo extends BaseCoin {
     try {
       algoKey = new AlgoLib.KeyPair({ prv });
     } catch (e) {
-      throw new Error('Invalid private key');
+      throw new Error(`Invalid private key: ${e.message}`);
     }
     if (publicKey && publicKey !== algoKey.getKeys().pub) {
       throw new Error('Invalid public key');

modules/sdk-coin-algo/test/unit/algo.ts

@@ -1176,7 +1176,7 @@ describe('ALGO:', function () {
             walletPassphrase,
           });
         },
-        { message: 'Invalid private key' }
+        { message: 'Invalid private key: Invalid base32 characters' }
       );
     });
   });

modules/sdk-coin-avaxp/src/avaxp.ts

@@ -369,6 +369,7 @@ export class AvaxP extends BaseCoin {
 
   /** @inheritDoc */
   auditDecryptedKey(params: AuditDecryptedKeyParams): void {
+    /** https://bitgoinc.atlassian.net/browse/COIN-4213 */
     throw new MethodNotImplementedError();
   }
 }

modules/sdk-coin-hbar/src/hbar.ts

@@ -642,7 +642,7 @@ export class Hbar extends BaseCoin {
     try {
       hbarKeyPair = new HbarKeyPair({ prv });
     } catch (e) {
-      throw new Error('Invalid private key');
+      throw new Error(`Invalid private key: ${e.message}`);
     }
     const genPubKey = hbarKeyPair.getKeys().pub;
     if (publicKey && publicKey !== genPubKey) {

modules/sdk-coin-hbar/test/unit/hbar.ts

@@ -1374,7 +1374,7 @@ describe('Hedera Hashgraph:', function () {
             walletPassphrase,
           }),
         {
-          message: 'Invalid private key',
+          message: 'Invalid private key: Invalid private key length. Must be a hex and multiple of 2',
         }
       );
     });

modules/sdk-coin-vet/src/vet.ts

@@ -120,6 +120,7 @@ export class Vet extends BaseCoin {
 
   /** @inheritDoc */
   auditDecryptedKey(params: AuditDecryptedKeyParams) {
+    /** https://bitgoinc.atlassian.net/browse/COIN-4213 */
     throw new Error('Method not implemented.');
   }
 }

modules/sdk-coin-xlm/src/xlm.ts

@@ -1199,7 +1199,8 @@ export class Xlm extends BaseCoin {
     try {
       xlmKeyPair = new StellarKeyPair({ prv });
     } catch (e) {
-      throw new Error('Invalid private key');
+      // Avoid adding the error message to the thrown error because it can contain sensitive information
+      throw new Error(`Invalid private key: Unable to generate keypair from prv`);
     }
 
     if (publicKey && publicKey !== xlmKeyPair.getKeys().pub) {

modules/sdk-coin-xlm/test/unit/xlm.ts

@@ -1161,7 +1161,7 @@ describe('XLM:', function () {
             walletPassphrase,
           }),
         {
-          message: 'Invalid private key',
+          message: 'Invalid private key: Unable to generate keypair from prv',
         }
       );
     });

modules/sdk-core/src/bitgo/baseCoin/baseCoin.ts

@@ -642,7 +642,6 @@ export abstract class BaseCoin implements IBaseCoin {
    * @param {string} params.prv - the decrypted private key
    * @param {string} params.publicKey - the public key, or common keychain
    * @param {string} params.multiSigType - the multi-sig type, if applicable
-   * @returns {AuditKeyResponse} - result of the audit
    */
   abstract auditDecryptedKey(params: AuditDecryptedKeyParams): void;
 }