Add metadata attribute to REST

cosmpy/auth/interface.py

@@ -20,6 +20,7 @@
 """Interface for the Auth functionality of CosmosSDK."""
 
 from abc import ABC, abstractmethod
+from typing import Optional, Tuple
 
 from cosmpy.protos.cosmos.auth.v1beta1.query_pb2 import (
     QueryAccountRequest,
@@ -33,21 +34,31 @@ class Auth(ABC):
     """Auth abstract class."""
 
     @abstractmethod
-    def Account(self, request: QueryAccountRequest) -> QueryAccountResponse:
+    def Account(
+        self,
+        request: QueryAccountRequest,
+        metadata: Optional[Tuple[Tuple[str, str]]] = None,
+    ) -> QueryAccountResponse:
         """
         Query account data - sequence, account_id, etc.
 
         :param request: QueryAccountRequest that contains account address
+        :param metadata: The metadata for the call or None. metadata are additional headers
 
         :return: QueryAccountResponse
         """
 
     @abstractmethod
-    def Params(self, request: QueryParamsRequest) -> QueryParamsResponse:
+    def Params(
+        self,
+        request: QueryParamsRequest,
+        metadata: Optional[Tuple[Tuple[str, str]]] = None,
+    ) -> QueryParamsResponse:
         """
         Query all parameters.
 
         :param request: QueryParamsRequest
+        :param metadata: The metadata for the call or None. metadata are additional headers
 
         :return: QueryParamsResponse
         """

cosmpy/auth/rest_client.py

@@ -18,6 +18,7 @@
 # ------------------------------------------------------------------------------
 
 """Implementation of Auth interface using REST."""
+from typing import Optional, Tuple
 
 from google.protobuf.json_format import Parse
 
@@ -44,23 +45,32 @@ def __init__(self, rest_api: RestClient):
         """
         self._rest_api = rest_api
 
-    def Account(self, request: QueryAccountRequest) -> QueryAccountResponse:
+    def Account(
+        self,
+        request: QueryAccountRequest,
+        metadata: Optional[Tuple[Tuple[str, str]]] = None,
+    ) -> QueryAccountResponse:
         """
         Query account data - sequence, account_id, etc.
 
         :param request: QueryAccountRequest that contains account address
+        :param metadata: The metadata for the call or None. metadata are additional headers
 
         :return: QueryAccountResponse
         """
         json_response = self._rest_api.get(f"{self.API_URL}/accounts/{request.address}")
         return Parse(json_response, QueryAccountResponse())
 
-    def Params(self, request: QueryParamsRequest) -> QueryParamsResponse:
+    def Params(
+        self,
+        request: QueryParamsRequest,
+        metadata: Optional[Tuple[Tuple[str, str]]] = None,
+    ) -> QueryParamsResponse:
         """
         Query all parameters.
 
         :param request: QueryParamsRequest
-
+        :param metadata: The metadata for the call or None. metadata are additional headers
         :return: QueryParamsResponse
         """
         json_response = self._rest_api.get(f"{self.API_URL}/params")

cosmpy/bank/interface.py

@@ -20,6 +20,7 @@
 """Interface for the Bank functionality of CosmosSDK."""
 
 from abc import ABC, abstractmethod
+from typing import Optional, Tuple
 
 from cosmpy.protos.cosmos.bank.v1beta1.query_pb2 import (
     QueryAllBalancesRequest,
@@ -43,75 +44,106 @@ class Bank(ABC):
     """Bank abstract class."""
 
     @abstractmethod
-    def Balance(self, request: QueryBalanceRequest) -> QueryBalanceResponse:
+    def Balance(
+        self,
+        request: QueryBalanceRequest,
+        metadata: Optional[Tuple[Tuple[str, str]]] = None,
+    ) -> QueryBalanceResponse:
         """
         Query balance of selected denomination from specific account.
 
         :param request: QueryBalanceRequest with address and denomination
+        :param metadata: The metadata for the call or None. metadata are additional headers
 
         :return: QueryBalanceResponse
         """
 
     @abstractmethod
-    def AllBalances(self, request: QueryAllBalancesRequest) -> QueryAllBalancesResponse:
+    def AllBalances(
+        self,
+        request: QueryAllBalancesRequest,
+        metadata: Optional[Tuple[Tuple[str, str]]] = None,
+    ) -> QueryAllBalancesResponse:
         """
         Query balance of all denominations from specific account.
 
         :param request: QueryAllBalancesRequest with account address
+        :param metadata: The metadata for the call or None. metadata are additional headers
 
         :return: QueryAllBalancesResponse
         """
 
     @abstractmethod
-    def TotalSupply(self, request: QueryTotalSupplyRequest) -> QueryTotalSupplyResponse:
+    def TotalSupply(
+        self,
+        request: QueryTotalSupplyRequest,
+        metadata: Optional[Tuple[Tuple[str, str]]] = None,
+    ) -> QueryTotalSupplyResponse:
         """
         Query total supply of all denominations.
 
         :param request: QueryTotalSupplyRequest
+        :param metadata: The metadata for the call or None. metadata are additional headers
 
         :return: QueryTotalSupplyResponse
         """
 
     @abstractmethod
-    def SupplyOf(self, request: QuerySupplyOfRequest) -> QuerySupplyOfResponse:
+    def SupplyOf(
+        self,
+        request: QuerySupplyOfRequest,
+        metadata: Optional[Tuple[Tuple[str, str]]] = None,
+    ) -> QuerySupplyOfResponse:
         """
         Query total supply of specific denomination.
 
         :param request: QuerySupplyOfRequest with denomination
+        :param metadata: The metadata for the call or None. metadata are additional headers
 
         :return: QuerySupplyOfResponse
         """
 
     @abstractmethod
-    def Params(self, request: QueryParamsRequest) -> QueryParamsResponse:
+    def Params(
+        self,
+        request: QueryParamsRequest,
+        metadata: Optional[Tuple[Tuple[str, str]]] = None,
+    ) -> QueryParamsResponse:
         """
         Query the parameters of bank module.
 
         :param request: QueryParamsRequest
+        :param metadata: The metadata for the call or None. metadata are additional headers
 
         :return: QueryParamsResponse
         """
 
     @abstractmethod
     def DenomMetadata(
-        self, request: QueryDenomMetadataRequest
+        self,
+        request: QueryDenomMetadataRequest,
+        metadata: Optional[Tuple[Tuple[str, str]]] = None,
     ) -> QueryDenomMetadataResponse:
         """
         Query the client metadata for all registered coin denominations.
 
         :param request: QueryDenomMetadataRequest with denomination
+        :param metadata: The metadata for the call or None. metadata are additional headers
 
         :return: QueryDenomMetadataResponse
         """
 
     @abstractmethod
     def DenomsMetadata(
-        self, request: QueryDenomsMetadataRequest
+        self,
+        request: QueryDenomsMetadataRequest,
+        metadata: Optional[Tuple[Tuple[str, str]]] = None,
     ) -> QueryDenomsMetadataResponse:
         """
         Query the client metadata of a given coin denomination.
 
         :param request: QueryDenomsMetadataRequest
+        :param metadata: The metadata for the call or None. metadata are additional headers
 
         :return: QueryDenomsMetadataResponse
         """

cosmpy/bank/rest_client.py

@@ -18,6 +18,7 @@
 # ------------------------------------------------------------------------------
 
 """Implementation of Bank interface using REST."""
+from typing import Optional, Tuple
 
 from google.protobuf.json_format import Parse
 
@@ -54,11 +55,16 @@ def __init__(self, rest_api: RestClient):
         """
         self._rest_api = rest_api
 
-    def Balance(self, request: QueryBalanceRequest) -> QueryBalanceResponse:
+    def Balance(
+        self,
+        request: QueryBalanceRequest,
+        metadata: Optional[Tuple[Tuple[str, str]]] = None,
+    ) -> QueryBalanceResponse:
         """
         Query balance of selected denomination from specific account.
 
         :param request: QueryBalanceRequest with address and denomination
+        :param metadata: The metadata for the call or None. metadata are additional headers
 
         :return: QueryBalanceResponse
         """
@@ -69,11 +75,16 @@ def Balance(self, request: QueryBalanceRequest) -> QueryBalanceResponse:
         )
         return Parse(response, QueryBalanceResponse())
 
-    def AllBalances(self, request: QueryAllBalancesRequest) -> QueryAllBalancesResponse:
+    def AllBalances(
+        self,
+        request: QueryAllBalancesRequest,
+        metadata: Optional[Tuple[Tuple[str, str]]] = None,
+    ) -> QueryAllBalancesResponse:
         """
         Query balance of all denominations from specific account.
 
         :param request: QueryAllBalancesRequest with account address
+        :param metadata: The metadata for the call or None. metadata are additional headers
 
         :return: QueryAllBalancesResponse
         """
@@ -82,59 +93,80 @@ def AllBalances(self, request: QueryAllBalancesRequest) -> QueryAllBalancesRespo
         )
         return Parse(response, QueryAllBalancesResponse())
 
-    def TotalSupply(self, request: QueryTotalSupplyRequest) -> QueryTotalSupplyResponse:
+    def TotalSupply(
+        self,
+        request: QueryTotalSupplyRequest,
+        metadata: Optional[Tuple[Tuple[str, str]]] = None,
+    ) -> QueryTotalSupplyResponse:
         """
         Query total supply of all denominations.
 
         :param request: QueryTotalSupplyRequest
+        :param metadata: The metadata for the call or None. metadata are additional headers
 
         :return: QueryTotalSupplyResponse
         """
         response = self._rest_api.get(f"{self.API_URL}/supply", request)
         return Parse(response, QueryTotalSupplyResponse())
 
-    def SupplyOf(self, request: QuerySupplyOfRequest) -> QuerySupplyOfResponse:
+    def SupplyOf(
+        self,
+        request: QuerySupplyOfRequest,
+        metadata: Optional[Tuple[Tuple[str, str]]] = None,
+    ) -> QuerySupplyOfResponse:
         """
         Query total supply of specific denomination.
 
         :param request: QuerySupplyOfRequest with denomination
+        :param metadata: The metadata for the call or None. metadata are additional headers
 
         :return: QuerySupplyOfResponse
         """
         response = self._rest_api.get(f"{self.API_URL}/supply/{request.denom}")
         return Parse(response, QuerySupplyOfResponse())
 
-    def Params(self, request: QueryParamsRequest) -> QueryParamsResponse:
+    def Params(
+        self,
+        request: QueryParamsRequest,
+        metadata: Optional[Tuple[Tuple[str, str]]] = None,
+    ) -> QueryParamsResponse:
         """
         Query the parameters of bank module.
 
         :param request: QueryParamsRequest
+        :param metadata: The metadata for the call or None. metadata are additional headers
 
         :return: QueryParamsResponse
         """
         response = self._rest_api.get(f"{self.API_URL}/params")
         return Parse(response, QueryParamsResponse())
 
     def DenomMetadata(
-        self, request: QueryDenomMetadataRequest
+        self,
+        request: QueryDenomMetadataRequest,
+        metadata: Optional[Tuple[Tuple[str, str]]] = None,
     ) -> QueryDenomMetadataResponse:
         """
         Query the client metadata for all registered coin denominations.
 
         :param request: QueryDenomMetadataRequest with denomination
+        :param metadata: The metadata for the call or None. metadata are additional headers
 
         :return: QueryDenomMetadataResponse
         """
         response = self._rest_api.get(f"{self.API_URL}/denoms_metadata/{request.denom}")
         return Parse(response, QueryDenomMetadataResponse())
 
     def DenomsMetadata(
-        self, request: QueryDenomsMetadataRequest
+        self,
+        request: QueryDenomsMetadataRequest,
+        metadata: Optional[Tuple[Tuple[str, str]]] = None,
     ) -> QueryDenomsMetadataResponse:
         """
         Query the client metadata of a given coin denomination.
 
         :param request: QueryDenomsMetadataRequest
+        :param metadata: The metadata for the call or None. metadata are additional headers
 
         :return: QueryDenomsMetadataResponse
         """

cosmpy/common/rest_client.py

@@ -20,7 +20,7 @@
 """Implementation of REST api client."""
 import base64
 import json
-from typing import List, Optional
+from typing import List, Optional, Tuple
 from urllib.parse import urlencode
 
 import requests
@@ -45,13 +45,15 @@ def get(
         url_base_path: str,
         request: Optional[Message] = None,
         used_params: Optional[List[str]] = None,
+        metadata: Optional[Tuple[Tuple[str, str]]] = None,
     ) -> bytes:
         """
         Send a GET request.
 
         :param url_base_path: URL base path
         :param request: Protobuf coded request
         :param used_params: Parameters to be removed from request after converting it to dict
+        :param metadata: The metadata for the call or None. metadata are additional headers
 
         :raises RuntimeError: if response code is not 200
 
@@ -60,8 +62,11 @@ def get(
         url = self._make_url(
             url_base_path=url_base_path, request=request, used_params=used_params
         )
-
-        response = self._session.get(url=url)
+        headers = {}
+        if metadata:
+            for key, value in metadata:
+                headers[key] = value
+        response = self._session.get(url=url, headers=headers)
         if response.status_code != 200:
             raise RuntimeError(
                 f"Error when sending a GET request.\n Response: {response.status_code}, {str(response.content)})"