Merge pull request #11 from republicprotocol/type-fix

bn.js and Web3 typings fix

package.json

@@ -26,7 +26,7 @@
     "build:dev": "cross-env NODE_ENV=development webpack --mode development --display-error-details --progress --color",
     "build:prod": "npm run clean && cross-env NODE_ENV=production webpack --mode production --progress --color",
     "prepare": "# npm run lint && npm run build:dev",
-    "test": "source .env; ./node_modules/ts-mocha/bin/ts-mocha --timeout 60000 --paths -p ./tsconfig.json ./test/*.spec.ts ./test/**/*.spec.ts",
+    "test": "source .env; ./node_modules/ts-mocha/bin/ts-mocha --timeout 180000 --paths -p ./tsconfig.json ./test/*.spec.ts ./test/**/*.spec.ts",
     "clean": "rm -rf dist"
   },
   "devDependencies": {
@@ -35,6 +35,7 @@
     "@types/chai-as-promised": "7.1.0",
     "@types/expect": "^1.20.3",
     "@types/mocha": "^5.2.5",
+    "@types/web3": "^1.0.12",
     "awesome-typescript-loader": "5.2.1",
     "babel-loader": "8.0.2",
     "babel-plugin-transform-es2015-modules-simple-commonjs": "^0.3.0",
@@ -61,6 +62,7 @@
     "webpack-node-externals": "1.7.2"
   },
   "dependencies": {
+    "@types/bn.js": "^4.11.3",
     "@types/bs58": "3.0.30",
     "@types/detect-node": "^2.0.0",
     "@types/node-fetch": "2.1.2",
@@ -78,7 +80,7 @@
     "node-persist": "^3.0.1",
     "node-rsa": "1.0.1",
     "truffle-contract": "4.0.0-next.0",
-    "web3": "1.0.0-beta.35",
+    "web3": "1.0.0-beta.36",
     "web3-provider-engine": "^14.1.0"
   }
 }

src/contracts/bindings/darknode_registry.ts

@@ -1,11 +1,13 @@
 // tslint:disable
 
-import { BN } from "bn.js";
-import { Log, PromiEvent, Provider, TransactionReceipt, Tx } from "web3/types";
+import { Tx } from "web3/eth/types";
+import { Provider } from "web3/providers";
+import PromiEvent from "web3/promiEvent";
+import { TransactionReceipt, EventLog } from "web3/types";
 
-export interface Transaction { receipt: TransactionReceipt; tx: string; logs: Log[]; }
+interface Transaction { receipt: TransactionReceipt; tx: string; logs: EventLog[]; }
 
-type BigNumber = string | number | BN;
+type BigNumber = string;
 
 export interface DarknodeRegistryContract {
     numDarknodesNextEpoch(options?: Tx): Promise<BigNumber>;

src/contracts/bindings/erc20.ts

@@ -1,11 +1,13 @@
 // tslint:disable
 
-import { BN } from "bn.js";
-import { Log, PromiEvent, Provider, TransactionReceipt, Tx } from "web3/types";
+import { Tx } from "web3/eth/types";
+import { Provider } from "web3/providers";
+import PromiEvent from "web3/promiEvent";
+import { TransactionReceipt, EventLog } from "web3/types";
 
-export interface Transaction { receipt: TransactionReceipt; tx: string; logs: Log[]; }
+interface Transaction { receipt: TransactionReceipt; tx: string; logs: EventLog[]; }
 
-type BigNumber = string | number | BN;
+type BigNumber = string;
 
 export interface ERC20Contract {
     totalSupply(options?: Tx): Promise<BigNumber>;

src/contracts/bindings/orderbook.ts

@@ -1,11 +1,13 @@
 // tslint:disable
 
-import { BN } from "bn.js";
-import { Log, PromiEvent, Provider, TransactionReceipt, Tx } from "web3/types";
+import { Tx } from "web3/eth/types";
+import { Provider } from "web3/providers";
+import PromiEvent from "web3/promiEvent";
+import { TransactionReceipt, EventLog } from "web3/types";
 
-export interface Transaction { receipt: TransactionReceipt; tx: string; logs: Log[]; }
+interface Transaction { receipt: TransactionReceipt; tx: string; logs: EventLog[]; }
 
-type BigNumber = string | number | BN;
+type BigNumber = string;
 
 export interface OrderbookContract {
     renounceOwnership(options?: Tx): PromiEvent<Transaction>;

src/contracts/bindings/ren_ex_balances.ts

@@ -1,11 +1,13 @@
 // tslint:disable
 
-import { BN } from "bn.js";
-import { Log, PromiEvent, Provider, TransactionReceipt, Tx } from "web3/types";
+import { Tx } from "web3/eth/types";
+import { Provider } from "web3/providers";
+import PromiEvent from "web3/promiEvent";
+import { TransactionReceipt, EventLog } from "web3/types";
 
-export interface Transaction { receipt: TransactionReceipt; tx: string; logs: Log[]; }
+interface Transaction { receipt: TransactionReceipt; tx: string; logs: EventLog[]; }
 
-type BigNumber = string | number | BN;
+type BigNumber = string;
 
 export interface RenExBalancesContract {
     brokerVerifierContract(options?: Tx): Promise<string>;

src/contracts/bindings/ren_ex_settlement.ts

@@ -1,11 +1,13 @@
 // tslint:disable
 
-import { BN } from "bn.js";
-import { Log, PromiEvent, Provider, TransactionReceipt, Tx } from "web3/types";
+import { Tx } from "web3/eth/types";
+import { Provider } from "web3/providers";
+import PromiEvent from "web3/promiEvent";
+import { TransactionReceipt, EventLog } from "web3/types";
 
-export interface Transaction { receipt: TransactionReceipt; tx: string; logs: Log[]; }
+interface Transaction { receipt: TransactionReceipt; tx: string; logs: EventLog[]; }
 
-type BigNumber = string | number | BN;
+type BigNumber = string;
 
 export interface RenExSettlementContract {
     orderStatus(index_0: string, options?: Tx): Promise<BigNumber>;

src/contracts/bindings/ren_ex_tokens.ts

@@ -1,11 +1,13 @@
 // tslint:disable
 
-import { BN } from "bn.js";
-import { Log, PromiEvent, Provider, TransactionReceipt, Tx } from "web3/types";
+import { Tx } from "web3/eth/types";
+import { Provider } from "web3/providers";
+import PromiEvent from "web3/promiEvent";
+import { TransactionReceipt, EventLog } from "web3/types";
 
-export interface Transaction { receipt: TransactionReceipt; tx: string; logs: Log[]; }
+interface Transaction { receipt: TransactionReceipt; tx: string; logs: EventLog[]; }
 
-type BigNumber = string | number | BN;
+type BigNumber = string;
 
 export interface RenExTokensContract {
     renounceOwnership(options?: Tx): PromiEvent<Transaction>;

src/contracts/bindings/wyre.ts

@@ -1,11 +1,13 @@
 // tslint:disable
 
-import { BN } from "bn.js";
-import { Log, PromiEvent, TransactionReceipt, Tx, Provider } from "web3/types";
+import { Tx } from "web3/eth/types";
+import { Provider } from "web3/providers";
+import PromiEvent from "web3/promiEvent";
+import { TransactionReceipt, EventLog } from "web3/types";
 
-export interface Transaction { receipt: TransactionReceipt; tx: string; logs: Log[]; }
+interface Transaction { receipt: TransactionReceipt; tx: string; logs: EventLog[]; }
 
-type BigNumber = string | number | BN;
+type BigNumber = string;
 
 export interface WyreContract {
     approve(_to: string, _tokenId: BigNumber, options?: Tx): PromiEvent<Transaction>;

src/contracts/contracts.ts

@@ -1,6 +1,6 @@
 const contract = require("./truffle-contract/index.js");
 
-import { Provider } from "web3/types";
+import { Provider } from "web3/providers";
 
 // Bindings
 import { DarknodeRegistryArtifact } from "./bindings/darknode_registry";

src/declarations/bignumber.d.ts

@@ -1,5 +1,5 @@
 import * as BigNumberLib from "bignumber.js";
-import { BN } from "bn.js";
+import BN from "bn.js";
 
 /**
  * The existing typings does not let you convert BN into BigNumber.

src/index.ts

@@ -1,9 +1,10 @@
 import BigNumber from "bignumber.js";
 import Web3 from "web3";
 
-import { BN } from "bn.js";
+import BN from "bn.js";
+import PromiEvent from "web3/promiEvent";
 
-import { PromiEvent, Provider } from "web3/types";
+import { Provider } from "web3/providers";
 
 import LocalStorage from "./storage/localStorage";
 

src/lib/balances.ts

@@ -1,5 +1,5 @@
 import BigNumber from "bignumber.js";
-import { BN } from "bn.js";
+import BN from "bn.js";
 
 import { ErrNumericalPrecision } from "./errors";
 // import { Token, TokenDetails } from "./market";

src/lib/ingress.ts

@@ -6,7 +6,7 @@ const NodeRSA = require("node-rsa") as { new(): NodeRSAType };
 
 import Web3 from "web3";
 
-import { BN } from "bn.js";
+import BN from "bn.js";
 import { List, Map } from "immutable";
 
 import * as shamir from "./shamir";
@@ -236,10 +236,10 @@ export async function requestWithdrawalSignature(ingressURL: string, address: st
     return new EncodedData(resp.data.signature, Encodings.BASE64);
 }
 
-async function ordersBatch(orderbook: OrderbookContract, offset: number, limit: number): Promise<List<[OrderID, OrderStatus, string]>> {
+async function ordersBatch(web3: Web3, orderbook: OrderbookContract, offset: number, limit: number): Promise<List<[OrderID, OrderStatus, string]>> {
     let orders;
     try {
-        orders = await orderbook.getOrders(offset, limit);
+        orders = await orderbook.getOrders(web3.utils.toHex(offset), web3.utils.toHex(limit));
     } catch (error) {
         console.error(`Failed to get call getOrders in ordersBatch`);
         throw error;
@@ -256,7 +256,7 @@ async function ordersBatch(orderbook: OrderbookContract, offset: number, limit:
     return ordersList;
 }
 
-export async function getOrders(orderbook: OrderbookContract, startIn?: number, limitIn?: number): Promise<List<[OrderID, OrderStatus, string]>> {
+export async function getOrders(web3: Web3, orderbook: OrderbookContract, startIn?: number, limitIn?: number): Promise<List<[OrderID, OrderStatus, string]>> {
     let orderCount;
     try {
         orderCount = new BN(await orderbook.ordersCount()).toNumber();
@@ -288,7 +288,7 @@ export async function getOrders(orderbook: OrderbookContract, startIn?: number,
         batchLimit = Math.min(batchLimit, stop - start);
 
         // Retrieve batch of orders and increment start
-        const batch = await ordersBatch(orderbook, start, batchLimit);
+        const batch = await ordersBatch(web3, orderbook, start, batchLimit);
         ordersList = ordersList.concat(batch).toList();
         start += batchLimit;
     }
@@ -496,8 +496,8 @@ export function encryptForDarknode(darknodeKey: NodeRSAType | null, share: shami
  * When the {start} value is not the NULL address, it is always returned as the
  * first entry so it should not be re-added to the list of all darknodes.
  */
-async function getAllDarknodes(darknodeRegistryContract: DarknodeRegistryContract): Promise<string[]> {
-    const batchSize = 10;
+async function getAllDarknodes(web3: Web3, darknodeRegistryContract: DarknodeRegistryContract): Promise<string[]> {
+    const batchSize = web3.utils.toHex(10);
 
     const allDarknodes = [];
     let lastDarknode = NULL;
@@ -514,7 +514,7 @@ async function getAllDarknodes(darknodeRegistryContract: DarknodeRegistryContrac
  * Calculate pod arrangement based on current epoch
  */
 async function getPods(web3: Web3, darknodeRegistryContract: DarknodeRegistryContract, simpleConsole: SimpleConsole): Promise<List<Pod>> {
-    const darknodes = await getAllDarknodes(darknodeRegistryContract);
+    const darknodes = await getAllDarknodes(web3, darknodeRegistryContract);
     const minimumPodSize = new BN(await darknodeRegistryContract.minimumPodSize()).toNumber();
     simpleConsole.log(`Using minimum pod size ${minimumPodSize}`);
     const epoch = await darknodeRegistryContract.currentEpoch();

src/lib/order.ts

@@ -1,5 +1,5 @@
 import BigNumber from "bignumber.js";
-import { BN } from "bn.js";
+import BN from "bn.js";
 
 import { OrderStatus } from "../index";
 import { ErrUnknownOrderStatus } from "./errors";

src/lib/shamir.ts

@@ -1,4 +1,4 @@
-import { BN } from "bn.js";
+import BN from "bn.js";
 import crypto from "crypto";
 import { List } from "immutable";
 

src/lib/tokens.ts

@@ -1,7 +1,7 @@
 import RenExSDK from "../index";
 
 import { BigNumber } from "bignumber.js";
-import { BN } from "bn.js";
+import BN from "bn.js";
 import { Token, TokenCode, TokenDetails } from "../types";
 
 export function toSmallestUnit(amount: BigNumber, tokenDetails: TokenDetails): BigNumber {

src/methods/balanceActionMethods.ts

@@ -1,7 +1,7 @@
 import BigNumber from "bignumber.js";
 
-import { BN } from "bn.js";
-import { PromiEvent } from "web3/types";
+import BN from "bn.js";
+import PromiEvent from "web3/promiEvent";
 
 import RenExSDK from "../index";
 import { BalanceAction, BalanceActionType, NumberInput, Token, TokenCode, TokenDetails, Transaction, TransactionStatus } from "../types";
@@ -96,7 +96,7 @@ export const deposit = async (
 
             const { txHash, promiEvent } = await onTxHash(sdk._contracts.renExBalances.deposit(
                 tokenDetails.address,
-                valueBN,
+                sdk.getWeb3().utils.toHex(valueBN),
                 { value: valueBN.toString(), from: address, gasPrice },
             ));
 
@@ -131,12 +131,14 @@ export const deposit = async (
             // if there are any pending deposits for the same token
             const allowance = new BN(await tokenContract.allowance(address, sdk._contracts.renExBalances.address, { from: address, gasPrice }));
             if (allowance.lt(valueBN)) {
-                await onTxHash(tokenContract.approve(sdk._contracts.renExBalances.address, valueBN, { from: address, gasPrice }));
+                await onTxHash(tokenContract.approve(sdk._contracts.renExBalances.address,
+                    sdk.getWeb3().utils.toHex(valueBN),
+                    { from: address, gasPrice }));
             }
 
             const { txHash, promiEvent } = await onTxHash(sdk._contracts.renExBalances.deposit(
                 tokenDetails.address,
-                valueBN,
+                sdk.getWeb3().utils.toHex(valueBN),
                 {
                     // Manually set gas limit since gas estimation won't work
                     // if the ethereum node hasn't seen the previous transaction
@@ -226,7 +228,7 @@ export const withdraw = async (
 
         const { txHash, promiEvent } = await onTxHash(sdk._contracts.renExBalances.withdraw(
             tokenDetails.address,
-            valueBN,
+            sdk.getWeb3().utils.toHex(valueBN),
             signature.toHex(),
             { from: address, gasPrice, /* nonce: balanceAction.nonce */ },
         ));