fix: last review changes for branch

Author: Victor Wiebe

src/procedures/__tests__/EnableDividendManagers.ts

@@ -1,5 +1,5 @@
 import { ImportMock, MockManager } from 'ts-mock-imports';
-import { SinonStub, stub, spy, restore } from 'sinon';
+import { stub, spy, restore } from 'sinon';
 import { BigNumber } from '@polymathnetwork/contract-wrappers';
 import * as contractWrappersModule from '@polymathnetwork/contract-wrappers';
 import * as contextModule from '../../Context';
@@ -10,14 +10,9 @@ import { Procedure } from '~/procedures/Procedure';
 import { PolymathError } from '~/PolymathError';
 import { ErrorCode, PolyTransactionTag } from '~/types';
 
-const params1 = {
+const params = {
   symbol: 'TEST1',
-  name: 'Test Token 1',
-  amount: new BigNumber(1),
-  checkpointIndex: 1,
-  maturityDate: new Date(2030, 1),
-  expiryDate: new Date(2031, 1),
-  address: '0x4444444444444444444444444444444444444444',
+  storageWalletAddress: '0x5555555555555555555555555555555555555555',
 };
 
 describe('EnableDividendManagers', () => {
@@ -27,41 +22,30 @@ describe('EnableDividendManagers', () => {
   let tokenFactoryMock: MockManager<tokenFactoryModule.MockedTokenFactoryObject>;
   let etherDividendsMock: MockManager<contractWrappersModule.EtherDividendCheckpoint_3_0_0>;
   let securityTokenMock: MockManager<contractWrappersModule.SecurityToken_3_0_0>;
-  let tokenFactoryMockStub: SinonStub<any, any>;
-  let getAttachedModulesMockStub: SinonStub<any, any>;
 
   beforeAll(() => {
-    // Mock the context, wrappers, and tokenFactory to test CreateEtherDividendDistribution
+    // Mock the context, wrappers, and tokenFactory to test EnableDividendManagers
     contextMock = ImportMock.mockClass(contextModule, 'Context');
     wrappersMock = ImportMock.mockClass(wrappersModule, 'PolymathBase');
     tokenFactoryMock = ImportMock.mockClass(tokenFactoryModule, 'MockedTokenFactoryObject');
     contextMock.set('contractWrappers', wrappersMock.getMockInstance());
     wrappersMock.set('tokenFactory', tokenFactoryMock.getMockInstance());
 
     securityTokenMock = ImportMock.mockClass(contractWrappersModule, 'SecurityToken_3_0_0');
-    securityTokenMock.mock('address', Promise.resolve(params1.address));
+    securityTokenMock.mock('address', Promise.resolve(params.storageWalletAddress));
 
     etherDividendsMock = ImportMock.mockClass(
       contractWrappersModule,
       'EtherDividendCheckpoint_3_0_0'
     );
-    getAttachedModulesMockStub = wrappersMock.mock(
-      'getModuleFactoryAddress',
-      Promise.resolve(params1.address)
-    );
-    tokenFactoryMockStub = tokenFactoryMock.mock(
+    wrappersMock.mock('getModuleFactoryAddress', Promise.resolve(params.storageWalletAddress));
+    tokenFactoryMock.mock(
       'getSecurityTokenInstanceFromTicker',
       securityTokenMock.getMockInstance()
     );
 
     // Instantiate EnableDividendManagers
-    target = new EnableDividendManagers(
-      {
-        symbol: params1.symbol,
-        storageWalletAddress: params1.address,
-      },
-      contextMock.getMockInstance()
-    );
+    target = new EnableDividendManagers(params, contextMock.getMockInstance());
   });
   afterEach(() => {
     restore();
@@ -75,7 +59,7 @@ describe('EnableDividendManagers', () => {
   });
 
   describe('EnableDividendManagers', () => {
-    test('should send the transaction to EnableDividendManagers', async () => {
+    test('should add a transaction to the queue to enable dividend managers', async () => {
       const addTransactionSpy = spy(target, 'addTransaction');
       // Real call
       await target.prepareTransactions();
@@ -102,14 +86,14 @@ describe('EnableDividendManagers', () => {
       tokenFactoryMock.set(
         'getSecurityTokenInstanceFromTicker',
         stub()
-          .withArgs({ address: params1.symbol })
+          .withArgs({ address: params.symbol })
           .throws()
       );
 
       expect(target.prepareTransactions()).rejects.toThrow(
         new PolymathError({
           code: ErrorCode.ProcedureValidationError,
-          message: `There is no Security Token with symbol ${params1.symbol}`,
+          message: `There is no Security Token with symbol ${params.symbol}`,
         })
       );
     });

src/procedures/__tests__/EnableGeneralPermissionManager.ts

@@ -1,5 +1,5 @@
 import { ImportMock, MockManager } from 'ts-mock-imports';
-import { SinonStub, stub, spy, restore } from 'sinon';
+import { stub, spy, restore } from 'sinon';
 import { BigNumber } from '@polymathnetwork/contract-wrappers';
 import * as contractWrappersModule from '@polymathnetwork/contract-wrappers';
 import * as contextModule from '../../Context';
@@ -10,13 +10,8 @@ import { Procedure } from '~/procedures/Procedure';
 import { PolymathError } from '~/PolymathError';
 import { ErrorCode, PolyTransactionTag } from '~/types';
 
-const params1 = {
+const params = {
   symbol: 'TEST1',
-  name: 'Test Token 1',
-  amount: new BigNumber(1),
-  checkpointIndex: 1,
-  maturityDate: new Date(2030, 1),
-  expiryDate: new Date(2031, 1),
   address: '0x4444444444444444444444444444444444444444',
 };
 
@@ -27,40 +22,30 @@ describe('EnableGeneralPermissionManager', () => {
   let tokenFactoryMock: MockManager<tokenFactoryModule.MockedTokenFactoryObject>;
   let etherDividendsMock: MockManager<contractWrappersModule.EtherDividendCheckpoint_3_0_0>;
   let securityTokenMock: MockManager<contractWrappersModule.SecurityToken_3_0_0>;
-  let tokenFactoryMockStub: SinonStub<any, any>;
-  let getAttachedModulesMockStub: SinonStub<any, any>;
 
   beforeAll(() => {
-    // Mock the context, wrappers, and tokenFactory to test CreateEtherDividendDistribution
+    // Mock the context, wrappers, and tokenFactory to test EnableGeneralPermissionManagers
     contextMock = ImportMock.mockClass(contextModule, 'Context');
     wrappersMock = ImportMock.mockClass(wrappersModule, 'PolymathBase');
     tokenFactoryMock = ImportMock.mockClass(tokenFactoryModule, 'MockedTokenFactoryObject');
     contextMock.set('contractWrappers', wrappersMock.getMockInstance());
     wrappersMock.set('tokenFactory', tokenFactoryMock.getMockInstance());
 
     securityTokenMock = ImportMock.mockClass(contractWrappersModule, 'SecurityToken_3_0_0');
-    securityTokenMock.mock('address', Promise.resolve(params1.address));
+    securityTokenMock.mock('address', Promise.resolve(params.address));
 
     etherDividendsMock = ImportMock.mockClass(
       contractWrappersModule,
       'EtherDividendCheckpoint_3_0_0'
     );
-    getAttachedModulesMockStub = wrappersMock.mock(
-      'getModuleFactoryAddress',
-      Promise.resolve(params1.address)
-    );
-    tokenFactoryMockStub = tokenFactoryMock.mock(
+    wrappersMock.mock('getModuleFactoryAddress', Promise.resolve(params.address));
+    tokenFactoryMock.mock(
       'getSecurityTokenInstanceFromTicker',
       securityTokenMock.getMockInstance()
     );
 
-    // Instantiate EnableGeneralPermissionManager
-    target = new EnableGeneralPermissionManager(
-      {
-        symbol: params1.symbol,
-      },
-      contextMock.getMockInstance()
-    );
+    // Instantiate EnableGeneralPermissionManagers
+    target = new EnableGeneralPermissionManager(params, contextMock.getMockInstance());
   });
   afterEach(() => {
     restore();
@@ -74,7 +59,7 @@ describe('EnableGeneralPermissionManager', () => {
   });
 
   describe('EnableGeneralPermissionManager', () => {
-    test('should send the transaction to EnableGeneralPermissionManager', async () => {
+    test('should add a transaction to the queue to enable general permission manager', async () => {
       const addTransactionSpy = spy(target, 'addTransaction');
       // Real call
       await target.prepareTransactions();
@@ -94,14 +79,14 @@ describe('EnableGeneralPermissionManager', () => {
       tokenFactoryMock.set(
         'getSecurityTokenInstanceFromTicker',
         stub()
-          .withArgs({ address: params1.symbol })
+          .withArgs({ address: params.symbol })
           .throws()
       );
 
       expect(target.prepareTransactions()).rejects.toThrow(
         new PolymathError({
           code: ErrorCode.ProcedureValidationError,
-          message: `There is no Security Token with symbol ${params1.symbol}`,
+          message: `There is no Security Token with symbol ${params.symbol}`,
         })
       );
     });