[2.0.0-SNAPSHOT]

GasTrackerAPI refactored to new API
EthHttpClient package refactoring

Author: GoodforGod

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

@@ -112,21 +112,21 @@ public interface AccountAPI {
     /**
      * All ERC-20 token txs for given address and contract address
      *
-     * @param address    get txs for
+     * @param address         get txs for
      * @param contractAddress contract address to get txs for
-     * @param startBlock tx from this blockNumber
-     * @param endBlock   tx to this blockNumber
+     * @param startBlock      tx from this blockNumber
+     * @param endBlock        tx to this blockNumber
      * @return txs for address
-     * @throws ApiException parent exception class
+     * @throws EtherScanException parent exception class
      */
     @NotNull
-    List<TxToken> txsToken(String address, String contractAddress, long startBlock, long endBlock) throws ApiException;
+    List<TxERC20> txsERC20(String address, String contractAddress, long startBlock, long endBlock) throws EtherScanException;
 
     @NotNull
-    List<TxToken> txsToken(String address, String contractAddress, long startBlock) throws ApiException;
+    List<TxERC20> txsERC20(String address, String contractAddress, long startBlock) throws EtherScanException;
 
     @NotNull
-    List<TxToken> txsToken(String address, String contractAddress) throws ApiException;
+    List<TxERC20> txsERC20(String address, String contractAddress) throws EtherScanException;
 
     /**
      * All ERC-721 (NFT) token txs for given address

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

@@ -234,19 +234,20 @@ public List<TxERC20> txsERC20(String address, long startBlock, long endBlock) th
 
     @NotNull
     @Override
-    public List<TxToken> txsToken(final String address, final String contractAddress) throws ApiException {
-        return txsToken(address, contractAddress, MIN_START_BLOCK);
+    public List<TxERC20> txsERC20(String address, String contractAddress) throws EtherScanException {
+        return txsERC20(address, contractAddress, MIN_START_BLOCK);
     }
 
     @NotNull
     @Override
-    public List<TxToken> txsToken(final String address, final String contractAddress, final long startBlock) throws ApiException {
-        return txsToken(address, contractAddress, startBlock, MAX_END_BLOCK);
+    public List<TxERC20> txsERC20(String address, String contractAddress, long startBlock) throws EtherScanException {
+        return txsERC20(address, contractAddress, startBlock, MAX_END_BLOCK);
     }
 
     @NotNull
     @Override
-    public List<TxToken> txsToken(final String address, final String contractAddress, final long startBlock, final long endBlock) throws ApiException {
+    public List<TxERC20> txsERC20(String address, String contractAddress, long startBlock, long endBlock)
+            throws EtherScanException {
         BasicUtils.validateAddress(address);
         final BlockParam blocks = BasicUtils.compensateBlocks(startBlock, endBlock);
 
@@ -255,7 +256,7 @@ public List<TxToken> txsToken(final String address, final String contractAddress
         final String urlParams = ACT_TX_TOKEN_ACTION + offsetParam + ADDRESS_PARAM + address
                 + CONTRACT_PARAM + contractAddress + blockParam + SORT_ASC_PARAM;
 
-        return getRequestUsingOffset(urlParams, TxTokenResponseTO.class);
+        return getRequestUsingOffset(urlParams, TxERC20ResponseTO.class);
     }
 
     @NotNull

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

@@ -32,14 +32,14 @@ abstract class BasicProvider {
     private final RequestQueueManager queue;
     private final Gson gson;
 
-    BasicProvider(RequestQueueManager queue,
+    BasicProvider(RequestQueueManager requestQueueManager,
                   String module,
                   String baseUrl,
-                  EthHttpClient executor) {
-        this.queue = queue;
+                  EthHttpClient ethHttpClient) {
+        this.queue = requestQueueManager;
         this.module = "&module=" + module;
         this.baseUrl = baseUrl;
-        this.executor = executor;
+        this.executor = ethHttpClient;
         this.gson = new GsonConfiguration().builder().create();
     }
 

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

@@ -34,6 +34,10 @@ public interface EtherScanAPI extends AutoCloseable {
     @NotNull
     StatisticAPI stats();
 
+    @NotNull
+    GasTrackerAPI gasTracker();
+
+    @NotNull
     static Builder builder() {
         return new EthScanAPIBuilder();
     }

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

@@ -21,23 +21,25 @@ final class EtherScanAPIProvider implements EtherScanAPI {
     private final ProxyAPI proxy;
     private final StatisticAPI stats;
     private final TransactionAPI txs;
+    private final GasTrackerAPI gasTracker;
 
     EtherScanAPIProvider(String apiKey,
                          EthNetwork network,
                          Supplier<EthHttpClient> executorSupplier,
                          RequestQueueManager queue) {
         // EtherScan 1request\5sec limit support by queue manager
-        final EthHttpClient executor = executorSupplier.get();
+        final EthHttpClient ethHttpClient = executorSupplier.get();
         final String baseUrl = network.domain() + "?apikey=" + apiKey;
 
         this.requestQueueManager = queue;
-        this.account = new AccountAPIProvider(queue, baseUrl, executor);
-        this.block = new BlockAPIProvider(queue, baseUrl, executor);
-        this.contract = new ContractAPIProvider(queue, baseUrl, executor);
-        this.logs = new LogsAPIProvider(queue, baseUrl, executor);
-        this.proxy = new ProxyAPIProvider(queue, baseUrl, executor);
-        this.stats = new StatisticAPIProvider(queue, baseUrl, executor);
-        this.txs = new TransactionAPIProvider(queue, baseUrl, executor);
+        this.account = new AccountAPIProvider(queue, baseUrl, ethHttpClient);
+        this.block = new BlockAPIProvider(queue, baseUrl, ethHttpClient);
+        this.contract = new ContractAPIProvider(queue, baseUrl, ethHttpClient);
+        this.logs = new LogsAPIProvider(queue, baseUrl, ethHttpClient);
+        this.proxy = new ProxyAPIProvider(queue, baseUrl, ethHttpClient);
+        this.stats = new StatisticAPIProvider(queue, baseUrl, ethHttpClient);
+        this.txs = new TransactionAPIProvider(queue, baseUrl, ethHttpClient);
+        this.gasTracker = new GasTrackerAPIProvider(queue, baseUrl, ethHttpClient);
     }
 
     @NotNull
@@ -82,6 +84,11 @@ public StatisticAPI stats() {
         return stats;
     }
 
+    @Override
+    public @NotNull GasTrackerAPI gasTracker() {
+        return gasTracker;
+    }
+
     @Override
     public void close() throws Exception {
         requestQueueManager.close();

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

@@ -0,0 +1,24 @@
+package io.goodforgod.api.etherscan;
+
+import io.goodforgod.api.etherscan.error.EtherScanException;
+import io.goodforgod.api.etherscan.model.GasOracle;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * EtherScan - API Descriptions
+ * <a href="https://docs.etherscan.io/api-endpoints/gas-tracker">...</a>
+ *
+ * @author Abhay Gupta
+ * @since 14.11.2022
+ */
+public interface GasTrackerAPI {
+
+    /**
+     * GasOracle details
+     *
+     * @return fast, suggested gas price
+     * @throws EtherScanException parent exception class
+     */
+    @NotNull
+    GasOracle oracle() throws EtherScanException;
+}

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

@@ -0,0 +1,37 @@
+package io.goodforgod.api.etherscan;
+
+import io.goodforgod.api.etherscan.error.EtherScanException;
+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.GasOracle;
+import io.goodforgod.api.etherscan.model.response.GasOracleResponseTO;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * GasTracker API Implementation
+ *
+ * @see GasTrackerAPI
+ * @author Abhay Gupta
+ * @since 14.11.2022
+ */
+final class GasTrackerAPIProvider extends BasicProvider implements GasTrackerAPI {
+
+    private static final String ACT_GAS_ORACLE_PARAM = ACT_PREFIX + "gasoracle";
+
+    GasTrackerAPIProvider(RequestQueueManager queue,
+                          String baseUrl,
+                          EthHttpClient ethHttpClient) {
+        super(queue, "gastracker", baseUrl, ethHttpClient);
+    }
+
+    @NotNull
+    @Override
+    public GasOracle oracle() throws EtherScanException {
+        final GasOracleResponseTO response = getRequest(ACT_GAS_ORACLE_PARAM, GasOracleResponseTO.class);
+        if (response.getStatus() != 1)
+            throw new EtherScanResponseException(response);
+
+        return response.getResult();
+    }
+}

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

@@ -1,7 +1,6 @@
 package io.goodforgod.api.etherscan.model;
 
 import io.goodforgod.api.etherscan.util.BasicUtils;
-
 import java.math.BigInteger;
 import java.util.List;
 

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

@@ -1,15 +1,14 @@
-package io.api.etherscan.model;
+package io.goodforgod.api.etherscan.model;
 
 import java.math.BigInteger;
 import java.util.Objects;
 
 /**
- * ! NO DESCRIPTION !
- *
  * @author Abhay Gupta
  * @since 14.11.2022
  */
 public class GasOracle {
+
     private Long LastBlock;
     private Integer SafeGasPrice;
     private Integer ProposeGasPrice;
@@ -43,10 +42,14 @@ public String getGasUsedRatio() {
 
     @Override
     public boolean equals(Object o) {
-        if (this == o) return true;
-        if (o == null || getClass() != o.getClass()) return false;
+        if (this == o)
+            return true;
+        if (o == null || getClass() != o.getClass())
+            return false;
         GasOracle gasOracle = (GasOracle) o;
-        return LastBlock.equals(gasOracle.LastBlock) && SafeGasPrice.equals(gasOracle.SafeGasPrice) && ProposeGasPrice.equals(gasOracle.ProposeGasPrice) && FastGasPrice.equals(gasOracle.FastGasPrice) && suggestBaseFee.equals(gasOracle.suggestBaseFee) && gasUsedRatio.equals(gasOracle.gasUsedRatio);
+        return LastBlock.equals(gasOracle.LastBlock) && SafeGasPrice.equals(gasOracle.SafeGasPrice)
+                && ProposeGasPrice.equals(gasOracle.ProposeGasPrice) && FastGasPrice.equals(gasOracle.FastGasPrice)
+                && suggestBaseFee.equals(gasOracle.suggestBaseFee) && gasUsedRatio.equals(gasOracle.gasUsedRatio);
     }
 
     @Override

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

@@ -1,10 +1,8 @@
-package io.api.etherscan.model.utility;
+package io.goodforgod.api.etherscan.model.response;
 
-import io.api.etherscan.model.GasOracle;
+import io.goodforgod.api.etherscan.model.GasOracle;
 
 /**
- * ! NO DESCRIPTION !
- *
  * @author Abhay Gupta
  * @since 14.11.2022
  */

src/main/java/io/api/etherscan/model/GasOracle.java renamed to src/main/java/io/goodforgod/api/etherscan/model/GasOracle.java

@@ -2,10 +2,8 @@
 
 import io.goodforgod.api.etherscan.ApiRunner;
 import io.goodforgod.api.etherscan.error.EtherScanInvalidAddressException;
-import io.goodforgod.api.etherscan.model.TxERC20;
-import java.util.List;
-
 import io.goodforgod.api.etherscan.model.TxERC721;
+import java.util.List;
 import org.junit.jupiter.api.Test;
 
 /**

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

@@ -3,11 +3,10 @@
 import io.goodforgod.api.etherscan.ApiRunner;
 import io.goodforgod.api.etherscan.manager.impl.FakeRequestQueueManager;
 import io.goodforgod.api.etherscan.manager.impl.SemaphoreRequestQueueManager;
+import java.time.Duration;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.Timeout;
 
-import java.time.Duration;
-
 /**
  * @author GoodforGod
  * @since 03.11.2018
@@ -38,7 +37,8 @@ void queueManager() {
     @Test
     @Timeout(4500)
     void queueManagerWithDelay() {
-        RequestQueueManager requestQueueManager = new SemaphoreRequestQueueManager(1, Duration.ofSeconds(2), Duration.ofSeconds(2));
+        RequestQueueManager requestQueueManager = new SemaphoreRequestQueueManager(1, Duration.ofSeconds(2),
+                Duration.ofSeconds(2));
         requestQueueManager.takeTurn();
         requestQueueManager.takeTurn();
         assertNotNull(requestQueueManager);