@toruslabs/ethereum-controllers 5.11.0 → 6.0.0

package/dist/lib.cjs/Transaction/TransactionController.js

@@ -0,0 +1,515 @@
+'use strict';
+
+var _objectSpread = require('@babel/runtime/helpers/objectSpread2');
+var _defineProperty = require('@babel/runtime/helpers/defineProperty');
+var util = require('@ethereumjs/util');
+var baseControllers = require('@toruslabs/base-controllers');
+var auth = require('@web3auth/auth');
+var BigNumber = require('bignumber.js');
+var ethers = require('ethers');
+var log = require('loglevel');
+var constants = require('../utils/constants.js');
+var conversionUtils = require('../utils/conversionUtils.js');
+var helpers = require('../utils/helpers.js');
+var NonceTracker = require('./NonceTracker.js');
+var PendingTransactionTracker = require('./PendingTransactionTracker.js');
+var TransactionGasUtil = require('./TransactionGasUtil.js');
+var TransactionStateManager = require('./TransactionStateManager.js');
+var TransactionUtils = require('./TransactionUtils.js');
+
+class TransactionController extends TransactionStateManager.TransactionStateManager {
+  constructor({
+    config,
+    state,
+    provider,
+    blockTracker,
+    signEthTx,
+    getCurrentChainId,
+    getCurrentNetworkEIP1559Compatibility,
+    getProviderConfig,
+    getCurrentAccountEIP1559Compatibility,
+    getSelectedAddress,
+    getEIP1559GasFeeEstimates
+  }) {
+    super({
+      config,
+      state,
+      getCurrentChainId
+    });
+    _defineProperty(this, "getSelectedAddress", void 0);
+    _defineProperty(this, "getEIP1559GasFeeEstimates", void 0);
+    _defineProperty(this, "nonceTracker", void 0);
+    _defineProperty(this, "pendingTxTracker", void 0);
+    _defineProperty(this, "txGasUtil", void 0);
+    _defineProperty(this, "_getCurrentNetworkEIP1559Compatibility", void 0);
+    _defineProperty(this, "_getCurrentAccountEIP1559Compatibility", void 0);
+    _defineProperty(this, "getProviderConfig", void 0);
+    _defineProperty(this, "signEthTx", void 0);
+    _defineProperty(this, "provider", void 0);
+    _defineProperty(this, "blockTracker", void 0);
+    _defineProperty(this, "inProcessOfSigning", new Set());
+    _defineProperty(this, "getUnapprovedTxCount", () => Object.keys(this.getUnapprovedTxList()).length);
+    _defineProperty(this, "getPendingTxCount", account => this.getPendingTransactions(account).length);
+    this.blockTracker = blockTracker;
+    this.getProviderConfig = getProviderConfig;
+    this._getCurrentNetworkEIP1559Compatibility = getCurrentNetworkEIP1559Compatibility;
+    this._getCurrentAccountEIP1559Compatibility = getCurrentAccountEIP1559Compatibility;
+    this.getSelectedAddress = getSelectedAddress;
+    this.getEIP1559GasFeeEstimates = getEIP1559GasFeeEstimates;
+    this.signEthTx = signEthTx;
+    this.provider = provider;
+    this.txGasUtil = new TransactionGasUtil.TransactionGasUtil(this.provider, this.blockTracker);
+    this.nonceTracker = new NonceTracker.NonceTracker({
+      provider,
+      blockTracker,
+      getConfirmedTransactions: this.getConfirmedTransactions.bind(this),
+      getPendingTransactions: this.getSubmittedTransactions.bind(this) // nonce tracker should only care about submitted transactions
+    });
+    this.pendingTxTracker = new PendingTransactionTracker.PendingTransactionTracker({
+      provider,
+      nonceTracker: this.nonceTracker,
+      getPendingTransactions: this.getPendingTransactions.bind(this),
+      // pending tx tracker should only care about submitted and approved transactions
+      getConfirmedTransactions: this.getConfirmedTransactions.bind(this),
+      approveTransaction: this.approveTransaction.bind(this),
+      publishTransaction: rawTx => this.provider.request({
+        method: constants.METHOD_TYPES.ETH_SEND_RAW_TRANSACTION,
+        params: [rawTx]
+      })
+    });
+    this._setupListeners();
+  }
+  addTransactionUnapproved(txMeta) {
+    this.addTransactionToState(txMeta);
+    this.emit(`${txMeta.id}:unapproved`, txMeta);
+  }
+  async addNewUnapprovedTransaction(txParams, req) {
+    const txMeta = await this.createTransaction(txParams, req);
+    return this.processApproval(txMeta);
+  }
+  async processApproval(txMeta) {
+    return new Promise((resolve, reject) => {
+      const handleFinished = msg => {
+        if (msg.status === baseControllers.TransactionStatus.rejected) {
+          return reject(auth.providerErrors.userRejectedRequest(`Transaction Signature: User denied message signature`));
+        }
+        if (msg.status === baseControllers.TransactionStatus.failed) {
+          return reject(auth.rpcErrors.internal(`Transaction Signature: failed to sign message ${msg.error}`));
+        }
+        if (msg.status === baseControllers.TransactionStatus.submitted) {
+          return resolve(msg.transactionHash);
+        }
+        return reject(auth.rpcErrors.internal(`Transaction Signature: Unknown problem: ${JSON.stringify(txMeta.transaction)}`));
+      };
+      this.once(`${txMeta.id}:finished`, handleFinished);
+    });
+  }
+  async approveTransaction(transactionID) {
+    const txMeta = this.getTransaction(transactionID);
+    if (this.inProcessOfSigning.has(transactionID)) {
+      return;
+    }
+    this.inProcessOfSigning.add(transactionID);
+    let nonceLock;
+    try {
+      this.setTxStatusApproved(transactionID);
+      const fromAddress = txMeta.transaction.from;
+      const {
+        customNonceValue
+      } = txMeta.transaction;
+      const customNonceValueNumber = Number(customNonceValue);
+      nonceLock = await this.nonceTracker.getNonceLock(fromAddress);
+      // add nonce to txParams
+      // if txMeta has previousGasParams then it is a retry at same nonce with
+      // higher gas settings and therefor the nonce should not be recalculated
+      const nonce = nonceLock.nextNonce;
+      const customOrNonce = customNonceValueNumber === 0 ? customNonceValue : customNonceValue || nonce;
+      txMeta.transaction.nonce = util.addHexPrefix(customOrNonce.toString(16));
+      // add nonce debugging information to txMeta
+      txMeta.nonceDetails = nonceLock.nonceDetails;
+      this.updateTransactionInState(txMeta, "transactions#approveTransaction");
+      // sign transaction
+      const rawTx = await this.signTransaction(transactionID);
+      await this.publishTransaction(transactionID, rawTx);
+      nonceLock.releaseLock();
+    } catch (err) {
+      try {
+        this.setTxStatusFailed(transactionID, err);
+      } catch (err2) {
+        log.error(err2);
+      }
+      // must set transaction to submitted/failed before releasing lock
+      if (nonceLock) {
+        nonceLock.releaseLock();
+      }
+      // continue with error chain
+      throw err;
+    } finally {
+      this.inProcessOfSigning.delete(transactionID);
+    }
+  }
+  async signTransaction(txId) {
+    const txMeta = this.getTransaction(txId);
+    const chainId = this.getCurrentChainId();
+    const type = TransactionUtils.isEIP1559Transaction(txMeta) ? constants.TRANSACTION_ENVELOPE_TYPES.FEE_MARKET : constants.TRANSACTION_ENVELOPE_TYPES.LEGACY;
+    const txParams = _objectSpread(_objectSpread({}, txMeta.transaction), {}, {
+      type,
+      chainId,
+      gasLimit: txMeta.transaction.gas
+    });
+    const fromAddress = txParams.from;
+    const common = await this.getCommonConfiguration(fromAddress);
+    const {
+      TransactionFactory
+    } = await import('@ethereumjs/tx');
+    // TODO: fix this when @ethereumjs/tx is updated.
+    const unsignedEthTx = TransactionFactory.fromTxData(txParams, {
+      common
+    });
+    const signedEthTx = await this.signEthTx(unsignedEthTx, fromAddress);
+    txMeta.r = util.addHexPrefix(signedEthTx.r.toString(16));
+    txMeta.s = util.addHexPrefix(signedEthTx.s.toString(16));
+    txMeta.v = util.addHexPrefix(signedEthTx.v.toString(16));
+    this.updateTransactionInState(txMeta, "transactions#signTransaction: add r, s, v values");
+    this.setTxStatusSigned(txId);
+    const rawTx = util.addHexPrefix(Buffer.from(signedEthTx.serialize()).toString("hex"));
+    return rawTx;
+  }
+  async publishTransaction(txId, rawTx) {
+    const txMeta = this.getTransaction(txId);
+    txMeta.rawTransaction = rawTx;
+    this.updateTransactionInState(txMeta, "transactions#publishTransaction");
+    let txHash;
+    try {
+      txHash = await this.provider.request({
+        method: constants.METHOD_TYPES.ETH_SEND_RAW_TRANSACTION,
+        params: [rawTx]
+      });
+    } catch (error) {
+      if (error.message.toLowerCase().includes("known transaction")) {
+        txHash = ethers.keccak256(util.addHexPrefix(rawTx));
+        txHash = util.addHexPrefix(txHash);
+      } else {
+        throw error;
+      }
+    }
+    this.setTxHash(txId, txHash);
+    this.setTxStatusSubmitted(txId);
+  }
+  async confirmTransaction(params) {
+    const {
+      txId,
+      txReceipt
+    } = params;
+    log.info(params, "confirm params");
+    const txMeta = this.getTransaction(txId);
+    if (!txMeta) return;
+    try {
+      txMeta.txReceipt = _objectSpread({}, txReceipt);
+      this.setTxStatusConfirmed(txId);
+      this.markNonceDuplicatesDropped(txId);
+      this.updateTransactionInState(txMeta, "transactions#confirmTransaction - add txReceipt");
+    } catch (error) {
+      log.error(error);
+    }
+  }
+  cancelTransaction(transactionID) {
+    throw new Error(`Method not implemented. ${transactionID}`);
+  }
+  async getEIP1559Compatibility(fromAddress) {
+    const currentNetworkIsCompatible = await this._getCurrentNetworkEIP1559Compatibility();
+    const fromAccountIsCompatible = await this._getCurrentAccountEIP1559Compatibility(fromAddress);
+    return currentNetworkIsCompatible && fromAccountIsCompatible;
+  }
+  async addTransactionGasDefaults(txMeta) {
+    let updateTxMeta = txMeta;
+    try {
+      updateTxMeta = await this.addTxGasDefaults(txMeta);
+    } catch (error) {
+      log.warn(error);
+      updateTxMeta = this.getTransaction(txMeta.id);
+      updateTxMeta.loadingDefaults = false;
+      this.updateTransactionInState(txMeta, "Failed to calculate gas defaults.");
+      throw error;
+    }
+    updateTxMeta.loadingDefaults = false;
+    this.updateTransactionInState(updateTxMeta, "Added new unapproved transaction.");
+    return updateTxMeta;
+  }
+  async addTxGasDefaults(txMeta) {
+    const eip1559Compatibility = txMeta.transaction.type !== constants.TRANSACTION_ENVELOPE_TYPES.LEGACY && (await this.getEIP1559Compatibility());
+    const {
+      gasPrice: defaultGasPrice,
+      maxFeePerGas: defaultMaxFeePerGas,
+      maxPriorityFeePerGas: defaultMaxPriorityFeePerGas
+    } = await this.getDefaultGasFees(txMeta, eip1559Compatibility);
+    const {
+      gasLimit: defaultGasLimit,
+      simulationFails
+    } = await this.getDefaultGasLimit(txMeta);
+    txMeta = this.getTransaction(txMeta.id);
+    if (simulationFails) {
+      txMeta.simulationFails = simulationFails;
+    }
+    if (eip1559Compatibility) {
+      // If the dapp has suggested a gas price, but no maxFeePerGas or maxPriorityFeePerGas
+      //  then we set maxFeePerGas and maxPriorityFeePerGas to the suggested gasPrice.
+      if (txMeta.transaction.gasPrice && !txMeta.transaction.maxFeePerGas && !txMeta.transaction.maxPriorityFeePerGas) {
+        txMeta.transaction.maxFeePerGas = txMeta.transaction.gasPrice;
+        // If the dapp has suggested a gas price, but no maxFeePerGas or maxPriorityFeePerGas
+        // then we set maxFeePerGas to the suggested gasPrice.
+
+        txMeta.transaction.maxPriorityFeePerGas = helpers.bnLessThan(typeof defaultMaxPriorityFeePerGas === "string" ? util.stripHexPrefix(defaultMaxPriorityFeePerGas) : defaultMaxPriorityFeePerGas, typeof txMeta.transaction.gasPrice === "string" ? util.stripHexPrefix(txMeta.transaction.gasPrice) : txMeta.transaction.gasPrice) ? defaultMaxPriorityFeePerGas : txMeta.transaction.gasPrice;
+      } else {
+        if (defaultMaxFeePerGas && !txMeta.transaction.maxFeePerGas) {
+          // If the dapp has not set the gasPrice or the maxFeePerGas, then we set maxFeePerGas
+          // with the one returned by the gasFeeController, if that is available.
+          txMeta.transaction.maxFeePerGas = defaultMaxFeePerGas;
+        }
+        if (defaultMaxPriorityFeePerGas && !txMeta.transaction.maxPriorityFeePerGas) {
+          // If the dapp has not set the gasPrice or the maxPriorityFeePerGas, then we set maxPriorityFeePerGas
+          // with the one returned by the gasFeeController, if that is available.
+          txMeta.transaction.maxPriorityFeePerGas = defaultMaxPriorityFeePerGas;
+        }
+        if (defaultGasPrice && !txMeta.transaction.maxFeePerGas) {
+          // If the dapp has not set the gasPrice or the maxFeePerGas, and no maxFeePerGas is available
+          // from the gasFeeController, then we set maxFeePerGas to the defaultGasPrice, assuming it is
+          // available.
+          txMeta.transaction.maxFeePerGas = defaultGasPrice;
+        }
+        if (txMeta.transaction.maxFeePerGas && !txMeta.transaction.maxPriorityFeePerGas) {
+          // If the dapp has not set the gasPrice or the maxPriorityFeePerGas, and no maxPriorityFeePerGas is
+          // available from the gasFeeController, then we set maxPriorityFeePerGas to
+          // txMeta.transaction.maxFeePerGas, which will either be the gasPrice from the controller, the maxFeePerGas
+          // set by the dapp, or the maxFeePerGas from the controller.
+          txMeta.transaction.maxPriorityFeePerGas = txMeta.transaction.maxFeePerGas;
+        }
+      }
+
+      // We remove the gasPrice param entirely when on an eip1559 compatible network
+
+      delete txMeta.transaction.gasPrice;
+    } else {
+      // We ensure that maxFeePerGas and maxPriorityFeePerGas are not in the transaction params
+      // when not on a EIP1559 compatible network
+
+      delete txMeta.transaction.maxPriorityFeePerGas;
+      delete txMeta.transaction.maxFeePerGas;
+    }
+
+    // If we have gotten to this point, and none of gasPrice, maxPriorityFeePerGas or maxFeePerGas are
+    // set on transaction, it means that either we are on a non-EIP1559 network and the dapp didn't suggest
+    // a gas price, or we are on an EIP1559 network, and none of gasPrice, maxPriorityFeePerGas or maxFeePerGas
+    // were available from either the dapp or the network.
+    if (defaultGasPrice && !txMeta.transaction.gasPrice && !txMeta.transaction.maxPriorityFeePerGas && !txMeta.transaction.maxFeePerGas) {
+      txMeta.transaction.gasPrice = defaultGasPrice;
+    }
+    if (defaultGasLimit && !txMeta.transaction.gas) {
+      txMeta.transaction.gas = defaultGasLimit;
+    }
+    return txMeta;
+  }
+  setTxHash(txId, txHash) {
+    // Add the tx hash to the persisted meta-tx object
+    const txMeta = this.getTransaction(txId);
+    txMeta.transactionHash = txHash;
+    this.updateTransactionInState(txMeta, "transactions#setTxHash");
+  }
+  async getDefaultGasFees(txMeta, eip1559Compatibility) {
+    if (!eip1559Compatibility && txMeta.transaction.gasPrice || eip1559Compatibility && txMeta.transaction.maxFeePerGas && txMeta.transaction.maxPriorityFeePerGas) {
+      return {};
+    }
+    try {
+      const {
+        gasFeeEstimates,
+        gasEstimateType
+      } = await this.getEIP1559GasFeeEstimates();
+      if (eip1559Compatibility && gasEstimateType === constants.GAS_ESTIMATE_TYPES.FEE_MARKET) {
+        // this is in dec gwei
+        const {
+          medium: {
+            suggestedMaxPriorityFeePerGas,
+            suggestedMaxFeePerGas
+          } = {}
+        } = gasFeeEstimates;
+        if (suggestedMaxPriorityFeePerGas && suggestedMaxFeePerGas) {
+          return {
+            // send to controller in hex wei
+            maxFeePerGas: util.addHexPrefix(conversionUtils.decGWEIToHexWEI(new BigNumber(suggestedMaxFeePerGas)).toString(16)),
+            maxPriorityFeePerGas: util.addHexPrefix(conversionUtils.decGWEIToHexWEI(new BigNumber(suggestedMaxPriorityFeePerGas)).toString(16))
+          };
+        }
+      } else if (gasEstimateType === constants.GAS_ESTIMATE_TYPES.LEGACY) {
+        const {
+          medium
+        } = gasFeeEstimates;
+        // The LEGACY type includes low, medium and high estimates of
+        // gas price values.
+        return {
+          gasPrice: util.addHexPrefix(conversionUtils.decGWEIToHexWEI(new BigNumber(medium)).toString(16))
+        };
+      } else if (gasEstimateType === constants.GAS_ESTIMATE_TYPES.ETH_GASPRICE) {
+        const {
+          gasPrice
+        } = gasFeeEstimates;
+        // The ETH_GASPRICE type just includes a single gas price property,
+        // which we can assume was retrieved from eth_gasPrice
+        return {
+          gasPrice: util.addHexPrefix(conversionUtils.decGWEIToHexWEI(new BigNumber(gasPrice)).toString(16))
+        };
+      }
+    } catch (error) {
+      log.error(error);
+    }
+    const gasPrice = await this.provider.request({
+      method: constants.METHOD_TYPES.ETH_GET_GAS_PRICE
+    });
+    return {
+      gasPrice: gasPrice && util.addHexPrefix(gasPrice)
+    };
+  }
+  async getDefaultGasLimit(txMeta) {
+    const chainId = this.getCurrentChainId();
+    const customNetworkGasBuffer = constants.CHAIN_ID_TO_GAS_LIMIT_BUFFER_MAP[chainId];
+    const chainType = helpers.getChainType(chainId);
+    if (txMeta.transaction.gas) {
+      return {};
+    }
+    if (txMeta.transaction.to && txMeta.transactionCategory === baseControllers.TRANSACTION_TYPES.SENT_ETHER && chainType !== "custom" && !txMeta.transaction.data) {
+      // This is a standard ether simple send, gas requirement is exactly 21k
+      return {
+        gasLimit: helpers.GAS_LIMITS.SIMPLE
+      };
+    }
+    const {
+      blockGasLimit,
+      estimatedGasHex,
+      simulationFails
+    } = await this.txGasUtil.analyzeGasUsage(txMeta);
+
+    // add additional gas buffer to our estimation for safety
+    const gasLimit = this.txGasUtil.addGasBuffer(util.addHexPrefix(estimatedGasHex), blockGasLimit, customNetworkGasBuffer);
+    return {
+      gasLimit,
+      simulationFails
+    };
+  }
+  async createTransaction(txParameters, req) {
+    const normalizedTxParameters = TransactionUtils.normalizeTxParameters(txParameters);
+    const eip1559Compatibility = await this.getEIP1559Compatibility(txParameters.from);
+    TransactionUtils.validateTxParameters(normalizedTxParameters, eip1559Compatibility);
+    let txMeta = this.generateTxMeta({
+      transaction: normalizedTxParameters,
+      origin: req.origin
+    });
+    const {
+      type,
+      category,
+      methodParams
+    } = await TransactionUtils.determineTransactionType(txParameters, this.provider);
+    txMeta.contractType = type;
+    txMeta.transactionCategory = category;
+    txMeta.methodParams = methodParams;
+    txMeta.transaction.value = txMeta.transaction.value ? util.addHexPrefix(txMeta.transaction.value) : "0x0";
+    this.emit(`${txMeta.id}:unapproved`, txMeta);
+    txMeta = this.addTransactionToState(txMeta);
+    txMeta = await this.addTransactionGasDefaults(txMeta);
+    this.emit(baseControllers.TX_EVENTS.TX_UNAPPROVED, {
+      txMeta,
+      req
+    });
+    return txMeta;
+  }
+  _setupListeners() {
+    this.setupBlockTrackerListener();
+    this.pendingTxTracker.on(baseControllers.TX_EVENTS.TX_WARNING, data => {
+      this.updateTransactionInState(data.txMeta);
+    });
+    this.pendingTxTracker.on(baseControllers.TX_EVENTS.TX_DROPPED, data => this.setTxStatusDropped(data.txId));
+    this.pendingTxTracker.on(baseControllers.TX_EVENTS.TX_BLOCK_UPDATE, ({
+      txMeta,
+      latestBlockNumber
+    }) => {
+      if (!txMeta.firstRetryBlockNumber) {
+        txMeta.firstRetryBlockNumber = latestBlockNumber;
+        this.updateTransactionInState(txMeta);
+      }
+    });
+    this.pendingTxTracker.on(baseControllers.TX_EVENTS.TX_RETRY, data => {
+      if (!("retryCount" in data.txMeta)) {
+        data.txMeta.retryCount = 0;
+      }
+      data.txMeta.retryCount += 1;
+      this.updateTransactionInState(data.txMeta);
+    });
+    this.pendingTxTracker.on(baseControllers.TX_EVENTS.TX_FAILED, data => {
+      this.setTxStatusFailed(data.txId, data.error);
+    });
+    this.pendingTxTracker.on(baseControllers.TX_EVENTS.TX_CONFIRMED, data => this.confirmTransaction(data));
+  }
+  setupBlockTrackerListener() {
+    let listenersAreActive = false;
+    const latestBlockHandler = this.onLatestBlock.bind(this);
+    this.on(baseControllers.TX_EVENTS.TX_STATUS_UPDATE, () => {
+      const pendingTxs = this.getPendingTransactions();
+      if (!listenersAreActive && pendingTxs.length > 0) {
+        this.blockTracker.on("latest", latestBlockHandler);
+        listenersAreActive = true;
+      } else if (listenersAreActive && !pendingTxs.length) {
+        this.blockTracker.removeListener("latest", latestBlockHandler);
+        listenersAreActive = false;
+      }
+    });
+  }
+  async onLatestBlock(blockNumber) {
+    try {
+      await this.pendingTxTracker.updatePendingTxs();
+    } catch (error) {
+      log.error(error);
+    }
+    try {
+      await this.pendingTxTracker.resubmitPendingTxs(blockNumber);
+    } catch (error) {
+      log.error(error);
+    }
+  }
+  async getCommonConfiguration(fromAddress) {
+    const {
+      chainId,
+      displayName
+    } = this.getProviderConfig();
+    const supportsEIP1559 = await this.getEIP1559Compatibility(fromAddress);
+    const {
+      Common,
+      Hardfork
+    } = await import('@ethereumjs/common');
+    const hardfork = supportsEIP1559 ? Hardfork.Paris : Hardfork.Berlin;
+    return Common.custom({
+      chainId: chainId === "loading" ? 0 : Number.parseInt(chainId, 16),
+      defaultHardfork: hardfork,
+      name: displayName,
+      networkId: chainId === "loading" ? 0 : Number.parseInt(chainId, 16)
+    });
+  }
+  markNonceDuplicatesDropped(txId) {
+    const txMeta = this.getTransaction(txId);
+    const {
+      nonce,
+      from
+    } = txMeta.transaction;
+    const sameNonceTxs = this.getTransactions({
+      searchCriteria: {
+        from,
+        nonce
+      }
+    });
+    if (!sameNonceTxs.length) return;
+    sameNonceTxs.forEach(tx => {
+      if (tx.id === txId) return;
+      this.updateTransactionInState(txMeta, "transactions/pending-tx-tracker#event: tx:confirmed reference to confirmed txHash with same nonce");
+      if (tx.status !== baseControllers.TransactionStatus.failed) this.setTxStatusDropped(tx.id);
+    });
+  }
+}
+
+exports.TransactionController = TransactionController;

package/dist/lib.cjs/Transaction/TransactionGasUtil.js

@@ -0,0 +1,81 @@
+'use strict';
+
+var _defineProperty = require('@babel/runtime/helpers/defineProperty');
+var util = require('@ethereumjs/util');
+var baseControllers = require('@toruslabs/base-controllers');
+var BN = require('bn.js');
+var log = require('loglevel');
+
+class TransactionGasUtil {
+  constructor(provider, blockTracker) {
+    _defineProperty(this, "provider", void 0);
+    _defineProperty(this, "blockTracker", void 0);
+    this.provider = provider;
+    this.blockTracker = blockTracker;
+  }
+  async analyzeGasUsage(txMeta) {
+    const block = await this.blockTracker.getLatestBlock();
+    // fallback to block gasLimit
+    const blockGasLimitBN = new BN.BN(util.stripHexPrefix(block.gasLimit), 16);
+    const saferGasLimitBN = blockGasLimitBN.mul(new BN.BN(19)).div(new BN.BN(20));
+    let estimatedGasHex = util.addHexPrefix(saferGasLimitBN.toString("hex"));
+    let simulationFails;
+    try {
+      estimatedGasHex = await this.estimateTxGas(txMeta);
+    } catch (error) {
+      log.warn(error);
+      simulationFails = {
+        reason: error.message,
+        errorKey: error.errorKey,
+        debug: {
+          blockNumber: block.idempotencyKey,
+          blockGasLimit: block.gasLimit
+        }
+      };
+    }
+    return {
+      blockGasLimit: block.gasLimit,
+      estimatedGasHex,
+      simulationFails
+    };
+  }
+
+  /**
+    Adds a gas buffer with out exceeding the block gas limit
+  */
+  addGasBuffer(initialGasLimitHex, blockGasLimitHex, multiplier = 1.5) {
+    const initialGasLimitBn = new BN.BN(util.stripHexPrefix(initialGasLimitHex), 16);
+    const blockGasLimitBn = new BN.BN(util.stripHexPrefix(blockGasLimitHex), 16);
+    const upperGasLimitBn = blockGasLimitBn.muln(0.9);
+    const bufferedGasLimitBn = initialGasLimitBn.muln(multiplier);
+
+    // if initialGasLimit is above blockGasLimit, dont modify it
+    if (initialGasLimitBn.gt(upperGasLimitBn)) return util.addHexPrefix(initialGasLimitBn.toString("hex"));
+    // if bufferedGasLimit is below blockGasLimit, use bufferedGasLimit
+    if (bufferedGasLimitBn.lt(upperGasLimitBn)) return util.addHexPrefix(bufferedGasLimitBn.toString("hex"));
+    // otherwise use blockGasLimit
+    return util.addHexPrefix(upperGasLimitBn.toString("hex"));
+  }
+
+  /**
+    Estimates the tx's gas usage
+  */
+  async estimateTxGas(txMeta) {
+    const txParams = baseControllers.cloneDeep(txMeta.transaction);
+
+    // `eth_estimateGas` can fail if the user has insufficient balance for the
+    // value being sent, or for the gas cost. We don't want to check their
+    // balance here, we just want the gas estimate. The gas price is removed
+    // to skip those balance checks. We check balance elsewhere. We also delete
+    // maxFeePerGas and maxPriorityFeePerGas to support EIP-1559 txs.
+    delete txParams.gasPrice;
+    delete txParams.maxFeePerGas;
+    delete txParams.maxPriorityFeePerGas;
+    return this.provider.request({
+      method: "eth_estimateGas",
+      params: [txParams]
+    });
+  }
+}
+
+exports.TransactionGasUtil = TransactionGasUtil;

package/dist/lib.cjs/Transaction/TransactionStateHistoryHelper.js

@@ -0,0 +1,42 @@
+'use strict';
+
+var _objectSpread = require('@babel/runtime/helpers/objectSpread2');
+var baseControllers = require('@toruslabs/base-controllers');
+var jsonDiffer = require('fast-json-patch');
+
+/**
+  Generates an array of history objects sense the previous state.
+  The object has the keys
+    op (the operation performed),
+    path (the key and if a nested object then each key will be seperated with a `/`)
+    value
+  with the first entry having the note and a timestamp when the change took place
+*/
+function generateHistoryEntry(previousState, newState, note) {
+  const entry = jsonDiffer.compare(previousState, newState);
+  // Add a note to the first op, since it breaks if we append it to the entry
+  if (entry[0]) {
+    if (note) {
+      entry[0].note = note;
+    }
+    entry[0].timestamp = Date.now();
+  }
+  return entry;
+}
+
+/**
+  Recovers previous txMeta state obj
+*/
+function replayHistory(_shortHistory) {
+  const shortHistory = baseControllers.cloneDeep(_shortHistory);
+  return shortHistory.reduce((val, entry) => jsonDiffer.applyPatch(val, entry).newDocument);
+}
+function snapshotFromTxMeta(txMeta) {
+  const shallow = _objectSpread({}, txMeta);
+  delete shallow.history;
+  return baseControllers.cloneDeep(shallow);
+}
+
+exports.generateHistoryEntry = generateHistoryEntry;
+exports.replayHistory = replayHistory;
+exports.snapshotFromTxMeta = snapshotFromTxMeta;