Added docstrings and changed kwargs

Author: Kotsias, Panagiotis-Christos

etherscan/client.py

@@ -31,7 +31,7 @@ def wrapper(*args, **kwargs):
     def from_config(cls, config_path: str, api_key: str):
         config = cls.__load_config(config_path)
         for func, v in config.items():
-            if not func.startswith("_"):
+            if not func.startswith("_"):  # disabled if _
                 attr = getattr(getattr(etherscan, v["module"]), func)
                 setattr(cls, func, cls.__auth(attr, api_key))
         return cls

etherscan/modules/accounts.py

@@ -1,7 +1,6 @@
 from functools import reduce
 from typing import List
 
-from etherscan.utils.datatypes import TxHash, WalletAddress
 from etherscan.enums.actions_enum import ActionsEnum as actions
 from etherscan.enums.fields_enum import FieldsEnum as fields
 from etherscan.enums.modules_enum import ModulesEnum as modules
@@ -10,14 +9,21 @@
 
 class Accounts:
     @staticmethod
-    def get_eth_balance(wallet: WalletAddress) -> str:
+    def get_eth_balance(address: str) -> str:
+        """Returns ether balance for a single wallet.
+
+        :param address: Wallet address
+        :type address: str
+        :return: The url to get 
+        :rtype: str
+        """
         url = (
             f"{fields.MODULE}"
             f"{modules.ACCOUNT}"
             f"{fields.ACTION}"
             f"{actions.BALANCE}"
             f"{fields.ADDRESS}"
-            f"{wallet}"
+            f"{address}"
             f"{fields.TAG}"
             f"{tags.LATEST}"
         )
@@ -26,16 +32,22 @@ def get_eth_balance(wallet: WalletAddress) -> str:
         # return conversions.to_ticker_unit(parser.get_result(r))
 
     @staticmethod
-    def get_eth_balance_multiple(wallets: List[WalletAddress]) -> str:
-        # max 20 wallets
-        wallet_list = reduce(lambda w1, w2: str(w1) + "," + str(w2), wallets)
+    def get_eth_balance_multiple(addresses: List[str]) -> str:
+        """Returns ether balance for a list of wallets. Max of 20 wallets at a time.
+
+        :param addresses: List of wallets
+        :type addresses: List[str]
+        :return: The url to get
+        :rtype: str
+        """
+        address_list = reduce(lambda w1, w2: str(w1) + "," + str(w2), addresses)
         url = (
             f"{fields.MODULE}"
             f"{modules.ACCOUNT}"
             f"{fields.ACTION}"
             f"{actions.BALANCE_MULTI}"
             f"{fields.ADDRESS}"
-            f"{wallet_list}"
+            f"{address_list}"
             f"{fields.TAG}"
             f"{tags.LATEST}"
         )
@@ -45,19 +57,32 @@ def get_eth_balance_multiple(wallets: List[WalletAddress]) -> str:
 
     @staticmethod
     def get_normal_txs_by_address(
-        wallet: WalletAddress,
+        address: str,
         startblock: int = 0000,
         endblock: int = 99999999,
         sort: str = "asc",
     ) -> str:
+        """Returns the last 10k normal transactions for an address.
+
+        :param address: Wallet address
+        :type address: str
+        :param startblock: Starting block, defaults to 0000
+        :type startblock: int, optional
+        :param endblock: Ending block, defaults to 99999999
+        :type endblock: int, optional
+        :param sort: Sort results, defaults to "asc"
+        :type sort: str, optional
+        :return: The url to get
+        :rtype: str
+        """
         # last 10,000 txs only
         url = (
             f"{fields.MODULE}"
             f"{modules.ACCOUNT}"
             f"{fields.ACTION}"
             f"{actions.TXLIST}"
             f"{fields.ADDRESS}"
-            f"{wallet}"
+            f"{address}"
             f"{fields.START_BLOCK}"
             f"{str(startblock)}"
             f"{fields.END_BLOCK}"
@@ -69,20 +94,37 @@ def get_normal_txs_by_address(
 
     @staticmethod
     def get_normal_txs_by_address_paginated(
-        wallet: WalletAddress,
+        address: str,
         page: int,
         offset: int,
         startblock: int = 0000,
         endblock: int = 99999999,
         sort: str = "asc",
     ) -> str:
+        """Returns the paginated normal transactions for an address.
+
+        :param address: Wallet address
+        :type address: str
+        :param page: Page number
+        :type page: int
+        :param offset: Max records to return
+        :type offset: int
+        :param startblock: Starting block, defaults to 0000
+        :type startblock: int, optional
+        :param endblock: Ending block, defaults to 99999999
+        :type endblock: int, optional
+        :param sort: Sort results, defaults to "asc"
+        :type sort: str, optional
+        :return: The url to get
+        :rtype: str
+        """
         url = (
             f"{fields.MODULE}"
             f"{modules.ACCOUNT}"
             f"{fields.ACTION}"
             f"{actions.TXLIST}"
             f"{fields.ADDRESS}"
-            f"{wallet}"
+            f"{address}"
             f"{fields.START_BLOCK}"
             f"{str(startblock)}"
             f"{fields.END_BLOCK}"
@@ -98,19 +140,31 @@ def get_normal_txs_by_address_paginated(
 
     @staticmethod
     def get_internal_txs_by_address(
-        wallet: WalletAddress,
+        address: str,
         startblock: int = 0000,
         endblock: int = 99999999,
         sort: str = "asc",
     ) -> str:
-        # last 10,000 txs only
+        """Returns the last 10k internal transactions for an address.
+
+        :param address: Wallet address
+        :type address: str
+        :param startblock: Starting block, defaults to 0000
+        :type startblock: int, optional
+        :param endblock: Ending block, defaults to 99999999
+        :type endblock: int, optional
+        :param sort: Sort results, defaults to "asc"
+        :type sort: str, optional
+        :return: The url to get
+        :rtype: str
+        """
         url = (
             f"{fields.MODULE}"
             f"{modules.ACCOUNT}"
             f"{fields.ACTION}"
             f"{actions.TXLIST_INTERNAL}"
             f"{fields.ADDRESS}"
-            f"{wallet}"
+            f"{address}"
             f"{fields.START_BLOCK}"
             f"{str(startblock)}"
             f"{fields.END_BLOCK}"
@@ -122,20 +176,37 @@ def get_internal_txs_by_address(
 
     @staticmethod
     def get_internal_txs_by_address_paginated(
-        wallet: WalletAddress,
+        address: str,
         page: int,
         offset: int,
         startblock: int = 0000,
         endblock: int = 99999999,
         sort: str = "asc",
     ) -> str:
+        """Returns the paginated internal transactions for an address.
+
+        :param address: Wallet address
+        :type address: str
+        :param page: Page number
+        :type page: int
+        :param offset: Max records to return
+        :type offset: int
+        :param startblock: Starting block, defaults to 0000
+        :type startblock: int, optional
+        :param endblock: Ending block, defaults to 99999999
+        :type endblock: int, optional
+        :param sort: Sort results, defaults to "asc"
+        :type sort: str, optional
+        :return: The url to get
+        :rtype: str
+        """
         url = (
             f"{fields.MODULE}"
             f"{modules.ACCOUNT}"
             f"{fields.ACTION}"
             f"{actions.TXLIST_INTERNAL}"
             f"{fields.ADDRESS}"
-            f"{wallet}"
+            f"{address}"
             f"{fields.START_BLOCK}"
             f"{str(startblock)}"
             f"{fields.END_BLOCK}"
@@ -150,8 +221,14 @@ def get_internal_txs_by_address_paginated(
         return url
 
     @staticmethod
-    def get_internal_txs_by_txhash(txhash: TxHash) -> str:
-        # last 10,000 txs only
+    def get_internal_txs_by_txhash(txhash: str) -> str:
+        """Returns the last 10k internal transactions for a transaction hash.
+
+        :param txhash: Transaction hash
+        :type txhash: str
+        :return: The url to get
+        :rtype: str
+        """
         url = (
             f"{fields.MODULE}"
             f"{modules.ACCOUNT}"
@@ -166,8 +243,21 @@ def get_internal_txs_by_txhash(txhash: TxHash) -> str:
     def get_internal_txs_by_block_range_paginated(
         startblock: int, endblock: int, page: int, offset: int, sort: str = "asc",
     ) -> str:
-        # last 10,000 txs only
-        # BUG: returns empty message
+        """Returns the last 10k paginated internal transactions for a block range.
+
+        :param startblock: Starting block
+        :type startblock: int
+        :param endblock: Ending block
+        :type endblock: int
+        :param page: Page number
+        :type page: int
+        :param offset: Max records to return
+        :type offset: int
+        :param sort: Sort results, defaults to "asc"
+        :type sort: str, optional
+        :return: The url to get
+        :rtype: str
+        """
         url = (
             f"{fields.MODULE}"
             f"{modules.ACCOUNT}"
@@ -188,19 +278,28 @@ def get_internal_txs_by_block_range_paginated(
 
     @staticmethod
     def get_erc20_token_transfer_events_by_address(
-        wallet: WalletAddress,
-        startblock: int = 0,
-        endblock: int = 999999999,
-        sort: str = "asc",
+        address: str, startblock: int = 0, endblock: int = 999999999, sort: str = "asc",
     ) -> str:
-        # last 10,000 txs only
+        """Returns the last 10k ERC20 token transfer events for an address.
+
+        :param address: Wallet address
+        :type address: str
+        :param startblock: Starting block, defaults to 0
+        :type startblock: int, optional
+        :param endblock: Ending block, defaults to 999999999
+        :type endblock: int, optional
+        :param sort: Sort results, defaults to "asc"
+        :type sort: str, optional
+        :return: The url to get
+        :rtype: str
+        """
         url = (
             f"{fields.MODULE}"
             f"{modules.ACCOUNT}"
             f"{fields.ACTION}"
             f"{actions.TOKENTX}"
             f"{fields.ADDRESS}"
-            f"{wallet}"
+            f"{address}"
             f"{fields.START_BLOCK}"
             f"{str(startblock)}"
             f"{fields.END_BLOCK}"
@@ -212,19 +311,28 @@ def get_erc20_token_transfer_events_by_address(
 
     @staticmethod
     def get_erc721_token_transfer_events_by_address(
-        wallet: WalletAddress,
-        startblock: int = 0,
-        endblock: int = 999999999,
-        sort: str = "asc",
+        address: str, startblock: int = 0, endblock: int = 999999999, sort: str = "asc",
     ) -> str:
-        # last 10,000 txs only
+        """Returns the last 10k ERC721 token transfer events for an address.
+
+        :param address: Wallet address
+        :type address: str
+        :param startblock: Starting block, defaults to 0
+        :type startblock: int, optional
+        :param endblock: Ending block, defaults to 999999999
+        :type endblock: int, optional
+        :param sort: Sort results, defaults to "asc"
+        :type sort: str, optional
+        :return: The url to get
+        :rtype: str
+        """
         url = (
             f"{fields.MODULE}"
             f"{modules.ACCOUNT}"
             f"{fields.ACTION}"
             f"{actions.TOKENNFTTX}"
             f"{fields.ADDRESS}"
-            f"{wallet}"
+            f"{address}"
             f"{fields.START_BLOCK}"
             f"{str(startblock)}"
             f"{fields.END_BLOCK}"
@@ -235,14 +343,21 @@ def get_erc721_token_transfer_events_by_address(
         return url
 
     @staticmethod
-    def get_mined_blocks_by_address(wallet: WalletAddress) -> str:
+    def get_mined_blocks_by_address(address: str) -> str:
+        """Returns list of blocks mined by an address.
+
+        :param address: Wallet address
+        :type address: str
+        :return: The url to get
+        :rtype: str
+        """
         url = (
             f"{fields.MODULE}"
             f"{modules.ACCOUNT}"
             f"{fields.ACTION}"
             f"{actions.GET_MINED_BLOCKS}"
             f"{fields.ADDRESS}"
-            f"{wallet}"
+            f"{address}"
             f"{fields.BLOCK_TYPE}"
             f"blocks"
         )