(feat) Applied the new cookies assistant in the AsyncClient

Author: abel

examples/chain_client/1_MsgSend.py

@@ -11,8 +11,7 @@ async def main() -> None:
     network = Network.testnet()
 
     # initialize grpc client
-    # set custom cookie location (optional) - defaults to current dir
-    client = AsyncClient(network, insecure=False, chain_cookie_location="/tmp/.chain_cookie")
+    client = AsyncClient(network, insecure=False)
     composer = await client.composer()
     await client.sync_timeout_height()
 

pyinjective/async_client.py

@@ -4,10 +4,8 @@
 
 import grpc
 import aiocron
-import datetime
 from decimal import Decimal
-from http.cookies import SimpleCookie
-from typing import Dict, List, Optional, Tuple, Union
+from typing import Dict, List, Optional, Tuple, Union, Coroutine
 
 from pyinjective.composer import Composer
 
@@ -26,17 +24,10 @@
 from .proto.cosmos.auth.v1beta1 import (
     query_pb2_grpc as auth_query_grpc,
     query_pb2 as auth_query,
-    auth_pb2 as auth_type,
 )
 from .proto.cosmos.authz.v1beta1 import (
     query_pb2_grpc as authz_query_grpc,
     query_pb2 as authz_query,
-    authz_pb2 as authz_type,
-)
-from .proto.cosmos.authz.v1beta1 import (
-    query_pb2_grpc as authz_query_grpc,
-    query_pb2 as authz_query,
-    authz_pb2 as authz_type,
 )
 from .proto.cosmos.bank.v1beta1 import (
     query_pb2_grpc as bank_query_grpc,
@@ -85,31 +76,14 @@ def __init__(
             self,
             network: Network,
             insecure: bool = False,
-            load_balancer: bool = True,
             credentials=grpc.ssl_channel_credentials(),
-            chain_cookie_location=".chain_cookie",
     ):
 
-        # use append mode to create file if not exist
-        self.chain_cookie_location = chain_cookie_location
-        cookie_file = open(chain_cookie_location, "a+")
-        cookie_file.close()
-
         self.addr = ""
         self.number = 0
         self.sequence = 0
 
-        self.cookie_type = None
-        self.expiration_format = None
-        self.load_balancer = load_balancer
         self.network = network
-        self.cookie_type = "GCLB"
-        self.expiration_format = "{}"
-
-        if self.network.string() == "testnet":
-            self.load_balancer = False
-            self.cookie_type = "grpc-cookie"
-            self.expiration_format = "20{}"
 
         # chain stubs
         self.chain_channel = (
@@ -126,14 +100,6 @@ def __init__(
         self.stubBank = bank_query_grpc.QueryStub(self.chain_channel)
         self.stubTx = tx_service_grpc.ServiceStub(self.chain_channel)
 
-        # attempt to load from disk
-        cookie_file = open(chain_cookie_location, "r+")
-        self.chain_cookie = cookie_file.read()
-        cookie_file.close()
-        LoggerProvider().logger_for_class(logging_class=self.__class__).info(
-            f"chain session cookie loaded from disk: {self.chain_cookie}"
-        )
-
         self.exchange_cookie = ""
         self.timeout_height = 1
 
@@ -249,99 +215,15 @@ async def sync_timeout_height(self):
             )
             self.timeout_height = 0
 
-    # cookie helper methods
-    async def fetch_cookie(self, type):
-        metadata = None
-        if type == "chain":
-            req = tendermint_query.GetLatestBlockRequest()
-            metadata = await self.stubCosmosTendermint.GetLatestBlock(
-                req
-            ).initial_metadata()
-            time.sleep(DEFAULT_BLOCK_TIME)
-        if type == "exchange":
-            req = exchange_meta_rpc_pb.VersionRequest()
-            metadata = await self.stubMeta.Version(req).initial_metadata()
-        return metadata
-
-    async def renew_cookie(self, existing_cookie, type):
-        metadata = None
-        # format cookie date into RFC1123 standard
-        cookie = SimpleCookie()
-        cookie.load(existing_cookie)
-
-        expires_at = cookie.get(f"{self.cookie_type}").get("expires")
-        expires_at = expires_at.replace("-", " ")
-        yyyy = f"{self.expiration_format}".format(expires_at[12:14])
-        expires_at = expires_at[:12] + yyyy + expires_at[14:]
-
-        # parse expire field to unix timestamp
-        expire_timestamp = datetime.datetime.strptime(
-            expires_at, "%a, %d %b %Y %H:%M:%S GMT"
-        ).timestamp()
-
-        # renew session if timestamp diff < offset
-        timestamp_diff = expire_timestamp - int(time.time())
-        if timestamp_diff < DEFAULT_SESSION_RENEWAL_OFFSET:
-            metadata = await self.fetch_cookie(type)
-        else:
-            metadata = (("cookie", existing_cookie),)
-        return metadata
-
-    async def load_cookie(self, type):
-        metadata = None
-        if self.insecure:
-            return metadata
-
-        if type == "chain":
-            if self.chain_cookie != "":
-                metadata = await self.renew_cookie(self.chain_cookie, type)
-                self.set_cookie(metadata, type)
-            else:
-                metadata = await self.fetch_cookie(type)
-                self.set_cookie(metadata, type)
-
-        if type == "exchange":
-            if self.exchange_cookie != "":
-                metadata = await self.renew_cookie(self.exchange_cookie, type)
-                self.set_cookie(metadata, type)
-            else:
-                metadata = await self.fetch_cookie(type)
-                self.set_cookie(metadata, type)
-
-        return metadata
-
-    def set_cookie(self, metadata, type):
-        new_cookie = None
-        if self.insecure:
-            return new_cookie
-
-        for k, v in metadata:
-            if k == "set-cookie":
-                new_cookie = v
-
-        if new_cookie == None:
-            return
-
-        if type == "chain":
-            # write to client instance
-            self.chain_cookie = new_cookie
-            # write to disk
-            cookie_file = open(self.chain_cookie_location, "w")
-            cookie_file.write(new_cookie)
-            cookie_file.close()
-            LoggerProvider().logger_for_class(logging_class=self.__class__).info("chain session cookie saved to disk")
-
-        if type == "exchange":
-            self.exchange_cookie = new_cookie
-
     # default client methods
     async def get_latest_block(self) -> tendermint_query.GetLatestBlockResponse:
         req = tendermint_query.GetLatestBlockRequest()
         return await self.stubCosmosTendermint.GetLatestBlock(req)
 
     async def get_account(self, address: str) -> Optional[account_pb2.EthAccount]:
         try:
-            metadata = await self.load_cookie(type="chain")
+            metadata = await self.network.chain_metadata(
+                metadata_query_provider=self._chain_cookie_metadata_requestor)
             account_any = (await self.stubAuth.Account(
                 auth_query.QueryAccountRequest(address=address), metadata=metadata
             )).account
@@ -379,7 +261,8 @@ async def simulate_tx(
     ) -> Tuple[Union[abci_type.SimulationResponse, grpc.RpcError], bool]:
         try:
             req = tx_service.SimulateRequest(tx_bytes=tx_byte)
-            metadata = await self.load_cookie(type="chain")
+            metadata = await self.network.chain_metadata(
+                metadata_query_provider=self._chain_cookie_metadata_requestor)
             return await self.stubTx.Simulate(request=req, metadata=metadata), True
         except grpc.RpcError as err:
             return err, False
@@ -388,23 +271,23 @@ async def send_tx_sync_mode(self, tx_byte: bytes) -> abci_type.TxResponse:
         req = tx_service.BroadcastTxRequest(
             tx_bytes=tx_byte, mode=tx_service.BroadcastMode.BROADCAST_MODE_SYNC
         )
-        metadata = await self.load_cookie(type="chain")
+        metadata = await self.network.chain_metadata(metadata_query_provider=self._chain_cookie_metadata_requestor)
         result = await self.stubTx.BroadcastTx(request=req, metadata=metadata)
         return result.tx_response
 
     async def send_tx_async_mode(self, tx_byte: bytes) -> abci_type.TxResponse:
         req = tx_service.BroadcastTxRequest(
             tx_bytes=tx_byte, mode=tx_service.BroadcastMode.BROADCAST_MODE_ASYNC
         )
-        metadata = await self.load_cookie(type="chain")
+        metadata = await self.network.chain_metadata(metadata_query_provider=self._chain_cookie_metadata_requestor)
         result = await self.stubTx.BroadcastTx(request=req, metadata=metadata)
         return result.tx_response
 
     async def send_tx_block_mode(self, tx_byte: bytes) -> abci_type.TxResponse:
         req = tx_service.BroadcastTxRequest(
             tx_bytes=tx_byte, mode=tx_service.BroadcastMode.BROADCAST_MODE_BLOCK
         )
-        metadata = await self.load_cookie(type="chain")
+        metadata = await self.network.chain_metadata(metadata_query_provider=self._chain_cookie_metadata_requestor)
         result = await self.stubTx.BroadcastTx(request=req, metadata=metadata)
         return result.tx_response
 
@@ -672,7 +555,9 @@ async def stream_spot_markets(self, **kwargs):
         req = spot_exchange_rpc_pb.StreamMarketsRequest(
             market_ids=kwargs.get("market_ids")
         )
-        metadata = await self.load_cookie(type="exchange")
+        metadata = await self.network.exchange_metadata(
+            metadata_query_provider=self._exchange_cookie_metadata_requestor
+        )
         return self.stubSpotExchange.StreamMarkets(request=req, metadata=metadata)
 
     async def get_spot_orderbookV2(self, market_id: str):
@@ -729,12 +614,16 @@ async def get_spot_trades(self, **kwargs):
 
     async def stream_spot_orderbook_snapshot(self, market_ids: List[str]):
         req = spot_exchange_rpc_pb.StreamOrderbookV2Request(market_ids=market_ids)
-        metadata = await self.load_cookie(type="exchange")
+        metadata = await self.network.exchange_metadata(
+            metadata_query_provider=self._exchange_cookie_metadata_requestor
+        )
         return self.stubSpotExchange.StreamOrderbookV2(request=req, metadata=metadata)
 
     async def stream_spot_orderbook_update(self, market_ids: List[str]):
         req = spot_exchange_rpc_pb.StreamOrderbookUpdateRequest(market_ids=market_ids)
-        metadata = await self.load_cookie(type="exchange")
+        metadata = await self.network.exchange_metadata(
+            metadata_query_provider=self._exchange_cookie_metadata_requestor
+        )
         return self.stubSpotExchange.StreamOrderbookUpdate(request=req, metadata=metadata)
 
     async def stream_spot_orders(self, market_id: str, **kwargs):
@@ -743,7 +632,9 @@ async def stream_spot_orders(self, market_id: str, **kwargs):
             order_side=kwargs.get("order_side"),
             subaccount_id=kwargs.get("subaccount_id"),
         )
-        metadata = await self.load_cookie(type="exchange")
+        metadata = await self.network.exchange_metadata(
+            metadata_query_provider=self._exchange_cookie_metadata_requestor
+        )
         return self.stubSpotExchange.StreamOrders(request=req, metadata=metadata)
 
     async def stream_historical_spot_orders(self, market_id: str, **kwargs):
@@ -755,7 +646,9 @@ async def stream_historical_spot_orders(self, market_id: str, **kwargs):
             state=kwargs.get("state"),
             execution_types=kwargs.get("execution_types")
         )
-        metadata = await self.load_cookie(type="exchange")
+        metadata = await self.network.exchange_metadata(
+            metadata_query_provider=self._exchange_cookie_metadata_requestor
+        )
         return self.stubSpotExchange.StreamOrdersHistory(request=req, metadata=metadata)
 
     async def stream_historical_derivative_orders(self, market_id: str, **kwargs):
@@ -767,7 +660,9 @@ async def stream_historical_derivative_orders(self, market_id: str, **kwargs):
             state=kwargs.get("state"),
             execution_types=kwargs.get("execution_types")
         )
-        metadata = await self.load_cookie(type="exchange")
+        metadata = await self.network.exchange_metadata(
+            metadata_query_provider=self._exchange_cookie_metadata_requestor
+        )
         return self.stubDerivativeExchange.StreamOrdersHistory(request=req, metadata=metadata)
 
     async def stream_spot_trades(self, **kwargs):
@@ -780,7 +675,9 @@ async def stream_spot_trades(self, **kwargs):
             subaccount_ids=kwargs.get("subaccount_ids"),
             execution_types=kwargs.get("execution_types"),
         )
-        metadata = await self.load_cookie(type="exchange")
+        metadata = await self.network.exchange_metadata(
+            metadata_query_provider=self._exchange_cookie_metadata_requestor
+        )
         return self.stubSpotExchange.StreamTrades(request=req, metadata=metadata)
 
     async def get_spot_subaccount_orders(self, subaccount_id: str, **kwargs):
@@ -820,7 +717,9 @@ async def stream_derivative_markets(self, **kwargs):
         req = derivative_exchange_rpc_pb.StreamMarketRequest(
             market_ids=kwargs.get("market_ids")
         )
-        metadata = await self.load_cookie(type="exchange")
+        metadata = await self.network.exchange_metadata(
+            metadata_query_provider=self._exchange_cookie_metadata_requestor
+        )
         return self.stubDerivativeExchange.StreamMarket(request=req, metadata=metadata)
 
     async def get_derivative_orderbook(self, market_id: str):
@@ -886,12 +785,16 @@ async def get_derivative_trades(self, **kwargs):
 
     async def stream_derivative_orderbook_snapshot(self, market_ids: List[str]):
         req = derivative_exchange_rpc_pb.StreamOrderbookV2Request(market_ids=market_ids)
-        metadata = await self.load_cookie(type="exchange")
+        metadata = await self.network.exchange_metadata(
+            metadata_query_provider=self._exchange_cookie_metadata_requestor
+        )
         return self.stubDerivativeExchange.StreamOrderbookV2(request=req, metadata=metadata)
 
     async def stream_derivative_orderbook_update(self, market_ids: List[str]):
         req = derivative_exchange_rpc_pb.StreamOrderbookUpdateRequest(market_ids=market_ids)
-        metadata = await self.load_cookie(type="exchange")
+        metadata = await self.network.exchange_metadata(
+            metadata_query_provider=self._exchange_cookie_metadata_requestor
+        )
         return self.stubDerivativeExchange.StreamOrderbookUpdate(request=req, metadata=metadata)
 
     async def stream_derivative_orders(self, market_id: str, **kwargs):
@@ -900,7 +803,9 @@ async def stream_derivative_orders(self, market_id: str, **kwargs):
             order_side=kwargs.get("order_side"),
             subaccount_id=kwargs.get("subaccount_id"),
         )
-        metadata = await self.load_cookie(type="exchange")
+        metadata = await self.network.exchange_metadata(
+            metadata_query_provider=self._exchange_cookie_metadata_requestor
+        )
         return self.stubDerivativeExchange.StreamOrders(request=req, metadata=metadata)
 
     async def stream_derivative_trades(self, **kwargs):
@@ -915,7 +820,9 @@ async def stream_derivative_trades(self, **kwargs):
             limit=kwargs.get("limit"),
             execution_types=kwargs.get("execution_types"),
         )
-        metadata = await self.load_cookie(type="exchange")
+        metadata = await self.network.exchange_metadata(
+            metadata_query_provider=self._exchange_cookie_metadata_requestor
+        )
         return self.stubDerivativeExchange.StreamTrades(request=req, metadata=metadata)
 
     async def get_derivative_positions(self, **kwargs):
@@ -937,7 +844,9 @@ async def stream_derivative_positions(self, **kwargs):
             subaccount_id=kwargs.get("subaccount_id"),
             subaccount_ids=kwargs.get("subaccount_ids"),
         )
-        metadata = await self.load_cookie(type="exchange")
+        metadata = await self.network.exchange_metadata(
+            metadata_query_provider=self._exchange_cookie_metadata_requestor
+        )
         return self.stubDerivativeExchange.StreamPositions(request=req, metadata=metadata)
 
     async def get_derivative_liquidable_positions(self, **kwargs):
@@ -1013,7 +922,9 @@ async def stream_account_portfolio(self, account_address: str, **kwargs):
             subaccount_id=kwargs.get("subaccount_id"),
             type=kwargs.get("type")
         )
-        metadata = await self.load_cookie(type="exchange")
+        metadata = await self.network.exchange_metadata(
+            metadata_query_provider=self._exchange_cookie_metadata_requestor
+        )
         return self.stubPortfolio.StreamAccountPortfolio(request=req, metadata=metadata)
 
     async def composer(self):
@@ -1152,3 +1063,11 @@ def _token_representation(self, symbol: str, token_meta, denom: str, all_tokens:
                 existing_token = token
 
         return existing_token
+
+    def _chain_cookie_metadata_requestor(self) -> Coroutine:
+        request = tendermint_query.GetLatestBlockRequest()
+        return self.stubCosmosTendermint.GetLatestBlock(request).initial_metadata()
+
+    def _exchange_cookie_metadata_requestor(self) -> Coroutine:
+        request = exchange_meta_rpc_pb.VersionRequest()
+        return self.stubMeta.Version(request).initial_metadata()