redefine Const class and remove excessive nullables

Ebenezer Ackon · Ebenezer Ackon · commit 3f8cc000d439 · 2018-05-02T23:17:45.000-04:00
diff --git a/etherscanapi/src/main/java/jfyg/data/account/Accounts.kt b/etherscanapi/src/main/java/jfyg/data/account/Accounts.kt
@@ -7,8 +7,20 @@ import jfyg.data.ERC20Token
 import jfyg.data.Tx
 import jfyg.data.TxsInternal
 import jfyg.network.queries.ApiQuery
-import jfyg.utils.Const
 import jfyg.utils.QueryUtils
+import jfyg.utils.ACCOUNT
+import jfyg.utils.ASC
+import jfyg.utils.BALANCE
+import jfyg.utils.BALANCE_MULTI
+import jfyg.utils.BLOCKS
+import jfyg.utils.END_BLOCK
+import jfyg.utils.GENERIC_PUBLIC_ADDRESS
+import jfyg.utils.GET_MINED_BLOCKS
+import jfyg.utils.LATEST
+import jfyg.utils.START_BLOCK
+import jfyg.utils.TOKEN_TX
+import jfyg.utils.TX_LIST
+import jfyg.utils.TX_LIST_INTERNAL
 
 /**
  * https://etherscan.io/apis#accounts
@@ -17,76 +29,77 @@ class Accounts : AccountsContract {
 
     private val query = ApiQuery()
     private val genericNetworkQuery = query.accountBalance(
-            Const.ACCOUNT,
-            Const.BALANCE,
-            Const.GENERIC_PUBLIC_ADDRESS,
-            Const.LATEST)
+            ACCOUNT,
+            BALANCE,
+            GENERIC_PUBLIC_ADDRESS,
+            LATEST)
 
     /**
      * Get Ether Balance for a single Address
      */
-    override fun getBalance(address: String?):
+    override fun getBalance(address: String):
             Single<Double> = query.accountBalance(
-            Const.ACCOUNT,
-            Const.BALANCE,
+            ACCOUNT,
+            BALANCE,
             address,
-            Const.LATEST).map { it.result?.toDouble() }
+            LATEST).map { it.result?.toDouble() }
 
     /**
      * Get Ether Balance for multiple Addresses in a single call
      */
-    override fun getMultiBalance(addresses: List<String>?):
+    override fun getMultiBalance(addresses: List<String>):
             Single<List<Balance>> = query.accountMultiBalance(
-            Const.ACCOUNT,
-            Const.BALANCE_MULTI,
+            ACCOUNT,
+            BALANCE_MULTI,
             QueryUtils.retrieveList(addresses),
-            Const.LATEST).map { it.result }
+            LATEST).map { it.result }
 
     /**
      * Get list of blocks mined by address
      */
-    override fun getBlocks(address: String?):
+    override fun getBlocks(address: String):
             Single<List<BlockAccount>> = query.accountBlock(
-            Const.ACCOUNT,
-            Const.GET_MINED_BLOCKS,
+            ACCOUNT,
+            GET_MINED_BLOCKS,
             address,
-            Const.BLOCKS).map { it.result }
+            BLOCKS).map { it.result }
 
     /**
      * Get a list of 'Normal' Transactions By Address
      */
-    override fun getTransactions(address: String?):
-            Single<List<Tx>> = query.accountTxs(Const.ACCOUNT,
-            Const.TX_LIST,
+    override fun getTransactions(address: String):
+            Single<List<Tx>> = query.accountTxs(
+            ACCOUNT,
+            TX_LIST,
             address,
-            Const.START_BLOCK,
-            Const.END_BLOCK,
-            Const.ASC).map { it.result }
+            START_BLOCK,
+            END_BLOCK,
+            ASC).map { it.result }
 
     /**
      * [BETA] Get a list of "ERC20 - Token Transfer Events" by Address
      */
-    override fun getERC20Tokens(address: String?):
+    override fun getERC20Tokens(address: String):
             Single<List<ERC20Token>> = query.accountERC20Txs(
-            Const.ACCOUNT,
-            Const.TOKEN_TX,
+            ACCOUNT,
+            TOKEN_TX,
             address,
-            Const.START_BLOCK,
-            Const.END_BLOCK,
-            Const.ASC).map { it.result }
+            START_BLOCK,
+            END_BLOCK,
+            ASC).map { it.result }
 
 
     /**
      * [BETA] Get a list of 'Internal' Transactions by Address
      */
-    override fun getInternalTransactions(address: String?):
+    override fun getInternalTransactions(address: String):
             Single<List<TxsInternal>> = query.accountInternalTxs(
-            Const.ACCOUNT,
-            Const.TX_LIST_INTERNAL,
+            ACCOUNT,
+            TX_LIST_INTERNAL,
             address,
-            Const.START_BLOCK,
-            Const.END_BLOCK,
-            Const.ASC).map { it.result }
+            START_BLOCK,
+            END_BLOCK,
+            ASC).map { it.result }
 
     /**
      * Return network status
diff --git a/etherscanapi/src/main/java/jfyg/data/account/AccountsContract.kt b/etherscanapi/src/main/java/jfyg/data/account/AccountsContract.kt
@@ -15,32 +15,32 @@ internal interface AccountsContract {
     /**
      * Get Ether Balance for a single Address
      */
-    fun getBalance(address: String?): Single<Double>
+    fun getBalance(address: String): Single<Double>
 
     /**
      * Get Ether Balance for multiple Addresses in a single call
      */
-    fun getMultiBalance(addresses: List<String>?): Single<List<Balance>>
+    fun getMultiBalance(addresses: List<String>): Single<List<Balance>>
 
     /**
      * Get list of blocks mined by address
      */
-    fun getBlocks(address: String?): Single<List<BlockAccount>>
+    fun getBlocks(address: String): Single<List<BlockAccount>>
 
     /**
      * Get a list of 'Normal' Transactions By Address
      */
-    fun getTransactions(address: String?): Single<List<Tx>>
+    fun getTransactions(address: String): Single<List<Tx>>
 
     /**
      * [BETA] Get a list of "ERC20 - Token Transfer Events" by Address
      */
-    fun getERC20Tokens(address: String?): Single<List<ERC20Token>>
+    fun getERC20Tokens(address: String): Single<List<ERC20Token>>
 
     /**
      * [BETA] Get a list of 'Internal' Transactions by Address
      */
-    fun getInternalTransactions(address: String?): Single<List<TxsInternal>>
+    fun getInternalTransactions(address: String): Single<List<TxsInternal>>
 
     /**
      * Return network status
diff --git a/etherscanapi/src/main/java/jfyg/data/block/Blocks.kt b/etherscanapi/src/main/java/jfyg/data/block/Blocks.kt
@@ -3,25 +3,27 @@ package jfyg.data.block
 import io.reactivex.Single
 import jfyg.data.BlockMined
 import jfyg.network.queries.ApiQuery
-import jfyg.utils.Const
+import jfyg.utils.BLOCK
+import jfyg.utils.BLOCK_NO
+import jfyg.utils.GET_BLOCK_REWARD
 
 /**
  * https://etherscan.io/apis#blocks
  */
 class Blocks : BlocksContract {
     private val query = ApiQuery()
     private val genericNetworkQuery = query.blocksMined(
-            Const.BLOCK,
-            Const.GET_BLOCK_REWARD,
-            Const.BLOCK_NO)
+            BLOCK,
+            GET_BLOCK_REWARD,
+            BLOCK_NO)
 
     /**
      * [BETA] Get Block And Uncle Rewards by BlockNo
      */
-    override fun getBlocksMined(blockNo: String?):
+    override fun getBlocksMined(blockNo: String):
             Single<BlockMined> = query.blocksMined(
-            Const.BLOCK,
-            Const.GET_BLOCK_REWARD,
+            BLOCK,
+            GET_BLOCK_REWARD,
             blockNo).map { it.result }
 
     /**
diff --git a/etherscanapi/src/main/java/jfyg/data/block/BlocksContract.kt b/etherscanapi/src/main/java/jfyg/data/block/BlocksContract.kt
@@ -11,7 +11,7 @@ internal interface BlocksContract {
     /**
      * [BETA] Get Block And Uncle Rewards by BlockNo
      */
-    fun getBlocksMined(blockNo: String?): Single<BlockMined>
+    fun getBlocksMined(blockNo: String): Single<BlockMined>
 
     /**
      * Return network status
diff --git a/etherscanapi/src/main/java/jfyg/data/contract/Contracts.kt b/etherscanapi/src/main/java/jfyg/data/contract/Contracts.kt
@@ -2,7 +2,9 @@ package jfyg.data.contract
 
 import io.reactivex.Single
 import jfyg.network.queries.ApiQuery
-import jfyg.utils.Const
+import jfyg.utils.CONTRACT
+import jfyg.utils.CONTRACT_PUBLIC_ADDRESS
+import jfyg.utils.GET_ABI
 
 /**
  * Newly verified Contracts are synced to the API servers within 5 minutes or less
@@ -12,18 +14,18 @@ class Contracts : ContractsContract {
 
     private val query = ApiQuery()
     private val abiQuery = query.contractABI(
-            Const.CONTRACT,
-            Const.GET_ABI,
-            Const.CONTRACT_PUBLIC_ADDRESS)
+            CONTRACT,
+            GET_ABI,
+            CONTRACT_PUBLIC_ADDRESS)
 
     /**
      * Get Contract ABI for Verified Contract Source Codes
      * https://etherscan.io/contractsVerified
      */
-    override fun getContractABI(address: String?):
+    override fun getContractABI(address: String):
             Single<String> = query.contractABI(
-            Const.CONTRACT,
-            Const.GET_ABI,
+            CONTRACT,
+            GET_ABI,
             address).map { it.result }
 
     /**
diff --git a/etherscanapi/src/main/java/jfyg/data/contract/ContractsContract.kt b/etherscanapi/src/main/java/jfyg/data/contract/ContractsContract.kt
@@ -12,7 +12,7 @@ internal interface ContractsContract {
      * Get Contract ABI for Verified Contract Source Codes
      * https://etherscan.io/contractsVerified
      */
-    fun getContractABI(address: String?): Single<String>
+    fun getContractABI(address: String): Single<String>
 
     /**
      * Return network status
diff --git a/etherscanapi/src/main/java/jfyg/data/stat/Stats.kt b/etherscanapi/src/main/java/jfyg/data/stat/Stats.kt
@@ -2,16 +2,18 @@ package jfyg.data.stat
 
 import io.reactivex.Single
 import jfyg.network.queries.ApiQuery
-import jfyg.utils.Const
+import jfyg.utils.ETH_PRICE
+import jfyg.utils.ETH_SUPPLY
+import jfyg.utils.STATS
 
 /**
  * https://etherscan.io/apis#stats
  */
 class Stats : StatsContract {
 
     private val query = ApiQuery()
-    private val supplyQuery = query.statSupply(Const.STATS, Const.ETH_SUPPLY)
-    private val priceQuery = query.statPrice(Const.STATS, Const.ETH_PRICE)
+    private val supplyQuery = query.statSupply(STATS, ETH_SUPPLY)
+    private val priceQuery = query.statPrice(STATS, ETH_PRICE)
 
     private val wei = 1000000000000000000 // 1 Ether is 1000000000000000000 Wei
 
diff --git a/etherscanapi/src/main/java/jfyg/data/transaction/Transactions.kt b/etherscanapi/src/main/java/jfyg/data/transaction/Transactions.kt
@@ -4,7 +4,10 @@ import io.reactivex.Single
 import jfyg.data.TxExecutionStatus
 import jfyg.data.TxReceiptStatus
 import jfyg.network.queries.ApiQuery
-import jfyg.utils.Const
+import jfyg.utils.GET_STATUS
+import jfyg.utils.GET_TX_RECEIPT_STATUS
+import jfyg.utils.TRANSACTION
+import jfyg.utils.TRANSACTION_PUBLIC_ADDRESS
 
 /**
  * https://etherscan.io/apis#transactions
@@ -13,18 +16,18 @@ class Transactions : TransactionsContract {
 
     private val query = ApiQuery()
     private val genericNetworkQuery = query.txReceiptStatus(
-            Const.TRANSACTION,
-            Const.GET_STATUS,
-            Const.TRANSACTION_PUBLIC_ADDRESS)
+            TRANSACTION,
+            GET_STATUS,
+            TRANSACTION_PUBLIC_ADDRESS)
 
     /**
      * [BETA] Check Contract Execution Status (if there was an error during contract execution)
      * Note: isError":"0" = Pass , isError":"1" = Error during Contract Execution
      */
     override fun getTxExecutionStatus(txHash: String):
             Single<TxExecutionStatus> = query.txExecutionStatus(
-            Const.TRANSACTION,
-            Const.GET_STATUS,
+            TRANSACTION,
+            GET_STATUS,
             txHash).map { it.result }
 
     /**
@@ -33,8 +36,8 @@ class Transactions : TransactionsContract {
      */
     override fun getTxReceiptStatus(txHash: String):
             Single<TxReceiptStatus> = query.txReceiptStatus(
-            Const.TRANSACTION,
-            Const.GET_TX_RECEIPT_STATUS,
+            TRANSACTION,
+            GET_TX_RECEIPT_STATUS,
             txHash).map { it.result }
 
     /**
diff --git a/etherscanapi/src/main/java/jfyg/network/RestClient.kt b/etherscanapi/src/main/java/jfyg/network/RestClient.kt
@@ -5,14 +5,14 @@ import retrofit2.adapter.rxjava2.RxJava2CallAdapterFactory
 import retrofit2.converter.gson.GsonConverterFactory
 import com.google.gson.GsonBuilder
 import io.reactivex.schedulers.Schedulers
-import jfyg.utils.Const
+import jfyg.utils.BASE_URL
 
 /**
  * Client used to create the network call
  */
 internal class RestClient {
 
-    private var baseUrl: String = Const.BASE_URL
+    private var baseUrl: String = BASE_URL
     private var networkService: NetworkService
 
     init {
diff --git a/etherscanapi/src/main/java/jfyg/network/queries/ApiQuery.kt b/etherscanapi/src/main/java/jfyg/network/queries/ApiQuery.kt
@@ -20,7 +20,8 @@ import jfyg.network.response.transaction.TxContractReceiptResponse
  * A mediator between the responses and errors that come from every query
  */
 internal class ApiQuery : AccountsApi, StatsApi, ContractsApi, TransactionsApi, BlocksApi {
-
+// retrofit allows the usage of null parameters when building queries and some parameters being passed in the
+// following classes are null, hence the usage of .?func()
 
     override fun accountBalance(module: String?,
                                 action: String?,
diff --git a/etherscanapi/src/main/java/jfyg/utils/Const.kt b/etherscanapi/src/main/java/jfyg/utils/Const.kt
diff --git a/etherscanapi/src/test/java/jfyg/data/block/BlocksTest.kt b/etherscanapi/src/test/java/jfyg/data/block/BlocksTest.kt
diff --git a/etherscanapi/src/test/java/jfyg/network/RestClientTest.kt b/etherscanapi/src/test/java/jfyg/network/RestClientTest.kt
