@windingtree/wt-js-libs/src/on-chain-data-client/index.js

Javascript libraries to interact with the Winding Tree contracts

import Utils from './utils';
import Contracts from './contracts';
import Entrypoint from './entrypoint';
import UpdateableOrganization from './updateable-organization';
import Organization from './organization';

/**
 * A factory class used to access various on-chain data
 * represented by Winding Tree index.
 */
export class OnChainDataClient {
  static entrypoints;

  static options;

  static web3Utils;

  static web3Contracts;

  /**
   * Sets up Utils and Contracts with given web3 provider.
   * Sets up gasCoefficient or gasMargin. If neither is provided,
   * sets gasCoefficient to a default of 2.
   */
  static setup (options) {
    options = options || {};
    if (!options.gasMargin && !options.gasCoefficient) {
      options.gasCoefficient = 2;
    }
    OnChainDataClient.entrypoints = {};
    OnChainDataClient.options = options;
    OnChainDataClient.web3Utils = Utils.createInstance({
      gasCoefficient: OnChainDataClient.options.gasCoefficient,
      gasMargin: OnChainDataClient.options.gasMargin,
    }, OnChainDataClient.options.provider);
    OnChainDataClient.web3Contracts = Contracts.createInstance(OnChainDataClient.options.provider);
  }

  /**
   * Deletes options and entrypoints. Useful for testing.
   */
  static _reset () {
    OnChainDataClient.options = {};
    OnChainDataClient.entrypoints = {};
  }

  static getEntrypoint (address) {
    if (!OnChainDataClient.entrypoints[address]) {
      OnChainDataClient.entrypoints[address] = Entrypoint.createInstance(address, OnChainDataClient.web3Utils, OnChainDataClient.web3Contracts);
    }
    return OnChainDataClient.entrypoints[address];
  }

  static getUpdateableOrganization (address) {
    return UpdateableOrganization.createInstance(OnChainDataClient.web3Utils, OnChainDataClient.web3Contracts, address);
  }

  static getOrganization (address) {
    return Organization.createInstance(OnChainDataClient.web3Utils, OnChainDataClient.web3Contracts, address);
  }

  /**
   * Finds out in what state are Ethereum transactions. All logs
   * are decoded along the way and some metrics such as min/max blockAge
   * are computed. If you pass all transactions related to a single
   * operation (such as update), you may benefit from the computed
   * metrics.
   */
  static async getTransactionsStatus (txHashes) {
    const receiptsPromises = [];
    const txDataPromises = [];
    for (const hash of txHashes) {
      receiptsPromises.push(OnChainDataClient.web3Utils.getTransactionReceipt(hash));
      txDataPromises.push(OnChainDataClient.web3Utils.getTransaction(hash));
    }
    const currentBlockNumber = OnChainDataClient.web3Utils.getCurrentBlockNumber();
    const receipts = await Promise.all(receiptsPromises);
    const txData = await Promise.all(txDataPromises);

    const results = {};
    for (const receipt of receipts) {
      if (!receipt) { continue; }
      const decodedLogs = OnChainDataClient.web3Contracts.decodeLogs(receipt.logs);
      const originalTxData = txData.find((tx) => tx.hash === receipt.transactionHash);
      results[receipt.transactionHash] = {
        transactionHash: receipt.transactionHash,
        blockAge: (await currentBlockNumber) - receipt.blockNumber,
        decodedLogs: decodedLogs,
        from: originalTxData && originalTxData.from,
        to: originalTxData && originalTxData.to,
        raw: receipt,
      };
    }
    const resultsValues = Object.values(results);
    return {
      meta: {
        total: txHashes.length,
        processed: resultsValues.length,
        minBlockAge: Math.min(...(resultsValues.map((a) => a.blockAge))),
        maxBlockAge: Math.max(...(resultsValues.map((a) => a.blockAge))),
        // https://ethereum.stackexchange.com/questions/28077/how-do-i-detect-a-failed-transaction-after-the-byzantium-fork-as-the-revert-opco
        allPassed: (resultsValues.map((a) => a.raw.status)).every((x) => x) && txHashes.length === resultsValues.length,
      },
      results: results,
    };
  }
}

export default OnChainDataClient;