Smart Contract queries controller #16

popenta · 2024-03-05T09:35:21Z

Code snippet:

from multiversx_sdk import (ProxyNetworkProvider, QueryRunnerAdapter,
                            SmartContractQueriesController)

contract = Address.from_bech32("erd1qqqqqqqqqqqqqpgqqy34h7he2ya6qcagqre7ur7cc65vt0mxrc8qnudkr4")
query_runner = QueryRunnerAdapter(ProxyNetworkProvider("https://devnet-api.multiversx.com"))

query_controller = SmartContractQueriesController(query_runner)
query = query_controller.create_query(
    contract=contract.to_bech32(),
    function="getSum",
    arguments=[],
)

response = query_controller.run_query(query)

print("Return code:", response.return_code)
print("Return data:", response.return_data_parts)

andreibancioiu · 2024-03-06T12:09:39Z

.flake8

@@ -1,2 +1,2 @@
 [flake8]
-ignore = E501
+ignore = E501, E722


For reference (for reviewers):

https://www.flake8rules.com/rules/E722.html

andreibancioiu · 2024-03-06T12:10:49Z

README.md

+
+If you want to skip network interaction tests run:
+```
+pytest -m "not networkInteraction"


Perhaps we should have it the reversed way? That is, by default all except networkInteraction? Just thinking out loud.

Fine this way, as well - tests of mx-chain-go is the same: all tests by default, and long tests excluded on demand 👍

andreibancioiu · 2024-03-06T12:12:48Z

pytest.ini

+    only: only run a specific test (run using: pytest -m "only")
+    networkInteraction: only run API and Proxy network providers tests (run using `pytest -m networkInteraction` or run all tests excepting these using: `pytest -m "not networkInteraction"`)
+
+log_cli = True


andreibancioiu · 2024-03-06T12:13:32Z

multiversx_sdk/testutils/mock_network_provider.py

+
+
+class AccountOnNetwork(IAccountOnNetwork):
+    def __init__(self, nonce: int, balance: str | int) -> None:


Here, in PY, I think we can switch to only have the int variant.

now only supports int

andreibancioiu · 2024-03-06T12:13:37Z

multiversx_sdk/testutils/utils.py

+EGLD_NUM_DECIMALS = 18
+
+
+def create_account_egld_balance(egld: int | str) -> int:


Here, in PY, I think we can switch to only have the int variant.

now only supports int

andreibancioiu · 2024-03-06T12:40:57Z

multiversx_sdk/core/smart_contract_queries_controller.py

+            caller=caller
+        )
+
+        legacy_query_response = self.network_provider.query_contract(legacy_query)


Once we can do breaking changes in the network providers, I think we'll have them return core's SmartContractQueryResponse - or, anyway, have this "adapter" logic in some other place.

Made a special adapter for it.

andreibancioiu · 2024-03-06T12:42:47Z

multiversx_sdk/core/smart_contract_queries_controller_test.py

+        parsed = controller.parse_query_response(response)
+        assert parsed == ["abba".encode()]
+
+    @pytest.mark.skip("Depends on the actual contract deployed on Devnet")


Always skip or only when networkInteraction marker is missing - maybe have an adder deployed beforehand (manually deployed)? Or query a system VM contract.

In the future, perhaps we can add some tests based on localnet.

added the pytes.mark.networkInteraction marker. Will do some tests using the localnet in the future.

andreibancioiu · 2024-03-06T12:46:36Z

multiversx_sdk/network_providers/proxy_network_provider_test.py

 from multiversx_sdk.core.address import Address
 from multiversx_sdk.core.transaction import Transaction
 from multiversx_sdk.network_providers.proxy_network_provider import (
    ContractQuery, ProxyNetworkProvider)


+@pytest.mark.networkInteraction


andreibancioiu · 2024-03-06T12:48:19Z

multiversx_sdk/testutils/mock_network_provider.py

+from multiversx_sdk.testutils.utils import create_account_egld_balance
+
+
+class AccountOnNetwork(IAccountOnNetwork):


In JS, we've defined the class since, back then, the network providers package wasn't referenced as a dev dependency (for tests), but here, I think we can use this class:

https://github.com/multiversx/mx-sdk-py/blob/main/multiversx_sdk/network_providers/accounts.py#L8

Now using the above class.

andreibancioiu · 2024-03-06T12:49:30Z

multiversx_sdk/testutils/interface_of_network.py

+from typing import Protocol
+
+
+class IAccountOnNetwork(Protocol):


Re-check if can be dropped, if we use the existing AccountOnNetwork.

Deleted the file, now using AccountOnNetwork.

andreibancioiu · 2024-03-08T10:00:01Z

multiversx_sdk/core/adapters/query_runner_adapter.py

+        ...
+
+
+class ContractQuery(IQuery):


Is the existing one usable here?

https://github.com/multiversx/mx-sdk-py/blob/main/multiversx_sdk/core/contract_query.py

If that one isn't used in core anymore, but only by network providers and adapters, then add a TODO to be moved to network providers.

Removed the implementation of ContractQuery from the adapter, now using the ContractQuery class from core.

andreibancioiu · 2024-03-08T10:01:36Z

multiversx_sdk/core/adapters/query_runner_adapter.py

+        self.network_provider = network_provider
+
+    def run_query(self, query: SmartContractQuery) -> SmartContractQueryResponse:
+        legacy_query = ContractQuery(


Without the prefix "legacy", as in JS. Ultimately, they aren't legacy, it's just that they are the concept that the network provider uses, not the concepts that the query controller uses.

Renamed it to adapted_query here and in JS, as well.

ssd04 · 2024-03-11T13:19:28Z

multiversx_sdk/core/smart_contract_queries_controller_test.py

+class TestSmartContractQueriesController:
+    provider = ProxyNetworkProvider("https://devnet-api.multiversx.com")


use @pytest.mark.networkInteraction here also?

there's no point in using the annotation for the class because there is no actual network interaction. In the first two tests i just create a query, then in the other tests i use a mock network provider and the last test actually interacts with the network but that one is annotated with @pytest.mark.networkInteraction

sc queries controller

8816915

popenta self-assigned this Mar 5, 2024

popenta marked this pull request as draft March 5, 2024 09:35

popenta added 3 commits March 5, 2024 11:49

fix flake error

b0e5fc4

add unittests and mock network provider

10330c9

add markers for network interaction tests

f5293ee

popenta marked this pull request as ready for review March 6, 2024 12:07

andreibancioiu reviewed Mar 6, 2024

View reviewed changes

popenta added 4 commits March 7, 2024 11:55

Merge branch 'main' into sc-query-controller

1cb307c

export account transactions factory

a5e84e1

refactoring & fixes after review

474b307

export query runner adapter

618e63d

andreibancioiu reviewed Mar 8, 2024

View reviewed changes

fixes after review

bfd94ad

andreibancioiu approved these changes Mar 8, 2024

View reviewed changes

ssd04 reviewed Mar 11, 2024

View reviewed changes

ssd04 approved these changes Mar 12, 2024

View reviewed changes

popenta merged commit 75ac77f into main Mar 12, 2024
3 checks passed

popenta deleted the sc-query-controller branch March 12, 2024 13:45

popenta mentioned this pull request May 23, 2024

Migration support (from the legacy sdk-py-* libraries to this unified library) #41

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Smart Contract queries controller #16

Smart Contract queries controller #16

popenta commented Mar 5, 2024 •

edited

Loading

andreibancioiu Mar 6, 2024

andreibancioiu Mar 6, 2024

andreibancioiu Mar 6, 2024

andreibancioiu Mar 6, 2024

popenta Mar 7, 2024

andreibancioiu Mar 6, 2024

popenta Mar 7, 2024

andreibancioiu Mar 6, 2024

popenta Mar 7, 2024

andreibancioiu Mar 6, 2024

popenta Mar 7, 2024

andreibancioiu Mar 6, 2024

andreibancioiu Mar 6, 2024

popenta Mar 7, 2024

andreibancioiu Mar 6, 2024

popenta Mar 7, 2024

andreibancioiu Mar 8, 2024

andreibancioiu Mar 8, 2024

popenta Mar 8, 2024

andreibancioiu Mar 8, 2024

popenta Mar 8, 2024

ssd04 Mar 11, 2024

popenta Mar 12, 2024



		class AccountOnNetwork(IAccountOnNetwork):
		def __init__(self, nonce: int, balance: str \| int) -> None:

		EGLD_NUM_DECIMALS = 18


		def create_account_egld_balance(egld: int \| str) -> int:

		from multiversx_sdk.testutils.utils import create_account_egld_balance


		class AccountOnNetwork(IAccountOnNetwork):

		from typing import Protocol


		class IAccountOnNetwork(Protocol):

		class TestSmartContractQueriesController:
		provider = ProxyNetworkProvider("https://devnet-api.multiversx.com")

Smart Contract queries controller #16

Smart Contract queries controller #16

Conversation

popenta commented Mar 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

popenta commented Mar 5, 2024 •

edited

Loading