Bignumbers in providers (#169)

* Changes of getBalance for Ethereum and ERC20 provider and singleChain tests

* Bitcoin balance is now returned as a bignumber

* Added chai bignumber extension

* Fixed typo in EthereumProvider unit tests

* Updated package lock for Travis

package.json

@@ -83,6 +83,7 @@
     "babel-plugin-istanbul": "^5.1.1",
     "babel-plugin-lodash": "^3.3.4",
     "chai-as-promised": "^7.1.1",
+    "chai-bignumber": "^3.0.0",
     "copy": "^0.3.2",
     "coveralls": "^3.0.2",
     "cross-env": "^5.2.0",

src/Client.js

@@ -1,5 +1,6 @@
 import { find, findLast, findLastIndex, isArray, isBoolean, isFunction, isNumber, isString } from 'lodash'
 import Ajv from 'ajv'
+import { BigNumber } from 'bignumber.js'
 
 import { Block, Transaction } from './schema'
 import { sha256 } from './crypto'
@@ -274,7 +275,7 @@ export default class Client {
 
     const balance = await this.getMethod('getBalance')(addresses)
 
-    if (!isNumber(balance)) {
+    if (!BigNumber.isBigNumber(balance)) {
       throw new InvalidProviderResponseError('Provider returned an invalid response')
     }
 

src/providers/bitcoin/BitcoinRPCProvider.js

@@ -65,7 +65,7 @@ export default class BitcoinRPCProvider extends JsonRpcProvider {
 
     const _utxos = await this.getUnspentTransactionsForAddresses(addresses)
     const utxos = _.flatten(_utxos)
-    return utxos.reduce((acc, utxo) => acc + utxo.satoshis, 0)
+    return utxos.map(balance => new BigNumber(balance.satoshis)).reduce((acc, utxo) => acc.plus(utxo), new BigNumber(0))
   }
 
   async getListUnspent (addresses) {

src/providers/ethereum/EthereumERC20Provider.js

@@ -1,6 +1,7 @@
 import Provider from '../../Provider'
 import { padHexStart } from '../../crypto'
 import { ensureAddressStandardFormat, ensureHexEthFormat } from './EthereumUtil'
+import { BigNumber } from 'bignumber.js'
 
 export default class EthereumERC20Provider extends Provider {
   constructor (contractAddress) {
@@ -9,6 +10,7 @@ export default class EthereumERC20Provider extends Provider {
   }
 
   generateErc20Transfer (to, value) {
+    // function transfer(address to, uint tokens) public returns (bool success)
     const functionSignature = 'a9059cbb'
     const encodedAddress = padHexStart(ensureAddressStandardFormat(to), 64)
     const encodedValue = padHexStart(value.toString(16), 64)
@@ -25,12 +27,13 @@ export default class EthereumERC20Provider extends Provider {
   }
 
   async getBalance (addresses) {
+    // function balanceOf(address tokenOwner)
     const functionSignature = '0x70a08231'
     addresses = addresses
       .map(address => String(address))
     const addrs = addresses.map(ensureHexEthFormat)
     const promiseBalances = await Promise.all(addrs.map(address => this.getMethod('jsonrpc')('eth_call', { data: functionSignature + padHexStart(ensureAddressStandardFormat(address), 64), to: ensureHexEthFormat(this._contractAddress) }, 'latest')))
-    return promiseBalances.map(balance => parseInt(balance, 16))
-      .reduce((acc, balance) => acc + balance, 0)
+    return promiseBalances.map(balance => new BigNumber(balance, 16))
+      .reduce((acc, balance) => acc.plus(balance), new BigNumber(0))
   }
 }

src/providers/ethereum/EthereumERC20SwapProvider.js

@@ -2,6 +2,7 @@ import Provider from '../../Provider'
 import { padHexStart } from '../../crypto'
 import { sleep } from '../../GlobalUtils'
 import { ensureAddressStandardFormat } from './EthereumUtil'
+import { BigNumber } from 'bignumber.js'
 
 export default class EthereumERC20SwapProvider extends Provider {
   createSwapScript (recipientAddress, refundAddress, secretHash, expiration) {
@@ -66,7 +67,7 @@ export default class EthereumERC20SwapProvider extends Provider {
 
   async doesBalanceMatchValue (contractAddress, value) {
     const balance = await this.getMethod('getBalance')([contractAddress])
-    return balance === value
+    return balance.isEqualTo(new BigNumber(value))
   }
 
   async verifyInitiateSwapTransaction (initiationTxHash, value, recipientAddress, refundAddress, secretHash, expiration) {

src/providers/ethereum/EthereumRPCProvider.js

@@ -97,8 +97,8 @@ export default class EthereumRPCProvider extends JsonRpcProvider {
 
     const addrs = addresses.map(ensureHexEthFormat)
     const promiseBalances = await Promise.all(addrs.map(address => this.jsonrpc('eth_getBalance', address, 'latest')))
-    return promiseBalances.map(balance => parseInt(balance, 16))
-      .reduce((acc, balance) => acc + balance, 0)
+    return promiseBalances.map(balance => new BigNumber(balance, 16))
+      .reduce((acc, balance) => acc.plus(balance), new BigNumber(0))
   }
 
   async isAddressUsed (address) {

test/integration/swap/singleChain.js

@@ -11,6 +11,7 @@ import config from './config'
 process.env['NODE_TLS_REJECT_UNAUTHORIZED'] = 0
 
 chai.use(chaiAsPromised)
+chai.use(require('chai-bignumber')())
 
 const { calculateFee } = providers.bitcoin.BitcoinUtil
 const mockSecret = _.repeat('ff', 32)
@@ -31,7 +32,7 @@ function testSingle (chain) {
     let claimTx
     await expectBalance(chain, swapParams.recipientAddress,
       async () => { claimTx = await claimAndVerify(chain, initiationTxId, secret, swapParams) },
-      (before, after) => expect(after).to.be.greaterThan(before))
+      (before, after) => expect(after).to.be.bignumber.greaterThan(before))
     const revealedSecret = claimTx.secret
     expect(revealedSecret).to.equal(secret)
   })
@@ -75,7 +76,7 @@ function testSingle (chain) {
         await sleep(20000)
         await refund(chain, initiationTxId, secretHash, swapParams)
       },
-      (before, after) => expect(after).to.be.greaterThan(before))
+      (before, after) => expect(after).to.be.bignumber.greaterThan(before))
   })
 
   it('Refund fails after claim', async () => {
@@ -85,18 +86,18 @@ function testSingle (chain) {
     const initiationTxId = await initiateAndVerify(chain, secretHash, swapParams)
     await expectBalance(chain, swapParams.recipientAddress,
       async () => claimAndVerify(chain, initiationTxId, mockSecret, swapParams),
-      (before, after) => expect(after).to.be.greaterThan(before))
+      (before, after) => expect(after).to.be.bignumber.greaterThan(before))
     await expectBalance(chain, swapParams.refundAddress,
       async () => {
         try { await refund(chain, initiationTxId, secretHash, swapParams) } catch (e) {} // Refund failing is ok
       },
-      (before, after) => expect(after).to.be.equal(before))
+      (before, after) => expect(after).to.be.bignumber.equal(before))
     await sleep(20000)
     await expectBalance(chain, swapParams.refundAddress,
       async () => {
         try { await refund(chain, initiationTxId, secretHash, swapParams) } catch (e) {} // Refund failing is ok
       },
-      (before, after) => expect(after).to.be.equal(before))
+      (before, after) => expect(after).to.be.bignumber.equal(before))
   })
 
   it('Refund available after expiration', async () => {
@@ -118,8 +119,8 @@ function testEthereumBalance (chain) {
     await expectBalance(chain, swapParams.recipientAddress,
       async () => { await claimAndVerify(chain, initiationTxId, mockSecret, swapParams) },
       (before, after) => {
-        const expectedBalance = BigNumber(before).plus(BigNumber(swapParams.value)).toNumber()
-        expect(after).to.be.equal(expectedBalance)
+        const expectedBalance = BigNumber(before).plus(BigNumber(swapParams.value))
+        expect(after.toString()).to.be.bignumber.equal(expectedBalance)
       })
   })
 
@@ -132,8 +133,8 @@ function testEthereumBalance (chain) {
     await expectBalance(chain, swapParams.refundAddress,
       async () => refund(chain, initiationTxId, secretHash, swapParams),
       (before, after) => {
-        const expectedBalance = BigNumber(before).plus(BigNumber(swapParams.value)).toNumber()
-        expect(after).to.be.equal(expectedBalance)
+        const expectedBalance = BigNumber(before).plus(BigNumber(swapParams.value))
+        expect(after).to.be.bignumber.equal(expectedBalance)
       })
   })
 }
@@ -147,8 +148,8 @@ function testBitcoinBalance (chain) {
     await expectBalance(chain, swapParams.recipientAddress,
       async () => { await claimAndVerify(chain, initiationTxId, mockSecret, swapParams) },
       (before, after) => {
-        const expectedBalance = BigNumber(before).plus(BigNumber(swapParams.value)).minus(BigNumber(fee)).toNumber()
-        expect(after).to.be.equal(expectedBalance)
+        const expectedBalance = BigNumber(before).plus(BigNumber(swapParams.value)).minus(BigNumber(fee))
+        expect(after).to.be.bignumber.equal(expectedBalance)
       })
   })
 
@@ -162,8 +163,8 @@ function testBitcoinBalance (chain) {
     await expectBalance(chain, swapParams.refundAddress,
       async () => refund(chain, initiationTxId, secretHash, swapParams),
       (before, after) => {
-        const expectedBalance = BigNumber(before).plus(BigNumber(swapParams.value)).minus(BigNumber(fee)).toNumber()
-        expect(after).to.be.equal(expectedBalance)
+        const expectedBalance = BigNumber(before).plus(BigNumber(swapParams.value)).minus(BigNumber(fee))
+        expect(after).to.be.bignumber.equal(expectedBalance)
       })
   })
 }

test/unit/providers/bitcoin/BitcoinRPCProvider.test.js

@@ -1,11 +1,13 @@
 /* eslint-env mocha */
-require('chai').config.truncateThreshold = 0
-const { expect } = require('chai')
+import BigNumber from 'bignumber.js'
+import chai, { expect } from 'chai'
 
 const { Client, providers: { bitcoin: { BitcoinRPCProvider } } } = require('../../../../src')
 const mockJsonRpc = require('../../../mock/mockJsonRpc')
 const bitcoinRpc = require('../../../mock/bitcoin/rpc')
 
+chai.config.truncateThreshold = 0
+
 describe('Bitcoin RPC provider', () => {
   let client
   let provider
@@ -123,7 +125,7 @@ describe('Bitcoin RPC provider', () => {
   describe('getBalance', () => {
     it('should return correct balance in sats', async () => {
       const balance = await provider.getBalance(['mpJJQJzJhjceFabMVXAMB8i4VJcwwWQmcc'])
-      expect(balance).to.equal(20000000)
+      expect(balance).to.be.bignumber.equal(new BigNumber(20000000))
     })
   })
 

test/unit/providers/ethereum/EthereumRPCProvider.test.js

@@ -1,12 +1,16 @@
 /* eslint-env mocha */
 
-require('chai').config.truncateThreshold = 0
-const { expect } = require('chai')
+import BigNumber from 'bignumber.js'
+import chai, { expect } from 'chai'
+
+chai.config.truncateThreshold = 0
 
 const { Client, providers: { ethereum: { EthereumRPCProvider } } } = require('../../../../src')
 const mockJsonRpc = require('../../../mock/mockJsonRpc')
 const ethereumRpc = require('../../../mock/ethereum/rpc')
 
+chai.use(require('chai-bignumber')())
+
 describe('Ethereum RPC provider', () => {
   let client
   let provider
@@ -127,8 +131,8 @@ describe('Ethereum RPC provider', () => {
     it('should return correct balance', async () => {
       const balance = await client.getBalance([ '322d4959c911520645c0638204b42ce0689236e9' ])
       expect(balance)
-        .to
-        .equal(99995379999999890000)
+        .to.be.bignumber
+        .equal(new BigNumber(99995379999999890000))
     })
   })