2017-08-04 10:55:00 -07:00
|
|
|
const EthQuery = require('ethjs-query')
|
|
|
|
const {
|
|
|
|
hexToBn,
|
|
|
|
BnMultiplyByFraction,
|
|
|
|
bnToHex,
|
|
|
|
} = require('./util')
|
2016-12-16 10:33:36 -08:00
|
|
|
|
|
|
|
/*
|
|
|
|
tx-utils are utility methods for Transaction manager
|
2017-05-18 14:54:02 -07:00
|
|
|
its passed ethquery
|
2016-12-16 10:33:36 -08:00
|
|
|
and used to do things like calculate gas of a tx.
|
|
|
|
*/
|
2016-12-14 12:55:41 -08:00
|
|
|
|
2017-08-08 15:30:49 -07:00
|
|
|
module.exports = class txProvideUtil {
|
2017-08-04 10:55:00 -07:00
|
|
|
constructor (provider) {
|
|
|
|
this.query = new EthQuery(provider)
|
2016-12-14 12:55:41 -08:00
|
|
|
}
|
2017-01-13 17:47:20 -08:00
|
|
|
|
2017-07-26 11:56:52 -07:00
|
|
|
async analyzeGasUsage (txMeta) {
|
|
|
|
const block = await this.query.getBlockByNumber('latest', true)
|
2017-08-08 23:34:18 -07:00
|
|
|
let estimatedGasHex
|
|
|
|
try {
|
|
|
|
estimatedGasHex = await this.estimateTxGas(txMeta, block.gasLimit)
|
|
|
|
} catch (err) {
|
2017-12-14 18:15:38 -08:00
|
|
|
const simulationFailed = (
|
|
|
|
err.message.includes('Transaction execution error.') ||
|
|
|
|
err.message.includes('gas required exceeds allowance or always failing transaction')
|
|
|
|
)
|
2017-12-27 17:27:48 -08:00
|
|
|
if (simulationFailed) {
|
2017-08-08 23:34:18 -07:00
|
|
|
txMeta.simulationFails = true
|
|
|
|
return txMeta
|
|
|
|
}
|
|
|
|
}
|
2017-07-26 11:56:52 -07:00
|
|
|
this.setTxGas(txMeta, block.gasLimit, estimatedGasHex)
|
2017-08-02 08:35:35 -07:00
|
|
|
return txMeta
|
2016-12-14 12:55:41 -08:00
|
|
|
}
|
|
|
|
|
2017-07-26 11:56:52 -07:00
|
|
|
async estimateTxGas (txMeta, blockGasLimitHex) {
|
2017-03-28 13:35:27 -07:00
|
|
|
const txParams = txMeta.txParams
|
2016-12-14 12:55:41 -08:00
|
|
|
// check if gasLimit is already specified
|
2017-03-28 13:35:27 -07:00
|
|
|
txMeta.gasLimitSpecified = Boolean(txParams.gas)
|
2016-12-14 12:55:41 -08:00
|
|
|
// if not, fallback to block gasLimit
|
2017-03-28 13:35:27 -07:00
|
|
|
if (!txMeta.gasLimitSpecified) {
|
2017-05-24 16:17:03 -07:00
|
|
|
const blockGasLimitBN = hexToBn(blockGasLimitHex)
|
2017-06-01 12:53:16 -07:00
|
|
|
const saferGasLimitBN = BnMultiplyByFraction(blockGasLimitBN, 19, 20)
|
2017-05-24 16:17:03 -07:00
|
|
|
txParams.gas = bnToHex(saferGasLimitBN)
|
2016-12-14 12:55:41 -08:00
|
|
|
}
|
2017-08-08 23:34:18 -07:00
|
|
|
// run tx
|
|
|
|
return await this.query.estimateGas(txParams)
|
2016-12-14 12:55:41 -08:00
|
|
|
}
|
|
|
|
|
2017-07-26 11:56:52 -07:00
|
|
|
setTxGas (txMeta, blockGasLimitHex, estimatedGasHex) {
|
2017-03-28 13:35:27 -07:00
|
|
|
txMeta.estimatedGas = estimatedGasHex
|
|
|
|
const txParams = txMeta.txParams
|
2017-01-10 14:20:46 -08:00
|
|
|
|
2016-12-14 12:55:41 -08:00
|
|
|
// if gasLimit was specified and doesnt OOG,
|
|
|
|
// use original specified amount
|
2017-03-28 13:35:27 -07:00
|
|
|
if (txMeta.gasLimitSpecified) {
|
|
|
|
txMeta.estimatedGas = txParams.gas
|
2016-12-14 12:55:41 -08:00
|
|
|
return
|
|
|
|
}
|
|
|
|
// if gasLimit not originally specified,
|
|
|
|
// try adding an additional gas buffer to our estimation for safety
|
2017-03-28 13:35:27 -07:00
|
|
|
const recommendedGasHex = this.addGasBuffer(txMeta.estimatedGas, blockGasLimitHex)
|
2017-03-07 22:47:35 -08:00
|
|
|
txParams.gas = recommendedGasHex
|
2016-12-14 12:55:41 -08:00
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2017-03-07 22:18:14 -08:00
|
|
|
addGasBuffer (initialGasLimitHex, blockGasLimitHex) {
|
2017-03-07 22:47:35 -08:00
|
|
|
const initialGasLimitBn = hexToBn(initialGasLimitHex)
|
|
|
|
const blockGasLimitBn = hexToBn(blockGasLimitHex)
|
2017-03-29 23:21:31 -07:00
|
|
|
const upperGasLimitBn = blockGasLimitBn.muln(0.9)
|
2017-03-07 22:18:14 -08:00
|
|
|
const bufferedGasLimitBn = initialGasLimitBn.muln(1.5)
|
2017-03-23 13:56:32 -07:00
|
|
|
|
2017-03-07 22:18:14 -08:00
|
|
|
// if initialGasLimit is above blockGasLimit, dont modify it
|
2017-03-29 23:21:31 -07:00
|
|
|
if (initialGasLimitBn.gt(upperGasLimitBn)) return bnToHex(initialGasLimitBn)
|
2017-03-07 22:18:14 -08:00
|
|
|
// if bufferedGasLimit is below blockGasLimit, use bufferedGasLimit
|
2017-03-29 23:21:31 -07:00
|
|
|
if (bufferedGasLimitBn.lt(upperGasLimitBn)) return bnToHex(bufferedGasLimitBn)
|
2017-03-07 22:18:14 -08:00
|
|
|
// otherwise use blockGasLimit
|
2017-03-29 23:21:31 -07:00
|
|
|
return bnToHex(upperGasLimitBn)
|
2016-12-14 12:55:41 -08:00
|
|
|
}
|
2017-01-13 02:00:11 -08:00
|
|
|
|
2017-08-02 15:58:05 -07:00
|
|
|
async validateTxParams (txParams) {
|
2017-12-19 14:28:02 -08:00
|
|
|
if ('value' in txParams) {
|
|
|
|
const value = txParams.value.toString()
|
2018-01-02 14:22:44 -08:00
|
|
|
if (value.includes('-')) {
|
2017-12-19 14:28:02 -08:00
|
|
|
throw new Error(`Invalid transaction value of ${txParams.value} not a positive number.`)
|
|
|
|
}
|
|
|
|
|
2018-01-02 14:22:44 -08:00
|
|
|
if (value.includes('.')) {
|
2017-12-19 14:28:02 -08:00
|
|
|
throw new Error(`Invalid transaction value of ${txParams.value} number must be in wei`)
|
|
|
|
}
|
2017-08-02 15:58:05 -07:00
|
|
|
}
|
2017-01-13 17:47:20 -08:00
|
|
|
}
|
2017-10-21 12:06:39 -07:00
|
|
|
}
|