genlayer-test 0.2.0__tar.gz → 0.3.0__tar.gz

{genlayer_test-0.2.0/genlayer_test.egg-info → genlayer_test-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: genlayer-test
-Version: 0.2.0
+Version: 0.3.0
 Summary: GenLayer Testing Suite
 Author: GenLayer
 License-Expression: MIT
@@ -14,7 +14,11 @@ Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pytest
-Requires-Dist: genlayer-py==0.3.0
+Requires-Dist: setuptools>=77.0
+Requires-Dist: genlayer-py==0.5.0
+Requires-Dist: colorama>=0.4.6
+Requires-Dist: pyyaml
+Requires-Dist: python-dotenv
 Dynamic: license-file
 
 # GenLayer Testing Suite
@@ -41,13 +45,13 @@ pip install genlayer-test
 ### Basic Usage
 
 ```python
-from gltest import get_contract_factory, default_account, create_account
+from gltest import get_contract_factory, get_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
+assert contract.account == get_default_account()
 
 # Deploy a contract with other account
 other_account = create_account()
@@ -99,6 +103,58 @@ $ cd genlayer-testing-suite
 $ pip install -e .
 ```
 
+### Configuration
+
+The GenLayer Testing Suite can be configured using an optional but recommended `gltest.config.yaml` file in your project root. While not required, this file helps manage network configurations, contract paths, and environment settings in a centralized way, making it easier to maintain different environments and share configurations across team members.
+
+```yaml
+# gltest.config.yaml
+networks:
+  default: localnet  # Default network to use
+
+  localnet:  # Local development network configuration
+    url: "http://127.0.0.1:4000/api"
+
+  testnet_asimov:  # Test network configuration
+    id: 4221
+    url: "http://34.32.169.58:9151"
+    accounts:
+      - "${ACCOUNT_PRIVATE_KEY_1}"
+      - "${ACCOUNT_PRIVATE_KEY_2}"
+      - "${ACCOUNT_PRIVATE_KEY_3}"
+
+paths:
+  contracts: "contracts"  # Path to your contracts directory
+
+environment: .env  # Path to your environment file containing private keys and other secrets
+```
+
+Key configuration sections:
+
+1. **Networks**: Define different network environments
+   - `default`: Specifies which network to use by default
+   - Network configurations can include:
+     - `url`: The RPC endpoint for the network
+     - `id`: Chain ID
+     - `accounts`: List of account private keys (using environment variables)
+   - Special case for `localnet`:
+     - If a network is named `localnet`, missing fields will be filled with default values
+     - For all other network names, `id`, `url`, and `accounts` are required fields
+
+2. **Paths**: Define important directory paths
+   - `contracts`: Location of your contract files
+
+3. **Environment**: Path to your `.env` file containing sensitive information like private keys
+
+If you don't provide a config file, the suite will use default values. You can override these settings using command-line arguments. For example:
+```bash
+# Override the default network
+gltest --network testnet_asimov
+
+# Override the contracts directory
+gltest --contracts-dir custom/contracts/path
+```
+
 ### Running Tests
 
 1. Run all tests:
@@ -126,17 +182,27 @@ $ gltest -v
 $ gltest --contracts-dir <path_to_contracts>
 ```
 
-6. Run tests with a custom RPC url
+6. Run tests on a specific network:
+```bash
+# Run tests on localnet (default)
+$ gltest --network localnet
+
+# Run tests on testnet
+$ gltest --network testnet_asimov
+```
+The `--network` flag allows you to specify which network configuration to use from your `gltest.config.yaml`. If not specified, it will use the `default` network defined in your config file.
+
+7. 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
+8. 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
+9. Run tests with a default wait retries for waiting transaction receipts
 ```bash
 $ gltest --default-wait-retries <default_wait_retries>
 ```
@@ -233,13 +299,14 @@ def test_deployment():
 Reading from the contract is straightforward:
 
 ```python
-from gltest import get_contract_factory, default_account
+from gltest import get_contract_factory
 
 def test_read_methods():
+
     # Get the contract factory and deploy the contract
     factory = get_contract_factory("Storage")
-    contract = factory.deploy(account=default_account)
-    
+    contract = factory.deploy()
+
     # Call a read-only method
     result = contract.get_value(args=[])
     

genlayer_test-0.2.0/PKG-INFO → genlayer_test-0.3.0/README.md

@@ -1,22 +1,3 @@
-Metadata-Version: 2.4
-Name: genlayer-test
-Version: 0.2.0
-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.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Topic :: Software Development :: Testing
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: pytest
-Requires-Dist: genlayer-py==0.3.0
-Dynamic: license-file
-
 # GenLayer Testing Suite
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/license/mit/)
@@ -41,13 +22,13 @@ pip install genlayer-test
 ### Basic Usage
 
 ```python
-from gltest import get_contract_factory, default_account, create_account
+from gltest import get_contract_factory, get_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
+assert contract.account == get_default_account()
 
 # Deploy a contract with other account
 other_account = create_account()
@@ -99,6 +80,58 @@ $ cd genlayer-testing-suite
 $ pip install -e .
 ```
 
+### Configuration
+
+The GenLayer Testing Suite can be configured using an optional but recommended `gltest.config.yaml` file in your project root. While not required, this file helps manage network configurations, contract paths, and environment settings in a centralized way, making it easier to maintain different environments and share configurations across team members.
+
+```yaml
+# gltest.config.yaml
+networks:
+  default: localnet  # Default network to use
+
+  localnet:  # Local development network configuration
+    url: "http://127.0.0.1:4000/api"
+
+  testnet_asimov:  # Test network configuration
+    id: 4221
+    url: "http://34.32.169.58:9151"
+    accounts:
+      - "${ACCOUNT_PRIVATE_KEY_1}"
+      - "${ACCOUNT_PRIVATE_KEY_2}"
+      - "${ACCOUNT_PRIVATE_KEY_3}"
+
+paths:
+  contracts: "contracts"  # Path to your contracts directory
+
+environment: .env  # Path to your environment file containing private keys and other secrets
+```
+
+Key configuration sections:
+
+1. **Networks**: Define different network environments
+   - `default`: Specifies which network to use by default
+   - Network configurations can include:
+     - `url`: The RPC endpoint for the network
+     - `id`: Chain ID
+     - `accounts`: List of account private keys (using environment variables)
+   - Special case for `localnet`:
+     - If a network is named `localnet`, missing fields will be filled with default values
+     - For all other network names, `id`, `url`, and `accounts` are required fields
+
+2. **Paths**: Define important directory paths
+   - `contracts`: Location of your contract files
+
+3. **Environment**: Path to your `.env` file containing sensitive information like private keys
+
+If you don't provide a config file, the suite will use default values. You can override these settings using command-line arguments. For example:
+```bash
+# Override the default network
+gltest --network testnet_asimov
+
+# Override the contracts directory
+gltest --contracts-dir custom/contracts/path
+```
+
 ### Running Tests
 
 1. Run all tests:
@@ -126,17 +159,27 @@ $ gltest -v
 $ gltest --contracts-dir <path_to_contracts>
 ```
 
-6. Run tests with a custom RPC url
+6. Run tests on a specific network:
+```bash
+# Run tests on localnet (default)
+$ gltest --network localnet
+
+# Run tests on testnet
+$ gltest --network testnet_asimov
+```
+The `--network` flag allows you to specify which network configuration to use from your `gltest.config.yaml`. If not specified, it will use the `default` network defined in your config file.
+
+7. 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
+8. 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
+9. Run tests with a default wait retries for waiting transaction receipts
 ```bash
 $ gltest --default-wait-retries <default_wait_retries>
 ```
@@ -233,13 +276,14 @@ def test_deployment():
 Reading from the contract is straightforward:
 
 ```python
-from gltest import get_contract_factory, default_account
+from gltest import get_contract_factory
 
 def test_read_methods():
+
     # Get the contract factory and deploy the contract
     factory = get_contract_factory("Storage")
-    contract = factory.deploy(account=default_account)
-    
+    contract = factory.deploy()
+
     # Call a read-only method
     result = contract.get_value(args=[])
     

genlayer_test-0.2.0/README.md → genlayer_test-0.3.0/genlayer_test.egg-info/PKG-INFO

@@ -1,3 +1,26 @@
+Metadata-Version: 2.4
+Name: genlayer-test
+Version: 0.3.0
+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.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pytest
+Requires-Dist: setuptools>=77.0
+Requires-Dist: genlayer-py==0.5.0
+Requires-Dist: colorama>=0.4.6
+Requires-Dist: pyyaml
+Requires-Dist: python-dotenv
+Dynamic: license-file
+
 # GenLayer Testing Suite
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/license/mit/)
@@ -22,13 +45,13 @@ pip install genlayer-test
 ### Basic Usage
 
 ```python
-from gltest import get_contract_factory, default_account, create_account
+from gltest import get_contract_factory, get_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
+assert contract.account == get_default_account()
 
 # Deploy a contract with other account
 other_account = create_account()
@@ -80,6 +103,58 @@ $ cd genlayer-testing-suite
 $ pip install -e .
 ```
 
+### Configuration
+
+The GenLayer Testing Suite can be configured using an optional but recommended `gltest.config.yaml` file in your project root. While not required, this file helps manage network configurations, contract paths, and environment settings in a centralized way, making it easier to maintain different environments and share configurations across team members.
+
+```yaml
+# gltest.config.yaml
+networks:
+  default: localnet  # Default network to use
+
+  localnet:  # Local development network configuration
+    url: "http://127.0.0.1:4000/api"
+
+  testnet_asimov:  # Test network configuration
+    id: 4221
+    url: "http://34.32.169.58:9151"
+    accounts:
+      - "${ACCOUNT_PRIVATE_KEY_1}"
+      - "${ACCOUNT_PRIVATE_KEY_2}"
+      - "${ACCOUNT_PRIVATE_KEY_3}"
+
+paths:
+  contracts: "contracts"  # Path to your contracts directory
+
+environment: .env  # Path to your environment file containing private keys and other secrets
+```
+
+Key configuration sections:
+
+1. **Networks**: Define different network environments
+   - `default`: Specifies which network to use by default
+   - Network configurations can include:
+     - `url`: The RPC endpoint for the network
+     - `id`: Chain ID
+     - `accounts`: List of account private keys (using environment variables)
+   - Special case for `localnet`:
+     - If a network is named `localnet`, missing fields will be filled with default values
+     - For all other network names, `id`, `url`, and `accounts` are required fields
+
+2. **Paths**: Define important directory paths
+   - `contracts`: Location of your contract files
+
+3. **Environment**: Path to your `.env` file containing sensitive information like private keys
+
+If you don't provide a config file, the suite will use default values. You can override these settings using command-line arguments. For example:
+```bash
+# Override the default network
+gltest --network testnet_asimov
+
+# Override the contracts directory
+gltest --contracts-dir custom/contracts/path
+```
+
 ### Running Tests
 
 1. Run all tests:
@@ -107,17 +182,27 @@ $ gltest -v
 $ gltest --contracts-dir <path_to_contracts>
 ```
 
-6. Run tests with a custom RPC url
+6. Run tests on a specific network:
+```bash
+# Run tests on localnet (default)
+$ gltest --network localnet
+
+# Run tests on testnet
+$ gltest --network testnet_asimov
+```
+The `--network` flag allows you to specify which network configuration to use from your `gltest.config.yaml`. If not specified, it will use the `default` network defined in your config file.
+
+7. 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
+8. 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
+9. Run tests with a default wait retries for waiting transaction receipts
 ```bash
 $ gltest --default-wait-retries <default_wait_retries>
 ```
@@ -214,13 +299,14 @@ def test_deployment():
 Reading from the contract is straightforward:
 
 ```python
-from gltest import get_contract_factory, default_account
+from gltest import get_contract_factory
 
 def test_read_methods():
+
     # Get the contract factory and deploy the contract
     factory = get_contract_factory("Storage")
-    contract = factory.deploy(account=default_account)
-    
+    contract = factory.deploy()
+
     # Call a read-only method
     result = contract.get_value(args=[])
     

{genlayer_test-0.2.0 → genlayer_test-0.3.0}/genlayer_test.egg-info/SOURCES.txt

@@ -10,8 +10,6 @@ genlayer_test.egg-info/top_level.txt
 gltest/__init__.py
 gltest/assertions.py
 gltest/exceptions.py
-gltest/plugin_config.py
-gltest/plugin_hooks.py
 gltest/types.py
 gltest/artifacts/__init__.py
 gltest/artifacts/contract.py
@@ -22,12 +20,16 @@ gltest/glchain/contract.py
 gltest/helpers/__init__.py
 gltest/helpers/fixture_snapshot.py
 gltest/helpers/take_snapshot.py
+gltest_cli/logging.py
 gltest_cli/main.py
-tests/artifact/test_contract_definition.py
-tests/artifact/contracts/duplicate_ic_contract_1.py
-tests/artifact/contracts/duplicate_ic_contract_2.py
-tests/artifact/contracts/not_ic_contract.py
-tests/assertions/test_assertions.py
+gltest_cli/config/__init__.py
+gltest_cli/config/constants.py
+gltest_cli/config/general.py
+gltest_cli/config/plugin.py
+gltest_cli/config/types.py
+gltest_cli/config/user.py
+tests/__init__.py
+tests/conftest.py
 tests/examples/contracts/football_prediction_market.py
 tests/examples/contracts/intelligent_oracle.py
 tests/examples/contracts/intelligent_oracle_factory.py
@@ -54,5 +56,13 @@ tests/examples/tests/test_storage.py
 tests/examples/tests/test_storage_legacy.py
 tests/examples/tests/test_user_storage.py
 tests/examples/tests/test_wizard_of_coin.py
-tests/plugin/conftest.py
-tests/plugin/test_plugin_hooks.py
+tests/gltest/__init__.py
+tests/gltest/artifact/__init__.py
+tests/gltest/artifact/test_contract_definition.py
+tests/gltest/artifact/contracts/duplicate_ic_contract_1.py
+tests/gltest/artifact/contracts/duplicate_ic_contract_2.py
+tests/gltest/artifact/contracts/not_ic_contract.py
+tests/gltest/assertions/test_assertions.py
+tests/gltest_cli/__init__.py
+tests/gltest_cli/config/test_plugin.py
+tests/gltest_cli/config/test_user.py

{genlayer_test-0.2.0 → genlayer_test-0.3.0}/genlayer_test.egg-info/entry_points.txt

@@ -2,4 +2,4 @@
 gltest = gltest_cli.main:main
 
 [pytest11]
-gltest = gltest.plugin_hooks
+gltest = gltest_cli.config.plugin

genlayer_test-0.3.0/genlayer_test.egg-info/requires.txt

@@ -0,0 +1,6 @@
+pytest
+setuptools>=77.0
+genlayer-py==0.5.0
+colorama>=0.4.6
+pyyaml
+python-dotenv

{genlayer_test-0.2.0 → genlayer_test-0.3.0}/gltest/__init__.py

@@ -3,8 +3,8 @@ from gltest.glchain import (
     create_accounts,
     get_contract_factory,
     get_gl_client,
-    default_account,
-    accounts,
+    get_accounts,
+    get_default_account,
 )
 
 __all__ = [
@@ -13,6 +13,6 @@ __all__ = [
     "create_accounts",
     "get_contract_factory",
     "get_gl_client",
-    "default_account",
-    "accounts",
+    "get_accounts",
+    "get_default_account",
 ]

{genlayer_test-0.2.0 → genlayer_test-0.3.0}/gltest/artifacts/contract.py

@@ -2,7 +2,7 @@ import ast
 from typing import Optional
 from dataclasses import dataclass
 from pathlib import Path
-from gltest.plugin_config import get_contracts_dir
+from gltest_cli.config.general import get_general_config
 import io
 import zipfile
 from typing import Union
@@ -21,9 +21,12 @@ 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."""
     matching_files = []
+    exclude_dirs = {".venv", "venv", "env", "build", "dist", "__pycache__", ".git"}
 
     for file_path in contracts_dir.rglob("*"):
-        if not file_path.suffix in [".gpy", ".py"]:
+        if any(exclude_dir in file_path.parts for exclude_dir in exclude_dirs):
+            continue
+        if file_path.suffix not in [".gpy", ".py"]:
             continue
         try:
             # Read the file content
@@ -142,7 +145,8 @@ def find_contract_definition_from_name(
     """
     Search in the contracts directory for a contract definition.
     """
-    contracts_dir = get_contracts_dir()
+    general_config = get_general_config()
+    contracts_dir = general_config.get_contracts_dir()
     if not contracts_dir.exists():
         raise FileNotFoundError(f"Contracts directory not found at: {contracts_dir}")
 
@@ -156,7 +160,8 @@ def find_contract_definition_from_path(
     """
     Create a ContractDefinition from a given file path relative to the contracts directory.
     """
-    contracts_dir = get_contracts_dir()
+    general_config = get_general_config()
+    contracts_dir = general_config.get_contracts_dir()
     if not contracts_dir.exists():
         raise FileNotFoundError(f"Contracts directory not found at: {contracts_dir}")
 

{genlayer_test-0.2.0 → genlayer_test-0.3.0}/gltest/glchain/__init__.py

@@ -1,6 +1,6 @@
 from .contract import Contract, ContractFactory, get_contract_factory
 from .client import get_gl_client, get_gl_provider
-from .account import create_accounts, create_account, accounts, default_account
+from .account import create_account, get_accounts, get_default_account, create_accounts
 
 
 __all__ = [
@@ -8,9 +8,9 @@ __all__ = [
     "ContractFactory",
     "get_contract_factory",
     "create_account",
-    "default_account",
-    "accounts",
     "create_accounts",
+    "get_accounts",
+    "get_default_account",
     "get_gl_client",
     "get_gl_provider",
 ]

genlayer_test-0.3.0/gltest/glchain/account.py

@@ -0,0 +1,22 @@
+from gltest_cli.config.general import get_general_config
+from genlayer_py import create_account
+from eth_account.signers.local import LocalAccount
+from typing import List
+
+
+def create_accounts(n_accounts: int):
+    return [create_account() for _ in range(n_accounts)]
+
+
+def get_accounts() -> List[LocalAccount]:
+    general_config = get_general_config()
+    selected_network = general_config.get_network_name()
+    accounts = general_config.get_accounts_keys(selected_network)
+    return [create_account(account) for account in accounts]
+
+
+def get_default_account() -> LocalAccount:
+    general_config = get_general_config()
+    selected_network = general_config.get_network_name()
+    default_account_key = general_config.get_default_account_key(selected_network)
+    return create_account(default_account_key)

genlayer_test-0.3.0/gltest/glchain/client.py

@@ -0,0 +1,59 @@
+from genlayer_py.chains import localnet
+from genlayer_py import create_client
+from .account import get_default_account
+from functools import lru_cache
+from gltest_cli.config.general import get_general_config
+
+
+@lru_cache(maxsize=1)
+def get_gl_client():
+    """
+    Get the GenLayer client instance.
+    """
+    general_config = get_general_config()
+    chain = general_config.get_chain()
+    default_account = get_default_account()
+    endpoint = general_config.get_rpc_url()
+    return create_client(
+        chain=chain,
+        account=default_account,
+        endpoint=endpoint,
+    )
+
+
+@lru_cache(maxsize=1)
+def get_gl_hosted_studio_client():
+    """
+    Get the GenLayer hosted studio client instance.
+
+    Note: This is a temporary solution to get contract schema.
+    TODO: Remove this once we have a proper way to get contract schema from testnet.
+    """
+    return create_client(
+        chain=localnet,
+        account=get_default_account(),
+        endpoint="https://studio.genlayer.com/api",
+    )
+
+
+@lru_cache(maxsize=1)
+def get_local_client():
+    """
+    Get the GenLayer local client instance.
+
+    Note: This is a temporary solution to get contract schema.
+    TODO: Remove this once we have a proper way to get contract schema from testnet.
+    """
+    return create_client(
+        chain=localnet,
+        account=get_default_account(),
+        endpoint="http://127.0.0.1:4000/api",
+    )
+
+
+def get_gl_provider():
+    """
+    Get the GenLayer provider instance.
+    """
+    client = get_gl_client()
+    return client.provider