fix: gpm typos and refactoring to improve simplicity

Author: Victor Wiebe

examples/generalPermissionManager.ts

@@ -4,7 +4,7 @@ import { GeneralPermissionManagerEvents } from '@polymathnetwork/abi-wrappers';
 import ModuleFactoryWrapper from '../src/contract_wrappers/modules/module_factory_wrapper';
 import { ApiConstructorParams, PolymathAPI } from '../src/PolymathAPI';
 import { bytes32ToString } from '../src/utils/convert';
-import { ModuleName, ModuleType } from '../src';
+import { ModuleName, ModuleType, Perm } from '../src';
 
 // This file acts as a valid sandbox for adding a permission manager  module on an unlocked node (like ganache)
 
@@ -132,14 +132,22 @@ window.addEventListener('load', async () => {
   }))[0];
 
   // Get all delegates
-  await generalPM.changePermission({ valid: true, perm: 'ADMIN', delegate: myAddress, module: generalTMAddress });
+  const permissionChanged = await generalPM.changePermission({
+    valid: true,
+    perm: Perm.Admin,
+    delegate: myAddress,
+    module: generalTMAddress,
+  });
 
   // Check  delegate
-  console.log('Delegate is added:');
+  console.log('Permission changed:');
+  console.log(permissionChanged);
+
   console.log(await generalPM.checkDelegate({ delegate: myAddress }));
   console.log('Delegate has flags perm added on general transfer manager:');
-  console.log(await generalPM.checkPermission({ delegate: myAddress, module: generalTMAddress, permission: 'FLAGS' }));
-
+  console.log(
+    await generalPM.checkPermission({ delegate: myAddress, module: generalTMAddress, permission: Perm.Admin }),
+  );
 
   // Change allow all whitelist transfers: I_GeneralTransferManager.modifyTransferRequirementsMulti(
   //                 [0, 1, 2],
@@ -153,19 +161,29 @@ window.addEventListener('load', async () => {
     name: ModuleName.GeneralTransferManager,
     address: generalTMAddress,
   });
+  /*
   await generalTM.changeAllowAllWhitelistTransfers({ allowAllWhitelistTransfers: true });
-
+*/
   // Revoking Permission
-  await generalPM.changePermission({ valid: false, perm: 'ADMIN', delegate: myAddress, module: generalTMAddress });
+  const permissionResult = await generalPM.changePermission({
+    valid: false,
+    perm: Perm.Admin,
+    delegate: myAddress,
+    module: generalTMAddress,
+  });
 
-  console.log('Delegate perm has been revoked. Check permission result: ');
-  console.log(await generalPM.checkPermission({ delegate: myAddress, module: generalTMAddress, permission: 'FLAGS' }));
+  console.log('Delegate perm has been revoked. Check permission result:');
+  console.log(permissionResult);
+  console.log(
+    await generalPM.checkPermission({ delegate: myAddress, module: generalTMAddress, permission: Perm.Admin }),
+  );
 
   // Removing Delegate
-  await generalPM.deleteDelegate({ delegate: myAddress });
+  const deleteDelegateResult = await generalPM.deleteDelegate({ delegate: myAddress });
 
   // Check delegate
   console.log('Delegate is removed. Check delegate result:');
+  console.log(deleteDelegateResult);
   console.log(await generalPM.checkDelegate({ delegate: myAddress }));
 
   generalPM.unsubscribeAll();

src/contract_wrappers/modules/permission_manager/general_permission_manager_wrapper.ts

@@ -107,7 +107,7 @@ interface ChangePermissionMultiParams extends TxParams {
 }
 
 // // Return types ////
-interface PermissonsPerModule {
+interface PermissionsPerModule {
   /** Module address */
   module: string;
   /** List of permissions */
@@ -235,15 +235,15 @@ export default class GeneralPermissionManagerWrapper extends ModuleWrapper {
     const groupedResult = _.groupBy(zippedResult, value => {
       return value[0];
     }); // [module1: [[module1, perm1], [module1, perm2]], ...]
-    const typedResult: PermissonsPerModule[] = [];
+    const typedResult: PermissionsPerModule[] = [];
     _.forEach(
       groupedResult,
       (value, key): void => {
-        const permissonsPerModule: PermissonsPerModule = {
+        const permissionsPerModule: PermissionsPerModule = {
           module: key,
           permissions: value.map(pair => parsePermBytes32Value(pair[1] as string)),
         };
-        typedResult.push(permissonsPerModule);
+        typedResult.push(permissionsPerModule);
       },
     );
     return typedResult;

src/utils/convert.ts

@@ -96,11 +96,11 @@ export function parsePartitionBytes32Value(value: string): Partition {
 }
 export function parsePermBytes32Value(value: string): Perm {
   switch (bytes32ToString(value)) {
-    case 'ADMIN':
+    case Perm.Admin:
       return Perm.Admin;
-    case 'OPERATOR':
+    case Perm.Operator:
       return Perm.Operator;
     default:
-      throw new Error('Partition not recognized');
+      throw new Error('Permission not recognized');
   }
 }