fix: 🐛 improve error type definitions and error messages

Author: shuffledex

src/contract_wrappers/modules/permission_manager/general_permission_manager_wrapper.ts

@@ -190,7 +190,7 @@ export default class GeneralPermissionManagerWrapper extends ModuleWrapper {
     assert.isNonZeroETHAddressHex('delegate', params.delegate);
     assert.assert(
       await (await this.contract).checkDelegate.callAsync(params.delegate),
-      ErrorCode.InvalidDelegate,
+      ErrorCode.NotFound,
       'Delegate does not exist',
     );
     return (await this.contract).deleteDelegate.sendTransactionAsync(

src/contract_wrappers/modules/sto/usd_tiered_sto_wrapper.ts

@@ -770,7 +770,7 @@ export default class USDTieredSTOWrapper extends STOWrapper {
       ErrorCode.Unauthorized,
       'The caller must be the ST owner',
     );
-    assert.assert(!(await this.isFinalized()), ErrorCode.PreconditionRequired, 'STO is finalized');
+    assert.assert(!(await this.isFinalized()), ErrorCode.PreconditionRequired, 'STO is already finalized');
     // we can't execute mint to validate the method
     return (await this.contract).finalize.sendTransactionAsync(params.txData, params.safetyFactor);
   };
@@ -906,7 +906,7 @@ export default class USDTieredSTOWrapper extends STOWrapper {
       'The caller must be the ST owner',
     );
     assert.isFutureDate(bigNumberToDate(await this.startTime()), 'STO already started');
-    assert.assert(params.tokensPerTierTotal.length > 0, ErrorCode.MismatchedArrayLength, 'No tiers provided');
+    assert.assert(params.tokensPerTierTotal.length > 0, ErrorCode.InvalidData, 'No tiers provided');
     assert.assert(
       params.ratePerTier.length === params.tokensPerTierTotal.length &&
         params.ratePerTierDiscountPoly.length === params.tokensPerTierTotal.length &&
@@ -1052,7 +1052,7 @@ export default class USDTieredSTOWrapper extends STOWrapper {
       assert.assert(
         functionsUtils.checksumAddressComparision(beneficiary, from),
         ErrorCode.Unauthorized,
-        'Beneficiary != funder',
+        'Beneficiary address must be the same as sender',
       );
     }
     const rate = await this.getRate({
@@ -1065,8 +1065,8 @@ export default class USDTieredSTOWrapper extends STOWrapper {
     const minimumInvestmentUSD = await this.minimumInvestmentUSD();
     assert.assert(
       investedUSD.plus(investorInvestedUSD).isGreaterThan(minimumInvestmentUSD),
-      ErrorCode.InsufficientBalance,
-      'Investment < min',
+      ErrorCode.PreconditionRequired,
+      'Investment amount must be greater than the minimum investment amount',
     );
 
     const generalTMAddress = await (await this.securityTokenContract()).getModulesByName.callAsync(
@@ -1089,7 +1089,11 @@ export default class USDTieredSTOWrapper extends STOWrapper {
         !nonAccreditedLimit || nonAccreditedLimit.isEqualTo(BIG_NUMBER_ZERO)
           ? await this.nonAccreditedLimitUSD()
           : nonAccreditedLimit;
-      assert.assert(investorInvestedUSD.isLessThan(nonAccreditedLimitUSD), ErrorCode.ErrorLimit, 'Over investor limit');
+      assert.assert(
+        investorInvestedUSD.isLessThan(nonAccreditedLimitUSD),
+        ErrorCode.PreconditionRequired,
+        'Over investor limit',
+      );
     }
   };
 }

src/contract_wrappers/modules/transfer_manager/blacklist_transfer_manager_wrapper.ts

@@ -820,7 +820,7 @@ export default class BlacklistTransferManagerWrapper extends ModuleWrapper {
     const blacklistInfo = await this.blacklists({ blacklistName: params.blacklistName });
     assert.assert(
       dateToBigNumber(blacklistInfo.endTime).isZero(),
-      ErrorCode.BacklistAlreadyExist,
+      ErrorCode.AlreadyExists,
       'Blacklist you are trying to add already exists',
     );
     await this.checkBlacklistTypeDetails(params);
@@ -840,7 +840,7 @@ export default class BlacklistTransferManagerWrapper extends ModuleWrapper {
       const blacklistDays = (params.endTime.getTime() - params.startTime.getTime()) / (1000 * 60 * 60 * 24);
       assert.assert(
         blacklistDays <= params.repeatPeriodTime,
-        ErrorCode.TooEarly,
+        ErrorCode.InvalidData,
         'The repeat period time in days must be greater than or equal to the difference between start and end time',
       );
     }
@@ -869,7 +869,7 @@ export default class BlacklistTransferManagerWrapper extends ModuleWrapper {
     const currentBlacklistNames = await this.getBlacklistNamesToUser({ user: params.userAddress });
     assert.assert(
       !currentBlacklistNames.includes(params.blacklistName),
-      ErrorCode.AlreadyAdded,
+      ErrorCode.AlreadyExists,
       'User already added to this blacklist name',
     );
   };

src/contract_wrappers/modules/transfer_manager/general_transfer_manager_wrapper.ts

@@ -555,7 +555,7 @@ export default class GeneralTransferManagerWrapper extends ModuleWrapper {
     assert.isFutureDate(params.validTo, 'ValidTo date must be in the future');
     assert.assert(
       !(await this.nonceMap({ address: params.investor, nonce: params.nonce })),
-      ErrorCode.AlreadyAdded,
+      ErrorCode.AlreadyExists,
       'Already used signature of investor address and nonce',
     );
     return (await this.contract).modifyKYCDataSigned.sendTransactionAsync(

src/types.ts

@@ -356,14 +356,12 @@ export enum ErrorCode {
   InvalidCheckpoint = 'InvalidCheckpoint',
   ArrayTooLarge = 'ArrayTooLarge',
   InvalidBound = 'InvalidBound',
-  InvalidDelegate = 'InvalidDelegate',
   InsufficientAllowance = 'InsufficientAllowance',
   DifferentMode = 'DifferentMode',
   InvalidTransfer = 'InvalidTransfer',
   InvalidDiscount = 'InvalidDiscount',
   STOClosed = 'STOClosed',
   CoinNotAllowed = 'CoinNotAllowed',
-  ErrorLimit = 'ErrorLimit',
-  BacklistAlreadyExist = 'BacklistAlreadyExist',
-  AlreadyAdded = 'AlreadyAdded',
+  AlreadyExists = 'AlreadyExists',
+  NotFound = 'NotFound',
 }