Dynamic gas limit for the deployment/configuration transactions

deploy/.env.example

@@ -1,7 +1,7 @@
 #BRIDGE_MODE=ERC_TO_ERC
 BRIDGE_MODE=NATIVE_TO_ERC
 DEPLOYMENT_ACCOUNT_PRIVATE_KEY=67..14
-DEPLOYMENT_GAS_LIMIT=5000000
+DEPLOYMENT_GAS_LIMIT_EXTRA=0.2
 HOME_DEPLOYMENT_GAS_PRICE=10000000000
 FOREIGN_DEPLOYMENT_GAS_PRICE=10000000000
 GET_RECEIPT_INTERVAL_IN_MILLISECONDS=3000

deploy/README.md

@@ -36,8 +36,10 @@ BRIDGE_MODE=NATIVE_TO_ERC
 # deployments and initial configuration. The account's balance must contain
 # funds from both networks.
 DEPLOYMENT_ACCOUNT_PRIVATE_KEY=67..14
-# The "gas" parameter set in every deployment/configuration transaction.
-DEPLOYMENT_GAS_LIMIT=4000000
+# Extra gas added to the estimated gas of a particular deployment/configuration transaction
+# E.g. if estimated gas returns 100000 and the parameter is 0.2, 
+# the transaction gas limit will be (100000 + 100000 * 0.2) = 120000
+DEPLOYMENT_GAS_LIMIT_EXTRA=0.2
 # The "gasPrice" parameter set in every deployment/configuration transaction on
 # Home network (in Wei).
 HOME_DEPLOYMENT_GAS_PRICE=10000000000
@@ -152,8 +154,10 @@ BRIDGE_MODE=ERC_TO_ERC
 # deployments and initial configuration. The account's balance must contain
 # funds from both networks.
 DEPLOYMENT_ACCOUNT_PRIVATE_KEY=67..14
-# The "gas" parameter set in every deployment/configuration transaction.
-DEPLOYMENT_GAS_LIMIT=4000000
+# Extra gas added to the estimated gas of a particular deployment/configuration transaction
+# E.g. if estimated gas returns 100000 and the parameter is 0.2, 
+# the transaction gas limit will be (100000 + 100000 * 0.2) = 120000
+DEPLOYMENT_GAS_LIMIT_EXTRA=0.2
 # The "gasPrice" parameter set in every deployment/configuration transaction on
 # Home network (in Wei).
 HOME_DEPLOYMENT_GAS_PRICE=10000000000
@@ -266,8 +270,10 @@ BRIDGE_MODE=ERC_TO_NATIVE
 # deployments and initial configuration. The account's balance must contain
 # funds from both networks.
 DEPLOYMENT_ACCOUNT_PRIVATE_KEY=67..14
-# The "gas" parameter set in every deployment/configuration transaction.
-DEPLOYMENT_GAS_LIMIT=4000000
+# Extra gas added to the estimated gas of a particular deployment/configuration transaction
+# E.g. if estimated gas returns 100000 and the parameter is 0.2, 
+# the transaction gas limit will be (100000 + 100000 * 0.2) = 120000
+DEPLOYMENT_GAS_LIMIT_EXTRA=0.2
 # The "gasPrice" parameter set in every deployment/configuration transaction on
 # Home network (in Wei).
 HOME_DEPLOYMENT_GAS_PRICE=10000000000

deploy/package.json

@@ -10,6 +10,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
+    "bignumber.js": "^7.2.1",
     "dotenv": "^5.0.1",
     "envalid": "^4.1.4",
     "ethereumjs-tx": "^1.3.4",

deploy/src/deploymentUtils.js

@@ -1,3 +1,4 @@
+const BigNumber = require('bignumber.js')
 const Web3 = require('web3')
 const Tx = require('ethereumjs-tx')
 const Web3Utils = require('web3-utils')
@@ -9,7 +10,7 @@ const {
   deploymentPrivateKey,
   FOREIGN_RPC_URL,
   HOME_RPC_URL,
-  GAS_LIMIT,
+  GAS_LIMIT_EXTRA,
   HOME_DEPLOYMENT_GAS_PRICE,
   FOREIGN_DEPLOYMENT_GAS_PRICE,
   GET_RECEIPT_INTERVAL_IN_MILLISECONDS
@@ -70,10 +71,30 @@ async function sendRawTxForeign(options) {
 
 async function sendRawTx({ data, nonce, to, privateKey, url, gasPrice, value }) {
   try {
+    const  txToEstimateGas = {
+        from: privateKeyToAddress(Web3Utils.bytesToHex(privateKey)),
+        value: value,
+        to,
+        data
+    }
+    const estimatedGas = BigNumber(await sendNodeRequest(url, 'eth_estimateGas', txToEstimateGas))
+
+    const blockData = await sendNodeRequest(url, 'eth_getBlockByNumber', ["latest", false])
+    const blockGasLimit = BigNumber(blockData.gasLimit)
+    if (estimatedGas.isGreaterThan(blockGasLimit)) {
+      throw new Error(`estimated gas greater (${estimatedGas.toString()}) than the block gas limit (${blockGasLimit.toString()})`)
+    }
+    let gas = estimatedGas.multipliedBy(BigNumber(1 + GAS_LIMIT_EXTRA))
+    if (gas.isGreaterThan(blockGasLimit)) {
+      gas = blockGasLimit
+    } else {
+      gas = gas.toFixed(0)
+    }
+
     const rawTx = {
       nonce,
       gasPrice: Web3Utils.toHex(gasPrice),
-      gasLimit: Web3Utils.toHex(GAS_LIMIT),
+      gasLimit: Web3Utils.toHex(gas),
       to,
       data,
       value
@@ -96,6 +117,9 @@ async function sendRawTx({ data, nonce, to, privateKey, url, gasPrice, value })
 }
 
 async function sendNodeRequest(url, method, signedData) {
+  if (! Array.isArray(signedData)) {
+    signedData = [signedData]
+  }
   const request = await fetch(url, {
     headers: {
       'Content-type': 'application/json'
@@ -104,15 +128,19 @@ async function sendNodeRequest(url, method, signedData) {
     body: JSON.stringify({
       jsonrpc: '2.0',
       method,
-      params: [signedData],
+      params: signedData,
       id: 1
     })
   })
   const json = await request.json()
+  if (typeof json.error === 'undefined' || json.error === null) {
   if (method === 'eth_sendRawTransaction') {
     assert.strictEqual(json.result.length, 66, `Tx wasn't sent ${json}`)
   }
   return json.result
+  } else {
+    throw new Error(`web3 RPC failed: ${JSON.stringify(json.error)}`)
+  }
 }
 
 function timeout(ms) {

deploy/src/loadEnv.js

@@ -30,7 +30,7 @@ if (!validBridgeModes.includes(BRIDGE_MODE)) {
 
 let validations = {
   DEPLOYMENT_ACCOUNT_PRIVATE_KEY: envalid.str(),
-  DEPLOYMENT_GAS_LIMIT: bigNumValidator(),
+  DEPLOYMENT_GAS_LIMIT_EXTRA: envalid.num(),
   HOME_DEPLOYMENT_GAS_PRICE: bigNumValidator(),
   FOREIGN_DEPLOYMENT_GAS_PRICE: bigNumValidator(),
   GET_RECEIPT_INTERVAL_IN_MILLISECONDS: bigNumValidator(),

deploy/src/web3.js

@@ -15,7 +15,7 @@ const foreignProvider = new Web3.providers.HttpProvider(FOREIGN_RPC_URL)
 const web3Foreign = new Web3(foreignProvider)
 
 const { HOME_DEPLOYMENT_GAS_PRICE, FOREIGN_DEPLOYMENT_GAS_PRICE } = env
-const GAS_LIMIT = env.DEPLOYMENT_GAS_LIMIT
+const GAS_LIMIT_EXTRA = env.DEPLOYMENT_GAS_LIMIT_EXTRA
 
 const deploymentPrivateKey = Buffer.from(DEPLOYMENT_ACCOUNT_PRIVATE_KEY, 'hex')
 
@@ -25,7 +25,7 @@ module.exports = {
   deploymentPrivateKey,
   HOME_RPC_URL,
   FOREIGN_RPC_URL,
-  GAS_LIMIT,
+  GAS_LIMIT_EXTRA,
   HOME_DEPLOYMENT_GAS_PRICE,
   FOREIGN_DEPLOYMENT_GAS_PRICE,
   GET_RECEIPT_INTERVAL_IN_MILLISECONDS