feat: add getFactoryDetails with associated test and prettier formatting

Author: Victor Wiebe

src/contract_wrappers/registries/__tests__/module_registry_wrapper.test.ts

@@ -77,7 +77,6 @@ describe('ModuleRegistryWrapper', () => {
     });
   });
 
-
   describe('RegisterModule', () => {
     test.todo('should fail as moduleFactory is not an Eth address');
 
@@ -307,11 +306,7 @@ describe('ModuleRegistryWrapper', () => {
       when(mockedContract.verifyModule).thenReturn(instance(mockedMethod));
       // Stub the request
       when(
-          mockedMethod.sendTransactionAsync(
-              mockedParams.moduleFactory,
-              mockedParams.txData,
-              mockedParams.safetyFactor,
-          ),
+        mockedMethod.sendTransactionAsync(mockedParams.moduleFactory, mockedParams.txData, mockedParams.safetyFactor),
       ).thenResolve(expectedResult);
 
       // Real call
@@ -322,11 +317,7 @@ describe('ModuleRegistryWrapper', () => {
       // Verifications
       verify(mockedContract.verifyModule).once();
       verify(
-          mockedMethod.sendTransactionAsync(
-              mockedParams.moduleFactory,
-              mockedParams.txData,
-              mockedParams.safetyFactor,
-          ),
+        mockedMethod.sendTransactionAsync(mockedParams.moduleFactory, mockedParams.txData, mockedParams.safetyFactor),
       ).once();
       verify(mockedContract.getModulesByType).times(5);
 
@@ -384,11 +375,7 @@ describe('ModuleRegistryWrapper', () => {
       when(mockedContract.unverifyModule).thenReturn(instance(mockedMethod));
       // Stub the request
       when(
-          mockedMethod.sendTransactionAsync(
-              mockedParams.moduleFactory,
-              mockedParams.txData,
-              mockedParams.safetyFactor,
-          ),
+        mockedMethod.sendTransactionAsync(mockedParams.moduleFactory, mockedParams.txData, mockedParams.safetyFactor),
       ).thenResolve(expectedResult);
 
       // Real call
@@ -399,11 +386,7 @@ describe('ModuleRegistryWrapper', () => {
       // Verifications
       verify(mockedContract.unverifyModule).once();
       verify(
-          mockedMethod.sendTransactionAsync(
-              mockedParams.moduleFactory,
-              mockedParams.txData,
-              mockedParams.safetyFactor,
-          ),
+        mockedMethod.sendTransactionAsync(mockedParams.moduleFactory, mockedParams.txData, mockedParams.safetyFactor),
       ).once();
       verify(mockedContract.getModulesByType).times(5);
 
@@ -675,6 +658,37 @@ describe('ModuleRegistryWrapper', () => {
     });
   });
 
+  describe('GetFactoryDetails', () => {
+    test('should call to getFactoryDetails', async () => {
+      // Address expected
+      const factoryIsVerified = true;
+      const factoryOwnerAddress = '0x1111111111111111111111111111111111111111';
+      const listSecurityTokens = [
+        '0x4444444444444444444444444444444444444444',
+        '0x2222222222222222222222222222222222222222',
+      ];
+      const expectedResult = [factoryIsVerified, factoryOwnerAddress, listSecurityTokens];
+      const params = {
+        factoryAddress: '0x5555555555555555555555555555555555555555',
+      };
+      // Mocked method
+      const mockedMethod = mock(MockedCallMethod);
+      // Stub the method
+      when(mockedContract.getFactoryDetails).thenReturn(instance(mockedMethod));
+      // Stub the request
+      when(mockedMethod.callAsync(params.factoryAddress)).thenResolve(expectedResult);
+      // Real call
+      const result = await target.getFactoryDetails(params);
+      // Result expectation
+      expect(result.factoryIsVerified).toBe(factoryIsVerified);
+      expect(result.factoryOwnerAddress).toBe(factoryOwnerAddress);
+      expect(result.listSecurityTokens).toBe(listSecurityTokens);
+      // Verifications
+      verify(mockedContract.getFactoryDetails).once();
+      verify(mockedMethod.callAsync(params.factoryAddress)).once();
+    });
+  });
+
   describe('ReclaimERC20', () => {
     test.todo('should fail as tokenContract is not an Eth address');
 

src/contract_wrappers/registries/module_registry_wrapper.ts

@@ -131,14 +131,6 @@ interface GetModuleRegistryLogsAsyncParams extends GetLogs {
   >;
 }
 
-interface GetValueByVariableParams {
-  variable: string;
-}
-
-interface GetValueByKeyParams {
-  key: string;
-}
-
 interface ModuleFactoryParams extends TxParams {
   moduleFactory: string;
 }
@@ -161,6 +153,10 @@ interface IsCompatibleModuleParams {
   securityToken: string;
 }
 
+interface GetFactoryDetailsParams {
+  factoryAddress: string;
+}
+
 interface ReclaimERC20Params extends TxParams {
   tokenContract: string;
 }
@@ -174,6 +170,12 @@ interface TagsByModule {
   module: string;
   tags: string[];
 }
+
+interface FactoryDetails {
+  factoryIsVerified: boolean;
+  factoryOwnerAddress: string;
+  listSecurityTokens: string[];
+}
 // // End of return types ////
 
 /**
@@ -336,6 +338,19 @@ export default class ModuleRegistryWrapper extends ContractWrapper {
     return typedResult;
   };
 
+  /**
+   * @returns Returns factoryIsVerified, factoryOwnerAddress, listSecurityTokens
+   */
+  public getFactoryDetails = async (params: GetFactoryDetailsParams) => {
+    const result = await (await this.contract).getFactoryDetails.callAsync(params.factoryAddress);
+    const typedResult: FactoryDetails = {
+      factoryIsVerified: result[0],
+      factoryOwnerAddress: result[1],
+      listSecurityTokens: result[2],
+    };
+    return typedResult;
+  };
+
   public getModulesByType = async (params: ModuleTypeParams) => {
     return (await this.contract).getModulesByType.callAsync(params.moduleType);
   };