[2.0.0-SNAPSHOT]

GasEstimate added to GasTrackerAPI#estimate

Author: GoodforGod

src/main/java/io/goodforgod/api/etherscan/GasTrackerAPI.java

@@ -1,7 +1,9 @@
 package io.goodforgod.api.etherscan;
 
 import io.goodforgod.api.etherscan.error.EtherScanException;
+import io.goodforgod.api.etherscan.model.GasEstimate;
 import io.goodforgod.api.etherscan.model.GasOracle;
+import io.goodforgod.api.etherscan.model.Wei;
 import org.jetbrains.annotations.NotNull;
 
 /**
@@ -14,7 +16,16 @@
 public interface GasTrackerAPI {
 
     /**
-     * GasOracle details
+     * Returns the estimated time, in seconds, for a transaction to be confirmed on the blockchain.
+     *
+     * @return fast, suggested gas price
+     * @throws EtherScanException parent exception class
+     */
+    @NotNull
+    GasEstimate estimate(@NotNull Wei wei) throws EtherScanException;
+
+    /**
+     * Returns the current Safe, Proposed and Fast gas prices.
      *
      * @return fast, suggested gas price
      * @throws EtherScanException parent exception class

src/main/java/io/goodforgod/api/etherscan/GasTrackerAPIProvider.java

@@ -4,7 +4,10 @@
 import io.goodforgod.api.etherscan.error.EtherScanResponseException;
 import io.goodforgod.api.etherscan.executor.EthHttpClient;
 import io.goodforgod.api.etherscan.manager.RequestQueueManager;
+import io.goodforgod.api.etherscan.model.GasEstimate;
 import io.goodforgod.api.etherscan.model.GasOracle;
+import io.goodforgod.api.etherscan.model.Wei;
+import io.goodforgod.api.etherscan.model.response.GasEstimateResponseTO;
 import io.goodforgod.api.etherscan.model.response.GasOracleResponseTO;
 import org.jetbrains.annotations.NotNull;
 
@@ -18,13 +21,26 @@
 final class GasTrackerAPIProvider extends BasicProvider implements GasTrackerAPI {
 
     private static final String ACT_GAS_ORACLE_PARAM = ACT_PREFIX + "gasoracle";
+    private static final String ACT_GAS_ESTIMATE_PARAM = ACT_PREFIX + "gasestimate";
+
+    private static final String GASPRICE_PARAM = "&gasprice=";
 
     GasTrackerAPIProvider(RequestQueueManager queue,
                           String baseUrl,
                           EthHttpClient ethHttpClient) {
         super(queue, "gastracker", baseUrl, ethHttpClient);
     }
 
+    @Override
+    public @NotNull GasEstimate estimate(@NotNull Wei wei) throws EtherScanException {
+        final String urlParams = ACT_GAS_ESTIMATE_PARAM + GASPRICE_PARAM + wei.getValue().toString();
+        final GasEstimateResponseTO response = getRequest(urlParams, GasEstimateResponseTO.class);
+        if (response.getStatus() != 1)
+            throw new EtherScanResponseException(response);
+
+        return new GasEstimate(Long.parseLong(response.getResult()));
+    }
+
     @NotNull
     @Override
     public GasOracle oracle() throws EtherScanException {

src/main/java/io/goodforgod/api/etherscan/model/GasEstimate.java

@@ -0,0 +1,47 @@
+package io.goodforgod.api.etherscan.model;
+
+import java.time.Duration;
+import java.util.Objects;
+
+/**
+ * @author GoodforGod
+ * @since 14.05.2023
+ */
+public class GasEstimate {
+
+    private final Duration duration;
+
+    public GasEstimate(long durationInSeconds) {
+        this.duration = Duration.ofSeconds(durationInSeconds);
+    }
+
+    public GasEstimate(Duration duration) {
+        this.duration = duration;
+    }
+
+    public Duration getDuration() {
+        return duration;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o)
+            return true;
+        if (!(o instanceof GasEstimate))
+            return false;
+        GasEstimate that = (GasEstimate) o;
+        return Objects.equals(duration, that.duration);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(duration);
+    }
+
+    @Override
+    public String toString() {
+        return "GasEstimate{" +
+                "duration=" + duration +
+                '}';
+    }
+}

src/main/java/io/goodforgod/api/etherscan/model/response/GasEstimateResponseTO.java

@@ -0,0 +1,14 @@
+package io.goodforgod.api.etherscan.model.response;
+
+/**
+ * @author Abhay Gupta
+ * @since 14.11.2022
+ */
+public class GasEstimateResponseTO extends BaseResponseTO {
+
+    private String result;
+
+    public String getResult() {
+        return result;
+    }
+}