@exodus/ethereum-api 0.1.1 → 0.2.0

package/package.json

@@ -1,11 +1,8 @@
 {
   "name": "@exodus/ethereum-api",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Ethereum Api",
-  "main": "lib/index.js",
-  "files": [
-    "lib"
-  ],
+  "main": "src/index.js",
   "author": "Exodus Movement, Inc.",
   "license": "UNLICENSED",
   "homepage": "https://github.com/ExodusMovement/ethereum#readme",
@@ -20,5 +17,5 @@
     "url-join": "4.0.0",
     "ws": "6.1.0"
   },
-  "gitHead": "8a2481e4de93011fe76652287b80500f1b5115aa"
+  "gitHead": "c04f7f85e7025762fa69cd816adf95c5811455d0"
 }

package/src/etherscan/account.js

@@ -0,0 +1,49 @@
+import assert from 'assert'
+import request from './request'
+
+const isValidResponseCheck = (x) =>
+  (x.status === '1' && x.message === 'OK') || x.message === 'No transactions found'
+const _request = async (...args) => request(isValidResponseCheck, 'account', ...args)
+
+export async function fetchBalance(address) {
+  const balance = await _request('balance', { address })
+
+  const isValid = /^[0-9]+$/.test(balance)
+  if (!isValid) throw new RangeError(`Invalid balance: ${balance}`)
+
+  return balance
+}
+
+export async function fetchTxlist(address, options) {
+  const params = { startblock: 0, endblock: 'latest', ...options, address }
+  const txlist = await _request('txlist', params)
+
+  // simple check
+  assert(Array.isArray(txlist), `Invalid transactions: ${txlist}`)
+
+  return txlist
+}
+
+export async function fetchTxlistinternal(address, options) {
+  const params = { startblock: 0, endblock: 'latest', ...options, address }
+  const txlist = await _request('txlistinternal', params)
+
+  // simple check
+  assert(Array.isArray(txlist), `Invalid transactions: ${txlist}`)
+
+  return txlist
+}
+
+export async function tokenBalance(token, address) {
+  const params = {
+    [token.length === 42 ? 'contractaddress' : 'tokenname']: token,
+    address,
+    tag: 'latest',
+  }
+  const balance = await _request('tokenbalance', params)
+
+  const isValid = /^[0-9]+$/.test(balance)
+  if (!isValid) throw new RangeError(`Invalid balance: ${balance}`)
+
+  return balance
+}

package/src/etherscan/index.js

@@ -0,0 +1,48 @@
+import {
+  fetchBalance as _fetchBalance,
+  fetchTxlist as _fetchTxlist,
+  fetchTxlistinternal as _fetchTxlistinternal,
+  tokenBalance as _tokenBalance,
+} from './account'
+import {
+  sendRawTransaction as _sendRawTransaction,
+  getTransactionCount as _getTransactionCount,
+  getTransactionReceipt as _getTransactionReceipt,
+  estimateGas as _estimateGas,
+  getCode as _getCode,
+  gasPrice as _gasPrice,
+  ethCall as _ethCall,
+} from './proxy'
+import { setEtherscanApiKey } from './request'
+import { getLogs as _getLogs } from './logs'
+import createWebSocket from './ws'
+
+export const ETHERSCAN_WS_URL = 'wss://socket.etherscan.io/wshandler'
+
+export const fetchBalance = _fetchBalance
+export const fetchTxlist = _fetchTxlist
+export const fetchTxlistinternal = _fetchTxlistinternal
+export const tokenBalance = _tokenBalance
+
+export const sendRawTransaction = _sendRawTransaction
+export const getTransactionCount = _getTransactionCount
+export const getTransactionReceipt = _getTransactionReceipt
+export const estimateGas = _estimateGas
+export const getCode = _getCode
+export const gasPrice = _gasPrice
+
+export const getLogs = _getLogs
+
+export const setApiKey = setEtherscanApiKey
+
+export const ws = createWebSocket(ETHERSCAN_WS_URL)
+
+export const ethCall = _ethCall
+
+export function filterTxsSent(addr, etherscanTxs) {
+  return etherscanTxs.filter((tx) => tx.from.toLowerCase() === addr.toLowerCase())
+}
+
+export function filterTxsReceived(addr, etherscanTxs) {
+  return etherscanTxs.filter((tx) => tx.to.toLowerCase() === addr.toLowerCase())
+}

package/src/etherscan/logs.js

@@ -0,0 +1,16 @@
+import assert from 'assert'
+import request from './request'
+
+const isValidResponseCheck = (x) =>
+  (x.status === '1' && x.message === 'OK') || x.message === 'No records found'
+const _request = async (...args) => request(isValidResponseCheck, 'logs', ...args)
+
+export async function getLogs(address, fromBlock, toBlock, options) {
+  const params = { ...options, address, fromBlock, toBlock }
+  const events = await _request('getLogs', params)
+
+  // simple check
+  assert(Array.isArray(events), `Invalid transactions: ${events}`)
+
+  return events
+}

package/src/etherscan/proxy.js

@@ -0,0 +1,47 @@
+import request from './request'
+
+const isValidResponseCheck = (x) => x.result !== undefined
+const _request = async (...args) => request(isValidResponseCheck, 'proxy', ...args)
+
+export async function sendRawTransaction(data) {
+  const txhash = await _request('eth_sendRawTransaction', { hex: '0x' + data })
+
+  const isValidTxHash = /^0x[0-9a-fA-F]{64}$/.test(txhash)
+  if (!isValidTxHash) throw new Error(`Invalid tx hash: ${txhash}`)
+
+  return txhash.slice(2)
+}
+
+export async function getTransactionCount(address) {
+  return _request('eth_getTransactionCount', { address })
+}
+
+export async function getTransactionReceipt(txhash) {
+  return _request('eth_getTransactionReceipt', { txhash })
+}
+
+export async function estimateGas(data) {
+  return _request('eth_estimateGas', data)
+}
+
+export async function getCode(address) {
+  const code = await _request('eth_getCode', { address })
+
+  const isValidCode = /^0x[0-9a-fA-F]*$/.test(code) && code.length % 2 === 0
+  if (!isValidCode) throw new Error(`Invalid address code: ${code}`)
+
+  return code
+}
+
+export async function gasPrice() {
+  const price = await _request('eth_gasPrice')
+
+  const isValidPrice = /^0x[0-9a-fA-F]+$/.test(price)
+  if (!isValidPrice) throw new Error(`Invalid price: ${price}`)
+
+  return price
+}
+
+export async function ethCall(data) {
+  return _request('eth_call', data)
+}

package/src/etherscan/request.js

@@ -0,0 +1,25 @@
+import ms from 'ms'
+import makeConcurrent from 'make-concurrent'
+import fetchival from 'fetchival'
+// The module in desktop explicitly sets node-fetch. Do we need this?
+// import fetch from '../fetch'
+// fetchival.fetch = fetch
+
+const ETHERSCAN_API_URL = 'https://api.etherscan.io/api'
+const DEFAULT_ETHERSCAN_API_KEY = 'XM3VGRSNW1TMSIR14I9MVFP15X74GNHTRI'
+
+let etherscanApiKey = DEFAULT_ETHERSCAN_API_KEY
+
+export function setEtherscanApiKey(apiKey) {
+  etherscanApiKey = apiKey || DEFAULT_ETHERSCAN_API_KEY
+}
+
+export default makeConcurrent(
+  async function(isValidResponseCheck, module, action, params = {}) {
+    const queryParams = { ...params, module, action, apiKey: etherscanApiKey }
+    const data = await fetchival(ETHERSCAN_API_URL, { timeout: ms('15s') }).get(queryParams)
+    if (!isValidResponseCheck(data)) throw new Error(`Invalid response: ${JSON.stringify(data)}`)
+    return data.result
+  },
+  { concurrency: 3 }
+)

package/src/etherscan/ws.js

@@ -0,0 +1,88 @@
+import { EventEmitter } from 'events'
+import ms from 'ms'
+import WebSocket from '../websocket'
+
+const RECONNECT_INTERVAL = ms('10s')
+const PING_INTERVAL = ms('20s')
+
+export default function createWebSocket(url) {
+  const addresses = new Set()
+  const events = new EventEmitter().setMaxListeners(20)
+  const pingMessage = JSON.stringify({ event: 'ping' })
+  let ws
+  let wsOpened = false
+  let opened = false
+  let openTimeoutId
+  let pingIntervalId
+
+  function subscribeAddress(address) {
+    const data = JSON.stringify({ event: 'txlist', address })
+    ws.send(data)
+  }
+
+  function onMessage(data) {
+    data = JSON.parse(data)
+    switch (data.event) {
+      case 'txlist':
+        for (const tx of data.result) events.emit(`address-${data.address}`, tx)
+        break
+
+      case 'subscribe-txlist':
+        const match = data.message.toLowerCase().match(/0x[0-9a-f]{40}/)
+        if (match && data.status === '1') events.emit(`address-${match[0]}-subscribed`)
+        else ws.close()
+        break
+    }
+  }
+
+  function isOpened() {
+    return wsOpened
+  }
+
+  function open() {
+    opened = true
+    clearTimeout(openTimeoutId)
+    if (ws) return
+
+    ws = new WebSocket(url)
+
+    ws.on('message', (data) => {
+      try {
+        onMessage(data)
+      } catch (err) {}
+    })
+    ws.once('open', () => {
+      for (const address of addresses.values()) subscribeAddress(address)
+      pingIntervalId = setInterval(() => ws && ws.send(pingMessage), PING_INTERVAL)
+      wsOpened = true
+      events.emit('open')
+    })
+    ws.once('close', () => {
+      ws = null
+      clearInterval(pingIntervalId)
+      if (opened) openTimeoutId = setTimeout(open, RECONNECT_INTERVAL)
+      wsOpened = false
+      events.emit('close')
+    })
+  }
+
+  function close() {
+    opened = false
+    clearTimeout(openTimeoutId)
+    if (!ws) return
+
+    ws.close()
+    ws = null
+  }
+
+  function watch(address) {
+    address = address.toLowerCase()
+
+    if (addresses.has(address)) return
+    addresses.add(address)
+
+    if (wsOpened) subscribeAddress(address)
+  }
+
+  return { events, isOpened, open, close, watch }
+}

package/src/exodus-eth-server/api.js

@@ -0,0 +1,114 @@
+import urlJoin from 'url-join'
+import url from 'url'
+import fetchival from 'fetchival'
+import ms from 'ms'
+import createWebSocket from './ws'
+
+export function create(defaultURL) {
+  let API_URL = defaultURL
+  const ws = createWebSocket(() => {
+    // eslint-disable-next-line
+    const obj = url.parse(API_URL)
+    obj.protocol = 'wss:'
+    return url.format(obj)
+  })
+
+  async function request(module, params = {}) {
+    const url = urlJoin(API_URL, module)
+    try {
+      return await fetchival(url, { timeout: ms('15s') }).get(params)
+    } catch (err) {
+      let nerr = err
+      if (err.response && err.response.status === 500) {
+        try {
+          const data = await err.response.json()
+          const msg = data.error.replace(/^RPC error \(code: -\d+\): /, '')
+          nerr = new Error(msg)
+        } catch (err) {}
+      }
+
+      throw nerr
+    }
+  }
+
+  return {
+    getURL() {
+      return API_URL
+    },
+
+    setURL(newURL) {
+      API_URL = newURL || defaultURL
+
+      if (ws.isCreated()) {
+        ws.close()
+        ws.open()
+      }
+    },
+
+    ws,
+
+    async getBalance(address, opts) {
+      opts = { startblock: 'earliest', endblock: 'pending', ...opts }
+      return request('balance', { address, from: opts.startblock, to: opts.endblock })
+    },
+
+    async getHistory(address, opts) {
+      opts = { startblock: 'earliest', endblock: 'pending', limit: 1000, ...opts }
+      return request('history', {
+        address,
+        from: opts.startblock,
+        to: opts.endblock,
+        limit: opts.limit,
+      })
+    },
+
+    async gasPrice() {
+      return request('proxy', { method: 'eth_gasPrice' })
+    },
+
+    async getTransactionCount(address, tag = 'latest') {
+      return request('proxy', { method: 'eth_getTransactionCount', address, tag })
+    },
+
+    async getTransactionByHash(hash) {
+      return request('proxy', { method: 'eth_getTransactionByHash', hash })
+    },
+
+    async getTransactionReceipt(txhash) {
+      return request('proxy', { method: 'eth_getTransactionReceipt', txhash })
+    },
+
+    async getCode(address, tag = 'latest') {
+      return request('proxy', { method: 'eth_getCode', address, tag })
+    },
+
+    async sendRawTransaction(data) {
+      return request('proxy', { method: 'eth_sendRawTransaction', hex: '0x' + data })
+    },
+
+    async estimateGas(data, tag = 'latest') {
+      return request('proxy', { method: 'eth_estimateGas', ...data, tag })
+    },
+
+    async ethCall(data, tag = 'latest') {
+      return request('proxy', { method: 'eth_call', ...data, tag })
+    },
+
+    async blockNumber() {
+      return request('proxy', { method: 'eth_blockNumber' })
+    },
+
+    async getBlockByNumber(number, isFullTransactions = false) {
+      return request('proxy', { method: 'eth_getBlockByNumber', number, isFullTransactions })
+    },
+
+    async simulateRawTransaction(rawTransaction, applyPending = true) {
+      rawTransaction = rawTransaction.replace('0x', '')
+      return request('proxy', {
+        method: 'debug_simulateRawTransaction',
+        rawTransaction,
+        applyPending,
+      })
+    },
+  }
+}

package/src/exodus-eth-server/index.js

@@ -0,0 +1,9 @@
+import { create } from './api'
+
+const EXODUS_ETH_SERVER_URL = 'https://eth.a.exodus.io/wallet/v1/'
+const EXODUS_ETC_SERVER_URL = 'https://etc.a.exodus.io/wallet/v1/'
+
+// allow self-signed certs
+// process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0'
+export const eth = create(EXODUS_ETH_SERVER_URL)
+export const etc = create(EXODUS_ETC_SERVER_URL)

package/src/exodus-eth-server/ws.js

@@ -0,0 +1,89 @@
+import ms from 'ms'
+import { EventEmitter } from 'events'
+import WebSocket from '../websocket'
+
+const RECONNECT_INTERVAL = ms('10s')
+const PING_INTERVAL = ms('10s')
+
+export default function createWebSocket(getURL) {
+  const addresses = new Set()
+  const events = new EventEmitter()
+  let ws
+  let pingIntervalId = null
+  let opened = false
+  let openTimeoutId
+
+  function subscribeAddress(address) {
+    const data = JSON.stringify({ type: 'subscribe-address', address })
+    ws.send(data)
+  }
+
+  function subscribeGasPrice() {
+    const data = JSON.stringify({ type: 'subscribe-gasprice' })
+    ws.send(data)
+  }
+
+  function onMessage(data) {
+    data = JSON.parse(data)
+    switch (data.type) {
+      case 'address':
+        events.emit(`address-${data.address}`)
+        break
+      case 'gasprice':
+        events.emit('gasprice', data.gasprice)
+        break
+    }
+  }
+
+  function open() {
+    opened = true
+    clearTimeout(openTimeoutId)
+    if (ws) return
+
+    ws = new WebSocket(getURL())
+    ws.onerror = () => {}
+    ws.onmessage = (e) => {
+      try {
+        onMessage(e.data)
+      } catch (err) {}
+    }
+    ws.onopen = () => {
+      for (const address of addresses.values()) subscribeAddress(address)
+      subscribeGasPrice()
+      pingIntervalId = setInterval(() => ws.ping(), PING_INTERVAL)
+      events.emit('open')
+    }
+    ws.onclose = () => {
+      ws = null
+      clearInterval(pingIntervalId)
+      pingIntervalId = null
+      if (opened) openTimeoutId = setTimeout(open, RECONNECT_INTERVAL)
+      events.emit('close')
+    }
+  }
+
+  function close() {
+    opened = false
+    clearTimeout(openTimeoutId)
+    if (!ws) return
+
+    ws.onerror = null
+    ws.onmessage = null
+    ws.onopen = null
+    ws.onclose = null
+    ws.close()
+    ws = null
+    clearInterval(pingIntervalId)
+    pingIntervalId = null
+    events.emit('close')
+  }
+
+  function watch(address) {
+    if (addresses.has(address)) return
+    addresses.add(address)
+
+    if (ws) subscribeAddress(address)
+  }
+
+  return { events, open, close, watch, isCreated: () => !!ws, isOpened: () => !!pingIntervalId }
+}

package/src/index.js

@@ -0,0 +1,5 @@
+import * as etherscan from './etherscan'
+
+export * from './with-fallback'
+export * from './exodus-eth-server'
+export { etherscan }

package/src/websocket/index.android.js

@@ -0,0 +1,2 @@
+/* global WebSocket */
+export default WebSocket

package/src/websocket/index.ios.js

@@ -0,0 +1,2 @@
+/* global WebSocket */
+export default WebSocket

package/src/websocket/index.js

@@ -0,0 +1,3 @@
+import WebSocket from 'ws'
+
+export default WebSocket

package/src/with-fallback.js

@@ -0,0 +1,14 @@
+export function withFallback(fn, fn2) {
+  return async (...args) => {
+    try {
+      return await fn(...args)
+    } catch (err1) {
+      try {
+        return await fn2(...args)
+      } catch (err2) {
+        const err = new Error(`${err1.message} | ${err2.message}`)
+        throw Object.assign(err, { err1, err2 })
+      }
+    }
+  }
+}

package/lib/etherscan/account.js

@@ -1,66 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.fetchBalance = fetchBalance;
-exports.fetchTxlist = fetchTxlist;
-exports.fetchTxlistinternal = fetchTxlistinternal;
-exports.tokenBalance = tokenBalance;
-
-var _assert = _interopRequireDefault(require("assert"));
-
-var _request2 = _interopRequireDefault(require("./request"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const isValidResponseCheck = x => x.status === '1' && x.message === 'OK' || x.message === 'No transactions found';
-
-const _request = async (...args) => (0, _request2.default)(isValidResponseCheck, 'account', ...args);
-
-async function fetchBalance(address) {
-  const balance = await _request('balance', {
-    address
-  });
-  const isValid = /^[0-9]+$/.test(balance);
-  if (!isValid) throw new RangeError(`Invalid balance: ${balance}`);
-  return balance;
-}
-
-async function fetchTxlist(address, options) {
-  const params = {
-    startblock: 0,
-    endblock: 'latest',
-    ...options,
-    address
-  };
-  const txlist = await _request('txlist', params); // simple check
-
-  (0, _assert.default)(Array.isArray(txlist), `Invalid transactions: ${txlist}`);
-  return txlist;
-}
-
-async function fetchTxlistinternal(address, options) {
-  const params = {
-    startblock: 0,
-    endblock: 'latest',
-    ...options,
-    address
-  };
-  const txlist = await _request('txlistinternal', params); // simple check
-
-  (0, _assert.default)(Array.isArray(txlist), `Invalid transactions: ${txlist}`);
-  return txlist;
-}
-
-async function tokenBalance(token, address) {
-  const params = {
-    [token.length === 42 ? 'contractaddress' : 'tokenname']: token,
-    address,
-    tag: 'latest'
-  };
-  const balance = await _request('tokenbalance', params);
-  const isValid = /^[0-9]+$/.test(balance);
-  if (!isValid) throw new RangeError(`Invalid balance: ${balance}`);
-  return balance;
-}

package/lib/etherscan/index.js

@@ -1,59 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.filterTxsSent = filterTxsSent;
-exports.filterTxsReceived = filterTxsReceived;
-exports.ethCall = exports.ws = exports.setApiKey = exports.getLogs = exports.gasPrice = exports.getCode = exports.estimateGas = exports.getTransactionReceipt = exports.getTransactionCount = exports.sendRawTransaction = exports.tokenBalance = exports.fetchTxlistinternal = exports.fetchTxlist = exports.fetchBalance = exports.ETHERSCAN_WS_URL = void 0;
-
-var _account = require("./account");
-
-var _proxy = require("./proxy");
-
-var _request = require("./request");
-
-var _logs = require("./logs");
-
-var _ws = _interopRequireDefault(require("./ws"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const ETHERSCAN_WS_URL = 'wss://socket.etherscan.io/wshandler';
-exports.ETHERSCAN_WS_URL = ETHERSCAN_WS_URL;
-const fetchBalance = _account.fetchBalance;
-exports.fetchBalance = fetchBalance;
-const fetchTxlist = _account.fetchTxlist;
-exports.fetchTxlist = fetchTxlist;
-const fetchTxlistinternal = _account.fetchTxlistinternal;
-exports.fetchTxlistinternal = fetchTxlistinternal;
-const tokenBalance = _account.tokenBalance;
-exports.tokenBalance = tokenBalance;
-const sendRawTransaction = _proxy.sendRawTransaction;
-exports.sendRawTransaction = sendRawTransaction;
-const getTransactionCount = _proxy.getTransactionCount;
-exports.getTransactionCount = getTransactionCount;
-const getTransactionReceipt = _proxy.getTransactionReceipt;
-exports.getTransactionReceipt = getTransactionReceipt;
-const estimateGas = _proxy.estimateGas;
-exports.estimateGas = estimateGas;
-const getCode = _proxy.getCode;
-exports.getCode = getCode;
-const gasPrice = _proxy.gasPrice;
-exports.gasPrice = gasPrice;
-const getLogs = _logs.getLogs;
-exports.getLogs = getLogs;
-const setApiKey = _request.setEtherscanApiKey;
-exports.setApiKey = setApiKey;
-const ws = (0, _ws.default)(ETHERSCAN_WS_URL);
-exports.ws = ws;
-const ethCall = _proxy.ethCall;
-exports.ethCall = ethCall;
-
-function filterTxsSent(addr, etherscanTxs) {
-  return etherscanTxs.filter(tx => tx.from.toLowerCase() === addr.toLowerCase());
-}
-
-function filterTxsReceived(addr, etherscanTxs) {
-  return etherscanTxs.filter(tx => tx.to.toLowerCase() === addr.toLowerCase());
-}