update gas price oracle

update gas-price-oracle dep, add BLOCK_GAS_LIMIT const

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tx-manager",
-  "version": "0.2.4",
+  "version": "0.3.3",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -23,7 +23,7 @@
   "dependencies": {
     "async-mutex": "^0.2.4",
     "ethers": "^5.0.17",
-    "gas-price-oracle": "^0.2.0",
+    "gas-price-oracle": "^0.3.5",
     "web3-core-promievent": "^1.3.0"
   },
   "devDependencies": {

src/Transaction.js

@@ -4,21 +4,23 @@ const BigNumber = ethers.BigNumber
 const PromiEvent = require('web3-core-promievent')
 const { sleep, min, max } = require('./utils')
 
-// prettier-ignore
 const nonceErrors = [
   'Transaction nonce is too low. Try incrementing the nonce.',
-  'nonce too low'
+  'nonce too low',
+  'nonce has already been used',
 ]
 
 const gasPriceErrors = [
   'Transaction gas price supplied is too low. There is another transaction with same nonce in the queue. Try increasing the gas price or incrementing the nonce.',
   'replacement transaction underpriced',
+  'transaction underpriced',
   /Transaction gas price \d+wei is too low. There is another transaction with same nonce in the queue with gas price: \d+wei. Try increasing the gas price or incrementing the nonce./,
 ]
 
 // prettier-ignore
 const sameTxErrors = [
   'Transaction with the same hash was already imported.',
+  'already known',
 ]
 
 class Transaction {
@@ -64,6 +66,7 @@ class Transaction {
     if (!tx.gasLimit) {
       tx.gasLimit = await this._wallet.estimateGas(tx)
       tx.gasLimit = Math.floor(tx.gasLimit * this.config.GAS_LIMIT_MULTIPLIER)
+      tx.gasLimit = Math.min(tx.gasLimit, this.config.BLOCK_GAS_LIMIT)
     }
     tx.nonce = this.tx.nonce // can be different from `this.manager._nonce`
     tx.gasPrice = Math.max(this.tx.gasPrice, tx.gasPrice || 0) // start no less than current tx gas price
@@ -93,16 +96,16 @@ class Transaction {
    * @private
    */
   async _execute() {
-    await this.manager._mutex.acquire()
+    const mutexRelease = await this.manager._mutex.acquire()
     try {
       await this._prepare()
       await this._send()
-      const receipt = this._waitForConfirmations()
+      const receipt = await this._waitForConfirmations()
       // we could have bumped nonce during execution, so get the latest one + 1
       this.manager._nonce = this.tx.nonce + 1
       return receipt
     } finally {
-      this.manager._mutex.release()
+      mutexRelease()
     }
   }
 
@@ -113,14 +116,22 @@ class Transaction {
    * @private
    */
   async _prepare() {
+    if (!this.config.BLOCK_GAS_LIMIT) {
+      const lastBlock = await this._provider.getBlock('latest')
+      this.config.BLOCK_GAS_LIMIT = Math.floor(lastBlock.gasLimit.toNumber() * 0.95)
+    }
+
     if (!this.tx.gasLimit || this.config.ESTIMATE_GAS) {
       const gas = await this._wallet.estimateGas(this.tx)
       if (!this.tx.gasLimit) {
-        this.tx.gasLimit = Math.floor(gas * this.config.GAS_LIMIT_MULTIPLIER)
+        const gasLimit = Math.floor(gas * this.config.GAS_LIMIT_MULTIPLIER)
+        this.tx.gasLimit = Math.min(gasLimit, this.config.BLOCK_GAS_LIMIT)
       }
     }
     if (!this.tx.gasPrice) {
-      this.tx.gasPrice = await this._getGasPrice('fast')
+      const fastGasPrice = BigNumber.from(await this._getGasPrice('fast'))
+      const maxGasPrice = parseUnits(this.config.MAX_GAS_PRICE.toString(), 'gwei')
+      this.tx.gasPrice = min(fastGasPrice, maxGasPrice).toHexString()
     }
     if (!this.manager._nonce) {
       this.manager._nonce = await this._getLastNonce()
@@ -182,6 +193,9 @@ class Transaction {
         this._emitter.emit('confirmations', confirmations)
         if (confirmations >= this.config.CONFIRMATIONS) {
           // Tx is mined and has enough confirmations
+          if (this.config.THROW_ON_REVERT && Number(receipt.status) === 0) {
+            throw new Error('EVM execution failed, so the transaction was reverted.')
+          }
           return receipt
         }
 
@@ -234,7 +248,6 @@ class Transaction {
         }
       }
 
-      console.log('Mined. Start waiting for confirmations...')
       this._emitter.emit('mined', receipt)
       this.currentTxHash = receipt.transactionHash
     }
@@ -266,11 +279,13 @@ class Transaction {
   }
 
   _handleSendError(e) {
-    console.log('Got error', e)
+    if (e.error.error) {
+      // Sometimes ethers wraps known errors, unwrap it in this case
+      e = e.error
+    }
 
-    if (e.code === 'SERVER_ERROR' && e.error) {
+    if (e.error && e.code === 'SERVER_ERROR') {
       const message = e.error.message
-      console.log('Error', e.error.code, e.error.message)
 
       // nonce is too low, trying to increase and resubmit
       if (this._hasError(message, nonceErrors)) {
@@ -287,8 +302,11 @@ class Transaction {
         console.log(
           `Gas price ${formatUnits(this.tx.gasPrice, 'gwei')} gwei is too low, increasing and retrying`,
         )
-        this._increaseGasPrice()
-        return this._send()
+        if (this._increaseGasPrice()) {
+          return this._send()
+        } else {
+          throw new Error('Already at max gas price, but still not enough to submit the transaction')
+        }
       }
 
       if (this._hasError(message, sameTxErrors)) {
@@ -313,17 +331,17 @@ class Transaction {
   }
 
   _increaseGasPrice() {
+    const maxGasPrice = parseUnits(this.config.MAX_GAS_PRICE.toString(), 'gwei')
     const minGweiBump = parseUnits(this.config.MIN_GWEI_BUMP.toString(), 'gwei')
     const oldGasPrice = BigNumber.from(this.tx.gasPrice)
+    if (oldGasPrice.gte(maxGasPrice)) {
+      console.log('Already at max gas price, not bumping')
+      return false
+    }
     const newGasPrice = max(
       oldGasPrice.mul(100 + this.config.GAS_BUMP_PERCENTAGE).div(100),
       oldGasPrice.add(minGweiBump),
     )
-    const maxGasPrice = parseUnits(this.config.MAX_GAS_PRICE.toString(), 'gwei')
-    if (oldGasPrice.eq(maxGasPrice)) {
-      console.log('Already at max gas price, not bumping')
-      return false
-    }
     this.tx.gasPrice = min(newGasPrice, maxGasPrice).toHexString()
     console.log(`Increasing gas price to ${formatUnits(this.tx.gasPrice, 'gwei')} gwei`)
     return true

src/TxManager.js

@@ -13,17 +13,19 @@ const defaultConfig = {
   POLL_INTERVAL: 5000,
   CONFIRMATIONS: 8,
   ESTIMATE_GAS: true,
+  THROW_ON_REVERT: true,
+  BLOCK_GAS_LIMIT: null,
 }
 
 class TxManager {
-  constructor({ privateKey, rpcUrl, broadcastNodes = [], config = {} }) {
+  constructor({ privateKey, rpcUrl, broadcastNodes = [], config = {}, gasPriceOracleConfig = {} }) {
     this.config = Object.assign({ ...defaultConfig }, config)
     this._privateKey = privateKey.startsWith('0x') ? privateKey : '0x' + privateKey
     this._provider = new ethers.providers.JsonRpcProvider(rpcUrl)
     this._wallet = new ethers.Wallet(this._privateKey, this._provider)
     this.address = this._wallet.address
     this._broadcastNodes = broadcastNodes
-    this._gasPriceOracle = new GasPriceOracle({ defaultRpc: rpcUrl })
+    this._gasPriceOracle = new GasPriceOracle({ defaultRpc: rpcUrl, ...gasPriceOracleConfig })
     this._mutex = new Mutex()
     this._nonce = null
   }

test/TxManager.test.js

@@ -10,7 +10,7 @@ describe('TxManager', () => {
     privateKey: PRIVATE_KEY,
     rpcUrl: RPC_URL,
     config: {
-      CONFIRMATIONS: 3,
+      CONFIRMATIONS: 1,
       GAS_BUMP_INTERVAL: 1000 * 15,
     },
   })
@@ -101,5 +101,23 @@ describe('TxManager', () => {
 
       console.log('receipt', receipt)
     })
+    it.only('should send multiple txs', async () => {
+      const genTx = value => ({
+        value,
+        to: '0x0039F22efB07A647557C7C5d17854CFD6D489eF3',
+      })
+      await Promise.all([
+        manager.createTx(genTx(1)).send(),
+        manager.createTx(genTx(2)).send(),
+        manager.createTx(genTx(3)).send(),
+        manager.createTx(genTx(4)).send(),
+        manager.createTx(genTx(5)).send(),
+        manager.createTx(genTx(6)).send(),
+        manager.createTx(genTx(7)).send(),
+        manager.createTx(genTx(8)).send(),
+        manager.createTx(genTx(9)).send(),
+        manager.createTx(genTx(10)).send(),
+      ])
+    })
   })
 })

yarn.lock

@@ -1141,10 +1141,10 @@ functional-red-black-tree@^1.0.1:
   resolved "https://registry.yarnpkg.com/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz#1b0ab3bd553b2a0d6399d29c0e3ea0b252078327"
   integrity sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc=
 
-gas-price-oracle@^0.2.0:
-  version "0.2.0"
-  resolved "https://registry.yarnpkg.com/gas-price-oracle/-/gas-price-oracle-0.2.0.tgz#981926c96089497115113162b03151aacfe44a5a"
-  integrity sha512-2+mMyunV/pMJrmKl/IeEtX860NaE/bQ7H4D8PO2dc0OQd8ZAj/e4WJ+C9F/uOeG3dwm8SEFjofOvcYRHeGxo/Q==
+gas-price-oracle@^0.3.5:
+  version "0.3.5"
+  resolved "https://registry.yarnpkg.com/gas-price-oracle/-/gas-price-oracle-0.3.5.tgz#b7bff364e37fb7f30a2297cb65be80fceb4b8da3"
+  integrity sha512-9NAKzmGgWLjGUc4XsqNJjh0JXthETucijNrkV47FrZIjP8YMzq4jhBvlNeMBt6VVGnr64qjIY2RWb+In7qNsFA==
   dependencies:
     axios "^0.19.2"
     bignumber.js "^9.0.0"