fix: 🐛 improve throw error with PolymathError class

Author: shuffledex

src/PolymathAPI.ts

@@ -39,6 +39,8 @@ import ERC20 from './contract_wrappers/tokens/erc20_wrapper';
 import assert from './utils/assert';
 import PolyTokenFaucetWrapper from './contract_wrappers/tokens/poly_token_faucet_wrapper';
 import ContractFactory from './factories/contractFactory';
+import { ErrorCode } from './types';
+import { PolymathError } from './PolymathError';
 
 /**
  * @param provider The web3 provider
@@ -213,7 +215,7 @@ export class PolymathAPI {
   public getPolyTokens = async (params: GetTokensParams): Promise<PolyResponse> => {
     const networkId = await this.web3Wrapper.getNetworkIdAsync();
     if (networkId === 1) {
-      throw new Error('Only for testnet');
+      throw new PolymathError({ message: 'Only for testnet', code: ErrorCode.PreconditionRequired });
     }
     const address = params.address !== undefined ? params.address : await this.getAccount();
     assert.isETHAddressHex('address', address);

src/contract_wrappers/contract_wrapper.ts

@@ -26,12 +26,11 @@ import {
   EventCallback,
   GetLogs,
   Subscribe,
+  ErrorCode,
 } from '../types';
+import { PolymathError } from '../PolymathError';
 import assert from '../utils/assert';
 
-const SUBSCRIPTION_NOT_FOUND = 'SUBSCRIPTION_NOT_FOUND';
-const SUBSCRIPTION_ALREADY_PRESENT = 'SUBSCRIPTION_ALREADY_PRESENT';
-
 export default abstract class ContractWrapper {
   protected contract: Promise<BaseContract>;
 
@@ -106,7 +105,7 @@ export default abstract class ContractWrapper {
 
   protected unsubscribeInternal(filterToken: string, err?: Error): void {
     if (_.isUndefined(this._filters[filterToken])) {
-      throw new Error(SUBSCRIPTION_NOT_FOUND);
+      throw new PolymathError({ code: ErrorCode.NotFound });
     }
     if (!_.isUndefined(err)) {
       const callback = this._filterCallbacks[filterToken];
@@ -181,7 +180,7 @@ export default abstract class ContractWrapper {
 
   private _startBlockAndLogStream(isVerbose: boolean): void {
     if (!_.isUndefined(this._blockAndLogStreamerIfExists)) {
-      throw new Error(SUBSCRIPTION_ALREADY_PRESENT);
+      throw new PolymathError({ code: ErrorCode.AlreadyExists });
     }
     this._blockAndLogStreamerIfExists = new BlockAndLogStreamer(
       this._blockstreamGetBlockOrNullAsync.bind(this),
@@ -227,7 +226,7 @@ export default abstract class ContractWrapper {
 
   private _stopBlockAndLogStream(): void {
     if (_.isUndefined(this._blockAndLogStreamerIfExists)) {
-      throw new Error(SUBSCRIPTION_NOT_FOUND);
+      throw new PolymathError({ code: ErrorCode.NotFound });
     }
     this._blockAndLogStreamerIfExists.unsubscribeFromOnLogAdded(this._onLogAddedSubscriptionToken as string);
     this._blockAndLogStreamerIfExists.unsubscribeFromOnLogRemoved(this._onLogRemovedSubscriptionToken as string);

src/factories/moduleWrapperFactory.ts

@@ -15,7 +15,8 @@ import ModuleFactoryWrapper from '../contract_wrappers/modules/module_factory_wr
 import VestingEscrowWalletWrapper from '../contract_wrappers/modules/wallet/vesting_escrow_wallet_wrapper';
 import ContractFactory from './contractFactory';
 import assert from '../utils/assert';
-import { ModuleName } from '../types';
+import { ModuleName, ErrorCode } from '../types';
+import { PolymathError } from '../PolymathError';
 
 interface GetModuleParams {
   address: string;
@@ -198,7 +199,7 @@ export default class ModuleWrapperFactory {
       // Burn
       default:
         // TODO: Typed error here
-        throw new Error();
+        throw new PolymathError({ code: ErrorCode.NotFound });
     }
   };
 }

src/factories/tokenWrapperFactory.ts

@@ -5,6 +5,8 @@ import ERC20TokenWrapper from '../contract_wrappers/tokens/erc20_wrapper';
 import ERC20DetailedTokenWrapper from '../contract_wrappers/tokens/erc20_detailed_wrapper';
 import ContractFactory from './contractFactory';
 import assert from '../utils/assert';
+import { ErrorCode } from '../types';
+import { PolymathError } from '../PolymathError';
 
 /**
  * The SecurityTokenFactory class is a factory to generate new SecurityTokenWrappers.
@@ -48,9 +50,7 @@ export default class TokenWrapperFactory {
     if (await token.isValidContract()) {
       return token;
     }
-
-    // TODO: Replace this for a typed Error
-    throw new Error();
+    throw new PolymathError({ code: ErrorCode.NotFound });
   };
 
   /**
@@ -67,8 +67,7 @@ export default class TokenWrapperFactory {
         this.contractFactory,
       );
     }
-    // TODO: Replace this for a typed Error
-    throw new Error();
+    throw new PolymathError({ code: ErrorCode.NotFound });
   };
 
   /**

src/types.ts

@@ -366,4 +366,5 @@ export enum ErrorCode {
   NotFound = 'NotFound',
   MismatchedLength = 'MismatchedLength',
   TickerExpired = 'TickerExpired',
+  UnknownNetwork = 'UnknownNetwork',
 }

src/utils/addresses.ts

@@ -1,5 +1,6 @@
 import _ from 'lodash';
-import { NetworkId } from '../types';
+import { NetworkId, ErrorCode } from '../types';
+import { PolymathError } from '../PolymathError';
 
 const networkToAddresses: { [networkId: number]: string } = {
   1: '0xdfabf3e4793cd30affb47ab6fa4cf4eef26bbc27',
@@ -9,10 +10,10 @@ const networkToAddresses: { [networkId: number]: string } = {
 
 function getContractAddressesForNetworkOrThrow(networkId: NetworkId): string {
   if (_.isUndefined(networkToAddresses[networkId])) {
-    throw new Error(
-      `Unknown network id (${networkId}).
-      No known Polymath contracts have been deployed on this network.`,
-    );
+    throw new PolymathError({
+      message: `Unknown network id (${networkId}). No known Polymath contracts have been deployed on this network.`,
+      code: ErrorCode.UnknownNetwork,
+    });
   }
   return networkToAddresses[networkId];
 }
@@ -23,11 +24,12 @@ function getContractAddressesForNetworkOrThrow(networkId: NetworkId): string {
  */
 export default function getDefaultContractAddresses(networkId: NetworkId): string {
   if (!(networkId in NetworkId)) {
-    throw new Error(
-      `No default contract addresses found for the given network id (${networkId}).
-      If you want to use ContractWrappers on this network,
-      you must manually pass in the contract address(es) to the constructor.`,
-    );
+    throw new PolymathError({
+      message: `No default contract addresses found for the given network id (${networkId}).
+    If you want to use ContractWrappers on this network,
+    you must manually pass in the contract address(es) to the constructor.`,
+      code: ErrorCode.NotFound,
+    });
   }
   return getContractAddressesForNetworkOrThrow(networkId);
 }

src/utils/convert.ts

@@ -1,5 +1,6 @@
 import { ethers, BigNumber } from '@polymathnetwork/abi-wrappers';
-import { ModuleType, Partition, Perm, TransferResult } from '../types';
+import { ModuleType, Partition, Perm, TransferResult, ErrorCode } from '../types';
+import { PolymathError } from '../PolymathError';
 
 const BASE = new BigNumber(10);
 
@@ -88,7 +89,7 @@ export function parsePartitionBytes32Value(value: string): Partition {
     case '0':
       return Partition.Undefined;
     default:
-      throw new Error('Partition not recognized');
+      throw new PolymathError({ message: 'Partition not recognized', code: ErrorCode.NotFound });
   }
 }
 export function parsePermBytes32Value(value: string): Perm {
@@ -98,7 +99,7 @@ export function parsePermBytes32Value(value: string): Perm {
     case Perm.Operator:
       return Perm.Operator;
     default:
-      throw new Error('Permission not recognized');
+      throw new PolymathError({ message: 'Partition not recognized', code: ErrorCode.NotFound });
   }
 }
 export function parseModuleTypeValue(value: BigNumber): ModuleType {
@@ -114,7 +115,7 @@ export function parseModuleTypeValue(value: BigNumber): ModuleType {
     case ModuleType.Burn:
       return ModuleType.Burn;
     default:
-      throw new Error('Module Type not recognized');
+      throw new PolymathError({ message: 'Module Type not recognized', code: ErrorCode.NotFound });
   }
 }
 export function parseTransferResult(value: BigNumber): TransferResult {