feat: refactor method to check if wallet has enough gas (#165)

Author: jbern0rd

src/main/java/com/iexec/commons/poco/chain/IexecHubAbstractService.java

@@ -33,6 +33,7 @@
 import org.web3j.utils.Numeric;
 
 import java.io.IOException;
+import java.math.BigDecimal;
 import java.math.BigInteger;
 import java.util.Map;
 import java.util.Optional;
@@ -68,6 +69,7 @@ public abstract class IexecHubAbstractService {
     private final int maxRetries;
     private final Map<Long, ChainCategory> categories = new ConcurrentHashMap<>();
     private final Map<String, TaskDescription> taskDescriptions = new ConcurrentHashMap<>();
+    private BigInteger lastKnownBalance = BigInteger.ZERO;
 
     protected IexecHubAbstractService(
             Credentials credentials,
@@ -444,6 +446,40 @@ private void setMaxNbOfPeriodsForConsensus() {
         }
     }
 
+    public boolean hasEnoughGas() {
+        // if a sidechain is used, there is no need to check if the wallet has enough gas.
+        // if mainnet is used, the check should be done.
+        if (web3jAbstractService.isSidechain()) {
+            return true;
+        }
+
+        final Optional<BigInteger> oWeiBalance = web3jAbstractService.getBalance(credentials.getAddress());
+        if (oWeiBalance.isEmpty()) {
+            log.warn("ETH balance not retrieved on chain, falling back on last known balance");
+        }
+
+        final BigInteger weiBalance = oWeiBalance.orElse(lastKnownBalance);
+        // preserve last known balance for future checks
+        lastKnownBalance = weiBalance;
+        final BigInteger estimateTxNb = weiBalance.divide(web3jAbstractService.getMaxTxCost());
+        final BigDecimal balanceToShow = ChainUtils.weiToEth(weiBalance);
+
+        if (estimateTxNb.compareTo(BigInteger.ONE) < 0) {
+            log.error("ETH balance is empty, please refill gas now [balance:{}, estimateTxNb:{}]", balanceToShow, estimateTxNb);
+            return false;
+        } else if (estimateTxNb.compareTo(BigInteger.TEN) < 0) {
+            log.warn("ETH balance very low, should refill gas now [balance:{}, estimateTxNb:{}]", balanceToShow, estimateTxNb);
+        } else {
+            log.debug("ETH balance is fine [balance:{}, estimateTxNb:{}]", balanceToShow, estimateTxNb);
+        }
+
+        return true;
+    }
+
+    /**
+     * @deprecated Use hasEnoughGas() instead
+     */
+    @Deprecated(forRemoval = true)
     public boolean hasEnoughGas(String address) {
         return web3jAbstractService.hasEnoughGas(address);
     }

src/main/java/com/iexec/commons/poco/chain/Web3jAbstractService.java

@@ -62,6 +62,7 @@ public abstract class Web3jAbstractService {
     private final Duration blockTime;
     private final float gasPriceMultiplier;
     private final long gasPriceCap;
+    @Getter
     private final boolean isSidechain;
     @Getter
     private final Web3j web3j;
@@ -121,6 +122,10 @@ public boolean isConnected() {
         return false;
     }
 
+    /**
+     * @deprecated only used from deprecated method
+     */
+    @Deprecated(forRemoval = true)
     public static BigInteger getMaxTxCost(long gasPriceCap) {
         return BigInteger.valueOf(GAS_LIMIT_CAP * gasPriceCap);
     }
@@ -240,6 +245,10 @@ private void decodeAndThrowEvmRpcError(final Response.Error error) {
         throw new JsonRpcError(error.getCode(), message, null);
     }
 
+    /**
+     * @deprecated Use IexecHubAbstractService#hasEnoughGas() instead
+     */
+    @Deprecated(forRemoval = true)
     public boolean hasEnoughGas(String address) {
         // if a sidechain is used, there is no need to check if the wallet has enough gas.
         // if mainnet is used, the check should be done.
@@ -268,9 +277,9 @@ public boolean hasEnoughGas(String address) {
         return true;
     }
 
-    public Optional<BigInteger> getBalance(String address) {
+    public Optional<BigInteger> getBalance(final String address) {
         try {
-            BigInteger balance = web3j.ethGetBalance(address, DefaultBlockParameterName.LATEST).send().getBalance();
+            final BigInteger balance = web3j.ethGetBalance(address, DefaultBlockParameterName.LATEST).send().getBalance();
             log.debug("{} current balance is {}", address, balance);
             return Optional.of(balance);
         } catch (IOException e) {
@@ -279,6 +288,10 @@ public Optional<BigInteger> getBalance(String address) {
         }
     }
 
+    public BigInteger getMaxTxCost() {
+        return BigInteger.valueOf(GAS_LIMIT_CAP * gasPriceCap);
+    }
+
     /**
      * Request current gas price on the network.
      * <p>

src/test/java/com/iexec/commons/poco/itest/ChainTests.java

@@ -29,6 +29,7 @@
 import org.testcontainers.junit.jupiter.Container;
 import org.testcontainers.junit.jupiter.Testcontainers;
 import org.web3j.crypto.Credentials;
+import org.web3j.crypto.Keys;
 import org.web3j.crypto.WalletUtils;
 import org.web3j.crypto.exception.CipherException;
 
@@ -81,6 +82,26 @@ void shouldGetAccount() {
         assertThat(chainAccount.getLocked()).isZero();
     }
 
+    @Test
+    void shouldHaveEnoughGasOnBellecour() {
+        assertThat(iexecHubService.hasEnoughGas()).isTrue();
+    }
+
+    @Test
+    void shouldHaveEnoughGasOnArbitrum() throws IOException {
+        final Web3jTestService arbitrumWeb3j = new Web3jTestService(chainNodeAddress, 1.0f, 22_000_000_000L, false);
+        final IexecHubTestService arbitrumHub = new IexecHubTestService(credentials, arbitrumWeb3j);
+        assertThat(arbitrumHub.hasEnoughGas()).isTrue();
+    }
+
+    @Test
+    void shouldNotHaveEnoughGasOnArbitrum() throws Exception {
+        final Credentials newCredentials = Credentials.create(Keys.createEcKeyPair());
+        final Web3jTestService arbitrumWeb3j = new Web3jTestService(chainNodeAddress, 1.0f, 22_000_000_000L, false);
+        final IexecHubTestService arbitrumHub = new IexecHubTestService(newCredentials, arbitrumWeb3j);
+        assertThat(arbitrumHub.hasEnoughGas()).isFalse();
+    }
+
     @Test
     void shouldGetBalance() {
         final BigInteger balance = web3jService.getBalance(credentials.getAddress()).orElse(null);

src/test/java/com/iexec/commons/poco/itest/Web3jTestService.java

@@ -42,7 +42,11 @@ public Web3jTestService(String chainNodeAddress) {
     }
 
     public Web3jTestService(String chainNodeAddress, float gasPriceMultiplier, long gasPriceCap) {
-        super(65535, chainNodeAddress, Duration.ofSeconds(BLOCK_TIME), gasPriceMultiplier, gasPriceCap, true);
+        this(chainNodeAddress, gasPriceMultiplier, gasPriceCap, true);
+    }
+
+    public Web3jTestService(String chainNodeAddress, float gasPriceMultiplier, long gasPriceCap, boolean isSidechain) {
+        super(65535, chainNodeAddress, Duration.ofSeconds(BLOCK_TIME), gasPriceMultiplier, gasPriceCap, isSidechain);
     }
 
     @SneakyThrows