mech-client 0.8.1__tar.gz → 0.8.2__tar.gz

{mech_client-0.8.1 → mech_client-0.8.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mech-client
-Version: 0.8.1
+Version: 0.8.2
 Summary: Basic client to interact with a mech
 License: Apache-2.0
 Author: David Minarsch

mech_client-0.8.2/mech_client/__init__.py

@@ -0,0 +1,3 @@
+"""Mech client."""
+
+__version__ = "0.8.2"

{mech_client-0.8.1 → mech_client-0.8.2}/pyproject.toml

@@ -1,10 +1,10 @@
 [tool.poetry]
 name = "mech-client"
-version = "0.8.1"
+version = "0.8.2"
 description = "Basic client to interact with a mech"
 authors = ["David Minarsch <david.minarsch@googlemail.com>"]
 readme = "README.md"
-packages = [{include = "mech_client"}]
+packages = [{include = "mech_client"}, {include = "scripts"}]
 license = "Apache-2.0"
 include = [
     "mech_client/helpers/acn/*",

mech_client-0.8.2/scripts/__init__.py

@@ -0,0 +1 @@
+"""Mech client scripts"""

mech_client-0.8.2/scripts/benchmark.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+export MANUAL_GAS_LIMIT=150000
+export WEBSOCKET_ENDPOINT=wss://rpc.eu-central-2.gateway.fm/ws/v4/gnosis/non-archival/mainnet
+iterations=2
+
+mechx --version
+
+echo $WEBSOCKET_ENDPOINT
+
+start_time=$(date +%s.%N)
+
+# Execute the command for the specified number of iterations
+for ((i=1; i<=$iterations; i++)); do
+    echo "- Iteration $i"
+
+    prompt="($i) Will arsenal win the Premier League in 2024"
+    mechx interact "$prompt" 6 --tool prediction-offline --confirm on-chain --extra-attribute key1=value1 --extra-attribute key2=value2
+
+    if [ $? -ne 0 ]; then
+        echo "Error: Command execution failed."
+        exit 1
+    fi
+
+    echo ""
+done
+
+end_time=$(date +%s.%N)
+elapsed_time=$(echo "$end_time - $start_time" | bc)
+seconds_per_iteration=$(echo "$elapsed_time / $iterations" | bc)
+
+echo "Overall execution time for $iterations iterations: $elapsed_time seconds (rate of $seconds_per_iteration seconds/iteration)."

mech_client-0.8.2/scripts/bump.py

@@ -0,0 +1,316 @@
+# -*- coding: utf-8 -*-
+# ------------------------------------------------------------------------------
+#
+#   Copyright 2023 Valory AG
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+# ------------------------------------------------------------------------------
+
+"""
+Script for bumping core dependencies.
+
+This script
+
+- Fetches the latest core dependency versions from github
+- Updates the tox.ini, packages and Pipfile/pyproject.toml files
+- Performs the packages sync
+"""
+
+import os
+import re
+import typing as t
+from pathlib import Path
+
+import click
+import requests
+from aea.cli.utils.click_utils import PackagesSource, PyPiDependency
+from aea.configurations.constants import PACKAGES, PACKAGE_TYPE_TO_CONFIG_FILE
+from aea.configurations.data_types import Dependency
+from aea.helpers.logging import setup_logger
+from aea.helpers.yaml_utils import yaml_dump, yaml_dump_all, yaml_load, yaml_load_all
+from aea.package_manager.v1 import PackageManagerV1
+
+from autonomy.cli.helpers.ipfs_hash import load_configuration
+
+
+BUMP_BRANCH = "chore/bump"
+PIPFILE = Path.cwd() / "Pipfile"
+PYPROJECT_TOML = Path.cwd() / "pyproject.toml"
+TOX_INI = Path.cwd() / "tox.ini"
+
+TAGS_URL = "https://api.github.com/repos/{repo}/tags"
+FILE_URL = "https://raw.githubusercontent.com/{repo}/{tag}/{file}"
+
+VERISON_RE = re.compile(r"(__version__|version)( )?=( )?\"(?P<version>[0-9a-z\.]+)\"")
+
+OPEN_AEA_REPO = "valory-xyz/open-aea"
+OPEN_AUTONOMY_REPO = "valory-xyz/open-autonomy"
+
+DEPENDENCY_SPECS = {
+    "open-aea": {
+        "repo": OPEN_AEA_REPO,
+        "file": "aea/__version__.py",
+    },
+    "open-aea-ledger-ethereum": {
+        "repo": OPEN_AEA_REPO,
+        "file": "plugins/aea-ledger-ethereum/setup.py",
+    },
+    "open-aea-ledger-ethereum-flashbots": {
+        "repo": OPEN_AEA_REPO,
+        "file": "plugins/aea-ledger-ethereum-flashbots/setup.py",
+    },
+    "open-aea-ledger-ethereum-hwi": {
+        "repo": OPEN_AEA_REPO,
+        "file": "plugins/aea-ledger-ethereum-hwi/setup.py",
+    },
+    "open-aea-ledger-cosmos": {
+        "repo": OPEN_AEA_REPO,
+        "file": "plugins/aea-ledger-cosmos/setup.py",
+    },
+    "open-aea-ledger-solana": {
+        "repo": OPEN_AEA_REPO,
+        "file": "plugins/aea-ledger-solana/setup.py",
+    },
+    "open-aea-cli-ipfs": {
+        "repo": OPEN_AEA_REPO,
+        "file": "plugins/aea-cli-ipfs/setup.py",
+    },
+    "open-autonomy": {
+        "repo": OPEN_AUTONOMY_REPO,
+        "file": "autonomy/__version__.py",
+    },
+    "open-aea-test-autonomy": {
+        "repo": OPEN_AUTONOMY_REPO,
+        "file": "plugins/aea-test-autonomy/setup.py",
+    },
+}
+
+_cache_file = Path.home() / ".aea" / ".gitcache"
+_version_cache = {}
+_logger = setup_logger("bump")
+
+
+def load_git_cache() -> None:
+    """Load versions cache."""
+    if not _cache_file.exists():
+        return
+    with _cache_file.open("r", encoding="utf-8") as stream:
+        _version_cache.update(yaml_load(stream=stream))
+
+
+def dump_git_cache() -> None:
+    """Dump versions cache."""
+    with _cache_file.open("w", encoding="utf-8") as stream:
+        yaml_dump(data=_version_cache, stream=stream)
+
+
+def make_git_request(url: str) -> requests.Response:
+    """Make git request"""
+    auth = os.environ.get("GITHUB_AUTH")
+    if auth is None:
+        return requests.get(url=url)
+    return requests.get(url=url, headers={"Authorization": f"Bearer {auth}"})
+
+
+def get_latest_tag(repo: str) -> str:
+    """Fetch latest git tag."""
+    if repo in _version_cache:
+        return _version_cache[repo]
+
+    response = make_git_request(url=TAGS_URL.format(repo=repo))
+    if response.status_code != 200:
+        raise ValueError(
+            f"Fetching tags from `{repo}` failed with message '"
+            + response.json()["message"]
+            + "'"
+        )
+    latest_tag_data, *_ = response.json()
+    _version_cache[repo] = latest_tag_data["name"]
+    return _version_cache[repo]
+
+
+def get_dependency_version(repo: str, file: str) -> str:
+    """Get version spec ."""
+    response = make_git_request(
+        FILE_URL.format(
+            repo=repo,
+            tag=get_latest_tag(repo=repo),
+            file=file,
+        )
+    )
+    if response.status_code != 200:
+        raise ValueError(
+            f"Fetching packages from `{repo}` failed with message '"
+            + response.text
+            + "'"
+        )
+    ((*_, version),) = VERISON_RE.findall(response.content.decode())
+    return f"=={version}"
+
+
+def get_dependencies() -> t.Dict:
+    """Get dependency->version mapping."""
+    dependencies = {}
+    for dependency, specs in DEPENDENCY_SPECS.items():
+        version = _version_cache.get(
+            dependency,
+            get_dependency_version(
+                repo=specs["repo"],
+                file=specs["file"],
+            ),
+        )
+        dependencies[dependency] = version
+    _version_cache.update(dependencies)
+    return dependencies
+
+
+def bump_pipfile_or_pyproject(file: Path, dependencies: t.Dict[str, str]) -> None:
+    """Bump Pipfile."""
+    if not file.exists():
+        return
+
+    _logger.info(f"Updating {file.name}")
+    updated = ""
+    content = file.read_text(encoding="utf-8")
+    for line in content.split("\n"):
+        try:
+            spec = Dependency.from_pipfile_string(line)
+            update = dependencies.get(spec.name)
+            if update is None:
+                updated += line + "\n"
+                continue
+            spec = Dependency(
+                name=spec.name,
+                version=update,
+                extras=spec.extras,
+            )
+            updated += spec.to_pipfile_string() + "\n"
+        except ValueError:
+            updated += line + "\n"
+    file.write_text(updated[:-1], encoding="utf-8")
+
+
+def bump_tox(dependencies: t.Dict[str, str]) -> None:
+    """Bump tox file."""
+    if not TOX_INI.exists():
+        return
+
+    _logger.info("Updating tox.ini")
+    updated = ""
+    content = TOX_INI.read_text(encoding="utf-8")
+    for line in content.split("\n"):
+        try:
+            spec = Dependency.from_string(line.lstrip().rstrip())
+            update = dependencies.get(spec.name)
+            if update is None:
+                updated += line + "\n"
+                continue
+            spec = Dependency(
+                name=spec.name,
+                version=update,
+                extras=spec.extras,
+            )
+            updated += "    " + spec.to_pip_string() + "\n"
+        except ValueError:
+            updated += line + "\n"
+    TOX_INI.write_text(updated[:-1], encoding="utf-8")
+
+
+def bump_packages(dependencies: t.Dict[str, str]) -> None:
+    """Bump packages."""
+    _logger.info("Updating packages")
+    manager = PackageManagerV1.from_dir(Path(PACKAGES))
+    for package_id in manager.dev_packages:
+        path = (
+            manager.package_path_from_package_id(
+                package_id=package_id,
+            )
+            / PACKAGE_TYPE_TO_CONFIG_FILE[package_id.package_type.value]
+        )
+        with path.open("r", encoding="utf-8") as stream:
+            config, *extra = yaml_load_all(stream=stream)
+
+        for name in config.get("dependencies", {}):
+            update = dependencies.get(name)
+            if update is None:
+                continue
+            config["dependencies"][name]["version"] = update
+
+        with path.open("w", encoding="utf-8") as stream:
+            yaml_dump_all([config, *extra], stream=stream)
+
+
+@click.command(name="bump")
+@click.option(
+    "-d",
+    "--dependency",
+    "extra",
+    type=PyPiDependency(),
+    multiple=True,
+    help="Specify extra dependency.",
+)
+@click.option(
+    "-s",
+    "--source",
+    "sources",
+    type=PackagesSource(),
+    multiple=True,
+    help="Specify extra sources.",
+)
+@click.option("--sync", is_flag=True, help="Perform sync.")
+@click.option(
+    "--no-cache",
+    is_flag=True,
+    default=False,
+    help="Avoid using cache to bump.",
+)
+def main(
+    extra: t.Tuple[Dependency, ...],
+    sources: t.Tuple[str, ...],
+    sync: bool,
+    no_cache: bool,
+) -> None:
+    """Run the bump script."""
+
+    if not no_cache:
+        load_git_cache()
+
+    dependencies = {}
+    dependencies.update(get_dependencies())
+    dependencies.update({dep.name: dep.version for dep in extra or []})
+
+    bump_pipfile_or_pyproject(PIPFILE, dependencies=dependencies)
+    bump_pipfile_or_pyproject(PYPROJECT_TOML, dependencies=dependencies)
+    bump_tox(dependencies=dependencies)
+    bump_packages(dependencies=dependencies)
+    dump_git_cache()
+
+    if sync:
+        pm = PackageManagerV1.from_dir(
+            Path.cwd() / PACKAGES, config_loader=load_configuration
+        )
+        pm.sync(
+            sources=[
+                f"{OPEN_AEA_REPO}:{_version_cache[OPEN_AEA_REPO]}",
+                f"{OPEN_AUTONOMY_REPO}:{_version_cache[OPEN_AUTONOMY_REPO]}",
+                *sources,
+            ],
+            update_packages=True,
+        )
+        pm.update_package_hashes()
+        pm.dump()
+
+
+if __name__ == "__main__":
+    main()  # pylint: disable=no-value-for-parameter

mech_client-0.8.2/scripts/deposit_native.py

@@ -0,0 +1,118 @@
+# -*- coding: utf-8 -*-
+# ------------------------------------------------------------------------------
+#
+#   Copyright 2025 Valory AG
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+# ------------------------------------------------------------------------------
+
+
+import sys
+from pathlib import Path
+from typing import Optional
+from aea_ledger_ethereum import EthereumApi, EthereumCrypto
+from dataclasses import asdict
+
+from mech_client.interact import get_mech_config, PRIVATE_KEY_FILE_PATH
+from .utils import (
+    print_title,
+    CHAIN_TO_NATIVE_BALANCE_TRACKER,
+)
+from mech_client.wss import wait_for_receipt
+
+
+def deposit(
+    ledger_api: EthereumApi,
+    crypto: EthereumCrypto,
+    to: str,
+    amount: int,
+) -> str:
+    sender = crypto.address
+
+    try:
+        print("Fetching user balance")
+        user_balance = ledger_api.get_balance(address=sender)
+        if user_balance < amount:
+            formatted_user_balance = user_balance / 1e18
+            formatted_amount = amount / 1e18
+            print("User balance low!!")
+            print(f"Balance: {formatted_user_balance}")
+            print(f"Want to Deposit: {formatted_amount}")
+            sys.exit(1)
+    except Exception as e:
+        print(f"Error occured while fetching user balance: {e}")
+        return str(e)
+
+    try:
+        print("Sending deposit tx")
+        raw_transaction = ledger_api.get_transfer_transaction(
+            sender_address=sender,
+            destination_address=to,
+            amount=amount,
+            tx_fee=50000,
+            tx_nonce="0x",
+        )
+        signed_transaction = crypto.sign_transaction(raw_transaction)
+        transaction_digest = ledger_api.send_signed_transaction(
+            signed_transaction,
+            raise_on_try=True,
+        )
+        return transaction_digest
+    except Exception as e:  # pylint: disable=broad-except
+        print(f"Error occured while sending the transaction: {e}")
+        return str(e)
+
+
+def main(
+    amount: str,
+    private_key_path: Optional[str] = None,
+    chain_config: Optional[str] = None,
+) -> None:
+    """Runs the deposit functionality for the native mech type"""
+    print_title("Native Deposit")
+    print("This script will assist you in depositing native balance for mech requests.")
+    print()
+
+    amount_to_deposit = int(float(amount) * 10**18)
+    private_key_path = private_key_path or PRIVATE_KEY_FILE_PATH
+
+    mech_config = get_mech_config(chain_config)
+    ledger_config = mech_config.ledger_config
+    ledger_api = EthereumApi(**asdict(ledger_config))
+
+    if not Path(private_key_path).exists():
+        raise FileNotFoundError(
+            f"Private key file `{private_key_path}` does not exist!"
+        )
+    crypto = EthereumCrypto(private_key_path=private_key_path)
+
+    print(f"Sender address: {crypto.address}")
+
+    chain_id = mech_config.ledger_config.chain_id
+    to = CHAIN_TO_NATIVE_BALANCE_TRACKER[chain_id]
+
+    deposit_tx = deposit(ledger_api, crypto, to, amount_to_deposit)
+    if not deposit_tx:
+        print("Unable to deposit")
+        sys.exit(1)
+
+    transaction_url_formatted = mech_config.transaction_url.format(
+        transaction_digest=deposit_tx
+    )
+    print(f" - Transaction sent: {transaction_url_formatted}")
+    print(" - Waiting for transaction receipt...")
+    wait_for_receipt(deposit_tx, ledger_api)
+
+    print("")
+    print("Deposit Successful")

mech_client-0.8.2/scripts/deposit_token.py

@@ -0,0 +1,187 @@
+# -*- coding: utf-8 -*-
+# ------------------------------------------------------------------------------
+#
+#   Copyright 2025 Valory AG
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+# ------------------------------------------------------------------------------
+
+
+import sys
+from pathlib import Path
+from typing import Optional
+from aea_ledger_ethereum import EthereumApi, EthereumCrypto
+from dataclasses import asdict
+from web3.contract import Contract as Web3Contract
+
+
+from mech_client.interact import (
+    get_mech_config,
+    PRIVATE_KEY_FILE_PATH,
+)
+from .utils import (
+    print_title,
+    get_token_contract,
+    get_token_balance_tracker_contract,
+)
+from mech_client.wss import wait_for_receipt
+
+
+def check_token_balance(token_contract: Web3Contract, sender: str, amount: int) -> None:
+    try:
+        print("Fetching user balance")
+        user_token_balance = token_contract.functions.balanceOf(sender).call()
+        if user_token_balance < amount:
+            formatted_user_balance = user_token_balance / 1e18
+            formatted_amount = amount / 1e18
+            print("User balance low!!")
+            print(f"Balance: {formatted_user_balance}")
+            print(f"Want to Deposit: {formatted_amount}")
+            sys.exit(1)
+    except Exception as e:
+        print(f"Error occured while fetching user balance: {e}")
+
+
+def approve(
+    crypto: EthereumCrypto,
+    ledger_api: EthereumApi,
+    token_contract: Web3Contract,
+    token_balance_tracker_contract: Web3Contract,
+    amount: int,
+) -> str:
+    sender = crypto.address
+
+    print("Sending approve tx")
+    try:
+        tx_args = {"sender_address": sender, "value": 0, "gas": 60000}
+        raw_transaction = ledger_api.build_transaction(
+            contract_instance=token_contract,
+            method_name="approve",
+            method_args={
+                "_to": token_balance_tracker_contract.address,
+                "_value": amount,
+            },
+            tx_args=tx_args,
+            raise_on_try=True,
+        )
+        signed_transaction = crypto.sign_transaction(raw_transaction)
+        transaction_digest = ledger_api.send_signed_transaction(
+            signed_transaction,
+            raise_on_try=True,
+        )
+        return transaction_digest
+    except Exception as e:  # pylint: disable=broad-except
+        print(f"Error occured while sending the transaction: {e}")
+        return str(e)
+
+
+def deposit(
+    ledger_api: EthereumApi,
+    crypto: EthereumCrypto,
+    token_balance_tracker_contract: Web3Contract,
+    amount: int,
+) -> str:
+    sender = crypto.address
+
+    print("Sending deposit tx")
+    try:
+        tx_args = {"sender_address": sender, "value": 0, "gas": 100000}
+        raw_transaction = ledger_api.build_transaction(
+            contract_instance=token_balance_tracker_contract,
+            method_name="deposit",
+            method_args={"amount": amount},
+            tx_args=tx_args,
+            raise_on_try=True,
+        )
+        signed_transaction = crypto.sign_transaction(raw_transaction)
+        transaction_digest = ledger_api.send_signed_transaction(
+            signed_transaction,
+            raise_on_try=True,
+        )
+        return transaction_digest
+    except Exception as e:  # pylint: disable=broad-except
+        print(f"Error occured while sending the transaction: {e}")
+        return str(e)
+
+
+def main(
+    amount: str,
+    private_key_path: Optional[str] = None,
+    chain_config: Optional[str] = None,
+) -> None:
+    """Runs the deposit functionality for the token mech type"""
+    print_title("Token Deposit")
+    print("This script will assist you in depositing token balance for mech requests.")
+    print()
+
+    amount_to_deposit = int(float(amount) * 10**18)
+    private_key_path = private_key_path or PRIVATE_KEY_FILE_PATH
+
+    mech_config = get_mech_config(chain_config)
+    ledger_config = mech_config.ledger_config
+    ledger_api = EthereumApi(**asdict(ledger_config))
+
+    if not Path(private_key_path).exists():
+        raise FileNotFoundError(
+            f"Private key file `{private_key_path}` does not exist!"
+        )
+    crypto = EthereumCrypto(private_key_path=private_key_path)
+
+    print(f"Sender address: {crypto.address}")
+
+    chain_id = mech_config.ledger_config.chain_id
+    token_balance_tracker_contract = get_token_balance_tracker_contract(
+        ledger_api, chain_id
+    )
+    token_contract = get_token_contract(ledger_api, chain_id)
+
+    check_token_balance(token_contract, crypto.address, amount_to_deposit)
+
+    approve_tx = approve(
+        crypto,
+        ledger_api,
+        token_contract,
+        token_balance_tracker_contract,
+        amount_to_deposit,
+    )
+    if not approve_tx:
+        print("Unable to approve")
+        sys.exit(1)
+
+    transaction_url_formatted = mech_config.transaction_url.format(
+        transaction_digest=approve_tx
+    )
+    print(f" - Transaction sent: {transaction_url_formatted}")
+    print(" - Waiting for transaction receipt...")
+    wait_for_receipt(approve_tx, ledger_api)
+
+    deposit_tx = deposit(
+        ledger_api,
+        crypto,
+        token_balance_tracker_contract,
+        amount_to_deposit,
+    )
+    if not deposit_tx:
+        print("Unable to deposit")
+        sys.exit(1)
+
+    transaction_url_formatted = mech_config.transaction_url.format(
+        transaction_digest=deposit_tx
+    )
+    print(f" - Transaction sent: {transaction_url_formatted}")
+    print(" - Waiting for transaction receipt...")
+    wait_for_receipt(deposit_tx, ledger_api)
+
+    print("")
+    print("Deposit Successful")