Source: utils/logUtils.js

  1. /**
  2.  * @file Manages helper functions to work with logs
  3.  * @author Ivan Violentov <ivan.violentov@jibrel.network>
  4.  */
  6. import Promise from 'bluebird'
  8. import config from '../config'
  10. /**
  11.  * @function filter
  12.  *
  13.  * @description Gets filter object, that can be used for getting of past logs or watching of new
  14.  *
  15.  * @param {object} [options={}] - Filter options
  16.  * @param {(number|string)} [options.fromBlock] - The number of the earliest block
  17.  * @param {(number|string)} [options.toBlock] - The number of the latest block
  18.  * @param {(string|string[])} [options.address] - An address(es) to get logs from
  19.  * @param {string[]} [options.topics] - Allows to manually set the topics for the event filter
  20.  *
  21.  * @returns {object} (@see {@link https://github.com/ethereum/wiki/wiki/JavaScript-API#web3ethfilter})
  22.  */
  23. export function filter(options = {}) {
  24.   return jWeb3.eth.filter(options)
  25. }
  27. /**
  28.  * @async
  29.  * @function getLogs
  30.  *
  31.  * @description Gets past logs
  32.  *
  33.  * @param {object} [options={}] - Filter options
  34.  * @param {(number|string)} [options.fromBlock] - The number of the earliest block
  35.  * @param {(number|string)} [options.toBlock] - The number of the latest block
  36.  * @param {(string|string[])} [options.address] - An address(es) to get logs from
  37.  * @param {string[]} [options.topics] - Allows to manually set the topics for the event filter
  38.  *
  39.  * @returns Promise that will be resolved with past logs
  40.  */
  41. export function getLogs(options = {}) {
  42.   const filterObject = jWeb3.eth.filter(options)
  44.   /**
  45.    * filter.get uses instance methods inside,
  46.    * but bluebird promisify don't save context,
  47.    * so need to bind to filter object directly
  48.    */
  49.   return Promise
  50.     .promisify(filterObject.get.bind(filterObject))()
  51.     .timeout(
  52.       config.promiseTimeout,
  53.       new Error(`Can not get past logs within ${config.promiseTimeout}ms`)
  54.     )
  55. }