From 608442b2e80f64c1756e2c5125812c067e5ae1f3 Mon Sep 17 00:00:00 2001 From: fragosti Date: Thu, 5 Jul 2018 18:56:58 -0700 Subject: Add to changelog, rename to formatUtils and lint --- packages/utils/CHANGELOG.json | 4 ++ packages/utils/src/conversion.ts | 59 --------------------------- packages/utils/src/index.ts | 2 +- packages/web3-wrapper/src/marshaller.ts | 68 ++++++++++++++++--------------- packages/web3-wrapper/src/web3_wrapper.ts | 2 +- 5 files changed, 41 insertions(+), 94 deletions(-) delete mode 100644 packages/utils/src/conversion.ts diff --git a/packages/utils/CHANGELOG.json b/packages/utils/CHANGELOG.json index a27216be7..bea6a9566 100644 --- a/packages/utils/CHANGELOG.json +++ b/packages/utils/CHANGELOG.json @@ -12,6 +12,10 @@ { "note": "Fixes uncaught Error in abi_decoder", "pr": 763 + }, + { + "note": "Add formatUtils", + "pr": 829 } ] }, diff --git a/packages/utils/src/conversion.ts b/packages/utils/src/conversion.ts deleted file mode 100644 index f0eed9ee4..000000000 --- a/packages/utils/src/conversion.ts +++ /dev/null @@ -1,59 +0,0 @@ -import * as _ from 'lodash'; - -import { BigNumber } from './configured_bignumber'; - -export const conversion = { - isBigNumber(value: any): boolean { - const isBigNumber = _.isObject(value) && value.isBigNumber; - return isBigNumber; - }, - convertHexToNumber(value: string): number { - const valueBigNumber = new BigNumber(value); - const valueNumber = valueBigNumber.toNumber(); - return valueNumber; - }, - convertHexToNumberOrNull(hex: string | null): number | null { - if (_.isNull(hex)) { - return null; - } - const decimal = this.convertHexToNumber(hex); - return decimal; - }, - convertAmountToBigNumber(value: string | number | BigNumber): BigNumber { - const num = value || 0; - const isBigNumber = conversion.isBigNumber(num); - if (isBigNumber) { - return num as BigNumber; - } - - if (_.isString(num) && (num.indexOf('0x') === 0 || num.indexOf('-0x') === 0)) { - return new BigNumber(num.replace('0x', ''), 16); - } - - const baseTen = 10; - return new BigNumber((num as number).toString(baseTen), baseTen); - }, - encodeAmountAsHexString(value: string | number | BigNumber): string { - const valueBigNumber = conversion.convertAmountToBigNumber(value); - const hexBase = 16; - const valueHex = valueBigNumber.toString(hexBase); - - return valueBigNumber.lessThan(0) ? '-0x' + valueHex.substr(1) : '0x' + valueHex; - }, - numberToHex(value: number): string { - if (!isFinite(value) && !this.isHexStrict(value)) { - throw new Error(`Given input ${value} is not a number.`); - } - - const valueBigNumber = new BigNumber(value); - const hexBase = 16; - const result = valueBigNumber.toString(hexBase); - - return valueBigNumber.lt(0) ? '-0x' + result.substr(1) : '0x' + result; - }, - isHexStrict(hex: string | number): boolean { - return ( - (_.isString(hex) || _.isNumber(hex)) && /^(-)?0x[0-9a-f]*$/i.test(_.isNumber(hex) ? hex.toString() : hex) - ); - }, -}; diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts index de78f26df..cc8592400 100644 --- a/packages/utils/src/index.ts +++ b/packages/utils/src/index.ts @@ -8,4 +8,4 @@ export { logUtils } from './log_utils'; export { abiUtils } from './abi_utils'; export { NULL_BYTES } from './constants'; export { errorUtils } from './error_utils'; -export { conversion } from './conversion'; +export { formatUtils } from './format_utils'; diff --git a/packages/web3-wrapper/src/marshaller.ts b/packages/web3-wrapper/src/marshaller.ts index b4a1e2ce4..584f6252d 100644 --- a/packages/web3-wrapper/src/marshaller.ts +++ b/packages/web3-wrapper/src/marshaller.ts @@ -1,4 +1,4 @@ -import { addressUtils, conversion } from '@0xproject/utils'; +import { addressUtils, formatUtils } from '@0xproject/utils'; import { BlockParam, BlockParamLiteral, @@ -29,30 +29,30 @@ export const marshaller = { ): BlockWithoutTransactionData { const block = { ...blockWithHexValues, - gasLimit: conversion.convertHexToNumber(blockWithHexValues.gasLimit), - gasUsed: conversion.convertHexToNumber(blockWithHexValues.gasUsed), - size: conversion.convertHexToNumber(blockWithHexValues.size), - timestamp: conversion.convertHexToNumber(blockWithHexValues.timestamp), + gasLimit: formatUtils.convertHexToNumber(blockWithHexValues.gasLimit), + gasUsed: formatUtils.convertHexToNumber(blockWithHexValues.gasUsed), + size: formatUtils.convertHexToNumber(blockWithHexValues.size), + timestamp: formatUtils.convertHexToNumber(blockWithHexValues.timestamp), number: _.isNull(blockWithHexValues.number) ? null - : conversion.convertHexToNumber(blockWithHexValues.number), - difficulty: conversion.convertAmountToBigNumber(blockWithHexValues.difficulty), - totalDifficulty: conversion.convertAmountToBigNumber(blockWithHexValues.totalDifficulty), + : formatUtils.convertHexToNumber(blockWithHexValues.number), + difficulty: formatUtils.convertAmountToBigNumber(blockWithHexValues.difficulty), + totalDifficulty: formatUtils.convertAmountToBigNumber(blockWithHexValues.totalDifficulty), }; return block; }, unmarshalIntoBlockWithTransactionData(blockWithHexValues: BlockWithTransactionDataRPC): BlockWithTransactionData { const block = { ...blockWithHexValues, - gasLimit: conversion.convertHexToNumber(blockWithHexValues.gasLimit), - gasUsed: conversion.convertHexToNumber(blockWithHexValues.gasUsed), - size: conversion.convertHexToNumber(blockWithHexValues.size), - timestamp: conversion.convertHexToNumber(blockWithHexValues.timestamp), + gasLimit: formatUtils.convertHexToNumber(blockWithHexValues.gasLimit), + gasUsed: formatUtils.convertHexToNumber(blockWithHexValues.gasUsed), + size: formatUtils.convertHexToNumber(blockWithHexValues.size), + timestamp: formatUtils.convertHexToNumber(blockWithHexValues.timestamp), number: _.isNull(blockWithHexValues.number) ? null - : conversion.convertHexToNumber(blockWithHexValues.number), - difficulty: conversion.convertAmountToBigNumber(blockWithHexValues.difficulty), - totalDifficulty: conversion.convertAmountToBigNumber(blockWithHexValues.totalDifficulty), + : formatUtils.convertHexToNumber(blockWithHexValues.number), + difficulty: formatUtils.convertAmountToBigNumber(blockWithHexValues.difficulty), + totalDifficulty: formatUtils.convertAmountToBigNumber(blockWithHexValues.totalDifficulty), transactions: [] as Transaction[], }; block.transactions = _.map(blockWithHexValues.transactions, (tx: TransactionRPC) => { @@ -64,14 +64,14 @@ export const marshaller = { unmarshalTransaction(txRpc: TransactionRPC): Transaction { const tx = { ...txRpc, - blockNumber: !_.isNull(txRpc.blockNumber) ? conversion.convertHexToNumber(txRpc.blockNumber) : null, + blockNumber: !_.isNull(txRpc.blockNumber) ? formatUtils.convertHexToNumber(txRpc.blockNumber) : null, transactionIndex: !_.isNull(txRpc.transactionIndex) - ? conversion.convertHexToNumber(txRpc.transactionIndex) + ? formatUtils.convertHexToNumber(txRpc.transactionIndex) : null, - nonce: conversion.convertHexToNumber(txRpc.nonce), - gas: conversion.convertHexToNumber(txRpc.gas), - gasPrice: conversion.convertAmountToBigNumber(txRpc.gasPrice), - value: conversion.convertAmountToBigNumber(txRpc.value), + nonce: formatUtils.convertHexToNumber(txRpc.nonce), + gas: formatUtils.convertHexToNumber(txRpc.gas), + gasPrice: formatUtils.convertAmountToBigNumber(txRpc.gasPrice), + value: formatUtils.convertAmountToBigNumber(txRpc.value), }; return tx; }, @@ -81,12 +81,12 @@ export const marshaller = { } const txData = { ...txDataRpc, - value: !_.isUndefined(txDataRpc.value) ? conversion.convertHexToNumber(txDataRpc.value) : undefined, - gas: !_.isUndefined(txDataRpc.gas) ? conversion.convertHexToNumber(txDataRpc.gas) : undefined, + value: !_.isUndefined(txDataRpc.value) ? formatUtils.convertHexToNumber(txDataRpc.value) : undefined, + gas: !_.isUndefined(txDataRpc.gas) ? formatUtils.convertHexToNumber(txDataRpc.gas) : undefined, gasPrice: !_.isUndefined(txDataRpc.gasPrice) - ? conversion.convertHexToNumber(txDataRpc.gasPrice) + ? formatUtils.convertHexToNumber(txDataRpc.gasPrice) : undefined, - nonce: !_.isUndefined(txDataRpc.nonce) ? conversion.convertHexToNumber(txDataRpc.nonce) : undefined, + nonce: !_.isUndefined(txDataRpc.nonce) ? formatUtils.convertHexToNumber(txDataRpc.nonce) : undefined, }; return txData; }, @@ -133,15 +133,15 @@ export const marshaller = { if (_.isUndefined(blockParam)) { return BlockParamLiteral.Latest; } - const encodedBlockParam = _.isNumber(blockParam) ? conversion.numberToHex(blockParam) : blockParam; + const encodedBlockParam = _.isNumber(blockParam) ? formatUtils.numberToHex(blockParam) : blockParam; return encodedBlockParam; }, unmarshalLog(rawLog: RawLogEntry): LogEntry { const formattedLog = { ...rawLog, - logIndex: conversion.convertHexToNumberOrNull(rawLog.logIndex), - blockNumber: conversion.convertHexToNumberOrNull(rawLog.blockNumber), - transactionIndex: conversion.convertHexToNumberOrNull(rawLog.transactionIndex), + logIndex: formatUtils.convertHexToNumberOrNull(rawLog.logIndex), + blockNumber: formatUtils.convertHexToNumberOrNull(rawLog.blockNumber), + transactionIndex: formatUtils.convertHexToNumberOrNull(rawLog.transactionIndex), }; return formattedLog; }, @@ -151,14 +151,16 @@ export const marshaller = { to: _.isUndefined(callTxDataBase.to) ? undefined : this.marshalAddress(callTxDataBase.to), gasPrice: _.isUndefined(callTxDataBase.gasPrice) ? undefined - : conversion.encodeAmountAsHexString(callTxDataBase.gasPrice), - gas: _.isUndefined(callTxDataBase.gas) ? undefined : conversion.encodeAmountAsHexString(callTxDataBase.gas), + : formatUtils.encodeAmountAsHexString(callTxDataBase.gasPrice), + gas: _.isUndefined(callTxDataBase.gas) + ? undefined + : formatUtils.encodeAmountAsHexString(callTxDataBase.gas), value: _.isUndefined(callTxDataBase.value) ? undefined - : conversion.encodeAmountAsHexString(callTxDataBase.value), + : formatUtils.encodeAmountAsHexString(callTxDataBase.value), nonce: _.isUndefined(callTxDataBase.nonce) ? undefined - : conversion.encodeAmountAsHexString(callTxDataBase.nonce), + : formatUtils.encodeAmountAsHexString(callTxDataBase.nonce), }; return callTxDataBaseRPC; diff --git a/packages/web3-wrapper/src/web3_wrapper.ts b/packages/web3-wrapper/src/web3_wrapper.ts index f6f818279..57ad0a0db 100644 --- a/packages/web3-wrapper/src/web3_wrapper.ts +++ b/packages/web3-wrapper/src/web3_wrapper.ts @@ -1,6 +1,6 @@ import { assert } from '@0xproject/assert'; import { schemas } from '@0xproject/json-schemas'; -import { AbiDecoder, addressUtils, BigNumber, intervalUtils, promisify, conversion as utils } from '@0xproject/utils'; +import { AbiDecoder, addressUtils, BigNumber, formatUtils as utils, intervalUtils, promisify } from '@0xproject/utils'; import { BlockParam, BlockParamLiteral, -- cgit