genlayer-test 0.1.0b3__py3-none-any.whl → 0.1.0b5__py3-none-any.whl

genlayer_test-0.1.0b5.dist-info/METADATA

@@ -0,0 +1,402 @@
+Metadata-Version: 2.4
+Name: genlayer-test
+Version: 0.1.0b5
+Summary: GenLayer Testing Suite
+Author: GenLayer
+License-Expression: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pytest
+Requires-Dist: genlayer-py==0.1.0b1
+Dynamic: license-file
+
+# GenLayer Testing Suite
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/license/mit/)
+[![Discord](https://dcbadge.vercel.app/api/server/8Jm4v89VAu?compact=true&style=flat)](https://discord.gg/VpfmXEMN66)
+[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/yeagerai.svg?style=social&label=Follow%20%40GenLayer)](https://x.com/GenLayer)
+[![PyPI version](https://badge.fury.io/py/genlayer-test.svg)](https://badge.fury.io/py/genlayer-test)
+[![Documentation](https://img.shields.io/badge/docs-genlayer-blue)](https://docs.genlayer.com/api-references/genlayer-test)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+## About
+
+The GenLayer Testing Suite is a powerful testing framework designed to streamline the development and validation of intelligent contracts within the GenLayer ecosystem. Built on top of [pytest](https://docs.pytest.org/en/stable/) and [genlayer-py](https://docs.genlayer.com/api-references/genlayer-py), this suite provides developers with a comprehensive set of tools for deploying, interacting with, and testing intelligent contracts efficiently in a simulated GenLayer environment.
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+pip install genlayer-test
+```
+
+### Basic Usage
+
+```python
+from gltest import get_contract_factory, default_account, create_account
+from gltest.assertions import tx_execution_succeeded
+
+factory = get_contract_factory("MyContract")
+# Deploy a contract with default account
+contract = factory.deploy() # This will be deployed with default_account
+assert contract.account == default_account
+
+# Deploy a contract with other account
+other_account = create_account()
+contract = factory.deploy(account=other_account)
+assert contract.account == other_account
+
+# Interact with the contract
+result = contract.get_value()  # Read method
+tx_receipt = contract.set_value(args=["new_value"])  # Write method
+
+assert tx_execution_succeeded(tx_receipt)
+```
+
+## 📋 Table of Contents
+
+- [About](#about)
+- [Quick Start](#-quick-start)
+- [Prerequisites](#prerequisites)
+- [Installation and Usage](#installation-and-usage)
+- [Key Features](#-key-features)
+- [Examples](#-examples)
+- [Best Practices](#-best-practices)
+- [Troubleshooting](#-troubleshooting)
+- [Contributing](#-contributing)
+- [License](#-license)
+- [Support](#-support)
+
+## Prerequisites
+
+Before installing GenLayer Testing Suite, ensure you have the following prerequisites installed:
+
+- Python (>=3.12)
+- GenLayer Studio (Docker deployment)
+- pip (Python package installer)
+
+## Installation and Usage
+
+### Installation Options
+
+1. Install from PyPI (recommended):
+```bash
+$ pip install genlayer-test
+```
+
+2. Install from source:
+```bash
+$ git clone https://github.com/yeagerai/genlayer-testing-suite
+$ cd genlayer-testing-suite
+$ pip install -e .
+```
+
+### Running Tests
+
+1. Run all tests:
+```bash
+$ gltest
+```
+
+2. Run specific test file:
+```bash
+$ gltest tests/test_mycontract.py
+```
+
+3. Run tests with specific markers:
+```bash
+$ gltest -m "integration"
+```
+
+4. Run tests with verbose output:
+```bash
+$ gltest -v
+```
+
+5. Run tests in specific contracts directories, by default `<path_to_contracts>` is set to `contracts/`
+```bash
+$ gltest --contracts-dir <path_to_contracts>
+```
+
+## 🚀 Key Features
+
+- **Pytest Integration** – Extends pytest to support intelligent contract testing, making it familiar and easy to adopt.
+- **Account & Transaction Management** – Create, fund, and track accounts and transactions within the GenLayer Simulator.
+- **Contract Deployment & Interaction** – Deploy contracts, call methods, and monitor events seamlessly.
+- **CLI Compatibility** – Run tests directly from the command line, ensuring smooth integration with the GenLayer CLI.
+- **State Injection & Consensus Simulation** – Modify contract states dynamically and simulate consensus scenarios for advanced testing.
+- **Prompt Testing & Statistical Analysis** – Evaluate and statistically test prompts for AI-driven contract execution.
+- **Scalability to Security & Audit Tools** – Designed to extend into security testing and smart contract auditing.
+
+## 📚 Examples
+
+### Project Structure
+
+Before diving into the examples, let's understand the basic project structure:
+
+```
+genlayer-example/
+├── contracts/              # Contract definitions
+│   └── storage.gpy         # Example storage contract
+└── test/                   # Test files
+    └── test_contract.py    # Contract test cases
+```
+
+### Storage Contract Example
+
+Let's examine a simple Storage contract that demonstrates basic read and write operations:
+
+```python
+# { "Depends": "py-genlayer:test" }
+
+from genlayer import *
+
+
+# contract class
+class Storage(gl.Contract):
+    # State variable to store data
+    storage: str
+
+    # Constructor - initializes the contract state
+    def __init__(self, initial_storage: str):
+        self.storage = initial_storage
+
+    # Read method - marked with @gl.public.view decorator
+    # Returns the current storage value
+    @gl.public.view
+    def get_storage(self) -> str:
+        return self.storage
+
+    # Write method - marked with @gl.public.write decorator
+    # Updates the storage value
+    @gl.public.write
+    def update_storage(self, new_storage: str) -> None:
+        self.storage = new_storage
+```
+
+Key features demonstrated in this contract:
+- State variable declaration
+- Constructor with initialization
+- Read-only method with `@gl.public.view` decorator
+- State-modifying method with `@gl.public.write` decorator
+- Type hints for better code clarity
+
+### Contract Deployment
+
+Here's how to deploy the Storage contract:
+
+```python
+from gltest import get_contract_factory, default_account
+
+def test_deployment():
+    # Get the contract factory for your contract
+    # it will search in the contracts directory
+    factory = get_contract_factory("Storage")
+    
+    # Deploy the contract with constructor arguments
+    contract = factory.deploy(
+        args=["initial_value"],  # Constructor arguments
+        account=default_account,  # Account to deploy from
+        consensus_max_rotations=3,  # Optional: max consensus rotations
+        leader_only=False,  # Optional: whether to run only on leader
+    )
+    
+    # Contract is now deployed and ready to use
+    assert contract.address is not None
+```
+
+### Read Methods
+
+Reading from the contract is straightforward:
+
+```python
+from gltest import get_contract_factory, default_account
+
+def test_read_methods():
+    # Get the contract factory and deploy the contract
+    factory = get_contract_factory("Storage")
+    contract = factory.deploy(account=default_account)
+    
+    # Call a read-only method
+    result = contract.get_value(args=[])
+    
+    # Assert the result matches the initial value
+    assert result == "initial_value"
+```
+
+### Write Methods
+
+Writing to the contract requires transaction handling:
+
+```python
+from gltest import get_contract_factory
+from gltest.assertions import tx_execution_succeeded
+
+def test_write_methods():
+    # Get the contract factory and deploy the contract
+    factory = get_contract_factory("Storage")
+    contract = factory.deploy()
+    
+    # Call a write method with arguments
+    tx_receipt = contract.update_storage(
+        args=["new_value"],  # Method arguments
+        value=0,  # Optional: amount of native currency to send
+        consensus_max_rotations=3,  # Optional: max consensus rotations
+        leader_only=False,  # Optional: whether to run only on leader
+        wait_interval=1,  # Optional: seconds between status checks
+        wait_retries=10,  # Optional: max number of retries
+    )
+    
+    # Verify the transaction was successful
+    assert tx_execution_succeeded(tx_receipt)
+    
+    # Verify the value was updated
+    assert contract.get_storage() == "new_value"
+```
+
+## 📝 Best Practices
+
+1. **Test Organization**
+   - Keep tests in a dedicated `tests` directory
+   - Use descriptive test names
+   - Group related tests using pytest markers
+
+2. **Contract Deployment**
+   - Always verify deployment success
+   - Use appropriate consensus parameters
+   - Handle deployment errors gracefully
+
+3. **Transaction Handling**
+   - Always wait for transaction finalization
+   - Verify transaction status
+   - Handle transaction failures appropriately
+
+4. **State Management**
+   - Reset state between tests
+   - Use fixtures for common setup
+   - Avoid test dependencies
+
+## 🔧 Troubleshooting
+
+### Common Issues
+
+1. **Deployment Failures**
+   - **Problem**: Contract deployment fails due to various reasons like insufficient funds, invalid contract code, or network issues.
+   - **Solution**: Implement proper error handling
+   ```python
+   try:
+       contract = factory.deploy(args=["initial_value"])
+   except DeploymentError as e:
+       print(f"Deployment failed: {e}")
+   ```
+
+2. **Transaction Timeouts**
+   - **Problem**: Transactions take too long to complete or fail due to network congestion or consensus delays.
+   - **Solution**: Adjust timeout parameters and implement retry logic:
+   ```python
+   tx_receipt = contract.set_value(
+       args=["new_value"],
+       wait_interval=2,  # Increase wait interval between status checks
+       wait_retries=20,  # Increase number of retry attempts
+   )
+   ```
+
+3. **Consensus Issues**
+   - **Problem**: Transactions fail due to consensus-related problems like network partitions or slow consensus.
+   - **Solution**: Adjust consensus parameters and try different modes:
+   ```python
+   # Try with increased consensus parameters
+   contract = factory.deploy(
+       consensus_max_rotations=5,  # Increase number of consensus rotations
+       leader_only=True,  # Try leader-only mode for faster execution
+   )
+   
+   # For critical operations, use more conservative settings
+   contract = factory.deploy(
+       consensus_max_rotations=10,  # More rotations for better reliability
+       leader_only=False,  # Full consensus for better security
+       wait_interval=3,  # Longer wait between checks
+       wait_retries=30  # More retries for consensus
+   )
+   ```
+
+4. **Contracts Directory Issues**
+   - **Problem**: `get_contract_factory` can't find your contract files.
+   - **Solution**: Ensure proper directory structure and configuration:
+   ```bash
+   # Default structure
+   your_project/
+   ├── contracts/           # Default contracts directory
+   │   └── my_contract.gpy  # Your contract file
+   └── tests/
+       └── test_contract.py # Your test file
+   
+   # If using a different directory structure
+   gltest --contracts-dir /path/to/your/contracts
+   ```
+
+5. **Contract File Naming and Structure**
+   - **Problem**: Contracts aren't being recognized or loaded properly.
+   - **Solution**: Follow the correct naming and structure conventions:
+   ```python
+   # Correct file: contracts/my_contract.gpy
+   # Correct structure:
+   from genlayer import *
+   
+   class MyContract(gl.Contract):
+       # Contract code here
+       pass
+   
+   # Incorrect file: contracts/my_contract.py  # Wrong extension
+   # Incorrect structure:
+   class MyContract:  # Missing gl.Contract inheritance
+       pass
+   ```
+
+6. **Environment Setup Issues**
+   - **Problem**: Tests fail due to missing or incorrect environment setup.
+   - **Solution**: Verify your environment:
+   ```bash
+   # Check Python version
+   python --version  # Should be >= 3.8
+   
+   # Check GenLayer Studio status
+   docker ps  # Should show GenLayer Studio running
+   
+   # Verify package installation
+   pip list | grep genlayer-test  # Should show installed version
+   ```
+
+## 🤝 Contributing
+
+We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
+
+1. Fork the repository
+2. Create your feature branch
+3. Commit your changes
+4. Push to the branch
+5. Create a Pull Request
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 💬 Support
+
+- [Documentation](https://docs.genlayer.com/api-references/genlayer-test)
+- [Discord Community](https://discord.gg/VpfmXEMN66)
+- [GitHub Issues](https://github.com/yeagerai/genlayer-testing-suite/issues)
+- [Twitter](https://x.com/GenLayer)
+
+
+

genlayer_test-0.1.0b5.dist-info/RECORD

@@ -0,0 +1,24 @@
+genlayer_test-0.1.0b5.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=bma3aepoZkVOsGdbNbUKAMvbgW6kzmnWnTs9PrgVdas,7719
+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.0b5.dist-info/METADATA,sha256=Ox0jwGv_RkvZL5baRbQjpBENdJPmhl5DjHC58zCdl-s,12925
+genlayer_test-0.1.0b5.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
+genlayer_test-0.1.0b5.dist-info/entry_points.txt,sha256=rXhrPVq2IhVsd4uWzxzwCTx7jA1KcQIVNxDCUuxq4f8,89
+genlayer_test-0.1.0b5.dist-info/top_level.txt,sha256=-qiGZxTRBytujzgVcKpxjvQ-WNeUDjXa59ceGMwMpko,24
+genlayer_test-0.1.0b5.dist-info/RECORD,,

{genlayer_test-0.1.0b3.dist-info → genlayer_test-0.1.0b5.dist-info}/WHEEL

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

genlayer_test-0.1.0b5.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 YeagerAI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{genlayer_test-0.1.0b3.dist-info → genlayer_test-0.1.0b5.dist-info}/top_level.txt

@@ -1,2 +1,3 @@
 gltest
 gltest_cli
+tests

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 gl_client, get_gl_client
+from .client import get_gl_client, get_gl_provider
 from .account import create_accounts, create_account, accounts, default_account
 
 
@@ -7,10 +7,10 @@ __all__ = [
     "Contract",
     "ContractFactory",
     "get_contract_factory",
-    "gl_client",
     "create_account",
     "default_account",
     "accounts",
     "create_accounts",
     "get_gl_client",
+    "get_gl_provider",
 ]

gltest/glchain/client.py

@@ -2,9 +2,7 @@ from genlayer_py.chains import localnet
 from genlayer_py import create_client
 from .account import default_account
 from functools import lru_cache
-
-# Create the client
-gl_client = create_client(chain=localnet, account=default_account)
+from gltest.plugin_config import get_rpc_url
 
 
 @lru_cache(maxsize=1)
@@ -12,4 +10,14 @@ def get_gl_client():
     """
     Get the GenLayer client instance.
     """
-    return 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

@@ -7,6 +7,7 @@ from gltest.types import CalldataEncodable, GenLayerTransaction, TransactionStat
 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
 
 
 @dataclass
@@ -87,9 +88,9 @@ class Contract:
             value: int = 0,
             consensus_max_rotations: Optional[int] = None,
             leader_only: bool = False,
-            wait_interval: Optional[int] = None,
-            wait_retries: Optional[int] = None,
             wait_transaction_status: TransactionStatus = TransactionStatus.FINALIZED,
+            wait_interval: int = get_default_wait_interval(),
+            wait_retries: int = get_default_wait_retries(),
             wait_triggered_transactions: bool = True,
             wait_triggered_transactions_status: TransactionStatus = TransactionStatus.ACCEPTED,
         ) -> GenLayerTransaction:
@@ -106,15 +107,11 @@ class Contract:
                 leader_only=leader_only,
                 args=args,
             )
-            extra_args = {}
-            if wait_interval is not None:
-                extra_args["interval"] = wait_interval
-            if wait_retries is not None:
-                extra_args["retries"] = wait_retries
             receipt = client.wait_for_transaction_receipt(
                 transaction_hash=tx_hash,
                 status=wait_transaction_status,
-                **extra_args,
+                interval=wait_interval,
+                retries=wait_retries,
             )
             if wait_triggered_transactions:
                 triggered_transactions = receipt["triggered_transactions"]
@@ -122,7 +119,8 @@ class Contract:
                     client.wait_for_transaction_receipt(
                         transaction_hash=triggered_transaction,
                         status=wait_triggered_transactions_status,
-                        **extra_args,
+                        interval=wait_interval,
+                        retries=wait_retries,
                     )
             return receipt
 
@@ -160,8 +158,8 @@ class ContractFactory:
         account: Optional[LocalAccount] = None,
         consensus_max_rotations: Optional[int] = None,
         leader_only: bool = False,
-        wait_interval: Optional[int] = None,
-        wait_retries: Optional[int] = None,
+        wait_interval: int = get_default_wait_interval(),
+        wait_retries: int = get_default_wait_retries(),
         wait_transaction_status: TransactionStatus = TransactionStatus.FINALIZED,
     ) -> Contract:
         """
@@ -176,13 +174,11 @@ class ContractFactory:
                 consensus_max_rotations=consensus_max_rotations,
                 leader_only=leader_only,
             )
-            extra_args = {}
-            if wait_interval is not None:
-                extra_args["interval"] = wait_interval
-            if wait_retries is not None:
-                extra_args["retries"] = wait_retries
             tx_receipt = client.wait_for_transaction_receipt(
-                transaction_hash=tx_hash, status=wait_transaction_status, **extra_args
+                transaction_hash=tx_hash,
+                status=wait_transaction_status,
+                interval=wait_interval,
+                retries=wait_retries,
             )
             if (
                 not tx_receipt

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_config.py

@@ -1,6 +1,9 @@
 from pathlib import Path
 
 _contracts_dir = None
+_rpc_url = None
+_default_wait_interval = None
+_default_wait_retries = None
 
 
 def set_contracts_dir(path: Path):
@@ -10,3 +13,30 @@ def set_contracts_dir(path: Path):
 
 def get_contracts_dir() -> Path:
     return Path(_contracts_dir)
+
+
+def set_rpc_url(rpc_url: str):
+    global _rpc_url
+    _rpc_url = rpc_url
+
+
+def get_rpc_url() -> str:
+    return _rpc_url
+
+
+def set_default_wait_interval(default_wait_interval: int):
+    global _default_wait_interval
+    _default_wait_interval = default_wait_interval
+
+
+def get_default_wait_interval() -> int:
+    return _default_wait_interval
+
+
+def set_default_wait_retries(default_wait_retries: int):
+    global _default_wait_retries
+    _default_wait_retries = default_wait_retries
+
+
+def get_default_wait_retries() -> int:
+    return _default_wait_retries

gltest/plugin_hooks.py

@@ -1,16 +1,51 @@
-from gltest.plugin_config import set_contracts_dir
+from gltest.plugin_config import (
+    set_contracts_dir,
+    set_default_wait_interval,
+    set_default_wait_retries,
+    set_rpc_url,
+)
 from pathlib import Path
+from genlayer_py.chains.localnet import SIMULATOR_JSON_RPC_URL
 
 
 def pytest_addoption(parser):
-    parser.addoption(
+    group = parser.getgroup("gltest")
+    group.addoption(
         "--contracts-dir",
         action="store",
         default="contracts",
         help="Directory containing contract files",
     )
 
+    group.addoption(
+        "--default-wait-interval",
+        action="store",
+        default=10000,
+        help="Default wait interval for waiting transaction receipts",
+    )
+
+    group.addoption(
+        "--default-wait-retries",
+        action="store",
+        default=15,
+        help="Default wait retries for waiting transaction receipts",
+    )
+
+    group.addoption(
+        "--rpc-url",
+        action="store",
+        default=SIMULATOR_JSON_RPC_URL,
+        help="RPC URL for the genlayer network",
+    )
+
 
 def pytest_configure(config):
     contracts_dir = config.getoption("--contracts-dir")
+    default_wait_interval = config.getoption("--default-wait-interval")
+    default_wait_retries = config.getoption("--default-wait-retries")
+    rpc_url = config.getoption("--rpc-url")
+
     set_contracts_dir(Path(contracts_dir))
+    set_default_wait_interval(int(default_wait_interval))
+    set_default_wait_retries(int(default_wait_retries))
+    set_rpc_url(str(rpc_url))

tests/conftest.py

@@ -0,0 +1 @@
+pytest_plugins = 'pytester'

tests/test_plugin_hooks.py

@@ -0,0 +1,78 @@
+def test_help_message(pytester):
+    result = pytester.runpytest(
+        "--help",
+    )
+    # fnmatch_lines does an assertion internally
+    result.stdout.fnmatch_lines(
+        [
+            "gltest:",
+            "*--contracts-dir=CONTRACTS_DIR",
+            "*Directory containing contract files",
+            "*--default-wait-interval=DEFAULT_WAIT_INTERVAL",
+            "*Default wait interval for waiting transaction receipts",
+            "*--default-wait-retries=DEFAULT_WAIT_RETRIES",
+            "*Default wait retries for waiting transaction receipts",
+            "*--rpc-url=RPC_URL*RPC URL for the genlayer network",
+        ]
+    )
+
+
+def test_default_wait_interval(pytester):
+
+    pytester.makepyfile(
+        """
+        from gltest.plugin_config import get_default_wait_interval
+
+        def test_default_wait_interval():
+            assert get_default_wait_interval() == 5000
+    """
+    )
+
+    result = pytester.runpytest("--default-wait-interval=5000", "-v")
+
+    result.stdout.fnmatch_lines(
+        [
+            "*::test_default_wait_interval PASSED*",
+        ]
+    )
+    assert result.ret == 0
+
+
+def test_default_wait_retries(pytester):
+    pytester.makepyfile(
+        """
+        from gltest.plugin_config import get_default_wait_retries
+
+        def test_default_wait_retries():
+            assert get_default_wait_retries() == 4000
+    """
+    )
+
+    result = pytester.runpytest("--default-wait-retries=4000", "-v")
+
+    result.stdout.fnmatch_lines(
+        [
+            "*::test_default_wait_retries PASSED*",
+        ]
+    )
+    assert result.ret == 0
+
+
+def test_rpc_url(pytester):
+    pytester.makepyfile(
+        """
+        from gltest.plugin_config import get_rpc_url
+
+        def test_rpc_url():
+            assert get_rpc_url() == 'http://custom-rpc-url:8545' 
+    """
+    )
+
+    result = pytester.runpytest("--rpc-url=http://custom-rpc-url:8545", "-v")
+
+    result.stdout.fnmatch_lines(
+        [
+            "*::test_rpc_url PASSED*",
+        ]
+    )
+    assert result.ret == 0

genlayer_test-0.1.0b3.dist-info/METADATA

@@ -1,97 +0,0 @@
-Metadata-Version: 2.4
-Name: genlayer-test
-Version: 0.1.0b3
-Summary: GenLayer Testing Suite
-Author: GenLayer
-License-Expression: MIT
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Topic :: Software Development :: Testing
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: pytest
-Requires-Dist: genlayer-py==0.1.0b1
-
-# GenLayer Testing Suite
-
-[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/license/mit/)
-[![Discord](https://dcbadge.vercel.app/api/server/8Jm4v89VAu?compact=true&style=flat)](https://discord.gg/VpfmXEMN66)
-[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/yeagerai.svg?style=social&label=Follow%20%40GenLayer)](https://x.com/GenLayer)
-
-
-## About
-
-The GenLayer Testing Suite is a powerful testing framework designed to streamline the development and validation of intelligent contracts within the GenLayer ecosystem. Built on top of [pytest](https://docs.pytest.org/en/stable/), this suite provides developers with a comprehensive set of tools for deploying, interacting with, and testing intelligent contracts efficiently in a simulated GenLayer environment.
-
-
-## Prerequisites
-
-Before installing GenLayer Testing Suite, ensure you have the following prerequisites installed:
-
-- Python (>=3.8)
-- GenLayer Studio (Docker deployment)
-- pip (Python package installer)
-
-## 🛠️ Installation and Usage
-
-### Installation Options
-
-1. Install from PyPI (recommended):
-```bash
-$ pip install genlayer-test
-```
-
-2. Install from source:
-```bash
-$ git clone https://github.com/yeagerai/genlayer-testing-suite
-$ cd genlayer-testing-suite
-$ pip install -e .
-```
-
-
-### Running Tests
-
-1. Run all tests:
-```bash
-$ gltest
-```
-
-2. Run specific test file:
-```bash
-$ gltest tests/test_mycontract.py
-```
-
-3. Run tests with specific markers:
-```bash
-$ gltest -m "integration"
-```
-
-4. Run tests with verbose output:
-```bash
-$ gltest -v
-```
-
-For more detailed information and advanced usage, please refer to our [documentation](https://docs.genlayer.com/api-references/genlayer-testing-suite).
-
-## 🚀 Key Features
-- **Pytest Integration** – Extends pytest to support intelligent contract testing, making it familiar and easy to adopt.
-
-- **Account & Transaction Management** – Create, fund, and track accounts and transactions within the GenLayer Simulator.
-
-- **Contract Deployment & Interaction** – Deploy contracts, call methods, and monitor events seamlessly.
-
-- **CLI Compatibility** – Run tests directly from the command line, ensuring smooth integration with the GenLayer CLI.
-
-- **State Injection & Consensus Simulation** – Modify contract states dynamically and simulate consensus scenarios for advanced testing.
-
-- **Prompt Testing & Statistical Analysis** – Evaluate and statistically test prompts for AI-driven contract execution.
-
-- **Scalability to Security & Audit Tools** – Designed to extend into security testing and smart contract auditing.
-
-
-By leveraging the GenLayer Testing Suite, developers can ensure their contracts perform reliably and securely before deployment on the live network. 

genlayer_test-0.1.0b3.dist-info/RECORD

@@ -1,18 +0,0 @@
-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=O9Dx9IejbBJe-CJ9h8iMVtLzjWlzLGcTGOIgJM6gLWc,204
-gltest/plugin_hooks.py,sha256=cy4-LPm3Q-ZaO94t5vgjbPjQB8MRxYGGRXeDBeJ7buU,399
-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=wD2Hzdz_wKpu-mCAX5iBINZDCNdKezLVI2lywkSkjvw,400
-gltest/glchain/account.py,sha256=vOXxcR09NkT6iFw_m49DW1nVC7kP8wf23555iPPXRkw,402
-gltest/glchain/client.py,sha256=U_JJJQ0V8oLPLeIbGpFcHOtnCVPJIoN9DMlvHSD1C0I,355
-gltest/glchain/contract.py,sha256=46QFDjwwg6n0qmjMTPXR1wueV2ZdFOc1g2nas0U9C_c,7837
-gltest_cli/main.py,sha256=Ti2-0Ev1x5_cM0D1UKqdgaDt80CDHEQGtdRne2qLm4M,53
-genlayer_test-0.1.0b3.dist-info/METADATA,sha256=zzWsz5KgLuoQO7urlzrLz9BYQMmpP-QOiyZZB3zbeiw,3409
-genlayer_test-0.1.0b3.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
-genlayer_test-0.1.0b3.dist-info/entry_points.txt,sha256=rXhrPVq2IhVsd4uWzxzwCTx7jA1KcQIVNxDCUuxq4f8,89
-genlayer_test-0.1.0b3.dist-info/top_level.txt,sha256=GSdrnQbiLcZssmtCpbDgBTygsc8Bt_TPeYjwm0FmpdA,18
-genlayer_test-0.1.0b3.dist-info/RECORD,,