Move defaults to purser-core/constants

JoinColony · Apr 23, 2020 · ffd6884 · ffd6884
1 parent 75f617a
commit ffd6884
Show file tree

Hide file tree

Showing 20 changed files with 51 additions and 237 deletions.
diff --git a/packages/defaults.ts b/packages/defaults.ts
diff --git a/packages/purser-core/__tests__/GenericWallet.test.ts b/packages/purser-core/__tests__/GenericWallet.test.ts
@@ -9,7 +9,7 @@ import {
   addressValidator,
 } from '../src/validators';
 import { addressNormalizer, hexSequenceNormalizer } from '../src/normalizers';
-import { CHAIN_IDS } from '../src/defaults';
+import { CHAIN_IDS } from '../src/constants';
 
 jest.mock('hdkey');
 jest.mock('ethers/utils');

diff --git a/packages/purser-core/__tests__/helpers/recoverPublicKey.test.ts b/packages/purser-core/__tests__/helpers/recoverPublicKey.test.ts
@@ -7,7 +7,7 @@ import {
   recoveryParamNormalizer,
 } from '../../src/normalizers';
 
-import { HEX_HASH_TYPE } from '../../src/defaults';
+import { HEX_HASH_TYPE } from '../../src/constants';
 
 jest.mock('ethereumjs-util');
 jest.mock('../../src/normalizers');

diff --git a/packages/purser-core/__tests__/helpers/transactionObjectValidator.test.ts b/packages/purser-core/__tests__/helpers/transactionObjectValidator.test.ts
@@ -8,7 +8,7 @@ import {
   hexSequenceValidator,
 } from '../../src/validators';
 import { bigNumber } from '../../src/utils';
-import { TRANSACTION } from '../../src/defaults';
+import { TRANSACTION } from '../../src/constants';
 
 jest.mock('../../src/validators');
 jest.mock('../../src/utils');
@@ -98,7 +98,7 @@ describe('`Core` Module', () => {
       expect(validatedTransactionObject).toHaveProperty('inputData');
     });
     test('Has defaults for all object values (except for `to`)', async () => {
-      mockedBigNumber.mockImplementation(number => number);
+      mockedBigNumber.mockImplementation((number) => number);
       const validatedTransactionObject = transactionObjectValidator();
       expect(validatedTransactionObject).toHaveProperty(
         'gasPrice',

diff --git a/packages/purser-core/__tests__/normalizers/recoveryParam.test.ts b/packages/purser-core/__tests__/normalizers/recoveryParam.test.ts
@@ -1,6 +1,6 @@
 import { recoveryParamNormalizer } from '../../src/normalizers';
 
-import { SIGNATURE } from '../../src/defaults';
+import { SIGNATURE } from '../../src/constants';
 
 describe('`Core` Module', () => {
   describe('`recoveryParamNormalizer()` normalizer', () => {

diff --git a/packages/purser-core/__tests__/utils/bigNumber.test.ts b/packages/purser-core/__tests__/utils/bigNumber.test.ts
@@ -1,7 +1,7 @@
 import BN from 'bn.js';
 
 import { bigNumber } from '../../src/utils';
-import * as defaults from '../../src/defaults';
+import * as constants from '../../src/constants';
 
 describe('`Core` Module', () => {
   describe('`bigNumber()` util', () => {
@@ -16,25 +16,21 @@ describe('`Core` Module', () => {
       expect(bigNumberInstance).toHaveProperty('fromGwei');
     });
     test('Correctly converts to WEI', () => {
-      const bigNumberWei = bigNumber(1)
-        .toWei()
-        .toString();
-      expect(bigNumberWei).toEqual(`${defaults.WEI_MINIFICATION}`);
+      const bigNumberWei = bigNumber(1).toWei().toString();
+      expect(bigNumberWei).toEqual(`${constants.WEI_MINIFICATION}`);
     });
     test('Correctly converts from WEI', () => {
-      const bigNumberValue = bigNumber(`${defaults.WEI_MINIFICATION}`)
+      const bigNumberValue = bigNumber(`${constants.WEI_MINIFICATION}`)
         .fromWei()
         .toString();
       expect(bigNumberValue).toEqual(`1`);
     });
     test('Correctly converts to GWEI', () => {
-      const bigNumberGwei = bigNumber(1)
-        .toGwei()
-        .toString();
-      expect(bigNumberGwei).toEqual(`${defaults.GWEI_MINIFICATION}`);
+      const bigNumberGwei = bigNumber(1).toGwei().toString();
+      expect(bigNumberGwei).toEqual(`${constants.GWEI_MINIFICATION}`);
     });
     test('Correctly converts from GWEI', () => {
-      const bigNumberValue = bigNumber(`${defaults.GWEI_MINIFICATION}`)
+      const bigNumberValue = bigNumber(`${constants.GWEI_MINIFICATION}`)
         .fromGwei()
         .toString();
       expect(bigNumberValue).toEqual(`1`);

diff --git a/packages/purser-core/__tests__/utils/verbose.test.ts b/packages/purser-core/__tests__/utils/verbose.test.ts
@@ -1,5 +1,5 @@
 import { verbose } from '../../src/utils';
-import * as defaults from '../../src/defaults';
+import * as constants from '../../src/constants';
 
 // @ts-ignore
 global.console = {
@@ -10,35 +10,35 @@ global.console = {
 describe('`Core` Module', () => {
   describe('`verbose()` util', () => {
     test('Should be verbose if the environment is not defined', () => {
-      const env = defaults.ENV;
+      const env = constants.ENV;
       // @ts-ignore
-      defaults.ENV = undefined;
+      constants.ENV = undefined;
       const isVerbose = verbose();
       expect(isVerbose).toBeTruthy();
       // @ts-ignore
-      defaults.ENV = env;
+      constants.ENV = env;
     });
     test("Should be verbose if we're in a development environment", () => {
-      const env = defaults.ENV;
+      const env = constants.ENV;
       // @ts-ignore
-      defaults.ENV = 'development';
+      constants.ENV = 'development';
       const isVerbose = verbose();
       expect(isVerbose).toBeTruthy();
       // @ts-ignore
-      defaults.ENV = env;
+      constants.ENV = env;
     });
     test("Should NOT be verbose if we're not in `development` env", () => {
-      const env = defaults.ENV;
+      const env = constants.ENV;
       // @ts-ignore
-      defaults.ENV = 'production';
+      constants.ENV = 'production';
       let isVerbose = verbose();
       expect(isVerbose).not.toBeTruthy();
       // @ts-ignore
-      defaults.ENV = 'testing';
+      constants.ENV = 'testing';
       isVerbose = verbose();
       expect(isVerbose).not.toBeTruthy();
       // @ts-ignore
-      defaults.ENV = env;
+      constants.ENV = env;
     });
   });
 });
diff --git a/packages/purser-core/__tests__/utils/warning.test.ts b/packages/purser-core/__tests__/utils/warning.test.ts
@@ -1,7 +1,7 @@
 import { jestMocked } from '../../../testutils';
 
 import { warning } from '../../src/utils';
-import * as defaults from '../../src/defaults';
+import * as constants from '../../src/constants';
 
 // @ts-ignore
 global.console = {
@@ -18,7 +18,7 @@ describe('`Core` Module', () => {
   describe('`warning()` util', () => {
     beforeEach(() => {
       // @ts-ignore
-      defaults.ENV = 'development';
+      constants.ENV = 'development';
     });
     afterEach(() => {
       mockWarn.mockClear();
@@ -30,7 +30,7 @@ describe('`Core` Module', () => {
     });
     test("Doesn't log a message when in production", () => {
       // @ts-ignore
-      defaults.ENV = 'production';
+      constants.ENV = 'production';
       warning(message);
       expect(console.warn).not.toHaveBeenCalled();
       expect(console.error).not.toHaveBeenCalled();
@@ -61,7 +61,7 @@ describe('`Core` Module', () => {
     });
     test("Doesn't log a message when in production", () => {
       // @ts-ignore
-      defaults.ENV = 'production';
+      constants.ENV = 'production';
       warning(message);
       expect(console.warn).not.toHaveBeenCalled();
     });

diff --git a/packages/purser-core/src/ExtendedBigNumber.ts b/packages/purser-core/src/ExtendedBigNumber.ts
@@ -1,6 +1,6 @@
 import BN from 'bn.js';
 
-import { WEI_MINIFICATION, GWEI_MINIFICATION } from './defaults';
+import { WEI_MINIFICATION, GWEI_MINIFICATION } from './constants';
 
 const oneWei = new BN(WEI_MINIFICATION.toString());
 const oneGwei = new BN(GWEI_MINIFICATION.toString());

diff --git a/packages/purser-core/src/GenericWallet.ts b/packages/purser-core/src/GenericWallet.ts
@@ -9,7 +9,7 @@ import {
 import { addressNormalizer, hexSequenceNormalizer } from './normalizers';
 
 import { genericClass as messages } from './messages';
-import { HEX_HASH_TYPE, SPLITTER, CHAIN_IDS } from './defaults';
+import { HEX_HASH_TYPE, SPLITTER, CHAIN_IDS } from './constants';
 import {
   AddressObject,
   WalletType,

diff --git a/packages/purser-core/src/defaults.ts → packages/purser-core/src/constants.ts b/packages/purser-core/src/defaults.ts → packages/purser-core/src/constants.ts
@@ -1,5 +1,3 @@
-
-
 import { DerivationPathDefaultType } from './types';
 
 /*
@@ -55,21 +53,21 @@ export const MATCH = {
 /*
  * Used to separate misc. derivation paths or urls
  */
-export const SPLITTER: string = '/';
+export const SPLITTER = '/';
 
 /*
  * Used to better inform the user when a variable doesn't have a value
  * (Used in Error messsages)
  */
-export const UNDEFINED: string = 'undefined';
+export const UNDEFINED = 'undefined';
 
 /*
  * Hash types
  */
 export const HEX_HASH_TYPE: BufferEncoding = 'hex';
 
-export const WEI_MINIFICATION: number = 1e18;
-export const GWEI_MINIFICATION: number = 1e9;
+export const WEI_MINIFICATION = 1e18;
+export const GWEI_MINIFICATION = 1e9;
 
 /*
  * Default class descriptors.
@@ -98,7 +96,7 @@ export const DESCRIPTORS = {
 /*
  * Defaults for the transaction object
  */
-export const TRANSACTION  = {
+export const TRANSACTION = {
   CHAIN_ID: 1,
   GAS_PRICE: '9000000000', // 9 Gwei
   GAS_LIMIT: '21000',
@@ -117,7 +115,7 @@ export const SIGNATURE = {
   RECOVERY_EVEN: 28,
 };
 
-export const HTTPS_PROTOCOL: string = 'https:';
+export const HTTPS_PROTOCOL = 'https:';
 
 /*
  * Chain IDs