genlayer-test 0.1.0b4__py3-none-any.whl → 0.1.0b6__py3-none-any.whl

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: genlayer-test
-Version: 0.1.0b4
+Version: 0.1.0b6
 Summary: GenLayer Testing Suite
 Author: GenLayer
 License-Expression: MIT

genlayer_test-0.1.0b6.dist-info/RECORD

@@ -0,0 +1,24 @@
+genlayer_test-0.1.0b6.dist-info/licenses/LICENSE,sha256=che_H4vE0QUx3HvWrAa1_jDEVInift0U6VO15-QqEls,1064
+gltest/__init__.py,sha256=AK_YfRvwlhrOheOelUG8qIRG17on0-nFCF747dopg2w,332
+gltest/assertions.py,sha256=wrT5R8yLAxm0B1EzmdZjOK5gBriugIrdtOIt9Qi0G-k,591
+gltest/exceptions.py,sha256=V3OJlvW5iiv7lYmwV6h_EtAi2vqy63b7RcLB6ohDZ20,502
+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=QCsQI8BSOHQwGWFxZVDRL-HA0Dyae3Re24E-yAZrflA,86
+gltest/artifacts/contract.py,sha256=2wmfQF6FAiNuMlr9pePK7ZJjQj5Tl7-3SefeH3OnSRQ,3089
+gltest/glchain/__init__.py,sha256=X-mEbREoAOe9K4n74C55gCiXH4wItzY5HTJcg3_F3mI,412
+gltest/glchain/account.py,sha256=vOXxcR09NkT6iFw_m49DW1nVC7kP8wf23555iPPXRkw,402
+gltest/glchain/client.py,sha256=q04LIQy5SCIrYZflZiTapfeQ-AaSTa0w369ehnVbJLM,532
+gltest/glchain/contract.py,sha256=1pd4eAQlHXjnRF7hBvnoR-9f-HORUaYKVyV5P42io4o,8747
+gltest/helpers/__init__.py,sha256=a9uBXWj44P-Gu0vKKgVBPOSuZ5yumVFLYAzywrGZ36Y,179
+gltest/helpers/fixture_snapshot.py,sha256=r7olLq8Aq0h0mMydlvmr3sNxWZeUns_wx1WK3HFAVaY,1774
+gltest/helpers/take_snapshot.py,sha256=eXqEKXM2hcox3pLGIcNddobU8zXPQvD-Iwf87eHqW2s,1276
+gltest_cli/main.py,sha256=Ti2-0Ev1x5_cM0D1UKqdgaDt80CDHEQGtdRne2qLm4M,53
+tests/conftest.py,sha256=vY6XQ9K2kZ8Qo-h9-PmkhmEIRyR_ILjbM7R0dPPjU_g,28
+tests/test_plugin_hooks.py,sha256=FQOrkhoXLinq0sjvoYjr63Oqg-ZVPcNFeUrK4bqrn4E,2020
+genlayer_test-0.1.0b6.dist-info/METADATA,sha256=jgrseqjqUTnRcPEH_Z7KqEaIpSE0raE9OEcNoqAyshs,12925
+genlayer_test-0.1.0b6.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
+genlayer_test-0.1.0b6.dist-info/entry_points.txt,sha256=rXhrPVq2IhVsd4uWzxzwCTx7jA1KcQIVNxDCUuxq4f8,89
+genlayer_test-0.1.0b6.dist-info/top_level.txt,sha256=-qiGZxTRBytujzgVcKpxjvQ-WNeUDjXa59ceGMwMpko,24
+genlayer_test-0.1.0b6.dist-info/RECORD,,

gltest/exceptions.py

@@ -2,3 +2,19 @@ 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
+

gltest/glchain/__init__.py

@@ -1,5 +1,5 @@
 from .contract import Contract, ContractFactory, get_contract_factory
-from .client import get_gl_client
+from .client import get_gl_client, get_gl_provider
 from .account import create_accounts, create_account, accounts, default_account
 
 
@@ -12,4 +12,5 @@ __all__ = [
     "accounts",
     "create_accounts",
     "get_gl_client",
+    "get_gl_provider",
 ]

gltest/glchain/client.py

@@ -13,3 +13,11 @@ def get_gl_client():
     return create_client(
         chain=localnet, account=default_account, endpoint=get_rpc_url()
     )
+
+
+def get_gl_provider():
+    """
+    Get the GenLayer provider instance.
+    """
+    client = get_gl_client()
+    return client.provider

gltest/glchain/contract.py

@@ -1,10 +1,15 @@
+from eth_typing import (
+    Address,
+    ChecksumAddress,
+)
+from eth_account.signers.local import LocalAccount
+from typing import Union
 from dataclasses import dataclass
 from gltest.artifacts import find_contract_definition
 from gltest.assertions import tx_execution_failed
 from gltest.exceptions import DeploymentError
 from .client import get_gl_client
 from gltest.types import CalldataEncodable, GenLayerTransaction, TransactionStatus
-from eth_account.signers.local import LocalAccount
 from typing import List, Any, Type, Optional, Dict, Callable
 import types
 from gltest.plugin_config import get_default_wait_interval, get_default_wait_retries
@@ -89,14 +94,18 @@ class Contract:
             consensus_max_rotations: Optional[int] = None,
             leader_only: bool = False,
             wait_transaction_status: TransactionStatus = TransactionStatus.FINALIZED,
-            wait_interval: int = get_default_wait_interval(),
-            wait_retries: int = get_default_wait_retries(),
+            wait_interval: Optional[int] = None,
+            wait_retries: Optional[int] = None,
             wait_triggered_transactions: bool = True,
             wait_triggered_transactions_status: TransactionStatus = TransactionStatus.ACCEPTED,
         ) -> GenLayerTransaction:
             """
             Wrapper to the contract write method.
             """
+            if wait_interval is None:
+                wait_interval = get_default_wait_interval()
+            if wait_retries is None:
+                wait_retries = get_default_wait_retries()
             client = get_gl_client()
             tx_hash = client.write_contract(
                 address=self.address,
@@ -152,19 +161,42 @@ class ContractFactory:
             contract_name=contract_name, contract_code=contract_info.contract_code
         )
 
+    def build_contract(
+        self,
+        contract_address: Union[Address, ChecksumAddress],
+        account: Optional[LocalAccount] = None,
+    ) -> Contract:
+        """
+        Build contract from address
+        """
+        client = get_gl_client()
+        try:
+            schema = client.get_contract_schema(address=contract_address)
+            return Contract.new(
+                address=contract_address, schema=schema, account=account
+            )
+        except Exception as e:
+            raise ValueError(
+                f"Failed to build contract {self.contract_name}: {str(e)}"
+            ) from e
+
     def deploy(
         self,
         args: List[Any] = [],
         account: Optional[LocalAccount] = None,
         consensus_max_rotations: Optional[int] = None,
         leader_only: bool = False,
-        wait_interval: int = get_default_wait_interval(),
-        wait_retries: int = get_default_wait_retries(),
+        wait_interval: Optional[int] = None,
+        wait_retries: Optional[int] = None,
         wait_transaction_status: TransactionStatus = TransactionStatus.FINALIZED,
     ) -> Contract:
         """
         Deploy the contract
         """
+        if wait_interval is None:
+            wait_interval = get_default_wait_interval()
+        if wait_retries is None:
+            wait_retries = get_default_wait_retries()
         client = get_gl_client()
         try:
             tx_hash = client.deploy_contract(

gltest/helpers/__init__.py

@@ -0,0 +1,8 @@
+from .take_snapshot import take_snapshot
+from .fixture_snapshot import load_fixture, clear_snapshots
+
+__all__ = [
+    "take_snapshot",
+    "load_fixture",
+    "clear_snapshots",
+]

gltest/helpers/fixture_snapshot.py

@@ -0,0 +1,67 @@
+from typing import TypeVar, Callable, List, Any
+from dataclasses import dataclass
+from .take_snapshot import SnapshotRestorer, take_snapshot
+from gltest.exceptions import (
+    FixtureSnapshotError,
+    InvalidSnapshotError,
+    FixtureAnonymousFunctionError,
+)
+
+
+T = TypeVar("T")
+
+
+@dataclass
+class Snapshot:
+    """Represents a snapshot of the blockchain state."""
+
+    restorer: SnapshotRestorer
+    fixture: Callable[[], Any]
+    data: Any
+
+
+# Global storage for snapshots
+_snapshots: List[Snapshot] = []
+
+
+def load_fixture(fixture: Callable[[], T]) -> T:
+    """
+    Useful in tests for setting up the desired state of the network.
+    """
+    if fixture.__name__ == "<lambda>":
+        raise FixtureAnonymousFunctionError("Fixtures must be named functions")
+
+    # Find existing snapshot for this fixture
+    global _snapshots
+    snapshot = next((s for s in _snapshots if s.fixture == fixture), None)
+
+    if snapshot is not None:
+        try:
+            snapshot.restorer.restore()
+            # Remove snapshots that were taken after this one
+            
+            _snapshots = [
+                s
+                for s in _snapshots
+                if int(s.restorer.snapshot_id) <= int(snapshot.restorer.snapshot_id)
+            ]
+        except Exception as e:
+            if isinstance(e, InvalidSnapshotError):
+                raise FixtureSnapshotError(e) from e
+            raise e
+
+        return snapshot.data
+    else:
+        # Execute the fixture and take a snapshot
+        data = fixture()
+        restorer = take_snapshot()
+
+        _snapshots.append(Snapshot(restorer=restorer, fixture=fixture, data=data))
+
+        return data
+
+
+def clear_snapshots() -> None:
+    """Clears every existing snapshot."""
+    global _snapshots
+    _snapshots = []

gltest/helpers/take_snapshot.py

@@ -0,0 +1,41 @@
+from gltest.glchain import get_gl_provider
+from dataclasses import dataclass
+from typing import Callable
+from gltest.exceptions import HelperError, InvalidSnapshotError
+
+
+@dataclass
+class SnapshotRestorer:
+    """Class responsible for restoring blockchain state to a snapshot."""
+
+    restore: Callable[[], None]
+    snapshot_id: int
+
+
+def take_snapshot() -> SnapshotRestorer:
+    """
+    Take a snapshot of the current blockchain state and return a function to restore the state and the snapshot ID.
+    """
+    provider = get_gl_provider()
+    snapshot_id = provider.make_request(method="sim_createSnapshot", params=[])[
+        "result"
+    ]
+    if not isinstance(snapshot_id, int):
+        raise HelperError(
+            "Assertion error: the value returned by evm_snapshot should be a int"
+        )
+
+    def restore() -> None:
+        reverted = provider.make_request(
+            method="sim_restoreSnapshot", params=[snapshot_id]
+        )["result"]
+
+        if not isinstance(reverted, bool):
+            raise HelperError(
+                "Assertion error: the value returned by evm_revert should be a boolean"
+            )
+
+        if not reverted:
+            raise InvalidSnapshotError("")
+
+    return SnapshotRestorer(restore=restore, snapshot_id=snapshot_id)

gltest/plugin_hooks.py

@@ -35,7 +35,7 @@ def pytest_addoption(parser):
         "--rpc-url",
         action="store",
         default=SIMULATOR_JSON_RPC_URL,
-        help="Directory containing contract files",
+        help="RPC URL for the genlayer network",
     )
 
 

tests/test_plugin_hooks.py

@@ -12,7 +12,7 @@ def test_help_message(pytester):
             "*Default wait interval for waiting transaction receipts",
             "*--default-wait-retries=DEFAULT_WAIT_RETRIES",
             "*Default wait retries for waiting transaction receipts",
-            "*--rpc-url=RPC_URL*Directory containing contract files",
+            "*--rpc-url=RPC_URL*RPC URL for the genlayer network",
         ]
     )
 

genlayer_test-0.1.0b4.dist-info/RECORD

@@ -1,21 +0,0 @@
-genlayer_test-0.1.0b4.dist-info/licenses/LICENSE,sha256=che_H4vE0QUx3HvWrAa1_jDEVInift0U6VO15-QqEls,1064
-gltest/__init__.py,sha256=AK_YfRvwlhrOheOelUG8qIRG17on0-nFCF747dopg2w,332
-gltest/assertions.py,sha256=wrT5R8yLAxm0B1EzmdZjOK5gBriugIrdtOIt9Qi0G-k,591
-gltest/exceptions.py,sha256=g7IF0qA8L0PdonXHTsbFnWx05U3jEYWOL3EFTW21IL4,95
-gltest/plugin_config.py,sha256=8Z97RtEJ89OcRbki_oRuBBVct_q56BFmKvthan1y9Y4,840
-gltest/plugin_hooks.py,sha256=WYxkKAWlWwDe1-t_tL_WN1iQ99ZPCA5QmGhF8EvvQoc,1439
-gltest/types.py,sha256=BODmwTr2gAUEiO9FjiuTiWwuKvXgo4xZWstQWNUfnlw,156
-gltest/artifacts/__init__.py,sha256=QCsQI8BSOHQwGWFxZVDRL-HA0Dyae3Re24E-yAZrflA,86
-gltest/artifacts/contract.py,sha256=2wmfQF6FAiNuMlr9pePK7ZJjQj5Tl7-3SefeH3OnSRQ,3089
-gltest/glchain/__init__.py,sha256=jvUruSe3wRKtYr2tPIds888fhr4CWK87nsuhI-6WLuI,372
-gltest/glchain/account.py,sha256=vOXxcR09NkT6iFw_m49DW1nVC7kP8wf23555iPPXRkw,402
-gltest/glchain/client.py,sha256=PKHt7cANoCGcffvTFwoQsR9V2OH9fLTJZUafc1lz2yE,395
-gltest/glchain/contract.py,sha256=bma3aepoZkVOsGdbNbUKAMvbgW6kzmnWnTs9PrgVdas,7719
-gltest_cli/main.py,sha256=Ti2-0Ev1x5_cM0D1UKqdgaDt80CDHEQGtdRne2qLm4M,53
-tests/conftest.py,sha256=vY6XQ9K2kZ8Qo-h9-PmkhmEIRyR_ILjbM7R0dPPjU_g,28
-tests/test_plugin_hooks.py,sha256=r2HCAYPpLVyXsUe1h-hRMcdDEXZSZ1h5q6UGI8BWKAw,2023
-genlayer_test-0.1.0b4.dist-info/METADATA,sha256=mDE5zcBuzQONUYoWWjPxr0hFL-TQB0uCvblEJjgsZus,12925
-genlayer_test-0.1.0b4.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-genlayer_test-0.1.0b4.dist-info/entry_points.txt,sha256=rXhrPVq2IhVsd4uWzxzwCTx7jA1KcQIVNxDCUuxq4f8,89
-genlayer_test-0.1.0b4.dist-info/top_level.txt,sha256=-qiGZxTRBytujzgVcKpxjvQ-WNeUDjXa59ceGMwMpko,24
-genlayer_test-0.1.0b4.dist-info/RECORD,,