Chain/revenue access single param only (#15)

* feat: chain/revenue access single param only

* feat: allow specify protocol and/or chain in feed/revenue detail

* chore: flake8

* fix: flake8

Author: martinkersner

datamaxi/defillama/__init__.py

@@ -4,6 +4,7 @@
 from datamaxi.lib.utils import check_required_parameter
 from datamaxi.lib.utils import check_required_parameters
 from datamaxi.lib.utils import check_required_parameter_list
+from datamaxi.lib.utils import check_at_least_one_set_parameters
 from datamaxi.lib.utils import encode_string_list
 from datamaxi.lib.utils import make_list
 from datamaxi.lib.utils import postprocess
@@ -360,21 +361,21 @@ def stablecoin_price(
     @postprocess()
     def fee(
         self,
-        protocols: Union[str, List[str]] = None,
-        chains: Union[str, List[str]] = None,
+        protocol: str = None,
+        chain: str = None,
         daily: bool = True,
         pandas: bool = True,
     ) -> Union[List, pd.DataFrame]:
-        """Get fee for given protocols or chains
+        """Get fee for given protocol or chain
 
         `GET /v1/defillama/fee`
 
         <https://docs.datamaxiplus.com/defillama/fee>
 
         Args:
-            protocols (Union[str, List[str]]): single protocol or multiple protocol names
-            chains (Union[str, List[str]]): single chain or multiple chain names
-            daily (bool): daily fee or total fee
+            protocol (str): Protocol name
+            chain (str): Chain name
+            daily (bool): Daily fee or total fee
             pandas (bool): Return data as pandas DataFrame
 
         Returns:
@@ -385,38 +386,36 @@ def fee(
             "daily": str(daily).lower(),
         }
 
-        if not ((protocols is None) ^ (chains is None)):
+        if not ((protocol is None) ^ (chain is None)):
             raise ValueError("Either protocols or chains should be provided")
 
-        if protocols is not None:
-            protocols = make_list(protocols)
-            check_required_parameter_list(protocols, "protocols")
-            params["protocols"] = encode_string_list(protocols)
-        elif chains is not None:
-            chains = make_list(chains)
-            check_required_parameter_list(chains, "chains")
-            params["chains"] = encode_string_list(chains)
+        if protocol is not None:
+            check_required_parameter(protocol, "protocol")
+            params["protocol"] = protocol
+        elif chain is not None:
+            check_required_parameter(chain, "chain")
+            params["chain"] = chain
 
         return self.query("/v1/defillama/fee", params)
 
     @postprocess()
     def revenue(
         self,
-        protocols: Union[str, List[str]] = None,
-        chains: Union[str, List[str]] = None,
+        protocol: str = None,
+        chain: str = None,
         daily: bool = True,
         pandas: bool = True,
     ) -> Union[List, pd.DataFrame]:
-        """Get revenue for given protocols or chains
+        """Get revenue for given protocol or chain
 
         `GET /v1/defillama/revenue`
 
         <https://docs.datamaxiplus.com/defillama/revenue>
 
         Args:
-            protocols (Union[str, List[str]]): single protocol or multiple protocol names
-            chains (Union[str, List[str]]): single chain or multiple chain names
-            daily (bool): daily revenue or total revenue
+            protocol (str): Protocol name
+            chain (str): Chain name
+            daily (bool): Daily revenue or total revenue
             pandas (bool): Return data as pandas DataFrame
 
         Returns:
@@ -427,23 +426,25 @@ def revenue(
             "daily": str(daily).lower(),
         }
 
-        if not ((protocols is None) ^ (chains is None)):
+        if not ((protocol is None) ^ (chain is None)):
             raise ValueError("Either protocols or chains should be provided")
 
-        if protocols is not None:
-            protocols = make_list(protocols)
-            check_required_parameter_list(protocols, "protocols")
-            params["protocols"] = encode_string_list(protocols)
-        elif chains is not None:
-            chains = make_list(chains)
-            check_required_parameter_list(chains, "chains")
-            params["chains"] = encode_string_list(chains)
+        if protocol is not None:
+            check_required_parameter(protocol, "protocol")
+            params["protocol"] = protocol
+        elif chain is not None:
+            check_required_parameter(chain, "chain")
+            params["chain"] = chain
 
         return self.query("/v1/defillama/revenue", params)
 
     @postprocess(num_index=3)
     def fee_detail(
-        self, protocol: str, chain: str = None, daily: bool = True, pandas: bool = True
+        self,
+        protocol: str = None,
+        chain: str = None,
+        daily: bool = True,
+        pandas: bool = True,
     ) -> Union[List, pd.DataFrame]:
         """Get fee detail for given protocol and chain
 
@@ -452,27 +453,35 @@ def fee_detail(
         <https://docs.datamaxiplus.com/defillama/fee-detail>
 
         Args:
-            protocol (str): protocol name
-            chain (str): chain name (optional)
-            daily (bool): daily fee or total fee
+            protocol (str): Protocol name
+            chain (str): Chain name
+            daily (bool): Daily fee or total fee
             pandas (bool): Return data as pandas DataFrame
 
         Returns:
             Timeseries of fee detail for a given protocol and chain
         """
-        check_required_parameters([[protocol, "protocol"], [daily, "daily"]])
+        check_required_parameter(daily, "daily")
         params = {
-            "protocol": protocol,
             "daily": str(daily).lower(),
         }
+
+        check_at_least_one_set_parameters([[protocol, "protocol"], [chain, "chain"]])
+        if protocol is not None:
+            params["protocol"] = protocol
+
         if chain is not None:
             params["chain"] = chain
 
         return self.query("/v1/defillama/fee/detail", params)
 
     @postprocess(num_index=3)
     def revenue_detail(
-        self, protocol: str, chain: str = None, daily: bool = True, pandas: bool = True
+        self,
+        protocol: str = None,
+        chain: str = None,
+        daily: bool = True,
+        pandas: bool = True,
     ) -> Union[List, pd.DataFrame]:
         """Get revenue detail for given protocol and chain
 
@@ -481,19 +490,23 @@ def revenue_detail(
         <https://docs.datamaxiplus.com/defillama/revenue-detail>
 
         Args:
-            protocol (str): protocol name
-            chain (str): chain name (optional)
-            daily (bool): daily revenue or total revenue
+            protocol (str): Protocol name
+            chain (str): Chain name
+            daily (bool): Daily revenue or total revenue
             pandas (bool): Return data as pandas DataFrame
 
         Returns:
             Timeseries of revenue detail for a given protocol and chain
         """
-        check_required_parameters([[protocol, "protocol"], [daily, "daily"]])
+        check_required_parameter(daily, "daily")
         params = {
-            "protocol": protocol,
             "daily": str(daily).lower(),
         }
+
+        check_at_least_one_set_parameters([[protocol, "protocol"], [chain, "chain"]])
+        if protocol is not None:
+            params["protocol"] = protocol
+
         if chain is not None:
             params["chain"] = chain
 

datamaxi/error.py

@@ -28,3 +28,8 @@ def __init__(self, params):
 
     def __str__(self):
         return "%s is mandatory, but received empty." % (", ".join(self.params))
+
+
+class AtLeastOneParameterRequiredError(Error):
+    def __str__(self):
+        return "At least one parameter is required."

datamaxi/lib/utils.py

@@ -3,6 +3,7 @@
 import pandas as pd
 from functools import wraps
 from datamaxi.error import ParameterRequiredError
+from datamaxi.error import AtLeastOneParameterRequiredError
 
 
 def to_float(x):
@@ -38,6 +39,20 @@ def check_required_parameters(params):
         check_required_parameter(p[0], p[1])
 
 
+def check_at_least_one_set_parameters(params):
+    at_least_one_set = False
+    for p in params:
+        try:
+            check_required_parameter(p[0], p[1])
+            at_least_one_set = True
+            break
+        except:  # noqa: E722
+            pass
+
+    if not at_least_one_set:
+        raise AtLeastOneParameterRequiredError()
+
+
 def check_required_parameter_list(values: List, name: str):
     if len(values) == 0:
         raise ParameterRequiredError([name])