Merge pull request #5887 from BitGo/COIN-3422-erc20-sendmany

feat: enable erc20 sendmany

Author: pritam-gembali

modules/abstract-eth/src/abstractEthLikeNewCoins.ts

@@ -338,6 +338,7 @@ interface EthTransactionParams extends TransactionParams {
   hopParams?: HopParams;
   hop?: boolean;
   prebuildTx?: PrebuildTransactionResult;
+  tokenName?: string;
 }
 
 interface VerifyEthTransactionOptions extends VerifyTransactionOptions {
@@ -2598,14 +2599,21 @@ export abstract class AbstractEthLikeNewCoins extends AbstractEthLikeCoin {
       await this.validateHopPrebuild(wallet, txPrebuild.hopTransaction, { recipients });
     } else if (txParams.recipients.length > 1) {
       // Check total amount for batch transaction
-      let expectedTotalAmount = new BigNumber(0);
-      for (let i = 0; i < txParams.recipients.length; i++) {
-        expectedTotalAmount = expectedTotalAmount.plus(txParams.recipients[i].amount);
-      }
-      if (!expectedTotalAmount.isEqualTo(txPrebuild.recipients[0].amount)) {
-        throw new Error(
-          'batch transaction amount in txPrebuild received from BitGo servers does not match txParams supplied by client'
-        );
+      if (txParams.tokenName) {
+        const expectedTotalAmount = new BigNumber(0);
+        if (!expectedTotalAmount.isEqualTo(txPrebuild.recipients[0].amount)) {
+          throw new Error('batch token transaction amount in txPrebuild should be zero for token transfers');
+        }
+      } else {
+        let expectedTotalAmount = new BigNumber(0);
+        for (let i = 0; i < txParams.recipients.length; i++) {
+          expectedTotalAmount = expectedTotalAmount.plus(txParams.recipients[i].amount);
+        }
+        if (!expectedTotalAmount.isEqualTo(txPrebuild.recipients[0].amount)) {
+          throw new Error(
+            'batch transaction amount in txPrebuild received from BitGo servers does not match txParams supplied by client'
+          );
+        }
       }
 
       // Check batch transaction is sent to the batcher contract address for the chain

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

@@ -10,6 +10,7 @@ import { OfflineVaultTxInfo, optionalDeps, SignTransactionOptions } from '@bitgo
 import { Opeth, Topeth, TransactionBuilder, TransferBuilder } from '../../src/index';
 import * as mockData from '../fixtures/opeth';
 import { getBuilder } from '../getBuilder';
+import { EthereumNetwork } from '@bitgo/statics';
 
 nock.enableNetConnect();
 
@@ -578,6 +579,105 @@ describe('Optimism', function () {
         .verifyTransaction({ txParams, txPrebuild, wallet, verification })
         .should.be.rejectedWith('coin in txPrebuild did not match that in txParams supplied by client');
     });
+
+    it('should verify a txPrebuild with more than one recipient in case of token batch transfer', async function () {
+      const wallet = new Wallet(bitgo, basecoin, {});
+
+      const txParams = {
+        tokenName: 'topeth:terc18dp',
+        recipients: [
+          { amount: '1', address: address1 },
+          { amount: '2', address: address2 },
+          { amount: '3', address: address2 },
+        ],
+        wallet: wallet,
+        walletPassphrase: 'fakeWalletPassphrase',
+      };
+
+      const txPrebuild = {
+        recipients: [
+          { amount: '0', address: (basecoin?.staticsCoin?.network as EthereumNetwork).batcherContractAddress },
+        ],
+        nextContractSequenceId: 0,
+        gasPrice: 20000000000,
+        gasLimit: 500000,
+        isBatch: true,
+        coin: 'topeth',
+        walletId: 'fakeWalletId',
+        walletContractAddress: 'fakeWalletContractAddress',
+      };
+
+      const verification = {};
+
+      const isTransactionVerified = await basecoin.verifyTransaction({ txParams, txPrebuild, wallet, verification });
+      isTransactionVerified.should.equal(true);
+    });
+
+    it('should reject a txPrebuild with more than one recipient in case of token batch transfer with wrong amount', async function () {
+      const wallet = new Wallet(bitgo, basecoin, {});
+
+      const txParams = {
+        tokenName: 'topeth:terc18dp',
+        recipients: [
+          { amount: '1', address: address1 },
+          { amount: '2', address: address2 },
+          { amount: '3', address: address2 },
+        ],
+        wallet: wallet,
+        walletPassphrase: 'fakeWalletPassphrase',
+      };
+
+      const txPrebuild = {
+        recipients: [
+          { amount: '6', address: (basecoin?.staticsCoin?.network as EthereumNetwork).batcherContractAddress },
+        ],
+        nextContractSequenceId: 0,
+        gasPrice: 20000000000,
+        gasLimit: 500000,
+        isBatch: true,
+        coin: 'topeth',
+        walletId: 'fakeWalletId',
+        walletContractAddress: 'fakeWalletContractAddress',
+      };
+
+      const verification = {};
+
+      await basecoin
+        .verifyTransaction({ txParams, txPrebuild, wallet, verification })
+        .should.be.rejectedWith(`batch token transaction amount in txPrebuild should be zero for token transfers`);
+    });
+
+    it('should reject a txPrebuild with more than one recipient in case of token batch transfer with wrong batcher contract address', async function () {
+      const wallet = new Wallet(bitgo, basecoin, {});
+
+      const txParams = {
+        tokenName: 'topeth:terc18dp',
+        recipients: [
+          { amount: '1', address: address1 },
+          { amount: '2', address: address2 },
+          { amount: '3', address: address2 },
+        ],
+        wallet: wallet,
+        walletPassphrase: 'fakeWalletPassphrase',
+      };
+
+      const txPrebuild = {
+        recipients: [{ amount: '0', address: 'fakeContractAddress' }],
+        nextContractSequenceId: 0,
+        gasPrice: 20000000000,
+        gasLimit: 500000,
+        isBatch: true,
+        coin: 'topeth',
+        walletId: 'fakeWalletId',
+        walletContractAddress: 'fakeWalletContractAddress',
+      };
+
+      const verification = {};
+
+      await basecoin
+        .verifyTransaction({ txParams, txPrebuild, wallet, verification })
+        .should.be.rejectedWith(`recipient address of txPrebuild does not match batcher address`);
+    });
   });
 
   describe('Recover transaction:', function () {

modules/statics/src/networks.ts

@@ -1078,6 +1078,7 @@ class OptimismTestnet extends Testnet implements EthereumNetwork {
   forwarderImplementationAddress = '0xd5fe1c1f216b775dfd30638fa7164d41321ef79b';
   walletFactoryAddress = '0x809ee567e413543af1caebcdb247f6a67eafc8dd';
   walletImplementationAddress = '0x944fef03af368414f29dc31a72061b8d64f568d2';
+  batcherContractAddress = '0xc84c7eb4c84271ec03ca9e3dbf12cfa42146309e';
 }
 
 class ZkSync extends Mainnet implements EthereumNetwork {