Merge pull request #5070 from BitGo/COIN-1958

fix(sdk) : throw error on sendmany API call when recipients > 1

Author: nvrakesh06

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

@@ -1,7 +1,7 @@
 /**
  * @prettier
  */
-import { BaseCoin, BitGoBase } from '@bitgo/sdk-core';
+import { BaseCoin, BitGoBase, VerifyTransactionOptions } from '@bitgo/sdk-core';
 import { BaseCoin as StaticsBaseCoin, coins } from '@bitgo/statics';
 import { AbstractEthLikeCoin } from '@bitgo/abstract-eth';
 import { KeyPair, TransactionBuilder } from './lib';
@@ -28,4 +28,12 @@ export class Celo extends AbstractEthLikeCoin {
   protected getTransactionBuilder(): TransactionBuilder {
     return new TransactionBuilder(coins.get(this.getBaseChain()));
   }
+
+  async verifyTransaction(params: VerifyTransactionOptions): Promise<boolean> {
+    const { txParams } = params;
+    if (txParams?.recipients?.length !== 1) {
+      throw new Error(`txParams should only have 1 recipient but ${txParams?.recipients?.length} found`);
+    }
+    return true;
+  }
 }

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

@@ -1,15 +1,18 @@
 import { TestBitGo, TestBitGoAPI } from '@bitgo/sdk-test';
 import { BitGoAPI } from '@bitgo/sdk-api';
 import { Celo, Tcelo } from '../../src';
+import { Wallet } from '@bitgo/sdk-core';
 
 describe('Celo Gold', function () {
   let bitgo: TestBitGoAPI;
+  let basecoin;
 
   before(function () {
     bitgo = TestBitGo.decorate(BitGoAPI, { env: 'mock' });
     bitgo.safeRegister('tcelo', Tcelo.createInstance);
     bitgo.safeRegister('celo', Celo.createInstance);
     bitgo.initializeTestVars();
+    basecoin = bitgo.coin('celo');
   });
 
   it('should instantiate the coin', function () {
@@ -19,4 +22,25 @@ describe('Celo Gold', function () {
     localBasecoin = bitgo.coin('celo');
     localBasecoin.should.be.an.instanceof(Celo);
   });
+
+  describe('Verify Transaction', function () {
+    const address1 = '5Ge59qRnZa8bxyhVFE6BDoY3kuhSrNVETRxXYLty1Hh6XTaf';
+    const address2 = '5DiMLZugmcKEH3igPZP367FqummZkWeW5Z6zDCHLfxRjnPXe';
+    it('should reject a txPrebuild with more than one recipient', async function () {
+      const wallet = new Wallet(bitgo, basecoin, {});
+
+      const txParams = {
+        recipients: [
+          { amount: '1000000000000', address: address1 },
+          { amount: '2500000000000', address: address2 },
+        ],
+        wallet: wallet,
+        walletPassphrase: 'fakeWalletPassphrase',
+      };
+
+      await basecoin
+        .verifyTransaction({ txParams })
+        .should.be.rejectedWith('txParams should only have 1 recipient but 2 found');
+    });
+  });
 });

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

@@ -104,6 +104,10 @@ export class Xtz extends BaseCoin {
   }
 
   async verifyTransaction(params: VerifyTransactionOptions): Promise<boolean> {
+    const { txParams } = params;
+    if (txParams?.recipients?.length !== 1) {
+      throw new Error(`txParams should only have 1 recipient but ${txParams?.recipients?.length} found`);
+    }
     return true;
   }
 

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

@@ -10,6 +10,7 @@ import {
   unsignedHex,
   unsignedTransactionWithTwoTransfersHex,
 } from '../fixtures';
+import { Wallet } from '@bitgo/sdk-core';
 
 const bitgo: TestBitGoAPI = TestBitGo.decorate(BitGoAPI, { env: 'test' });
 bitgo.safeRegister('xtz', Xtz.createInstance);
@@ -199,4 +200,25 @@ describe('Tezos:', function () {
       isValid.should.equal(false);
     });
   });
+
+  describe('Verify Transaction', function () {
+    const address1 = '5Ge59qRnZa8bxyhVFE6BDoY3kuhSrNVETRxXYLty1Hh6XTaf';
+    const address2 = '5DiMLZugmcKEH3igPZP367FqummZkWeW5Z6zDCHLfxRjnPXe';
+    it('should reject a txPrebuild with more than one recipient', async function () {
+      const wallet = new Wallet(bitgo, basecoin, {});
+
+      const txParams = {
+        recipients: [
+          { amount: '1000000000000', address: address1 },
+          { amount: '2500000000000', address: address2 },
+        ],
+        wallet: wallet,
+        walletPassphrase: 'fakeWalletPassphrase',
+      };
+
+      await basecoin
+        .verifyTransaction({ txParams })
+        .should.be.rejectedWith('txParams should only have 1 recipient but 2 found');
+    });
+  });
 });