fix: 🐛 implement ErrorCode type for GPM

Author: shuffledex

src/contract_wrappers/modules/permission_manager/general_permission_manager_wrapper.ts

@@ -20,6 +20,7 @@ import {
   GetLogs,
   Subscribe,
   Perm,
+  ErrorCode,
 } from '../../../types';
 import {
   numberToBigNumber,
@@ -160,10 +161,18 @@ export default class GeneralPermissionManagerWrapper extends ModuleWrapper {
   };
 
   public addDelegate = async (params: AddDelegateParams) => {
-    assert.assert(await this.isCallerAllowed(params.txData, Perm.Admin), 'Caller is not allowed');
+    assert.assert(
+      await this.isCallerAllowed(params.txData, Perm.Admin),
+      ErrorCode.Unauthorized,
+      '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)), 'Delegate already present');
+    assert.assert(params.details.length > 0, ErrorCode.InvalidData, '0 value not allowed');
+    assert.assert(
+      !(await (await this.contract).checkDelegate.callAsync(params.delegate)),
+      ErrorCode.PreconditionRequired,
+      'Delegate already present',
+    );
     return (await this.contract).addDelegate.sendTransactionAsync(
       params.delegate,
       stringToBytes32(params.details),
@@ -173,9 +182,17 @@ export default class GeneralPermissionManagerWrapper extends ModuleWrapper {
   };
 
   public deleteDelegate = async (params: DelegateTxParams) => {
-    assert.assert(await this.isCallerAllowed(params.txData, Perm.Admin), 'Caller is not allowed');
+    assert.assert(
+      await this.isCallerAllowed(params.txData, Perm.Admin),
+      ErrorCode.Unauthorized,
+      'Caller is not allowed',
+    );
     assert.isNonZeroETHAddressHex('delegate', params.delegate);
-    assert.assert(await (await this.contract).checkDelegate.callAsync(params.delegate), 'Delegate does not exist');
+    assert.assert(
+      await (await this.contract).checkDelegate.callAsync(params.delegate),
+      ErrorCode.InvalidDelegate,
+      'Delegate does not exist',
+    );
     return (await this.contract).deleteDelegate.sendTransactionAsync(
       params.delegate,
       params.txData,
@@ -189,7 +206,11 @@ export default class GeneralPermissionManagerWrapper extends ModuleWrapper {
   };
 
   public changePermission = async (params: ChangePermissionParams) => {
-    assert.assert(await this.isCallerAllowed(params.txData, Perm.Admin), 'Caller is not allowed');
+    assert.assert(
+      await this.isCallerAllowed(params.txData, Perm.Admin),
+      ErrorCode.Unauthorized,
+      'Caller is not allowed',
+    );
     assert.isNonZeroETHAddressHex('delegate', params.delegate);
     assert.isETHAddressHex('module', params.module);
     return (await this.contract).changePermission.sendTransactionAsync(
@@ -203,12 +224,24 @@ export default class GeneralPermissionManagerWrapper extends ModuleWrapper {
   };
 
   public changePermissionMulti = async (params: ChangePermissionMultiParams) => {
-    assert.assert(await this.isCallerAllowed(params.txData, Perm.Admin), 'Caller is not allowed');
+    assert.assert(
+      await this.isCallerAllowed(params.txData, Perm.Admin),
+      ErrorCode.Unauthorized,
+      'Caller is not allowed',
+    );
     assert.isNonZeroETHAddressHex('delegate', params.delegate);
     params.modules.forEach(address => assert.isETHAddressHex('modules', address));
-    assert.assert(params.modules.length > 0, '0 length is not allowed');
-    assert.assert(params.modules.length === params.perms.length, 'Array length mismatch');
-    assert.assert(params.valids.length === params.perms.length, 'Array length mismatch');
+    assert.assert(params.modules.length > 0, ErrorCode.InvalidData, '0 length is not allowed');
+    assert.assert(
+      params.modules.length === params.perms.length,
+      ErrorCode.MismatchedArrayLength,
+      'Array length mismatch',
+    );
+    assert.assert(
+      params.valids.length === params.perms.length,
+      ErrorCode.MismatchedArrayLength,
+      'Array length mismatch',
+    );
     return (await this.contract).changePermissionMulti.sendTransactionAsync(
       params.delegate,
       params.modules,

src/types.ts

@@ -356,4 +356,5 @@ export enum ErrorCode {
   InvalidCheckpoint = 'InvalidCheckpoint',
   InvalidLenghtLimit = 'InvalidLenghtLimit',
   InvalidBound = 'InvalidBound',
+  InvalidDelegate = 'InvalidDelegate',
 }