feat: 🎸 blacklists method and test

Author: Victor Wiebe

src/contract_wrappers/modules/transfer_manager/__tests__/blacklist_transfer_manager_wrapper.test.ts

@@ -264,6 +264,46 @@ describe('BlacklistTransferManagerWrapper', () => {
     });
   });
 
+  describe('blacklists', () => {
+    test.todo('should fail as blacklists name is an empty string');
+
+    test('should call to blacklists', async () => {
+      const startTime = new Date(2030, 1);
+      const expectedStartTime = dateToBigNumber(startTime);
+      const endTime = new Date(2031, 1);
+      const expectedEndTime = dateToBigNumber(endTime);
+      const expectedRepeatPeriodTime = new BigNumber(3600);
+      const expectedResult = [
+        expectedStartTime,
+        expectedEndTime,
+        expectedRepeatPeriodTime,
+      ];
+      const mockedParams = {
+        blacklistName: 'Blacklist',
+      };
+
+      // Mocked method
+      const mockedMethod = mock(MockedCallMethod);
+      // Stub the method
+      when(mockedContract.blacklists).thenReturn(instance(mockedMethod));
+      // Stub the request
+      when(mockedMethod.callAsync(objectContaining(stringToBytes32(mockedParams.blacklistName)))).thenResolve(
+          expectedResult,
+      );
+
+      // Real call
+      const result = await target.blacklists(mockedParams);
+      // Result expectation
+      expect(result.startTime).toEqual(startTime);
+      expect(result.endTime).toEqual(endTime);
+      expect(result.repeatPeriodTime).toBe(expectedResult[2]);
+
+      // Verifications
+      verify(mockedContract.blacklists).once();
+      verify(mockedMethod.callAsync(objectContaining(stringToBytes32(mockedParams.blacklistName)))).once();
+    });
+  });
+
   describe('getListOfAddresses', () => {
     test.todo('should fail as blacklist name is an empty string');
 

src/contract_wrappers/modules/transfer_manager/blacklist_transfer_manager_wrapper.ts

@@ -159,6 +159,11 @@ interface VerifyTransfer {
   address: string;
 }
 
+interface BlacklistsDetails {
+  startTime: Date;
+  endTime: Date;
+  repeatPeriodTime: BigNumber;
+}
 /**
  * This class includes the functionality related to interacting with the Blacklist Transfer Manager contract.
  */
@@ -198,6 +203,19 @@ export default class BlacklistTransferManagerWrapper extends ModuleWrapper {
     return (await this.contract).pause.sendTransactionAsync(params.txData, params.safetyFactor);
   };
 
+  /**
+   * Return the blacklists
+   */
+  public blacklists = async (params: BlacklistParams): Promise<BlacklistsDetails> => {
+    assert.assert(params.blacklistName.length > 0, 'LockUp Details must not be an empty string');
+    const result = await (await this.contract).blacklists.callAsync(stringToBytes32(params.blacklistName));
+    return {
+      startTime: bigNumberToDate(result[0]),
+      endTime: bigNumberToDate(result[1]),
+      repeatPeriodTime: result[2],
+    };
+  };
+
   /**
    * getListOfAddresses
    */