fix: estimate gas before sending transactions to avoid intrinsic gas too low errors

jbern0rd · jbern0rd · commit a9f7e2b2c1aa · 2025-09-10T18:39:22.000+02:00
diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@ To run properly, the iExec Blockchain Adapter API requires:
 | `IEXEC_HUB_ADDRESS`                                     | Proxy contract address to interact with the iExec on-chain protocol.                                   | Ethereum Address | `0x3eca1B216A7DF1C7689aEb259fFB83ADFB894E7f` |
 | `IEXEC_GAS_PRICE_MULTIPLIER`                            | Transactions will be sent with `networkGasPrice * gasPriceMultiplier`.                                 | Float            | `1.0`                                        |
 | `IEXEC_GAS_PRICE_CAP`                                   | In Wei, will be used for transactions if `networkGasPrice * gasPriceMultiplier > gasPriceCap`.         | Positive integer | `22000000000`                                |
-| `IEXEC_BLOCKCHAIN_ADAPTER_API_MAX_ALLOWED_TX_PER_BLOCK` | Max number of transactions per block, between `1` and `4`.                                             | Positive integer | `1`                                          |
+| `IEXEC_BLOCKCHAIN_ADAPTER_API_MAX_ALLOWED_TX_PER_BLOCK` | Max number of transactions per block, between `1` and `8`.                                             | Positive integer | `1`                                          |
 | `IEXEC_BLOCKCHAIN_ADAPTER_API_WALLET_PATH`              | Path to the wallet of the server.                                                                      | String           | `src/main/resources/wallet.json`             |
 | `IEXEC_BLOCKCHAIN_ADAPTER_API_WALLET_PASSWORD`          | Password to unlock the wallet of the server.                                                           | String           | `whatever`                                   |
 
diff --git a/gradle.properties b/gradle.properties
@@ -1,8 +1,8 @@
 # x-release-please-start-version
 version=9.0.1
 # x-release-please-end
-iexecCommonVersion=9.0.0
-iexecCommonsPocoVersion=5.0.0
+iexecCommonsPocoVersion=5.1.0
+iexecCommonVersion=9.1.0
 
 nexusUser
 nexusPassword
diff --git a/src/main/java/com/iexec/blockchain/chain/ChainConfig.java b/src/main/java/com/iexec/blockchain/chain/ChainConfig.java
@@ -61,7 +61,7 @@ public class ChainConfig {
     long gasPriceCap;
 
     @Positive(message = "Max allowed tx per block must be greater than 0")
-    @Max(value = 4, message = "Max allowed tx per block must be less or equal to 4")
+    @Max(value = 8, message = "Max allowed tx per block must be less or equal to 8")
     int maxAllowedTxPerBlock;
 
 }
diff --git a/src/main/java/com/iexec/blockchain/chain/IexecHubService.java b/src/main/java/com/iexec/blockchain/chain/IexecHubService.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2024 IEXEC BLOCKCHAIN TECH
+ * Copyright 2020-2025 IEXEC BLOCKCHAIN TECH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,24 +16,36 @@
 
 package com.iexec.blockchain.chain;
 
+import com.iexec.blockchain.command.generic.SubmittedTx;
 import com.iexec.commons.poco.chain.*;
+import com.iexec.commons.poco.encoding.PoCoDataEncoder;
 import com.iexec.commons.poco.utils.BytesUtils;
 import com.iexec.commons.poco.utils.HashUtils;
+import io.micrometer.core.instrument.Counter;
+import io.micrometer.core.instrument.Metrics;
+import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.stereotype.Service;
 import org.web3j.protocol.core.methods.response.TransactionReceipt;
+import org.web3j.protocol.exceptions.TransactionException;
 
+import java.io.IOException;
 import java.math.BigInteger;
 import java.nio.charset.StandardCharsets;
-import java.time.Instant;
-import java.time.temporal.ChronoUnit;
 import java.util.Date;
 
 import static com.iexec.commons.poco.utils.BytesUtils.stringToBytes;
 
+@Slf4j
 @Service
 public class IexecHubService extends IexecHubAbstractService {
 
+    private final ChainConfig chainConfig;
+    private final SignerService signerService;
+    private final Web3jService web3jService;
+    private final Counter failureCounter = Metrics.counter("iexec.poco.transaction", "status", "failure");
+    private final Counter successCounter = Metrics.counter("iexec.poco.transaction", "status", "success");
+
     public IexecHubService(final SignerService signerService,
                            final Web3jService web3jService,
                            final ChainConfig chainConfig) {
@@ -42,6 +54,9 @@ public IexecHubService(final SignerService signerService,
                 web3jService,
                 chainConfig.getHubAddress()
         );
+        this.chainConfig = chainConfig;
+        this.signerService = signerService;
+        this.web3jService = web3jService;
     }
 
     public static boolean isByte32(final String hexString) {
@@ -51,12 +66,9 @@ public static boolean isByte32(final String hexString) {
 
     public TransactionReceipt initializeTask(final String chainDealId,
                                              final int taskIndex) throws Exception {
-        addLatency();
-        return iexecHubContract
-                .initialize(
-                        stringToBytes(chainDealId),
-                        BigInteger.valueOf(taskIndex))
-                .send();
+        final String txData = PoCoDataEncoder.encodeInitialize(chainDealId, taskIndex);
+        final SubmittedTx submittedTx = submit("initialize", txData);
+        return waitForTxMined(submittedTx);
     }
 
     public TransactionReceipt contribute(final String chainTaskId,
@@ -67,59 +79,64 @@ public TransactionReceipt contribute(final String chainTaskId,
         final String resultHash = HashUtils.concatenateAndHash(chainTaskId, resultDigest);
         final String resultSeal = HashUtils.concatenateAndHash(credentials.getAddress(), chainTaskId, resultDigest);
 
-        return iexecHubContract
-                .contribute(
-                        stringToBytes(chainTaskId),
-                        stringToBytes(resultHash),
-                        stringToBytes(resultSeal),
-                        enclaveChallenge,
-                        stringToBytes(enclaveSignature),
-                        stringToBytes(workerpoolSignature))
-                .send();
+        final String txData = PoCoDataEncoder.encodeContribute(
+                chainTaskId, resultHash, resultSeal, enclaveChallenge, enclaveSignature, workerpoolSignature);
+        final SubmittedTx submittedTx = submit("contribute", txData);
+        return waitForTxMined(submittedTx);
     }
 
 
     public TransactionReceipt reveal(final String chainTaskId,
                                      final String resultDigest) throws Exception {
-        return iexecHubContract
-                .reveal(
-                        stringToBytes(chainTaskId),
-                        stringToBytes(resultDigest))
-                .send();
+        final String txData = PoCoDataEncoder.encodeReveal(chainTaskId, resultDigest);
+        final SubmittedTx submittedTx = submit("reveal", txData);
+        return waitForTxMined(submittedTx);
     }
 
     public TransactionReceipt finalizeTask(final String chainTaskId,
                                            final String resultLink,
                                            final String callbackData) throws Exception {
-        addLatency();
-        byte[] results = StringUtils.isNotEmpty(resultLink) ?
+        final byte[] results = StringUtils.isNotEmpty(resultLink) ?
                 resultLink.getBytes(StandardCharsets.UTF_8) : new byte[0];
-        byte[] resultsCallback = StringUtils.isNotEmpty(callbackData) ?
+        final byte[] resultsCallback = StringUtils.isNotEmpty(callbackData) ?
                 stringToBytes(callbackData) : new byte[0];
 
-        return iexecHubContract
-                .finalize(
-                        stringToBytes(chainTaskId),
-                        results,
-                        resultsCallback)
-                .send();
+        final String txData = PoCoDataEncoder.encodeFinalize(chainTaskId, results, resultsCallback);
+        final SubmittedTx submittedTx = submit("finalize", txData);
+        return waitForTxMined(submittedTx);
     }
 
     /**
-     * Synchronized sleep to ensure several transactions will never be sent in the same time interval.
+     * Submits the transaction to the blockchain network mem-pool.
      * <p>
-     * This synchronized sleep is required for nonce computation on pending block.
+     * This method can be {@code synchronized} as there is only a single {@code IexecHubService} instance.
      * When a first transaction will be emitted, it will be emitted and registered on the pending block.
      * After a latency, a second transaction can be sent on the pending block and the nonce will be computed successfully.
      * With a correct nonce, it becomes possible to perform several transactions from the same wallet in the same block.
-     *
-     * @throws InterruptedException if the calling thread is interrupted
      */
-    private synchronized void addLatency() throws InterruptedException {
-        final long deadline = Instant.now().plus(1L, ChronoUnit.SECONDS).toEpochMilli();
-        while (Instant.now().toEpochMilli() < deadline) {
-            wait(deadline - Instant.now().toEpochMilli());
+    private synchronized SubmittedTx submit(final String function, final String txData) throws IOException {
+        final BigInteger nonce = signerService.getNonce();
+        final BigInteger gasLimit = switch (function) {
+            case "initialize" -> signerService.estimateGas(chainConfig.getHubAddress(), txData);
+            case "finalize" -> signerService.estimateGas(chainConfig.getHubAddress(), txData).add(getCallbackGas());
+            default -> PoCoDataEncoder.getGasLimitForFunction(function);
+        };
+        final String txHash = signerService.signAndSendTransaction(
+                nonce, web3jService.getUserGasPrice(), gasLimit, chainConfig.getHubAddress(), txData);
+        log.info("Transaction submitted [nonce:{}, hash:{}]", nonce, txHash);
+        return new SubmittedTx(nonce, gasLimit, txData, txHash);
+    }
+
+    private TransactionReceipt waitForTxMined(final SubmittedTx submittedTx) throws IOException, TransactionException {
+        final TransactionReceipt receipt = txReceiptProcessor.waitForTransactionReceipt(submittedTx.hash());
+        log.info("Transaction receipt [nonce:{}, hash:{}, status:{}, revert-reason:{}]",
+                submittedTx.nonce(), submittedTx.hash(), receipt.getStatus(), receipt.getRevertReason());
+        if (!receipt.isStatusOK()) {
+            failureCounter.increment();
+        } else {
+            successCounter.increment();
         }
+        return receipt;
     }
 
     public boolean hasEnoughGas() {
diff --git a/src/main/java/com/iexec/blockchain/command/generic/SubmittedTx.java b/src/main/java/com/iexec/blockchain/command/generic/SubmittedTx.java
@@ -0,0 +1,22 @@
+/*
+ * Copyright 2025 IEXEC BLOCKCHAIN TECH
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.iexec.blockchain.command.generic;
+
+import java.math.BigInteger;
+
+public record SubmittedTx(BigInteger nonce, BigInteger gasLimit, String txData, String hash) {
+}
diff --git a/src/main/java/com/iexec/blockchain/command/task/finalize/TaskFinalizeBlockchainService.java b/src/main/java/com/iexec/blockchain/command/task/finalize/TaskFinalizeBlockchainService.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2024 IEXEC BLOCKCHAIN TECH
+ * Copyright 2020-2025 IEXEC BLOCKCHAIN TECH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -32,12 +32,12 @@ public class TaskFinalizeBlockchainService implements CommandBlockchain<TaskFina
 
     private final IexecHubService iexecHubService;
 
-    public TaskFinalizeBlockchainService(IexecHubService iexecHubService) {
+    public TaskFinalizeBlockchainService(final IexecHubService iexecHubService) {
         this.iexecHubService = iexecHubService;
     }
 
     @Override
-    public boolean canSendBlockchainCommand(TaskFinalizeArgs args) {
+    public boolean canSendBlockchainCommand(final TaskFinalizeArgs args) {
         final String chainTaskId = args.getChainTaskId();
         final ChainTask chainTask = iexecHubService.getChainTask(chainTaskId).orElse(null);
         if (chainTask == null) {
@@ -62,13 +62,13 @@ public boolean canSendBlockchainCommand(TaskFinalizeArgs args) {
         return true;
     }
 
-    private void logError(String chainTaskId, TaskFinalizeArgs args, String error) {
-        log.error("Finalize task blockchain call is likely to revert ({}) " +
-                "[chainTaskId:{}, args:{}]", error, chainTaskId, args);
+    private void logError(final String chainTaskId, final TaskFinalizeArgs args, final String error) {
+        log.error("Finalize task blockchain call is likely to revert ({}) [chainTaskId:{}, args:{}]",
+                error, chainTaskId, args);
     }
 
     @Override
-    public TransactionReceipt sendBlockchainCommand(TaskFinalizeArgs args) throws Exception {
+    public TransactionReceipt sendBlockchainCommand(final TaskFinalizeArgs args) throws Exception {
         return iexecHubService.finalizeTask(args.getChainTaskId(),
                 args.getResultLink(),
                 args.getCallbackData());
diff --git a/src/main/java/com/iexec/blockchain/command/task/initialize/TaskInitializeBlockchainService.java b/src/main/java/com/iexec/blockchain/command/task/initialize/TaskInitializeBlockchainService.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2024 IEXEC BLOCKCHAIN TECH
+ * Copyright 2020-2025 IEXEC BLOCKCHAIN TECH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -28,12 +28,12 @@ public class TaskInitializeBlockchainService implements CommandBlockchain<TaskIn
 
     private final IexecHubService iexecHubService;
 
-    public TaskInitializeBlockchainService(IexecHubService iexecHubService) {
+    public TaskInitializeBlockchainService(final IexecHubService iexecHubService) {
         this.iexecHubService = iexecHubService;
     }
 
     @Override
-    public boolean canSendBlockchainCommand(TaskInitializeArgs args) {
+    public boolean canSendBlockchainCommand(final TaskInitializeArgs args) {
         String chainTaskId = args.getChainTaskId();
         if (!iexecHubService.hasEnoughGas()) {
             logError(chainTaskId, args, "task is not revealing");
@@ -50,13 +50,13 @@ public boolean canSendBlockchainCommand(TaskInitializeArgs args) {
         return true;
     }
 
-    private void logError(String chainTaskId, TaskInitializeArgs args, String error) {
-        log.error("Initialize task blockchain call is likely to revert ({}) " +
-                "[chainTaskId:{}, args:{}]", error, chainTaskId, args);
+    private void logError(final String chainTaskId, final TaskInitializeArgs args, final String error) {
+        log.error("Initialize task blockchain call is likely to revert ({}) [chainTaskId:{}, args:{}]",
+                error, chainTaskId, args);
     }
 
     @Override
-    public TransactionReceipt sendBlockchainCommand(TaskInitializeArgs args) throws Exception {
+    public TransactionReceipt sendBlockchainCommand(final TaskInitializeArgs args) throws Exception {
         return iexecHubService.initializeTask(args.getChainDealId(), args.getTaskIndex());
     }
 
diff --git a/src/test/java/com/iexec/blockchain/chain/BlockchainListenerTests.java b/src/test/java/com/iexec/blockchain/chain/BlockchainListenerTests.java
@@ -57,8 +57,8 @@ class BlockchainListenerTests {
     @DynamicPropertySource
     static void registerProperties(DynamicPropertyRegistry registry) {
         registry.add("chain.id", () -> "65535");
-        registry.add("chain.hubAddress", () -> "0xc4b11f41746D3Ad8504da5B383E1aB9aa969AbC7");
-        registry.add("chain.nodeAddress", () -> getServiceUrl(
+        registry.add("chain.hub-address", () -> "0xc4b11f41746D3Ad8504da5B383E1aB9aa969AbC7");
+        registry.add("chain.node-address", () -> getServiceUrl(
                 environment.getServiceHost(CHAIN_SVC_NAME, CHAIN_SVC_PORT),
                 environment.getServicePort(CHAIN_SVC_NAME, CHAIN_SVC_PORT)));
         registry.add("sprint.data.mongodb.host", () -> environment.getServiceHost(MONGO_SVC_NAME, MONGO_SVC_PORT));
diff --git a/src/test/java/com/iexec/blockchain/chain/IexecHubServiceTests.java b/src/test/java/com/iexec/blockchain/chain/IexecHubServiceTests.java

Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public class ChainConfig {`
`61`	`61`	`long gasPriceCap;`
`62`	`62`
`63`	`63`	`@Positive(message = "Max allowed tx per block must be greater than 0")`
`64`		`- @Max(value = 4, message = "Max allowed tx per block must be less or equal to 4")`
	`64`	`+ @Max(value = 8, message = "Max allowed tx per block must be less or equal to 8")`
`65`	`65`	`int maxAllowedTxPerBlock;`
`66`	`66`
`67`	`67`	`}`