(feat) Added low level API components for the exchange explorer module, with unit tests. Included new functions in AsyncClient to use the low level API components and marked the old functions as deprecated. Updated the examples to use the new AsyncClient functions.

Author: abel

examples/exchange_client/explorer_rpc/10_GetIBCTransfers.py

@@ -1,6 +1,7 @@
 import asyncio
 
 from pyinjective.async_client import AsyncClient
+from pyinjective.client.model.pagination import PaginationOption
 from pyinjective.core.network import Network
 
 
@@ -16,15 +17,15 @@ async def main() -> None:
     dest_port = "transfer"
     limit = 1
     skip = 10
-    ibc_transfers = await client.get_ibc_transfers(
+    pagination = PaginationOption(limit=limit, skip=skip)
+    ibc_transfers = await client.fetch_ibc_transfer_txs(
         sender=sender,
         receiver=receiver,
         src_channel=src_channel,
         src_port=src_port,
-        destination_channel=destination_channel,
+        dest_channel=destination_channel,
         dest_port=dest_port,
-        limit=limit,
-        skip=skip,
+        pagination=pagination,
     )
     print(ibc_transfers)
 

examples/exchange_client/explorer_rpc/1_GetTxByHash.py

@@ -11,10 +11,10 @@ async def main() -> None:
     client = AsyncClient(network)
     composer = Composer(network=network.string())
     tx_hash = "0F3EBEC1882E1EEAC5B7BDD836E976250F1CD072B79485877CEACCB92ACDDF52"
-    transaction_response = await client.get_tx_by_hash(tx_hash=tx_hash)
+    transaction_response = await client.fetch_tx_by_tx_hash(tx_hash=tx_hash)
     print(transaction_response)
 
-    transaction_messages = composer.UnpackTransactionMessages(transaction=transaction_response.data)
+    transaction_messages = composer.unpack_transaction_messages(transaction_data=transaction_response["data"])
     print(transaction_messages)
     first_message = transaction_messages[0]
     print(first_message)

examples/exchange_client/explorer_rpc/2_AccountTxs.py

@@ -1,6 +1,7 @@
 import asyncio
 
 from pyinjective.async_client import AsyncClient
+from pyinjective.client.model.pagination import PaginationOption
 from pyinjective.composer import Composer
 from pyinjective.core.network import Network
 
@@ -13,9 +14,14 @@ async def main() -> None:
     address = "inj1phd706jqzd9wznkk5hgsfkrc8jqxv0kmlj0kex"
     message_type = "cosmos.bank.v1beta1.MsgSend"
     limit = 2
-    transactions_response = await client.get_account_txs(address=address, type=message_type, limit=limit)
+    pagination = PaginationOption(limit=limit)
+    transactions_response = await client.fetch_account_txs(
+        address=address,
+        message_type=message_type,
+        pagination=pagination,
+    )
     print(transactions_response)
-    first_transaction_messages = composer.UnpackTransactionMessages(transaction=transactions_response.data[0])
+    first_transaction_messages = composer.unpack_transaction_messages(transaction_data=transactions_response["data"][0])
     print(first_transaction_messages)
     first_message = first_transaction_messages[0]
     print(first_message)

examples/exchange_client/explorer_rpc/3_Blocks.py

@@ -1,6 +1,7 @@
 import asyncio
 
 from pyinjective.async_client import AsyncClient
+from pyinjective.client.model.pagination import PaginationOption
 from pyinjective.core.network import Network
 
 
@@ -9,8 +10,9 @@ async def main() -> None:
     network = Network.testnet()
     client = AsyncClient(network)
     limit = 2
-    block = await client.get_blocks(limit=limit)
-    print(block)
+    pagination = PaginationOption(limit=limit)
+    blocks = await client.fetch_blocks(pagination=pagination)
+    print(blocks)
 
 
 if __name__ == "__main__":

examples/exchange_client/explorer_rpc/4_Block.py

@@ -9,7 +9,7 @@ async def main() -> None:
     network = Network.testnet()
     client = AsyncClient(network)
     block_height = "5825046"
-    block = await client.get_block(block_height=block_height)
+    block = await client.fetch_block(block_id=block_height)
     print(block)
 
 

examples/exchange_client/explorer_rpc/5_TxsRequest.py

@@ -1,6 +1,7 @@
 import asyncio
 
 from pyinjective.async_client import AsyncClient
+from pyinjective.client.model.pagination import PaginationOption
 from pyinjective.core.network import Network
 
 
@@ -9,7 +10,8 @@ async def main() -> None:
     network = Network.testnet()
     client = AsyncClient(network)
     limit = 2
-    txs = await client.get_txs(limit=limit)
+    pagination = PaginationOption(limit=limit)
+    txs = await client.fetch_txs(pagination=pagination)
     print(txs)
 
 

examples/exchange_client/explorer_rpc/8_GetPeggyDeposits.py

@@ -9,7 +9,7 @@ async def main() -> None:
     network = Network.testnet()
     client = AsyncClient(network)
     receiver = "inj1phd706jqzd9wznkk5hgsfkrc8jqxv0kmlj0kex"
-    peggy_deposits = await client.get_peggy_deposits(receiver=receiver)
+    peggy_deposits = await client.fetch_peggy_deposit_txs(receiver=receiver)
     print(peggy_deposits)
 
 

examples/exchange_client/explorer_rpc/9_GetPeggyWithdrawals.py

@@ -1,6 +1,7 @@
 import asyncio
 
 from pyinjective.async_client import AsyncClient
+from pyinjective.client.model.pagination import PaginationOption
 from pyinjective.core.network import Network
 
 
@@ -10,7 +11,8 @@ async def main() -> None:
     client = AsyncClient(network)
     sender = "inj14au322k9munkmx5wrchz9q30juf5wjgz2cfqku"
     limit = 2
-    peggy_deposits = await client.get_peggy_withdrawals(sender=sender, limit=limit)
+    pagination = PaginationOption(limit=limit)
+    peggy_deposits = await client.fetch_peggy_withdrawal_txs(sender=sender, pagination=pagination)
     print(peggy_deposits)
 
 

pyinjective/async_client.py

@@ -15,6 +15,7 @@
 from pyinjective.client.indexer.grpc.indexer_grpc_account_api import IndexerGrpcAccountApi
 from pyinjective.client.indexer.grpc.indexer_grpc_auction_api import IndexerGrpcAuctionApi
 from pyinjective.client.indexer.grpc.indexer_grpc_derivative_api import IndexerGrpcDerivativeApi
+from pyinjective.client.indexer.grpc.indexer_grpc_explorer_api import IndexerGrpcExplorerApi
 from pyinjective.client.indexer.grpc.indexer_grpc_insurance_api import IndexerGrpcInsuranceApi
 from pyinjective.client.indexer.grpc.indexer_grpc_meta_api import IndexerGrpcMetaApi
 from pyinjective.client.indexer.grpc.indexer_grpc_oracle_api import IndexerGrpcOracleApi
@@ -271,6 +272,13 @@ def __init__(
             ),
         )
 
+        self.exchange_explorer_api = IndexerGrpcExplorerApi(
+            channel=self.explorer_channel,
+            metadata_provider=lambda: self.network.exchange_metadata(
+                metadata_query_provider=self._explorer_cookie_metadata_requestor
+            ),
+        )
+
     async def all_tokens(self) -> Dict[str, Token]:
         if self._tokens is None:
             async with self._tokens_and_markets_initialization_lock:
@@ -601,10 +609,22 @@ async def listen_keepalive(
     # Explorer RPC
 
     async def get_tx_by_hash(self, tx_hash: str):
+        """
+        This method is deprecated and will be removed soon. Please use `fetch_tx_by_tx_hash` instead
+        """
+        warn("This method is deprecated. Use fetch_tx_by_tx_hash instead", DeprecationWarning, stacklevel=2)
+
         req = explorer_rpc_pb.GetTxByTxHashRequest(hash=tx_hash)
         return await self.stubExplorer.GetTxByTxHash(req)
 
+    async def fetch_tx_by_tx_hash(self, tx_hash: str) -> Dict[str, Any]:
+        return await self.exchange_explorer_api.fetch_tx_by_tx_hash(tx_hash=tx_hash)
+
     async def get_account_txs(self, address: str, **kwargs):
+        """
+        This method is deprecated and will be removed soon. Please use `fetch_account_txs` instead
+        """
+        warn("This method is deprecated. Use fetch_account_txs instead", DeprecationWarning, stacklevel=2)
         req = explorer_rpc_pb.GetAccountTxsRequest(
             address=address,
             before=kwargs.get("before"),
@@ -616,19 +636,66 @@ async def get_account_txs(self, address: str, **kwargs):
         )
         return await self.stubExplorer.GetAccountTxs(req)
 
+    async def fetch_account_txs(
+        self,
+        address: str,
+        before: Optional[int] = None,
+        after: Optional[int] = None,
+        message_type: Optional[str] = None,
+        module: Optional[str] = None,
+        from_number: Optional[int] = None,
+        to_number: Optional[int] = None,
+        status: Optional[str] = None,
+        pagination: Optional[PaginationOption] = None,
+    ) -> Dict[str, Any]:
+        return await self.exchange_explorer_api.fetch_account_txs(
+            address=address,
+            before=before,
+            after=after,
+            message_type=message_type,
+            module=module,
+            from_number=from_number,
+            to_number=to_number,
+            status=status,
+            pagination=pagination,
+        )
+
     async def get_blocks(self, **kwargs):
+        """
+        This method is deprecated and will be removed soon. Please use `fetch_blocks` instead
+        """
+        warn("This method is deprecated. Use fetch_blocks instead", DeprecationWarning, stacklevel=2)
         req = explorer_rpc_pb.GetBlocksRequest(
             before=kwargs.get("before"),
             after=kwargs.get("after"),
             limit=kwargs.get("limit"),
         )
         return await self.stubExplorer.GetBlocks(req)
 
+    async def fetch_blocks(
+        self,
+        before: Optional[int] = None,
+        after: Optional[int] = None,
+        pagination: Optional[PaginationOption] = None,
+    ) -> Dict[str, Any]:
+        return await self.exchange_explorer_api.fetch_blocks(before=before, after=after, pagination=pagination)
+
     async def get_block(self, block_height: str):
+        """
+        This method is deprecated and will be removed soon. Please use `fetch_block` instead
+        """
+        warn("This method is deprecated. Use fetch_block instead", DeprecationWarning, stacklevel=2)
         req = explorer_rpc_pb.GetBlockRequest(id=block_height)
         return await self.stubExplorer.GetBlock(req)
 
+    async def fetch_block(self, block_id: str) -> Dict[str, Any]:
+        return await self.exchange_explorer_api.fetch_block(block_id=block_id)
+
     async def get_txs(self, **kwargs):
+        """
+        This method is deprecated and will be removed soon. Please use `fetch_txs` instead
+        """
+        warn("This method is deprecated. Use fetch_txs instead", DeprecationWarning, stacklevel=2)
         req = explorer_rpc_pb.GetTxsRequest(
             before=kwargs.get("before"),
             after=kwargs.get("after"),
@@ -639,6 +706,28 @@ async def get_txs(self, **kwargs):
         )
         return await self.stubExplorer.GetTxs(req)
 
+    async def fetch_txs(
+        self,
+        before: Optional[int] = None,
+        after: Optional[int] = None,
+        message_type: Optional[str] = None,
+        module: Optional[str] = None,
+        from_number: Optional[int] = None,
+        to_number: Optional[int] = None,
+        status: Optional[str] = None,
+        pagination: Optional[PaginationOption] = None,
+    ) -> Dict[str, Any]:
+        return await self.exchange_explorer_api.fetch_txs(
+            before=before,
+            after=after,
+            message_type=message_type,
+            module=module,
+            from_number=from_number,
+            to_number=to_number,
+            status=status,
+            pagination=pagination,
+        )
+
     async def stream_txs(self):
         req = explorer_rpc_pb.StreamTxsRequest()
         return self.stubExplorer.StreamTxs(req)
@@ -648,6 +737,10 @@ async def stream_blocks(self):
         return self.stubExplorer.StreamBlocks(req)
 
     async def get_peggy_deposits(self, **kwargs):
+        """
+        This method is deprecated and will be removed soon. Please use `fetch_peggy_deposit_txs` instead
+        """
+        warn("This method is deprecated. Use fetch_peggy_deposit_txs instead", DeprecationWarning, stacklevel=2)
         req = explorer_rpc_pb.GetPeggyDepositTxsRequest(
             sender=kwargs.get("sender"),
             receiver=kwargs.get("receiver"),
@@ -656,7 +749,23 @@ async def get_peggy_deposits(self, **kwargs):
         )
         return await self.stubExplorer.GetPeggyDepositTxs(req)
 
+    async def fetch_peggy_deposit_txs(
+        self,
+        sender: Optional[str] = None,
+        receiver: Optional[str] = None,
+        pagination: Optional[PaginationOption] = None,
+    ) -> Dict[str, Any]:
+        return await self.exchange_explorer_api.fetch_peggy_deposit_txs(
+            sender=sender,
+            receiver=receiver,
+            pagination=pagination,
+        )
+
     async def get_peggy_withdrawals(self, **kwargs):
+        """
+        This method is deprecated and will be removed soon. Please use `fetch_peggy_withdrawal_txs` instead
+        """
+        warn("This method is deprecated. Use fetch_peggy_withdrawal_txs instead", DeprecationWarning, stacklevel=2)
         req = explorer_rpc_pb.GetPeggyWithdrawalTxsRequest(
             sender=kwargs.get("sender"),
             receiver=kwargs.get("receiver"),
@@ -665,7 +774,23 @@ async def get_peggy_withdrawals(self, **kwargs):
         )
         return await self.stubExplorer.GetPeggyWithdrawalTxs(req)
 
+    async def fetch_peggy_withdrawal_txs(
+        self,
+        sender: Optional[str] = None,
+        receiver: Optional[str] = None,
+        pagination: Optional[PaginationOption] = None,
+    ) -> Dict[str, Any]:
+        return await self.exchange_explorer_api.fetch_peggy_withdrawal_txs(
+            sender=sender,
+            receiver=receiver,
+            pagination=pagination,
+        )
+
     async def get_ibc_transfers(self, **kwargs):
+        """
+        This method is deprecated and will be removed soon. Please use `fetch_ibc_transfer_txs` instead
+        """
+        warn("This method is deprecated. Use fetch_ibc_transfer_txs instead", DeprecationWarning, stacklevel=2)
         req = explorer_rpc_pb.GetIBCTransferTxsRequest(
             sender=kwargs.get("sender"),
             receiver=kwargs.get("receiver"),
@@ -678,6 +803,26 @@ async def get_ibc_transfers(self, **kwargs):
         )
         return await self.stubExplorer.GetIBCTransferTxs(req)
 
+    async def fetch_ibc_transfer_txs(
+        self,
+        sender: Optional[str] = None,
+        receiver: Optional[str] = None,
+        src_channel: Optional[str] = None,
+        src_port: Optional[str] = None,
+        dest_channel: Optional[str] = None,
+        dest_port: Optional[str] = None,
+        pagination: Optional[PaginationOption] = None,
+    ) -> Dict[str, Any]:
+        return await self.exchange_explorer_api.fetch_ibc_transfer_txs(
+            sender=sender,
+            receiver=receiver,
+            src_channel=src_channel,
+            src_port=src_port,
+            dest_channel=dest_channel,
+            dest_port=dest_port,
+            pagination=pagination,
+        )
+
     # AccountsRPC
 
     async def stream_subaccount_balance(self, subaccount_id: str, **kwargs):
@@ -2390,6 +2535,10 @@ def _exchange_cookie_metadata_requestor(self) -> Coroutine:
         request = exchange_meta_rpc_pb.VersionRequest()
         return self.stubMeta.Version(request).initial_metadata()
 
+    def _explorer_cookie_metadata_requestor(self) -> Coroutine:
+        request = explorer_rpc_pb.GetBlocksRequest()
+        return self.stubExplorer.GetBlocks(request).initial_metadata()
+
     def _initialize_timeout_height_sync_task(self):
         self._cancel_timeout_height_sync_task()
         self._timeout_height_sync_task = asyncio.get_event_loop().create_task(self._timeout_height_sync_process())