feat: increase dividend distribution coverage

Author: Victor Wiebe

src/procedures/__tests__/CreateErc20DividendDistribution.ts

@@ -11,7 +11,7 @@ import * as tokenFactoryModule from '../../testUtils/MockedTokenFactoryObject';
 import { CreateErc20DividendDistribution } from '../../procedures/CreateErc20DividendDistribution';
 import { Procedure } from '~/procedures/Procedure';
 import { PolymathError } from '~/PolymathError';
-import { ErrorCode , ProcedureType } from '~/types';
+import { ErrorCode, ProcedureType } from '~/types';
 import { ApproveErc20 } from '../ApproveErc20';
 import * as securityTokenFactoryModule from '~/entities/factories/SecurityTokenFactory';
 import * as cappedStoFactoryModule from '~/entities/factories/CappedStoFactory';
@@ -27,7 +27,6 @@ import * as usdTieredStoFactoryModule from '~/entities/factories/UsdTieredStoFac
 import * as taxWithholdingFactoryModule from '~/entities/factories/TaxWithholdingFactory';
 import * as utilsModule from '~/utils';
 
-
 const params1 = {
   symbol: 'TEST1',
   name: 'Test Token 1',
@@ -199,6 +198,42 @@ describe('CreateErc20DividendDistribution', () => {
       expect(spyOnAddProcedure.withArgs(ApproveErc20).callCount).toBe(1);
     });
 
+    test('should send the transaction to CreateErc20DividendDistribution with taxWitholdings', async () => {
+      target = new CreateErc20DividendDistribution(
+        {
+          symbol: params1.symbol,
+          maturityDate: params1.maturityDate,
+          expiryDate: params1.expiryDate,
+          erc20Address: params1.erc20Address,
+          amount: params1.amount,
+          checkpointIndex: params1.checkpointIndex,
+          name: params1.name,
+          taxWithholdings: [
+            {
+              address: '0x5555555555555555555555555555555555555555',
+              percentage: 50,
+            },
+          ],
+        },
+        contextMock.getMockInstance()
+      );
+      const spyOnAddProcedure = sinon.spy(target, 'addProcedure');
+      const spyOnAddTransaction = sinon.spy(target, 'addTransaction');
+      // Real call
+      await target.prepareTransactions();
+
+      // Verifications
+      expect(
+        spyOnAddTransaction.withArgs(erc20DividendsMock.getMockInstance().setWithholding).callCount
+      ).toBe(2);
+      expect(
+        spyOnAddTransaction.withArgs(
+          erc20DividendsMock.getMockInstance().createDividendWithCheckpointAndExclusions
+        ).callCount
+      ).toBe(2);
+      expect(spyOnAddProcedure.withArgs(ApproveErc20).callCount).toBe(1);
+    });
+
     test('should throw if there is no supplied valid security token', async () => {
       tokenFactoryMock.set(
         'getSecurityTokenInstanceFromTicker',

src/procedures/__tests__/CreateEtherDividendDistribution.ts

@@ -182,6 +182,40 @@ describe('CreateEtherDividendDistribution', () => {
       ).toBe(1);
     });
 
+    test('should send the transaction to CreateEtherDividendDistribution with taxwithholdings', async () => {
+      target = new CreateEtherDividendDistribution(
+        {
+          symbol: params1.symbol,
+          maturityDate: params1.maturityDate,
+          expiryDate: params1.expiryDate,
+          amount: params1.amount,
+          checkpointIndex: params1.checkpointIndex,
+          name: params1.name,
+          taxWithholdings: [
+            {
+              address: '0x5555555555555555555555555555555555555555',
+              percentage: 50,
+            },
+          ],
+        },
+        contextMock.getMockInstance()
+      );
+
+      const spyOnAddTransaction = sinon.spy(target, 'addTransaction');
+      // Real call
+      await target.prepareTransactions();
+
+      // Verifications
+      expect(
+        spyOnAddTransaction.withArgs(etherDividendsMock.getMockInstance().setWithholding).callCount
+      ).toBe(2);
+      expect(
+        spyOnAddTransaction.withArgs(
+          etherDividendsMock.getMockInstance().createDividendWithCheckpointAndExclusions
+        ).callCount
+      ).toBe(2);
+    });
+
     test('should throw if corresponding event is not fired', async () => {
       findEventsStub = ImportMock.mockFunction(utilsModule, 'findEvents', []);