Merge pull request #6453 from BitGo/feature/CSI-702

feat: added new error NeedsUserSignupError

Author: sdoshibitgo

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

@@ -26,6 +26,7 @@ import {
   WalletWithKeychains,
   multisigTypes,
   IncorrectPasswordError,
+  NeedUserSignupError,
 } from '@bitgo/sdk-core';
 import { BitGo } from '../../../src';
 import { afterEach } from 'mocha';
@@ -2525,6 +2526,72 @@ describe('V2 Wallets:', function () {
       }
     });
 
+    it('should throw NeedsUserSignup error if pubkey is missing', async () => {
+      const userId = '[email protected]';
+      const permissions = ['view', 'spend'];
+      try {
+        await wallet.createBulkWalletShare({
+          walletPassphrase: 'Test',
+          keyShareOptions: [
+            {
+              userId: userId,
+              permissions: permissions,
+              path: 'm/999999/1/1',
+            },
+          ],
+        } as BulkWalletShareOptions);
+        assert.fail('Expected error not thrown');
+      } catch (error) {
+        assert(error instanceof NeedUserSignupError);
+        assert.strictEqual(error.name, 'NeedUserSignupError');
+        assert.strictEqual(error.message, userId);
+      }
+    });
+
+    it('should throw error if path is missing', async () => {
+      const userId = '[email protected]';
+      const permissions = ['view', 'spend'];
+      try {
+        await wallet.createBulkWalletShare({
+          walletPassphrase: 'Test',
+          keyShareOptions: [
+            {
+              userId: userId,
+              permissions: permissions,
+              pubKey: 'm/999999/1/1',
+            },
+          ],
+        } as BulkWalletShareOptions);
+        assert.fail('Expected error not thrown');
+      } catch (error) {
+        assert.strictEqual(error.name, 'Error');
+        assert.strictEqual(error.message, 'Missing parameter: path');
+      }
+    });
+
+    it('should throw NeedsUserSignup error if pubkey is empty string', async () => {
+      const userId = '[email protected]';
+      const permissions = ['view', 'spend'];
+      try {
+        await wallet.createBulkWalletShare({
+          walletPassphrase: 'Test',
+          keyShareOptions: [
+            {
+              userId: userId,
+              pubKey: '',
+              permissions: permissions,
+              path: 'm/999999/1/1',
+            },
+          ],
+        });
+        assert.fail('Expected error not thrown');
+      } catch (error) {
+        assert(error instanceof NeedUserSignupError);
+        assert.strictEqual(error.name, 'NeedUserSignupError');
+        assert.strictEqual(error.message, userId);
+      }
+    });
+
     it('should correctly process share options and call createBulkKeyShares', async () => {
       const userId = '[email protected]';
       const permissions = ['view', 'spend'];

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

@@ -169,6 +169,12 @@ export class IncorrectPasswordError extends Error {
   }
 }
 
+export class NeedUserSignupError extends BitGoJsError {
+  public constructor(message?: string) {
+    super(message || 'User signup is required');
+  }
+}
+
 export class ApiResponseError<ResponseBodyType = any> extends BitGoJsError {
   message: string;
   status: number;

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

@@ -23,6 +23,7 @@ import {
   IncorrectPasswordError,
   MethodNotImplementedError,
   MissingEncryptedKeychainError,
+  NeedUserSignupError,
 } from '../errors';
 import * as internal from '../internal/internal';
 import { drawKeycard } from '../internal';
@@ -1602,7 +1603,14 @@ export class Wallet implements IWallet {
     const bulkCreateShareOptions: BulkCreateShareOption[] = [];
 
     for (const shareOption of params.keyShareOptions) {
-      common.validateParams(shareOption, ['userId', 'pubKey', 'path'], []);
+      try {
+        common.validateParams(shareOption, ['userId', 'pubKey', 'path'], []);
+      } catch (e) {
+        if (!shareOption.pubKey) {
+          throw new NeedUserSignupError(shareOption.userId);
+        }
+        throw e;
+      }
 
       const needsKeychain = shareOption.permissions && shareOption.permissions.includes('spend');