Feat/network refactoring from master to dev #320
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -95,7 +95,7 @@ def __init__( | |
| self, | ||
| network: Network, | ||
| insecure: Optional[bool] = None, | ||
| credentials=None, | ||
| ): | ||
| # the `insecure` parameter is ignored and will be deprecated soon. The value is taken directly from `network` | ||
| if insecure is not None: | ||
|
|
@@ -104,6 +104,13 @@ def __init__( | |
| DeprecationWarning, | ||
| stacklevel=2, | ||
| ) | ||
| # the `credentials` parameter is ignored and will be deprecated soon. The value is taken directly from `network` | ||
| if credentials is not None: | ||
| warn( | ||
| "credentials parameter in AsyncClient is no longer used and will be deprecated", | ||
| DeprecationWarning, | ||
| stacklevel=2, | ||
| ) | ||
|
|
||
| self.addr = "" | ||
| self.number = 0 | ||
|
Comment on lines
104
to
116
Contributor
There was a problem hiding this comment. Tip Codebase Verification The output from the executed script reveals extensive usage of the However, the direct usage of the Given this information, it is clear that while the deprecation of the Conclusion:
Action Items:
Analysis chain
Deprecation of Ensure that all dependent code has been updated to use the new method of handling credentials through the Scripts ExecutedThe following scripts were executed for the analysis: Script: #!/bin/bash
# Search for any remaining direct uses of the `credentials` parameter in the codebase.
rg --type py 'credentials='
Length of output: 125138 |
||
|
|
@@ -112,11 +119,7 @@ def __init__( | |
| self.network = network | ||
|
|
||
| # chain stubs | ||
| self.chain_channel = self.network.create_chain_grpc_channel() | ||
|
|
||
| self.stubCosmosTendermint = tendermint_query_grpc.ServiceStub(self.chain_channel) | ||
| self.stubAuth = auth_query_grpc.QueryStub(self.chain_channel) | ||
|
|
@@ -128,11 +131,7 @@ def __init__( | |
| self.timeout_height = 1 | ||
|
|
||
| # exchange stubs | ||
| self.exchange_channel = self.network.create_exchange_grpc_channel() | ||
| self.stubMeta = exchange_meta_rpc_grpc.InjectiveMetaRPCStub(self.exchange_channel) | ||
| self.stubExchangeAccount = exchange_accounts_rpc_grpc.InjectiveAccountsRPCStub(self.exchange_channel) | ||
| self.stubOracle = oracle_rpc_grpc.InjectiveOracleRPCStub(self.exchange_channel) | ||
|
|
@@ -145,18 +144,10 @@ def __init__( | |
| self.stubPortfolio = portfolio_rpc_grpc.InjectivePortfolioRPCStub(self.exchange_channel) | ||
|
|
||
| # explorer stubs | ||
| self.explorer_channel = self.network.create_explorer_grpc_channel() | ||
| self.stubExplorer = explorer_rpc_grpc.InjectiveExplorerRPCStub(self.explorer_channel) | ||
|
|
||
| self.chain_stream_channel = self.network.create_chain_stream_grpc_channel() | ||
| self.chain_stream_stub = stream_rpc_grpc.StreamStub(channel=self.chain_stream_channel) | ||
|
|
||
| self._timeout_height_sync_task = None | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,10 @@ | |
| from abc import ABC, abstractmethod | ||
| from http.cookies import SimpleCookie | ||
| from typing import List, Optional | ||
| from warnings import warn | ||
|
|
||
| import grpc | ||
| from grpc import ChannelCredentials | ||
| from grpc.aio import Call, Metadata | ||
|
|
||
|
|
||
|
|
@@ -115,8 +118,20 @@ def __init__( | |
| chain_cookie_assistant: CookieAssistant, | ||
| exchange_cookie_assistant: CookieAssistant, | ||
| explorer_cookie_assistant: CookieAssistant, | ||
| use_secure_connection: Optional[bool] = None, | ||
| grpc_channel_credentials: Optional[ChannelCredentials] = None, | ||
| grpc_exchange_channel_credentials: Optional[ChannelCredentials] = None, | ||
| grpc_explorer_channel_credentials: Optional[ChannelCredentials] = None, | ||
| chain_stream_channel_credentials: Optional[ChannelCredentials] = None, | ||
| ): | ||
| # the `use_secure_connection` parameter is ignored and will be deprecated soon. | ||
| if use_secure_connection is not None: | ||
| warn( | ||
| "use_secure_connection parameter in Network is no longer used and will be deprecated", | ||
| DeprecationWarning, | ||
| stacklevel=2, | ||
| ) | ||
|
|
||
| self.lcd_endpoint = lcd_endpoint | ||
| self.tm_websocket_endpoint = tm_websocket_endpoint | ||
| self.grpc_endpoint = grpc_endpoint | ||
|
|
@@ -129,7 +144,10 @@ def __init__( | |
| self.chain_cookie_assistant = chain_cookie_assistant | ||
| self.exchange_cookie_assistant = exchange_cookie_assistant | ||
| self.explorer_cookie_assistant = explorer_cookie_assistant | ||
| self.grpc_channel_credentials = grpc_channel_credentials | ||
| self.grpc_exchange_channel_credentials = grpc_exchange_channel_credentials | ||
| self.grpc_explorer_channel_credentials = grpc_explorer_channel_credentials | ||
| self.chain_stream_channel_credentials = chain_stream_channel_credentials | ||
|
|
||
| @classmethod | ||
| def devnet(cls): | ||
|
|
@@ -157,6 +175,11 @@ def testnet(cls, node="lb"): | |
| if node not in nodes: | ||
| raise ValueError("Must be one of {}".format(nodes)) | ||
|
|
||
| grpc_channel_credentials = grpc.ssl_channel_credentials() | ||
| grpc_exchange_channel_credentials = grpc.ssl_channel_credentials() | ||
| grpc_explorer_channel_credentials = grpc.ssl_channel_credentials() | ||
| chain_stream_channel_credentials = grpc.ssl_channel_credentials() | ||
|
|
||
| if node == "lb": | ||
| lcd_endpoint = "https://testnet.sentry.lcd.injective.network:443" | ||
| tm_websocket_endpoint = "wss://testnet.sentry.tm.injective.network:443/websocket" | ||
|
|
@@ -167,7 +190,6 @@ def testnet(cls, node="lb"): | |
| chain_cookie_assistant = BareMetalLoadBalancedCookieAssistant() | ||
| exchange_cookie_assistant = BareMetalLoadBalancedCookieAssistant() | ||
| explorer_cookie_assistant = BareMetalLoadBalancedCookieAssistant() | ||
| else: | ||
| lcd_endpoint = "https://testnet.lcd.injective.network:443" | ||
| tm_websocket_endpoint = "wss://testnet.tm.injective.network:443/websocket" | ||
|
|
@@ -178,7 +200,6 @@ def testnet(cls, node="lb"): | |
| chain_cookie_assistant = DisabledCookieAssistant() | ||
| exchange_cookie_assistant = DisabledCookieAssistant() | ||
| explorer_cookie_assistant = DisabledCookieAssistant() | ||
|
|
||
| return cls( | ||
| lcd_endpoint=lcd_endpoint, | ||
|
|
@@ -193,7 +214,10 @@ def testnet(cls, node="lb"): | |
| chain_cookie_assistant=chain_cookie_assistant, | ||
| exchange_cookie_assistant=exchange_cookie_assistant, | ||
| explorer_cookie_assistant=explorer_cookie_assistant, | ||
| grpc_channel_credentials=grpc_channel_credentials, | ||
| grpc_exchange_channel_credentials=grpc_exchange_channel_credentials, | ||
| grpc_explorer_channel_credentials=grpc_explorer_channel_credentials, | ||
| chain_stream_channel_credentials=chain_stream_channel_credentials, | ||
| ) | ||
|
|
||
| @classmethod | ||
|
|
@@ -213,7 +237,10 @@ def mainnet(cls, node="lb"): | |
| chain_cookie_assistant = BareMetalLoadBalancedCookieAssistant() | ||
| exchange_cookie_assistant = BareMetalLoadBalancedCookieAssistant() | ||
| explorer_cookie_assistant = BareMetalLoadBalancedCookieAssistant() | ||
| grpc_channel_credentials = grpc.ssl_channel_credentials() | ||
| grpc_exchange_channel_credentials = grpc.ssl_channel_credentials() | ||
| grpc_explorer_channel_credentials = grpc.ssl_channel_credentials() | ||
| chain_stream_channel_credentials = grpc.ssl_channel_credentials() | ||
|
|
||
| return cls( | ||
| lcd_endpoint=lcd_endpoint, | ||
|
|
@@ -228,7 +255,10 @@ def mainnet(cls, node="lb"): | |
| chain_cookie_assistant=chain_cookie_assistant, | ||
| exchange_cookie_assistant=exchange_cookie_assistant, | ||
| explorer_cookie_assistant=explorer_cookie_assistant, | ||
| grpc_channel_credentials=grpc_channel_credentials, | ||
| grpc_exchange_channel_credentials=grpc_exchange_channel_credentials, | ||
| grpc_explorer_channel_credentials=grpc_explorer_channel_credentials, | ||
| chain_stream_channel_credentials=chain_stream_channel_credentials, | ||
| ) | ||
|
|
||
| @classmethod | ||
|
|
@@ -246,7 +276,6 @@ def local(cls): | |
| chain_cookie_assistant=DisabledCookieAssistant(), | ||
| exchange_cookie_assistant=DisabledCookieAssistant(), | ||
| explorer_cookie_assistant=DisabledCookieAssistant(), | ||
| ) | ||
|
|
||
| @classmethod | ||
|
|
@@ -263,8 +292,20 @@ def custom( | |
| chain_cookie_assistant: Optional[CookieAssistant] = None, | ||
| exchange_cookie_assistant: Optional[CookieAssistant] = None, | ||
| explorer_cookie_assistant: Optional[CookieAssistant] = None, | ||
| use_secure_connection: Optional[bool] = None, | ||
| grpc_channel_credentials: Optional[ChannelCredentials] = None, | ||
| grpc_exchange_channel_credentials: Optional[ChannelCredentials] = None, | ||
| grpc_explorer_channel_credentials: Optional[ChannelCredentials] = None, | ||
| chain_stream_channel_credentials: Optional[ChannelCredentials] = None, | ||
| ): | ||
| # the `use_secure_connection` parameter is ignored and will be deprecated soon. | ||
| if use_secure_connection is not None: | ||
| warn( | ||
| "use_secure_connection parameter in Network is no longer used and will be deprecated", | ||
| DeprecationWarning, | ||
| stacklevel=2, | ||
| ) | ||
|
|
||
| chain_assistant = chain_cookie_assistant or DisabledCookieAssistant() | ||
| exchange_assistant = exchange_cookie_assistant or DisabledCookieAssistant() | ||
| explorer_assistant = explorer_cookie_assistant or DisabledCookieAssistant() | ||
|
|
@@ -281,8 +322,59 @@ def custom( | |
| chain_cookie_assistant=chain_assistant, | ||
| exchange_cookie_assistant=exchange_assistant, | ||
| explorer_cookie_assistant=explorer_assistant, | ||
| grpc_channel_credentials=grpc_channel_credentials, | ||
| grpc_exchange_channel_credentials=grpc_exchange_channel_credentials, | ||
| grpc_explorer_channel_credentials=grpc_explorer_channel_credentials, | ||
| chain_stream_channel_credentials=chain_stream_channel_credentials, | ||
| ) | ||
|
|
||
| @classmethod | ||
| def custom_chain_and_public_indexer_mainnet( | ||
| cls, | ||
| lcd_endpoint, | ||
| tm_websocket_endpoint, | ||
| grpc_endpoint, | ||
| chain_stream_endpoint, | ||
| chain_cookie_assistant: Optional[CookieAssistant] = None, | ||
| ): | ||
| mainnet_network = cls.mainnet() | ||
|
|
||
| return cls.custom( | ||
| lcd_endpoint=lcd_endpoint, | ||
| tm_websocket_endpoint=tm_websocket_endpoint, | ||
| grpc_endpoint=grpc_endpoint, | ||
| grpc_exchange_endpoint=mainnet_network.grpc_exchange_endpoint, | ||
| grpc_explorer_endpoint=mainnet_network.grpc_explorer_endpoint, | ||
| chain_stream_endpoint=chain_stream_endpoint, | ||
| chain_id="injective-1", | ||
| env="mainnet", | ||
| chain_cookie_assistant=chain_cookie_assistant or DisabledCookieAssistant(), | ||
| exchange_cookie_assistant=mainnet_network.exchange_cookie_assistant, | ||
| explorer_cookie_assistant=mainnet_network.explorer_cookie_assistant, | ||
| grpc_channel_credentials=None, | ||
| grpc_exchange_channel_credentials=mainnet_network.grpc_exchange_channel_credentials, | ||
| grpc_explorer_channel_credentials=mainnet_network.grpc_explorer_channel_credentials, | ||
| chain_stream_channel_credentials=None, | ||
| ) | ||
|
|
||
| def string(self): | ||
| return self.env | ||
|
|
||
| def create_chain_grpc_channel(self) -> grpc.Channel: | ||
| return self._create_grpc_channel(self.grpc_endpoint, self.grpc_channel_credentials) | ||
|
|
||
| def create_exchange_grpc_channel(self) -> grpc.Channel: | ||
| return self._create_grpc_channel(self.grpc_exchange_endpoint, self.grpc_exchange_channel_credentials) | ||
|
|
||
| def create_explorer_grpc_channel(self) -> grpc.Channel: | ||
| return self._create_grpc_channel(self.grpc_explorer_endpoint, self.grpc_explorer_channel_credentials) | ||
|
|
||
| def create_chain_stream_grpc_channel(self) -> grpc.Channel: | ||
| return self._create_grpc_channel(self.chain_stream_endpoint, self.chain_stream_channel_credentials) | ||
|
|
||
| def _create_grpc_channel(self, endpoint: str, credentials: Optional[ChannelCredentials]) -> grpc.Channel: | ||
| if credentials is None: | ||
| channel = grpc.aio.insecure_channel(endpoint) | ||
| else: | ||
| channel = grpc.aio.secure_channel(endpoint, credentials) | ||
| return channel | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| [tool.poetry] | ||
| name = "injective-py" | ||
| version = "1.6.0-pre" | ||
| description = "Injective Python SDK, with Exchange API Client" | ||
| authors = ["Injective Labs <[email protected]>"] | ||
| license = "Apache-2.0" | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| from warnings import catch_warnings | ||
|
|
||
| from pyinjective.core.network import DisabledCookieAssistant, Network | ||
|
|
||
|
|
||
| class TestNetworkDeprecationWarnings: | ||
| def test_use_secure_connection_parameter_deprecation_warning(self): | ||
| with catch_warnings(record=True) as all_warnings: | ||
| Network( | ||
| lcd_endpoint="lcd_endpoint", | ||
| tm_websocket_endpoint="tm_websocket_endpoint", | ||
| grpc_endpoint="grpc_endpoint", | ||
| grpc_exchange_endpoint="grpc_exchange_endpoint", | ||
| grpc_explorer_endpoint="grpc_explorer_endpoint", | ||
| chain_stream_endpoint="chain_stream_endpoint", | ||
| chain_id="chain_id", | ||
| fee_denom="fee_denom", | ||
| env="env", | ||
| chain_cookie_assistant=DisabledCookieAssistant(), | ||
| exchange_cookie_assistant=DisabledCookieAssistant(), | ||
| explorer_cookie_assistant=DisabledCookieAssistant(), | ||
| use_secure_connection=True, | ||
| ) | ||
|
|
||
| deprecation_warnings = [warning for warning in all_warnings if issubclass(warning.category, DeprecationWarning)] | ||
| assert len(deprecation_warnings) == 1 | ||
| assert ( | ||
| str(deprecation_warnings[0].message) | ||
| == "use_secure_connection parameter in Network is no longer used and will be deprecated" | ||
| ) | ||
|
|
||
| def test_use_secure_connection_parameter_in_custom_network_deprecation_warning(self): | ||
| with catch_warnings(record=True) as all_warnings: | ||
| Network.custom( | ||
| lcd_endpoint="lcd_endpoint", | ||
| tm_websocket_endpoint="tm_websocket_endpoint", | ||
| grpc_endpoint="grpc_endpoint", | ||
| grpc_exchange_endpoint="grpc_exchange_endpoint", | ||
| grpc_explorer_endpoint="grpc_explorer_endpoint", | ||
| chain_stream_endpoint="chain_stream_endpoint", | ||
| chain_id="chain_id", | ||
| env="env", | ||
| chain_cookie_assistant=DisabledCookieAssistant(), | ||
| exchange_cookie_assistant=DisabledCookieAssistant(), | ||
| explorer_cookie_assistant=DisabledCookieAssistant(), | ||
| use_secure_connection=True, | ||
| ) | ||
|
|
||
| deprecation_warnings = [warning for warning in all_warnings if issubclass(warning.category, DeprecationWarning)] | ||
| assert len(deprecation_warnings) == 1 | ||
| assert ( | ||
| str(deprecation_warnings[0].message) | ||
| == "use_secure_connection parameter in Network is no longer used and will be deprecated" | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| from warnings import catch_warnings | ||
|
|
||
| import grpc | ||
| import pytest | ||
|
|
||
| from pyinjective.async_client import AsyncClient | ||
|
|
@@ -586,7 +587,7 @@ async def test_get_oracle_prices_deprecation_warning( | |
| assert str(deprecation_warnings[0].message) == "This method is deprecated. Use fetch_oracle_price instead" | ||
|
|
||
| @pytest.mark.asyncio | ||
| async def test_stream_oracle_prices_deprecation_warning( | ||
| self, | ||
| oracle_servicer, | ||
| ): | ||
|
|
@@ -1707,3 +1708,17 @@ async def test_get_latest_block_deprecation_warning( | |
| deprecation_warnings = [warning for warning in all_warnings if issubclass(warning.category, DeprecationWarning)] | ||
| assert len(deprecation_warnings) == 1 | ||
| assert str(deprecation_warnings[0].message) == "This method is deprecated. Use fetch_latest_block instead" | ||
|
|
||
| def test_credentials_parameter_deprecation_warning( | ||
| self, | ||
| auth_servicer, | ||
| ): | ||
| with catch_warnings(record=True) as all_warnings: | ||
| AsyncClient(network=Network.local(), credentials=grpc.ssl_channel_credentials()) | ||
|
|
||
| deprecation_warnings = [warning for warning in all_warnings if issubclass(warning.category, DeprecationWarning)] | ||
| assert len(deprecation_warnings) == 1 | ||
| assert ( | ||
| str(deprecation_warnings[0].message) | ||
| == "credentials parameter in AsyncClient is no longer used and will be deprecated" | ||
| ) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add surrounding blank lines for headings.
Headings should be surrounded by blank lines to enhance the readability and structure of the document.
Committable suggestion