(feat) Added support for all distribution module queries. Added also new example scripts for all queries and unit tests

abel · abel · commit 65e6e999ddce · 2024-02-13T00:04:45.000-03:00
diff --git a/examples/chain_client/distribution/1_ValidatorDistributionInfo.py b/examples/chain_client/distribution/1_ValidatorDistributionInfo.py
@@ -0,0 +1,16 @@
+import asyncio
+
+from pyinjective.async_client import AsyncClient
+from pyinjective.core.network import Network
+
+
+async def main() -> None:
+    network = Network.testnet()
+    client = AsyncClient(network)
+    validator_address = "injvaloper1jue5dpr9lerjn6wlwtrywxrsenrf28ru89z99z"
+    distribution_info = await client.fetch_validator_distribution_info(validator_address=validator_address)
+    print(distribution_info)
+
+
+if __name__ == "__main__":
+    asyncio.get_event_loop().run_until_complete(main())
diff --git a/examples/chain_client/distribution/2_ValidatorOutstandingRewards.py b/examples/chain_client/distribution/2_ValidatorOutstandingRewards.py
@@ -0,0 +1,16 @@
+import asyncio
+
+from pyinjective.async_client import AsyncClient
+from pyinjective.core.network import Network
+
+
+async def main() -> None:
+    network = Network.testnet()
+    client = AsyncClient(network)
+    validator_address = "injvaloper1jue5dpr9lerjn6wlwtrywxrsenrf28ru89z99z"
+    rewards = await client.fetch_validator_outstanding_rewards(validator_address=validator_address)
+    print(rewards)
+
+
+if __name__ == "__main__":
+    asyncio.get_event_loop().run_until_complete(main())
diff --git a/examples/chain_client/distribution/3_ValidatorCommission.py b/examples/chain_client/distribution/3_ValidatorCommission.py
@@ -0,0 +1,16 @@
+import asyncio
+
+from pyinjective.async_client import AsyncClient
+from pyinjective.core.network import Network
+
+
+async def main() -> None:
+    network = Network.testnet()
+    client = AsyncClient(network)
+    validator_address = "injvaloper1jue5dpr9lerjn6wlwtrywxrsenrf28ru89z99z"
+    commission = await client.fetch_validator_commission(validator_address=validator_address)
+    print(commission)
+
+
+if __name__ == "__main__":
+    asyncio.get_event_loop().run_until_complete(main())
diff --git a/examples/chain_client/distribution/4_ValidatorSlashes.py b/examples/chain_client/distribution/4_ValidatorSlashes.py
@@ -0,0 +1,20 @@
+import asyncio
+
+from pyinjective.async_client import AsyncClient
+from pyinjective.client.model.pagination import PaginationOption
+from pyinjective.core.network import Network
+
+
+async def main() -> None:
+    # select network: local, testnet, mainnet
+    network = Network.testnet()
+    client = AsyncClient(network)
+    limit = 2
+    pagination = PaginationOption(limit=limit)
+    validator_address = "injvaloper1jue5dpr9lerjn6wlwtrywxrsenrf28ru89z99z"
+    contracts = await client.fetch_validator_slashes(validator_address=validator_address, pagination=pagination)
+    print(contracts)
+
+
+if __name__ == "__main__":
+    asyncio.get_event_loop().run_until_complete(main())
diff --git a/examples/chain_client/distribution/5_DelegationRewards.py b/examples/chain_client/distribution/5_DelegationRewards.py
@@ -0,0 +1,19 @@
+import asyncio
+
+from pyinjective.async_client import AsyncClient
+from pyinjective.core.network import Network
+
+
+async def main() -> None:
+    network = Network.testnet()
+    client = AsyncClient(network)
+    delegator_address = "inj1hkhdaj2a2clmq5jq6mspsggqs32vynpk228q3r"
+    validator_address = "injvaloper156t3yxd4udv0h9gwagfcmwnmm3quy0nph7tyh5"
+    rewards = await client.fetch_delegation_rewards(
+        delegator_address=delegator_address, validator_address=validator_address
+    )
+    print(rewards)
+
+
+if __name__ == "__main__":
+    asyncio.get_event_loop().run_until_complete(main())
diff --git a/examples/chain_client/distribution/6_DelegationTotalRewards.py b/examples/chain_client/distribution/6_DelegationTotalRewards.py
@@ -0,0 +1,18 @@
+import asyncio
+
+from pyinjective.async_client import AsyncClient
+from pyinjective.core.network import Network
+
+
+async def main() -> None:
+    network = Network.testnet()
+    client = AsyncClient(network)
+    delegator_address = "inj1hkhdaj2a2clmq5jq6mspsggqs32vynpk228q3r"
+    rewards = await client.fetch_delegation_total_rewards(
+        delegator_address=delegator_address,
+    )
+    print(rewards)
+
+
+if __name__ == "__main__":
+    asyncio.get_event_loop().run_until_complete(main())
diff --git a/examples/chain_client/distribution/7_DelegatorValidators.py b/examples/chain_client/distribution/7_DelegatorValidators.py
@@ -0,0 +1,18 @@
+import asyncio
+
+from pyinjective.async_client import AsyncClient
+from pyinjective.core.network import Network
+
+
+async def main() -> None:
+    network = Network.testnet()
+    client = AsyncClient(network)
+    delegator_address = "inj1hkhdaj2a2clmq5jq6mspsggqs32vynpk228q3r"
+    validators = await client.fetch_delegator_validators(
+        delegator_address=delegator_address,
+    )
+    print(validators)
+
+
+if __name__ == "__main__":
+    asyncio.get_event_loop().run_until_complete(main())
diff --git a/examples/chain_client/distribution/8_DelegatorWithdrawAddress.py b/examples/chain_client/distribution/8_DelegatorWithdrawAddress.py
@@ -0,0 +1,18 @@
+import asyncio
+
+from pyinjective.async_client import AsyncClient
+from pyinjective.core.network import Network
+
+
+async def main() -> None:
+    network = Network.testnet()
+    client = AsyncClient(network)
+    delegator_address = "inj1hkhdaj2a2clmq5jq6mspsggqs32vynpk228q3r"
+    withdraw_address = await client.fetch_delegator_withdraw_address(
+        delegator_address=delegator_address,
+    )
+    print(withdraw_address)
+
+
+if __name__ == "__main__":
+    asyncio.get_event_loop().run_until_complete(main())
diff --git a/examples/chain_client/distribution/9_CommunityPool.py b/examples/chain_client/distribution/9_CommunityPool.py
@@ -0,0 +1,15 @@
+import asyncio
+
+from pyinjective.async_client import AsyncClient
+from pyinjective.core.network import Network
+
+
+async def main() -> None:
+    network = Network.testnet()
+    client = AsyncClient(network)
+    community_pool = await client.fetch_community_pool()
+    print(community_pool)
+
+
+if __name__ == "__main__":
+    asyncio.get_event_loop().run_until_complete(main())
diff --git a/pyinjective/async_client.py b/pyinjective/async_client.py
@@ -12,6 +12,7 @@
 from pyinjective.client.chain.grpc.chain_grpc_auth_api import ChainGrpcAuthApi
 from pyinjective.client.chain.grpc.chain_grpc_authz_api import ChainGrpcAuthZApi
 from pyinjective.client.chain.grpc.chain_grpc_bank_api import ChainGrpcBankApi
+from pyinjective.client.chain.grpc.chain_grpc_distribution_api import ChainGrpcDistributionApi
 from pyinjective.client.chain.grpc.chain_grpc_token_factory_api import ChainGrpcTokenFactoryApi
 from pyinjective.client.chain.grpc.chain_grpc_wasm_api import ChainGrpcWasmApi
 from pyinjective.client.chain.grpc_stream.chain_grpc_chain_stream import ChainGrpcChainStream
@@ -178,6 +179,12 @@ def __init__(
                 metadata_query_provider=self._chain_cookie_metadata_requestor
             ),
         )
+        self.distribution_api = ChainGrpcDistributionApi(
+            channel=self.chain_channel,
+            metadata_provider=lambda: self.network.chain_metadata(
+                metadata_query_provider=self._chain_cookie_metadata_requestor
+            ),
+        )
         self.token_factory_api = ChainGrpcTokenFactoryApi(
             channel=self.chain_channel,
             metadata_provider=lambda: self.network.chain_metadata(
@@ -572,6 +579,66 @@ async def fetch_send_enabled(
     ) -> Dict[str, Any]:
         return await self.bank_api.fetch_send_enabled(denoms=denoms, pagination=pagination)
 
+    async def fetch_validator_distribution_info(self, validator_address: str) -> Dict[str, Any]:
+        return await self.distribution_api.fetch_validator_distribution_info(validator_address=validator_address)
+
+    async def fetch_validator_outstanding_rewards(self, validator_address: str) -> Dict[str, Any]:
+        return await self.distribution_api.fetch_validator_outstanding_rewards(validator_address=validator_address)
+
+    async def fetch_validator_commission(self, validator_address: str) -> Dict[str, Any]:
+        return await self.distribution_api.fetch_validator_commission(validator_address=validator_address)
+
+    async def fetch_validator_slashes(
+        self,
+        validator_address: str,
+        starting_height: Optional[int] = None,
+        ending_height: Optional[int] = None,
+        pagination: Optional[PaginationOption] = None,
+    ) -> Dict[str, Any]:
+        return await self.distribution_api.fetch_validator_slashes(
+            validator_address=validator_address,
+            starting_height=starting_height,
+            ending_height=ending_height,
+            pagination=pagination,
+        )
+
+    async def fetch_delegation_rewards(
+        self,
+        delegator_address: str,
+        validator_address: str,
+    ) -> Dict[str, Any]:
+        return await self.distribution_api.fetch_delegation_rewards(
+            delegator_address=delegator_address,
+            validator_address=validator_address,
+        )
+
+    async def fetch_delegation_total_rewards(
+        self,
+        delegator_address: str,
+    ) -> Dict[str, Any]:
+        return await self.distribution_api.fetch_delegation_total_rewards(
+            delegator_address=delegator_address,
+        )
+
+    async def fetch_delegator_validators(
+        self,
+        delegator_address: str,
+    ) -> Dict[str, Any]:
+        return await self.distribution_api.fetch_delegator_validators(
+            delegator_address=delegator_address,
+        )
+
+    async def fetch_delegator_withdraw_address(
+        self,
+        delegator_address: str,
+    ) -> Dict[str, Any]:
+        return await self.distribution_api.fetch_delegator_withdraw_address(
+            delegator_address=delegator_address,
+        )
+
+    async def fetch_community_pool(self) -> Dict[str, Any]:
+        return await self.distribution_api.fetch_community_pool()
+
     # Injective Exchange client methods
 
     # Auction RPC
diff --git a/pyinjective/client/chain/grpc/chain_grpc_distribution_api.py b/pyinjective/client/chain/grpc/chain_grpc_distribution_api.py
@@ -0,0 +1,109 @@
+from typing import Any, Callable, Dict, Optional
+
+from grpc.aio import Channel
+
+from pyinjective.client.model.pagination import PaginationOption
+from pyinjective.proto.cosmos.distribution.v1beta1 import (
+    query_pb2 as distribution_query_pb,
+    query_pb2_grpc as distribution_query_grpc,
+)
+from pyinjective.utils.grpc_api_request_assistant import GrpcApiRequestAssistant
+
+
+class ChainGrpcDistributionApi:
+    def __init__(self, channel: Channel, metadata_provider: Callable):
+        self._stub = distribution_query_grpc.QueryStub(channel)
+        self._assistant = GrpcApiRequestAssistant(metadata_provider=metadata_provider)
+
+    async def fetch_module_params(self) -> Dict[str, Any]:
+        request = distribution_query_pb.QueryParamsRequest()
+        response = await self._execute_call(call=self._stub.Params, request=request)
+
+        return response
+
+    async def fetch_validator_distribution_info(self, validator_address: str) -> Dict[str, Any]:
+        request = distribution_query_pb.QueryValidatorDistributionInfoRequest(validator_address=validator_address)
+        response = await self._execute_call(call=self._stub.ValidatorDistributionInfo, request=request)
+
+        return response
+
+    async def fetch_validator_outstanding_rewards(self, validator_address: str) -> Dict[str, Any]:
+        request = distribution_query_pb.QueryValidatorOutstandingRewardsRequest(validator_address=validator_address)
+        response = await self._execute_call(call=self._stub.ValidatorOutstandingRewards, request=request)
+
+        return response
+
+    async def fetch_validator_commission(self, validator_address: str) -> Dict[str, Any]:
+        request = distribution_query_pb.QueryValidatorCommissionRequest(validator_address=validator_address)
+        response = await self._execute_call(call=self._stub.ValidatorCommission, request=request)
+
+        return response
+
+    async def fetch_validator_slashes(
+        self,
+        validator_address: str,
+        starting_height: Optional[int] = None,
+        ending_height: Optional[int] = None,
+        pagination: Optional[PaginationOption] = None,
+    ) -> Dict[str, Any]:
+        pagination_request = None
+        if pagination is not None:
+            pagination_request = pagination.create_pagination_request()
+        request = distribution_query_pb.QueryValidatorSlashesRequest(
+            validator_address=validator_address,
+            starting_height=starting_height,
+            ending_height=ending_height,
+            pagination=pagination_request,
+        )
+        response = await self._execute_call(call=self._stub.ValidatorSlashes, request=request)
+
+        return response
+
+    async def fetch_delegation_rewards(
+        self,
+        delegator_address: str,
+        validator_address: str,
+    ) -> Dict[str, Any]:
+        request = distribution_query_pb.QueryDelegationRewardsRequest(
+            delegator_address=delegator_address,
+            validator_address=validator_address,
+        )
+        response = await self._execute_call(call=self._stub.DelegationRewards, request=request)
+
+        return response
+
+    async def fetch_delegation_total_rewards(
+        self,
+        delegator_address: str,
+    ) -> Dict[str, Any]:
+        request = distribution_query_pb.QueryDelegationTotalRewardsRequest(
+            delegator_address=delegator_address,
+        )
+        response = await self._execute_call(call=self._stub.DelegationTotalRewards, request=request)
+
+        return response
+
+    async def fetch_delegator_validators(self, delegator_address: str) -> Dict[str, Any]:
+        request = distribution_query_pb.QueryDelegatorValidatorsRequest(
+            delegator_address=delegator_address,
+        )
+        response = await self._execute_call(call=self._stub.DelegatorValidators, request=request)
+
+        return response
+
+    async def fetch_delegator_withdraw_address(self, delegator_address: str) -> Dict[str, Any]:
+        request = distribution_query_pb.QueryDelegatorWithdrawAddressRequest(
+            delegator_address=delegator_address,
+        )
+        response = await self._execute_call(call=self._stub.DelegatorWithdrawAddress, request=request)
+
+        return response
+
+    async def fetch_community_pool(self) -> Dict[str, Any]:
+        request = distribution_query_pb.QueryCommunityPoolRequest()
+        response = await self._execute_call(call=self._stub.CommunityPool, request=request)
+
+        return response
+
+    async def _execute_call(self, call: Callable, request) -> Dict[str, Any]:
+        return await self._assistant.execute_call(call=call, request=request)
diff --git a/tests/client/chain/grpc/configurable_authz_query_servicer.py b/tests/client/chain/grpc/configurable_authz_query_servicer.py
diff --git a/tests/client/chain/grpc/configurable_distribution_query_servicer.py b/tests/client/chain/grpc/configurable_distribution_query_servicer.py
diff --git a/tests/client/chain/grpc/test_chain_grpc_distribution_api.py b/tests/client/chain/grpc/test_chain_grpc_distribution_api.py
