genlayer-test 0.1.0b6__py3-none-any.whl → 0.1.2__py3-none-any.whl

{genlayer_test-0.1.0b6.dist-info → genlayer_test-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: genlayer-test
-Version: 0.1.0b6
+Version: 0.1.2
 Summary: GenLayer Testing Suite
 Author: GenLayer
 License-Expression: MIT
@@ -16,7 +16,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pytest
-Requires-Dist: genlayer-py==0.1.0b1
+Requires-Dist: genlayer-py==0.3.0
 Dynamic: license-file
 
 # GenLayer Testing Suite
@@ -128,6 +128,21 @@ $ gltest -v
 $ gltest --contracts-dir <path_to_contracts>
 ```
 
+6. Run tests with a custom RPC url
+```bash
+$ gltest --rpc-url <custom_rpc_url>
+```
+
+6. Run tests with a default wait interval for waiting transaction receipts
+```bash
+$ gltest --default-wait-interval <default_wait_interval>
+```
+
+6. Run tests with a default wait retries for waiting transaction receipts
+```bash
+$ gltest --default-wait-retries <default_wait_retries>
+```
+
 ## 🚀 Key Features
 
 - **Pytest Integration** – Extends pytest to support intelligent contract testing, making it familiar and easy to adopt.
@@ -264,6 +279,8 @@ def test_write_methods():
     assert contract.get_storage() == "new_value"
 ```
 
+For more example contracts, check out the [contracts directory](tests/examples/contracts) which contains various sample contracts demonstrating different features and use cases.
+
 ## 📝 Best Practices
 
 1. **Test Organization**

genlayer_test-0.1.2.dist-info/RECORD

@@ -0,0 +1,53 @@
+genlayer_test-0.1.2.dist-info/licenses/LICENSE,sha256=che_H4vE0QUx3HvWrAa1_jDEVInift0U6VO15-QqEls,1064
+gltest/__init__.py,sha256=AK_YfRvwlhrOheOelUG8qIRG17on0-nFCF747dopg2w,332
+gltest/assertions.py,sha256=dBjiK5-LuxrrktkNDP7n-t6i43UNCL_cq7M4BLqRyFk,678
+gltest/exceptions.py,sha256=deJPmrTe5gF33qkkKF2IVJY7lc_knI7Ql3N7jZ8aLZs,510
+gltest/plugin_config.py,sha256=8Z97RtEJ89OcRbki_oRuBBVct_q56BFmKvthan1y9Y4,840
+gltest/plugin_hooks.py,sha256=py1rzIR9QSsFOt8SEePPL96e-8DeiPFxvcPZurRlExM,1436
+gltest/types.py,sha256=BODmwTr2gAUEiO9FjiuTiWwuKvXgo4xZWstQWNUfnlw,156
+gltest/artifacts/__init__.py,sha256=qiJN5F1cVh_3fmxZeDFznoABxAdLhLqBfUUKwqXqvgo,87
+gltest/artifacts/contract.py,sha256=CBRfUTltKv2tPy--LcmVbP_4hbXYt9VrunvJlMzNd5s,3566
+gltest/glchain/__init__.py,sha256=X-mEbREoAOe9K4n74C55gCiXH4wItzY5HTJcg3_F3mI,412
+gltest/glchain/account.py,sha256=ZxYsfbtBXKVC5vV4pko3yyL6lhPljqIb68NgIgvInSc,403
+gltest/glchain/client.py,sha256=q04LIQy5SCIrYZflZiTapfeQ-AaSTa0w369ehnVbJLM,532
+gltest/glchain/contract.py,sha256=1pd4eAQlHXjnRF7hBvnoR-9f-HORUaYKVyV5P42io4o,8747
+gltest/helpers/__init__.py,sha256=I7HiTu_H7_hP65zY6Wl02r-5eAMr2eZvqBVmusuQLX4,180
+gltest/helpers/fixture_snapshot.py,sha256=DWLTsMbTnfhpv0_7_gkJpDKX4hJx-tlruX7x3FWL6UI,2073
+gltest/helpers/take_snapshot.py,sha256=eXqEKXM2hcox3pLGIcNddobU8zXPQvD-Iwf87eHqW2s,1276
+gltest_cli/main.py,sha256=Ti2-0Ev1x5_cM0D1UKqdgaDt80CDHEQGtdRne2qLm4M,53
+tests/artifact/test_contract_definition.py,sha256=8X829MsNfEObtIMmotk6nRVLDEp5KfJE6zrAK4IPfCc,3323
+tests/artifact/contracts/not_ic_contract.py,sha256=hQyGnYiiVceYdLI2WrvcFgPqzy1S4-YMb9FPhiHEGSA,510
+tests/assertions/test_assertions.py,sha256=y1XE15908Rv3RjWNxU7DtRF2gEGM9eEiHPh9jJHbR4g,1046
+tests/examples/contracts/football_prediction_market.py,sha256=kdouFijjeCdIJyaVJlgXcqbBAXecA9_YdhklSsIW-QM,3219
+tests/examples/contracts/intelligent_oracle.py,sha256=WrNZWWoi1sz22Azt2EXgdWHDg5Ihca2pWUHrM9pVfQE,12319
+tests/examples/contracts/intelligent_oracle_factory.py,sha256=ax496IZuDCA728rRcbjwTaM4Q4E-Y1jGkHsEcyf1cig,1490
+tests/examples/contracts/llm_erc20.py,sha256=nfIs-7A79L46NgHQzWbPyEOUlzAlFLsf4K05acwKr_M,2523
+tests/examples/contracts/log_indexer.py,sha256=VwMC8_Gy1Z1qjuy5GeEMyepjZ3Z5y7VAOrHMl5MrjxI,1852
+tests/examples/contracts/multi_read_erc20.py,sha256=HsMJKGT9a9eZAO43Em7hCRfh1yyHDgcUbQ0gmOE1MXs,850
+tests/examples/contracts/multi_tenant_storage.py,sha256=aGLPC76FegXdnIjMjeGsu3s3AbKK9dtV6t1d_KoI8rI,1897
+tests/examples/contracts/read_erc20.py,sha256=kstiB93JHHajJe1GldzeawxnVYutjT8KE2d1bYTgggU,390
+tests/examples/contracts/storage.py,sha256=GZHBXhjc94eEkdSO1UWgcop0fEo0hD57KZM0ds3pUFM,490
+tests/examples/contracts/user_storage.py,sha256=j-RXxTIqb1dePYqP_pkeoCxxDq07VURryvzF_Q-sZmI,638
+tests/examples/contracts/wizard_of_coin.py,sha256=BJ0Nv6N-JJP_Pk7YUSXPPRxX5_mDRBDlfL6nabeaoyA,1606
+tests/examples/contracts/multi_file_contract/__init__.py,sha256=8O3BvoUrLSmc4uTf2jm7MyrmcaiGD0w8wPwotdAqZHQ,485
+tests/examples/contracts/multi_file_contract/other.py,sha256=jHDtjUL3eAUgE6yOYKFw_RfAH7kIwk8CvxUjbWHNruk,236
+tests/examples/tests/test_football_prediction_market.py,sha256=wFu024sq3IURLL1zyLyO_G1sRCjPTV7iImi87__dZ4Y,657
+tests/examples/tests/test_intelligent_oracle_factory.py,sha256=Nw7jO9bjD79AETT2QQl0Vun-yxSAAuqGSdkQn2Y3WUw,5377
+tests/examples/tests/test_llm_erc20.py,sha256=yL_5bbH2VC7jL3E6dDvSI6PfZ36bPtA4OxoysZpuLFc,1390
+tests/examples/tests/test_log_indexer.py,sha256=Km44SiA8dlA4WBqwugXVBCQUlODdf1dB4p4nt24HG9k,2649
+tests/examples/tests/test_multi_file_contract.py,sha256=pWmK6lcZrSAnDH09Z6Q-cXs8V6VGFhHkvgThvJKEB4U,512
+tests/examples/tests/test_multi_file_contract_legacy.py,sha256=Jx_u0rDrQJspQgFo1KUddcFgTcOhcE-YLuLgk3tKrCA,527
+tests/examples/tests/test_multi_read_erc20.py,sha256=Q3AKK7OZyTKRrG-tXmkPkoQOzQqVVDnFEWKDVVNVQLI,3062
+tests/examples/tests/test_multi_tenant_storage.py,sha256=XNR1AUpxkzXlRv_ltdgAF-HUkpAvWqIQ7Fb93zEeR2o,2376
+tests/examples/tests/test_read_erc20.py,sha256=_dXwdZoUTSMKwPhEmU3N2X3wNu2ke9ob0L3JKEyNjdE,1198
+tests/examples/tests/test_storage.py,sha256=FmA-pJohMBHlNFVzLlY3-asnq0kV33E5SRDCM-lWzoQ,664
+tests/examples/tests/test_storage_legacy.py,sha256=RNVnD0G9ilb4I2s0CPAAgJEuKUgEkkbItuesOfmv-pg,677
+tests/examples/tests/test_user_storage.py,sha256=QEgt2p22LAyzBnBb0YW4BWa_Jasrt15vrr1GuxXqqbI,2180
+tests/examples/tests/test_wizard_of_coin.py,sha256=aUDeV5w0XONMMS71Vzw80lHfcSM0z8RKPJSXAuDwRto,392
+tests/plugin/conftest.py,sha256=RKdoE5_zcMimeojAoA_GSFI9du4pMzMi1vZ1njtfoAs,28
+tests/plugin/test_plugin_hooks.py,sha256=FQOrkhoXLinq0sjvoYjr63Oqg-ZVPcNFeUrK4bqrn4E,2020
+genlayer_test-0.1.2.dist-info/METADATA,sha256=05aK4xzg2NrGQIAcFkWS6NNzvFyxVkF_jCqSZhgk8po,13471
+genlayer_test-0.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+genlayer_test-0.1.2.dist-info/entry_points.txt,sha256=rXhrPVq2IhVsd4uWzxzwCTx7jA1KcQIVNxDCUuxq4f8,89
+genlayer_test-0.1.2.dist-info/top_level.txt,sha256=-qiGZxTRBytujzgVcKpxjvQ-WNeUDjXa59ceGMwMpko,24
+genlayer_test-0.1.2.dist-info/RECORD,,

{genlayer_test-0.1.0b6.dist-info → genlayer_test-0.1.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.3.1)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

gltest/artifacts/__init__.py

@@ -1,3 +1,3 @@
 from .contract import find_contract_definition
 
-__all__ = ["find_contract_definition"]
+__all__ = ["find_contract_definition"]

gltest/artifacts/contract.py

@@ -20,7 +20,9 @@ class ContractDefinition:
 
 def search_path_by_class_name(contracts_dir: Path, contract_name: str) -> Path:
     """Search for a file by class name in the contracts directory."""
-    for file_path in contracts_dir.rglob("*.gpy"):
+    for file_path in contracts_dir.rglob("*"):
+        if not file_path.suffix in [".gpy", ".py"]:
+            continue
         try:
             # Read the file content
             with open(file_path, "r") as f:
@@ -30,8 +32,15 @@ def search_path_by_class_name(contracts_dir: Path, contract_name: str) -> Path:
             # Search for class definitions
             for node in ast.walk(tree):
                 if isinstance(node, ast.ClassDef) and node.name == contract_name:
-                    # Found the contract class
-                    return file_path
+                    # Check if the class directly inherits from gl.Contract
+                    for base in node.bases:
+                        if isinstance(base, ast.Attribute):
+                            if (
+                                isinstance(base.value, ast.Name)
+                                and base.value.id == "gl"
+                                and base.attr == "Contract"
+                            ):
+                                return file_path
         except Exception as e:
             raise ValueError(f"Error reading file {file_path}: {e}")
     raise FileNotFoundError(f"Contract {contract_name} not found at: {contracts_dir}")
@@ -53,7 +62,7 @@ def compute_contract_code(
     with zipfile.ZipFile(buffer, mode="w") as zip:
         zip.write(main_file_path, "contract/__init__.py")
         for file_path in main_file_dir.rglob("*"):
-            if file_path.name in ["runner.json", "__init__.gpy"]:
+            if file_path.name in ["runner.json", "__init__.py"]:
                 continue
             rel_path = file_path.relative_to(main_file_dir)
             zip.write(file_path, f"contract/{rel_path}")
@@ -72,7 +81,7 @@ def find_contract_definition(contract_name: str) -> Optional[ContractDefinition]
     main_file_path = search_path_by_class_name(contracts_dir, contract_name)
     main_file_dir = main_file_path.parent
     runner_file_path = None
-    if main_file_path.name == "__init__.gpy":
+    if main_file_path.name in ["__init__.py", "__init__.gpy"]:
         # Likely a multifile contract
         runner_file_path = main_file_dir.joinpath("runner.json")
         if not runner_file_path.exists():

gltest/assertions.py

@@ -6,12 +6,13 @@ def tx_execution_succeeded(result: GenLayerTransaction) -> bool:
         return False
     if "leader_receipt" not in result["consensus_data"]:
         return False
-    if "execution_result" not in result["consensus_data"]["leader_receipt"]:
+    if len(result["consensus_data"]["leader_receipt"]) == 0:
         return False
-    execution_result = result["consensus_data"]["leader_receipt"]["execution_result"]
+    if "execution_result" not in result["consensus_data"]["leader_receipt"][0]:
+        return False
+    execution_result = result["consensus_data"]["leader_receipt"][0]["execution_result"]
     return execution_result == "SUCCESS"
 
 
 def tx_execution_failed(result: GenLayerTransaction) -> bool:
     return not tx_execution_succeeded(result)
-

gltest/exceptions.py

@@ -2,19 +2,27 @@ class DeploymentError(Exception):
     """Raised when a contract deployment fails."""
 
     pass
+
+
 class FixtureSnapshotError(Exception):
     """Raised when there's an error restoring a snapshot."""
+
     pass
 
+
 class FixtureAnonymousFunctionError(Exception):
     """Raised when a fixture is an anonymous function."""
+
     pass
 
+
 class InvalidSnapshotError(Exception):
     """Raised when a snapshot is invalid."""
+
     pass
 
+
 class HelperError(Exception):
     """Raised when a helper function fails."""
-    pass
 
+    pass

gltest/glchain/account.py

@@ -10,6 +10,7 @@ def create_accounts(n_accounts: int):
         accounts.append(create_account())
     return accounts
 
+
 # Accounts for testing
 accounts = create_accounts(n_accounts=10)
 

gltest/helpers/__init__.py

@@ -5,4 +5,4 @@ __all__ = [
     "take_snapshot",
     "load_fixture",
     "clear_snapshots",
-]
+]

gltest/helpers/fixture_snapshot.py

@@ -1,12 +1,15 @@
 from typing import TypeVar, Callable, List, Any
 from dataclasses import dataclass
+from urllib.parse import urlparse
 from .take_snapshot import SnapshotRestorer, take_snapshot
 from gltest.exceptions import (
     FixtureSnapshotError,
     InvalidSnapshotError,
     FixtureAnonymousFunctionError,
 )
+from gltest.plugin_config import get_rpc_url
 
+SUPPORTED_RPC_DOMAINS = ["localhost", "127.0.0.1"]
 
 T = TypeVar("T")
 
@@ -31,6 +34,11 @@ def load_fixture(fixture: Callable[[], T]) -> T:
     if fixture.__name__ == "<lambda>":
         raise FixtureAnonymousFunctionError("Fixtures must be named functions")
 
+    rpc_url = get_rpc_url()
+    domain = urlparse(rpc_url).netloc.split(":")[0]  # Extract domain without port
+    if domain not in SUPPORTED_RPC_DOMAINS:
+        return fixture()
+
     # Find existing snapshot for this fixture
     global _snapshots
     snapshot = next((s for s in _snapshots if s.fixture == fixture), None)
@@ -38,8 +46,8 @@ def load_fixture(fixture: Callable[[], T]) -> T:
     if snapshot is not None:
         try:
             snapshot.restorer.restore()
+
             # Remove snapshots that were taken after this one
-            
             _snapshots = [
                 s
                 for s in _snapshots

tests/artifact/contracts/not_ic_contract.py

@@ -0,0 +1,22 @@
+# { "Depends": "py-genlayer:test" }
+
+from genlayer import *
+
+
+# contract class that is not an IC contract
+class NotICContract:
+    storage: str
+
+    # constructor
+    def __init__(self, initial_storage: str):
+        self.storage = initial_storage
+
+    # read methods must be annotated with view
+    @gl.public.view
+    def get_storage(self) -> str:
+        return self.storage
+
+    # write method
+    @gl.public.write
+    def update_storage(self, new_storage: str) -> None:
+        self.storage = new_storage

tests/artifact/test_contract_definition.py

@@ -0,0 +1,92 @@
+import pytest
+from gltest.artifacts.contract import (
+    find_contract_definition,
+    compute_contract_code,
+)
+from gltest.plugin_config import set_contracts_dir
+from pathlib import Path
+
+
+def test_single_file():
+    set_contracts_dir(".")
+    contract_definition = find_contract_definition("PredictionMarket")
+
+    assert contract_definition.contract_name == "PredictionMarket"
+
+    # Assert complete contract definition
+    expected_main_file_path = Path("examples/contracts/football_prediction_market.py")
+    expected_runner_file_path = None
+    contract_code = compute_contract_code(
+        expected_main_file_path, expected_runner_file_path
+    )
+    assert contract_definition.contract_code == contract_code
+    assert (
+        str(contract_definition.main_file_path)
+        == "examples/contracts/football_prediction_market.py"
+    )
+    assert contract_definition.runner_file_path is None
+
+
+def test_multiple_files():
+    set_contracts_dir(".")
+    contract_definition = find_contract_definition("MultiFileContract")
+
+    assert contract_definition.contract_name == "MultiFileContract"
+
+    # Assert complete contract definition
+    expected_main_file_path = Path("examples/contracts/multi_file_contract/__init__.py")
+    expected_runner_file_path = Path(
+        "examples/contracts/multi_file_contract/runner.json"
+    )
+    assert contract_definition.main_file_path == expected_main_file_path
+    assert contract_definition.runner_file_path == expected_runner_file_path
+    contract_code = compute_contract_code(
+        expected_main_file_path, expected_runner_file_path
+    )
+    assert contract_definition.contract_code == contract_code
+
+
+def test_single_file_legacy():
+    set_contracts_dir(".")
+    contract_definition = find_contract_definition("StorageLegacy")
+
+    # Assert complete contract definition
+    assert contract_definition.contract_name == "StorageLegacy"
+    expected_main_file_path = Path("examples/contracts/storage_legacy.gpy")
+    expected_runner_file_path = None
+    contract_code = compute_contract_code(
+        expected_main_file_path, expected_runner_file_path
+    )
+    assert contract_definition.contract_code == contract_code
+    assert (
+        str(contract_definition.main_file_path)
+        == "examples/contracts/storage_legacy.gpy"
+    )
+    assert contract_definition.runner_file_path is None
+
+
+def test_multiple_files_legacy():
+    set_contracts_dir(".")
+    contract_definition = find_contract_definition("MultiFileContractLegacy")
+
+    # Assert complete contract definition
+    assert contract_definition.contract_name == "MultiFileContractLegacy"
+    expected_main_file_path = Path(
+        "examples/contracts/multi_file_contract_legacy/__init__.gpy"
+    )
+    expected_runner_file_path = Path(
+        "examples/contracts/multi_file_contract_legacy/runner.json"
+    )
+    assert contract_definition.main_file_path == expected_main_file_path
+    assert contract_definition.runner_file_path == expected_runner_file_path
+    contract_code = compute_contract_code(
+        expected_main_file_path, expected_runner_file_path
+    )
+    assert contract_definition.contract_code == contract_code
+
+
+def test_class_is_not_intelligent_contract():
+    set_contracts_dir(".")
+
+    with pytest.raises(FileNotFoundError):
+        _ = find_contract_definition("NotICContract")

tests/assertions/test_assertions.py

@@ -0,0 +1,31 @@
+from gltest.assertions import tx_execution_succeeded, tx_execution_failed
+
+GENLAYER_SUCCESS_TRANSACTION = {
+    "consensus_data": {"leader_receipt": [{"execution_result": "SUCCESS"}]}
+}
+
+GENLAYER_FAILED_TRANSACTION = {
+    "consensus_data": {"leader_receipt": [{"execution_result": "ERROR"}]}
+}
+
+GENLAYER_EMPTY_LEADER_RECEIPT = {"consensus_data": {"leader_receipt": []}}
+
+
+def test_with_successful_transaction():
+    assert tx_execution_succeeded(GENLAYER_SUCCESS_TRANSACTION) is True
+    assert tx_execution_failed(GENLAYER_SUCCESS_TRANSACTION) is False
+
+
+def test_with_failed_transaction():
+    assert tx_execution_succeeded(GENLAYER_FAILED_TRANSACTION) is False
+    assert tx_execution_failed(GENLAYER_FAILED_TRANSACTION) is True
+
+
+def test_with_empty_leader_receipt():
+    assert tx_execution_succeeded(GENLAYER_EMPTY_LEADER_RECEIPT) is False
+    assert tx_execution_failed(GENLAYER_EMPTY_LEADER_RECEIPT) is True
+
+
+def test_with_invalid_transaction():
+    assert tx_execution_succeeded({}) is False
+    assert tx_execution_failed({}) is True

tests/examples/contracts/football_prediction_market.py

@@ -0,0 +1,97 @@
+# { "Depends": "py-genlayer:test" }
+
+from genlayer import *
+
+import json
+import typing
+
+
+class PredictionMarket(gl.Contract):
+    has_resolved: bool
+    team1: str
+    team2: str
+    resolution_url: str
+    winner: u256
+    score: str
+
+    def __init__(self, game_date: str, team1: str, team2: str):
+        """
+        Initializes a new instance of the prediction market with the specified game date and teams.
+
+        Args:
+            game_date (str): The date of the game in the format 'YYYY-MM-DD'.
+            team1 (str): The name of the first team.
+            team2 (str): The name of the second team.
+
+        Attributes:
+            has_resolved (bool): Indicates whether the game's resolution has been processed. Default is False.
+            game_date (str): The date of the game.
+            resolution_url (str): The URL to the game's resolution on BBC Sport.
+            team1 (str): The name of the first team.
+            team2 (str): The name of the second team.
+        """
+        self.has_resolved = False
+        self.resolution_url = (
+            "https://www.bbc.com/sport/football/scores-fixtures/" + game_date
+        )
+        self.team1 = team1
+        self.team2 = team2
+        self.winner = 0
+        self.score = ""
+
+    @gl.public.write
+    def resolve(self) -> typing.Any:
+
+        if self.has_resolved:
+            return "Already resolved"
+
+        market_resolution_url = self.resolution_url
+        team1 = self.team1
+        team2 = self.team2
+
+        def get_match_result() -> str:
+            web_data = gl.get_webpage(market_resolution_url, mode="text")
+            print(web_data)
+
+            task = f"""
+In the following web page, find the winning team in a matchup between the following teams:
+Team 1: {team1}
+Team 2: {team2}
+
+Web page content:
+{web_data}
+End of web page data.
+
+If it says "Kick off [time]" between the names of the two teams, it means the game hasn't started yet.
+If you fail to extract the score, assume the game is not resolved yet.
+
+Respond with the following JSON format:
+{{
+    "score": str, // The score with numbers only, e.g, "1:2", or "-" if the game is not resolved yet
+    "winner": int, // The number of the winning team, 0 for draw, or -1 if the game is not yet finished
+}}
+It is mandatory that you respond only using the JSON format above,
+nothing else. Don't include any other words or characters,
+your output must be only JSON without any formatting prefix or suffix.
+This result should be perfectly parsable by a JSON parser without errors.
+            """
+            result = gl.exec_prompt(task).replace("```json", "").replace("```", "")
+            print(result)
+            return json.dumps(json.loads(result), sort_keys=True)
+
+        result_json = json.loads(gl.eq_principle_strict_eq(get_match_result))
+
+        if result_json["winner"] > -1:
+            self.has_resolved = True
+            self.winner = result_json["winner"]
+            self.score = result_json["score"]
+
+        return result_json
+
+    @gl.public.view
+    def get_resolution_data(self) -> dict[str, typing.Any]:
+        return {
+            "winner": self.winner,
+            "score": self.score,
+            "has_resolved": self.has_resolved,
+        }