Merge pull request #6061 from BitGo/fix/CSI-445-error-msg-bulk-share

feat: change error type for password error in bulkshareoption

Author: ayush-9

modules/bitgo/test/v2/unit/wallets.ts

@@ -25,6 +25,7 @@ import {
   KeychainWithEncryptedPrv,
   WalletWithKeychains,
   multisigTypes,
+  IncorrectPasswordError,
 } from '@bitgo/sdk-core';
 import { BitGo } from '../../../src';
 import { afterEach } from 'mocha';
@@ -2605,6 +2606,52 @@ describe('V2 Wallets:', function () {
         ],
       });
     });
+
+    it('should throw error in processing share options when wallet password is incorrect', async () => {
+      const userId = '[email protected]';
+      const permissions = ['view', 'spend'];
+      const path = 'm/999999/1/1';
+      const walletPassphrase = 'bitgo1234';
+      const pub = 'Zo1ggzTUKMY5bYnDvT5mtVeZxzf2FaLTbKkmvGUhUQk';
+      nock(bgUrl)
+        .get(`/api/v2/tbtc/key/${wallet.keyIds()[0]}`)
+        .reply(200, {
+          id: wallet.keyIds()[0],
+          pub,
+          source: 'user',
+          encryptedPrv: bitgo.encrypt({ input: 'xprv1', password: walletPassphrase }),
+          coinSpecific: {},
+        });
+      const params: BulkWalletShareOptions = {
+        walletPassphrase: 'wrong password',
+        keyShareOptions: [
+          {
+            userId: userId,
+            permissions: permissions,
+            pubKey: '02705a6d33a2459feb537e7abe36aaad8c11532cdbffa3a2e4e58868467d51f532',
+            path: path,
+          },
+        ],
+      };
+
+      const prv1 = Math.random().toString();
+      const keychainTest: OptionalKeychainEncryptedKey = {
+        encryptedPrv: bitgo.encrypt({ input: prv1, password: walletPassphrase }),
+      };
+
+      sinon.stub(wallet, 'getEncryptedUserKeychain').resolves({
+        encryptedPrv: keychainTest.encryptedPrv,
+        pub,
+      } as KeychainWithEncryptedPrv);
+
+      try {
+        await wallet.createBulkWalletShare(params);
+        assert.fail('Expected error not thrown');
+      } catch (error) {
+        assert(error instanceof IncorrectPasswordError);
+        assert.equal(error.message, 'Password shared is incorrect for this wallet');
+      }
+    });
   });
 
   describe('List Wallets:', function () {

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

@@ -163,6 +163,12 @@ export class MissingEncryptedKeychainError extends Error {
   }
 }
 
+export class IncorrectPasswordError extends Error {
+  public constructor(message?: string) {
+    super(message || 'Incorrect password');
+  }
+}
+
 export class ApiResponseError<ResponseBodyType = any> extends BitGoJsError {
   message: string;
   status: number;

modules/sdk-core/src/bitgo/wallet/iWallets.ts

@@ -204,6 +204,10 @@ export interface AcceptShareResponse {
   walletShareId: string;
 }
 
+export interface BulkAcceptShareResponse {
+  acceptedWalletShares: AcceptShareResponse[];
+}
+
 export interface IWallets {
   get(params?: GetWalletOptions): Promise<Wallet>;
   list(params?: ListWalletOptions): Promise<{ wallets: IWallet[] }>;
@@ -218,6 +222,6 @@ export interface IWallets {
   getWallet(params?: GetWalletOptions): Promise<IWallet>;
   getWalletByAddress(params?: GetWalletByAddressOptions): Promise<IWallet>;
   getTotalBalances(params?: Record<string, never>): Promise<any>;
-  bulkAcceptShare(params: BulkAcceptShareOptions): Promise<AcceptShareResponse[]>;
+  bulkAcceptShare(params: BulkAcceptShareOptions): Promise<BulkAcceptShareResponse>;
   listSharesV2(): Promise<WalletShares>;
 }

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

@@ -18,7 +18,12 @@ import {
 import { makeRandomKey } from '../bitcoin';
 import { BitGoBase } from '../bitgoBase';
 import { getSharedSecret } from '../ecdh';
-import { AddressGenerationError, MethodNotImplementedError, MissingEncryptedKeychainError } from '../errors';
+import {
+  AddressGenerationError,
+  IncorrectPasswordError,
+  MethodNotImplementedError,
+  MissingEncryptedKeychainError,
+} from '../errors';
 import * as internal from '../internal/internal';
 import { drawKeycard } from '../internal';
 import { decryptKeychainPrivateKey, Keychain, KeychainWithEncryptedPrv } from '../keychain';
@@ -1685,7 +1690,7 @@ export class Wallet implements IWallet {
 
         const userPrv = decryptKeychainPrivateKey(this.bitgo, keychain, walletPassphrase);
         if (!userPrv) {
-          throw new Error('Unable to decrypt user keychain');
+          throw new IncorrectPasswordError('Password shared is incorrect for this wallet');
         }
 
         keychain.prv = userPrv;

modules/sdk-core/src/bitgo/wallet/wallets.ts

@@ -17,9 +17,9 @@ import { decodeOrElse, promiseProps, RequestTracer } from '../utils';
 import {
   AcceptShareOptions,
   AcceptShareOptionsRequest,
-  AcceptShareResponse,
   AddWalletOptions,
   BulkAcceptShareOptions,
+  BulkAcceptShareResponse,
   BulkUpdateWalletShareOptions,
   BulkUpdateWalletShareOptionsRequest,
   BulkUpdateWalletShareResponse,
@@ -636,9 +636,9 @@ export class Wallets implements IWallets {
   /**
    * Bulk accept wallet shares
    * @param params AcceptShareOptionsRequest[]
-   * @returns {Promise<AcceptShareResponse[]>}
+   * @returns {Promise<BulkAcceptShareResponse>}
    */
-  async bulkAcceptShareRequest(params: AcceptShareOptionsRequest[]): Promise<AcceptShareResponse[]> {
+  async bulkAcceptShareRequest(params: AcceptShareOptionsRequest[]): Promise<BulkAcceptShareResponse> {
     return await this.bitgo
       .put(this.bitgo.url('/walletshares/accept', 2))
       .send({
@@ -846,9 +846,9 @@ export class Wallets implements IWallets {
    * @param params.newWalletPassphrase - new wallet passphrase for saving the shared wallet prv.
    *                                     If left blank then the user's login password is used.
    *
-   *@returns {Promise<AcceptShareResponse[]>}
+   *@returns {Promise<BulkAcceptShareResponse>}
    */
-  async bulkAcceptShare(params: BulkAcceptShareOptions): Promise<AcceptShareResponse[]> {
+  async bulkAcceptShare(params: BulkAcceptShareOptions): Promise<BulkAcceptShareResponse> {
     common.validateParams(params, ['userLoginPassword'], ['newWalletPassphrase']);
     assert(params.walletShareIds.length > 0, 'no walletShareIds are passed');