fix: make GPM conform with Perm Enum

in each case where perm was still string, we used enum. added a parsing method to the convert file for return types

Author: Victor Wiebe

src/contract_wrappers/modules/permission_manager/__tests__/general_permission_manager_wrapper.test.ts

@@ -16,6 +16,7 @@ import {
   numberToBigNumber,
 } from '../../../../utils/convert';
 import { MockedCallMethod, MockedSendMethod, getMockedPolyResponse } from '../../../../test_utils/mocked_methods';
+import { Perm } from '../../../../types';
 
 describe('GeneralPermissionManagerWrapper', () => {
   // Declare GeneralPermissionManagerWrapper object
@@ -62,7 +63,7 @@ describe('GeneralPermissionManagerWrapper', () => {
       const params = {
         module: '0x1111111111111111111111111111111111111111',
         delegate: '0x2222222222222222222222222222222222222222',
-        permission: 'Permission1',
+        permission: Perm.Admin,
       };
       // Mocked method
       const mockedMethod = mock(MockedCallMethod);
@@ -143,7 +144,7 @@ describe('GeneralPermissionManagerWrapper', () => {
       const params = {
         module: '0x1111111111111111111111111111111111111111',
         delegate: '0x2222222222222222222222222222222222222222',
-        permission: 'Permission1',
+        permission: Perm.Admin,
       };
       // Mocked method
       const mockedMethod = mock(MockedCallMethod);
@@ -197,7 +198,7 @@ describe('GeneralPermissionManagerWrapper', () => {
       const expectedResult = ['string1', 'string2'];
       const params = {
         module: '0x2222222222222222222222222222222222222222',
-        perm: 'Perm1',
+        perm: Perm.Admin,
       };
       // Mocked method
       const mockedMethod = mock(MockedCallMethod);
@@ -246,7 +247,7 @@ describe('GeneralPermissionManagerWrapper', () => {
         '0x2222222222222222222222222222222222222222',
         '0x3333333333333333333333333333333333333333',
       ];
-      const perms = stringArrayToBytes32Array(['Perm1', 'Perm2', 'Perm3']);
+      const perms = stringArrayToBytes32Array(['ADMIN', 'OPERATOR', 'OPERATOR']);
       const expectedResult = [modules, perms];
       const params = {
         delegate: '0x2222222222222222222222222222222222222222',
@@ -449,7 +450,7 @@ describe('GeneralPermissionManagerWrapper', () => {
       const mockedParams = {
         delegate: '0x1111111111111111111111111111111111111111',
         module: '0x1111111111111111111111111111111111111111',
-        perm: 'string',
+        perm: Perm.Admin,
         valid: false,
         txData: {},
         safetyFactor: 10,
@@ -523,7 +524,7 @@ describe('GeneralPermissionManagerWrapper', () => {
       when(mockedWrapper.getAvailableAddressesAsync()).thenResolve([expectedOwnerResult]);
 
       // Mocked parameters
-      const mockedPerms = ['string', 'string2'];
+      const mockedPerms = [Perm.Admin, Perm.Operator];
       const mockedParams = {
         delegate: '0x1111111111111111111111111111111111111111',
         modules: ['0x1111111111111111111111111111111111111111', '0x2222222222222222222222222222222222222222'],
@@ -587,7 +588,9 @@ describe('GeneralPermissionManagerWrapper', () => {
 
       // Real call
       await expect(target.subscribeAsync(mockedParams)).rejects.toEqual(
-        new Error(`Expected eventName to be one of: 'ChangePermission', 'AddDelegate', 'Pause', 'Unpause', encountered: Transfer`),
+        new Error(
+          `Expected eventName to be one of: 'ChangePermission', 'AddDelegate', 'Pause', 'Unpause', encountered: Transfer`,
+        ),
       );
     });
   });

src/contract_wrappers/modules/permission_manager/general_permission_manager_wrapper.ts

@@ -22,7 +22,12 @@ import {
   Subscribe,
   Perm,
 } from '../../../types';
-import { numberToBigNumber, stringToBytes32, bytes32ToString, stringArrayToBytes32Array } from '../../../utils/convert';
+import {
+  numberToBigNumber,
+  stringToBytes32,
+  stringArrayToBytes32Array,
+  parsePermBytes32Value,
+} from '../../../utils/convert';
 
 interface ChangePermissionSubscribeAsyncParams extends SubscribeAsyncParams {
   eventName: GeneralPermissionManagerEvents.ChangePermission;
@@ -57,7 +62,7 @@ interface GetGeneralPermissionManagerLogsAsyncParams extends GetLogs {
 interface PermParams {
   module: string;
   delegate: string;
-  permission: string;
+  permission: Perm;
 }
 
 interface DelegateIndexParams {
@@ -70,7 +75,7 @@ interface DelegateParams {
 
 interface GetAllDelegatesWithPermParams {
   module: string;
-  perm: string;
+  perm: Perm;
 }
 
 interface GetAllModulesAndPermsFromTypesParams {
@@ -90,14 +95,14 @@ interface AddDelegateParams extends TxParams {
 interface ChangePermissionParams extends TxParams {
   delegate: string;
   module: string;
-  perm: string;
+  perm: Perm;
   valid: boolean;
 }
 
 interface ChangePermissionMultiParams extends TxParams {
   delegate: string;
   modules: string[];
-  perms: string[];
+  perms: Perm[];
   valids: boolean[];
 }
 
@@ -106,7 +111,7 @@ interface PermissonsPerModule {
   /** Module address */
   module: string;
   /** List of permissions */
-  permissions: string[];
+  permissions: Perm[];
 }
 // // End of return types ////
 
@@ -161,7 +166,7 @@ export default class GeneralPermissionManagerWrapper extends ModuleWrapper {
     assert.assert(await this.isCallerAllowed(params.txData, Perm.Admin), 'Caller is not allowed');
     assert.isNonZeroETHAddressHex('delegate', params.delegate);
     assert.assert(params.details.length > 0, '0 value not allowed');
-    assert.assert(!await (await this.contract).checkDelegate.callAsync(params.delegate), 'Already present');
+    assert.assert(!(await (await this.contract).checkDelegate.callAsync(params.delegate)), 'Already present');
     return (await this.contract).addDelegate.sendTransactionAsync(
       params.delegate,
       stringToBytes32(params.details),
@@ -236,7 +241,7 @@ export default class GeneralPermissionManagerWrapper extends ModuleWrapper {
       (value, key): void => {
         const permissonsPerModule: PermissonsPerModule = {
           module: key,
-          permissions: value.map(pair => bytes32ToString(pair[1] as string)),
+          permissions: value.map(pair => parsePermBytes32Value(pair[1] as string)),
         };
         typedResult.push(permissonsPerModule);
       },

src/utils/convert.ts

@@ -1,6 +1,6 @@
 import { ethers } from 'ethers';
 import { BigNumber } from '@0x/utils';
-import { Partition } from '../types';
+import { Partition, Perm } from '../types';
 
 const BASE = new BigNumber(10);
 
@@ -94,3 +94,13 @@ export function parsePartitionBytes32Value(value: string): Partition {
       throw new Error('Partition not recognized');
   }
 }
+export function parsePermBytes32Value(value: string): Perm {
+  switch (bytes32ToString(value)) {
+    case 'ADMIN':
+      return Perm.Admin;
+    case 'OPERATOR':
+      return Perm.Operator;
+    default:
+      throw new Error('Partition not recognized');
+  }
+}