Added suport for contract queries using abi file #436

popenta · 2024-07-11T12:38:06Z

The same arguments as for contract calls have been added. The args are --abi and --arguments-file. Keep in mind the args should be placed inside a list like such:

[
    5,
    {
         { "bech32": "erd1..." }
    }
]

When performing queries without the abi file the response looks like this:

[
    "0e"
]

But when using the abi file the response is parsed, and it looks like this:

[
    14
]

There are small differences in how values are returned. For example, if an endpoint returns variadic<Address>, when querying without abi, the response looks like this:

[
    "3c35d7eacb1a99a4a0ccaa537ef0cc0ae109f41f6c2b402203e633bfbb071f5c",
    "0139472eff6886771a982f3083da5d421f24c29181e63888228dc81ca60d69e1"
]

But when the abi is used, the response looks like this:

[
    [
        "3c35d7eacb1a99a4a0ccaa537ef0cc0ae109f41f6c2b402203e633bfbb071f5c",
        "0139472eff6886771a982f3083da5d421f24c29181e63888228dc81ca60d69e1"
    ]
]

axenteoctavian · 2024-07-25T13:27:58Z

multiversx_sdk_cli/contracts.py

+
+        response = sc_query_controller.run_query(query)
+
+        if self._abi:


This if-else is not consistent.
a)
With ABI you return the data-parts
Without ABI your return other stuff + data-parts as Dict

b) errors for bad queries
With ABI you raise SmartContractQueryError
Without ABI you return the Dict with error message

1/ What is the reason you return different types?
To make it consistent you can just return sc_query_controller.parse_query_response(response) but for NO abi case return parts as hex.
2/ Please add some unit tests for bad queries (wrong --function or whatever)
3/ I can't find test for contract query with abi

Now, the if-else is gone. The querying is done in a try-except block so all the errors thrown are of type
QueryContractError. Did a small "fix" for the json encoder to convert all bytes to hex. Also added tests.

Looks good to me

andreibancioiu · 2024-07-18T14:18:55Z

multiversx_sdk_cli/cli_contracts.py

@@ -443,17 +444,28 @@ def upgrade(args: Any):
 def query(args: Any):
    logger.debug("query")

-    # workaround so we can use the function bellow
+    # workaround so we can use the function bellow to set chainID


Typo below.

andreibancioiu · 2024-07-18T14:24:51Z

multiversx_sdk_cli/cli_wallet.py

@@ -134,6 +134,9 @@ def wallet_new(args: Any):
    else:
        mnemonic = Mnemonic.generate()

+    # this is done to get rid of the Pylance error: possibly unbound
+    mnemonic = cast(Mnemonic, mnemonic)  # type: ignore


Can also fix the warning by extracting the above logic to a separate function e.g. generate_mnemonic_with_shard_constraint() or something like that.

indeed, extracted to a separate function.

andreibancioiu · 2024-07-18T15:12:02Z

multiversx_sdk_cli/dns.py

+    return_code = response["returnCode"]
+    if return_code == "ok":
+        print(f"name [{name}] is valid")
+    else:
+        print(f"name [{name}] is invalid")
+
+    print(response)


Can be considered a breaking change by some (due to changing the stdout) - but this shouldn't be an issue anyway - we should just document it in the release notes.

indeed, it will be documented in the release notes

andreibancioiu · 2024-07-18T15:14:20Z

multiversx_sdk_cli/dns.py

+    chain_id = proxy.get_network_config().chain_id
+    config = TransactionsFactoryConfig(chain_id)
+    contract = SmartContract(config)


Can define a small function in this module e.g. query_contract(contract_address, proxy, function, args) - to extract the common functionality - getting chain ID, creating config etc.

andreibancioiu · 2024-07-18T15:16:21Z

multiversx_sdk_cli/contracts.py

@@ -63,6 +65,10 @@ class IContractQueryResponse(Protocol):
    return_data: List[str]
    return_code: str
    return_message: str
+    gas_used: int


If we reference the latest & greatest feat/next of sdk-py, maybe we can drop this interface (or maybe not yet)?

I don't think we can drop it.

andreibancioiu · 2024-07-26T12:09:05Z

multiversx_sdk_cli/utils.py

        if isinstance(o, ISerializable):
            return o.to_dictionary()
+        if isinstance(o, bytes):


Generally speaking, is not a breaking change (e.g. it does not alter the output for existing flows that use --outfile or so).

andreibancioiu · 2024-07-26T12:09:38Z

multiversx_sdk_cli/utils.py

        if isinstance(o, ISerializable):
            return o.to_dictionary()
+        if isinstance(o, bytes):
+            return o.hex()
+        if isinstance(o, list):


Is this necessary? (I did not do an extra check).

from what I've tested it's not. deleted it.

andreibancioiu · 2024-07-26T12:12:45Z

multiversx_sdk_cli/contracts.py

@@ -202,7 +201,7 @@ def query_contract(self,
                       contract_address: IAddress,
                       proxy: INetworkProvider,
                       function: str,
-                       arguments: List[Any],
+                       arguments: Union[List[Any], None],


Can also be Optional - or maybe not yet (older Python)?

changed to Optional[List[Any]].

andreibancioiu · 2024-07-26T12:14:00Z

multiversx_sdk_cli/contracts.py

-        else:
-            return [self._query_response_to_dict(response)]
+        try:
+            response = sc_query_controller.query(


So we don't support the caller and callValue parameters? But we didn't support them before anyway. I think we should, in the future.

we can do that in the future, we didn't support them before.

andreibancioiu · 2024-07-29T08:42:51Z

multiversx_sdk_cli/cli_wallet.py

-
-    # this is done to get rid of the Pylance error: possibly unbound
-    mnemonic = cast(Mnemonic, mnemonic)  # type: ignore
+    mnemonic = _generate_mnemonic_with_shard_constraint(shard)


Could be: if shard is not none, then call the new function, else call Mnemonic.generate().

axenteoctavian · 2024-07-29T15:37:17Z

multiversx_sdk_cli/dns.py

-        arguments=[],
-        args_from_file=False
-    )[0]
+        function="versgetRegistrationCostion",


Please fix this function :D

thanks:) fixed

add suport for contract queries using abi file

dd1442d

popenta self-assigned this Jul 11, 2024

popenta marked this pull request as draft July 11, 2024 12:38

Base automatically changed from contract-abi to feat/next July 17, 2024 11:08

popenta added 4 commits July 17, 2024 15:04

Merge branch 'feat/next' into vm-query-with-abi

1d47395

renamings

0e80e04

remove test

30b7606

fixes

140a871

popenta marked this pull request as ready for review July 18, 2024 14:10

axenteoctavian reviewed Jul 25, 2024

View reviewed changes

fixes and test for contract query

6e7a967

popenta requested a review from andreibancioiu July 26, 2024 11:53

andreibancioiu previously approved these changes Jul 26, 2024

View reviewed changes

fixes after review

3413f8c

popenta dismissed andreibancioiu’s stale review via 3413f8c July 29, 2024 08:22

andreibancioiu previously approved these changes Jul 29, 2024

View reviewed changes

fixes after review

650a8e6

popenta dismissed andreibancioiu’s stale review via 650a8e6 July 29, 2024 08:56

andreibancioiu previously approved these changes Jul 29, 2024

View reviewed changes

axenteoctavian reviewed Jul 29, 2024

View reviewed changes

fix function name

c86bfff

popenta dismissed andreibancioiu’s stale review via c86bfff July 29, 2024 15:39

axenteoctavian previously approved these changes Jul 29, 2024

View reviewed changes

use gateway for testing contract flow

37151e7

popenta dismissed axenteoctavian’s stale review via 37151e7 July 30, 2024 07:51

revert to using api

f3168b8

andreibancioiu approved these changes Jul 30, 2024

View reviewed changes

axenteoctavian approved these changes Jul 30, 2024

View reviewed changes

popenta merged commit a63926c into feat/next Jul 30, 2024
8 checks passed

popenta deleted the vm-query-with-abi branch July 30, 2024 09:02

popenta mentioned this pull request Sep 30, 2024

Merge feat/next in main #447

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added suport for contract queries using abi file #436

Added suport for contract queries using abi file #436

popenta commented Jul 11, 2024 •

edited

Loading

axenteoctavian Jul 25, 2024 •

edited

Loading

popenta Jul 26, 2024

axenteoctavian Jul 26, 2024

andreibancioiu Jul 18, 2024

popenta Jul 29, 2024

andreibancioiu Jul 18, 2024

popenta Jul 29, 2024

andreibancioiu Jul 18, 2024

popenta Jul 29, 2024

andreibancioiu Jul 18, 2024

popenta Jul 29, 2024

andreibancioiu Jul 18, 2024

popenta Jul 29, 2024

andreibancioiu Jul 26, 2024

andreibancioiu Jul 26, 2024

popenta Jul 29, 2024

andreibancioiu Jul 26, 2024

popenta Jul 29, 2024

andreibancioiu Jul 26, 2024

popenta Jul 29, 2024

andreibancioiu Jul 29, 2024

popenta Jul 29, 2024

axenteoctavian Jul 29, 2024

popenta Jul 29, 2024


		response = sc_query_controller.run_query(query)

		if self._abi:

Added suport for contract queries using abi file #436

Added suport for contract queries using abi file #436

Conversation

popenta commented Jul 11, 2024 • edited Loading

axenteoctavian Jul 25, 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

Choose a reason for hiding this comment

popenta commented Jul 11, 2024 •

edited

Loading

axenteoctavian Jul 25, 2024 •

edited

Loading