mech-client 0.2.10__py3-none-any.whl → 0.2.12__py3-none-any.whl

mech_client/__init__.py

@@ -1,3 +1,3 @@
 """Mech client."""
 
-__version__ = "0.2.10"
+__version__ = "0.2.12"

mech_client/acn.py

@@ -19,7 +19,6 @@
 
 """ACN helpers."""
 
-import asyncio
 from pathlib import Path
 from typing import Optional, Type, cast
 
@@ -171,19 +170,3 @@ async def watch_for_data_url_from_mech(crypto: Crypto) -> Optional[str]:
         return None
     finally:
         await connection.disconnect()
-
-
-def watch_for_data_url_from_mech_sync(crypto: Crypto) -> Optional[str]:
-    """
-    Request and wait for data from agent
-
-    :param crypto: instance of Crypto
-    :type crypto: Crypto
-    :return: Data URL
-    :rtype: str
-    :raises: None
-    """
-    loop = asyncio.new_event_loop()
-    task = loop.create_task(watch_for_data_url_from_mech(crypto=crypto))
-    loop.run_until_complete(task)
-    return task.result()

mech_client/cli.py

@@ -19,7 +19,7 @@
 
 """Mech client CLI module."""
 
-from typing import Optional
+from typing import Any, Dict, List, Optional
 
 import click
 
@@ -40,15 +40,22 @@ def cli() -> None:
 @click.command()
 @click.argument("prompt")
 @click.argument("agent_id", type=int)
+@click.option(
+    "--key",
+    type=click.Path(exists=True, file_okay=True, dir_okay=False),
+    help="Path to private key to use for request minting",
+)
 @click.option(
     "--tool",
     type=str,
     help="Name of the tool to be used",
 )
 @click.option(
-    "--key",
-    type=click.Path(exists=True, file_okay=True, dir_okay=False),
-    help="Path to private key to use for request minting",
+    "--extra-attribute",
+    type=str,
+    multiple=True,
+    help="Extra attribute (key=value) to be included in the request metadata",
+    metavar="KEY=VALUE",
 )
 @click.option(
     "--confirm",
@@ -72,23 +79,37 @@ def cli() -> None:
     type=float,
     help="Amount of sleep before retrying the transaction",
 )
+@click.option(
+    "--chain-config",
+    type=str,
+    help="Id of the mech's chain configuration (stored configs/mechs.json)",
+)
 def interact(  # pylint: disable=too-many-arguments
     prompt: str,
     agent_id: int,
-    tool: Optional[str],
     key: Optional[str],
+    tool: Optional[str],
+    extra_attribute: Optional[List[str]] = None,
     confirm: Optional[str] = None,
     retries: Optional[int] = None,
     timeout: Optional[float] = None,
     sleep: Optional[float] = None,
+    chain_config: Optional[str] = None,
 ) -> None:
     """Interact with a mech specifying a prompt and tool."""
     try:
+        extra_attributes_dict: Dict[str, Any] = {}
+        if extra_attribute:
+            for pair in extra_attribute:
+                k, v = pair.split("=")
+                extra_attributes_dict[k] = v
+
         interact_(
             prompt=prompt,
             agent_id=agent_id,
             private_key_path=key,
             tool=tool,
+            extra_attributes=extra_attributes_dict,
             confirmation_type=(
                 ConfirmationType(confirm)
                 if confirm is not None
@@ -97,6 +118,7 @@ def interact(  # pylint: disable=too-many-arguments
             retries=retries,
             timeout=timeout,
             sleep=sleep,
+            chain_config=chain_config,
         )
     except (ValueError, FileNotFoundError) as e:
         raise click.ClickException(str(e)) from e

mech_client/configs/mechs.json

@@ -0,0 +1,92 @@
+{
+    "gnosis": {
+        "agent_registry_contract": "0xE49CB081e8d96920C38aA7AB90cb0294ab4Bc8EA",
+        "rpc_url": "https://rpc.eu-central-2.gateway.fm/v4/gnosis/non-archival/mainnet",
+        "wss_endpoint": "wss://rpc.eu-central-2.gateway.fm/ws/v4/gnosis/non-archival/mainnet",
+        "ledger_config": {
+            "address": "https://rpc.eu-central-2.gateway.fm/v4/gnosis/non-archival/mainnet",
+            "chain_id": 100,
+            "poa_chain": false,
+            "default_gas_price_strategy": "eip1559",
+            "is_gas_estimation_enabled": false
+        },
+        "gas_limit": 100000,
+        "contract_abi_url": "https://gnosis.blockscout.com/api/v2/smart-contracts/{contract_address}",
+        "subgraph_url": "https://api.studio.thegraph.com/query/57238/mech/version/latest"
+    },
+    "arbitrum": {
+        "agent_registry_contract": "0xa4799B083E0068732456EF45ff9fe5c683658327",
+        "rpc_url": "https://arbitrum.llamarpc.com",
+        "wss_endpoint": "wss://arbitrum.gateway.tenderly.co",
+        "ledger_config": {
+            "address": "https://arbitrum.llamarpc.com",
+            "chain_id": 42161,
+            "poa_chain": false,
+            "default_gas_price_strategy": "eip1559",
+            "is_gas_estimation_enabled": false
+        },
+        "gas_limit": 100000,
+        "contract_abi_url": "https://api.arbiscan.io/api?module=contract&action=getabi&address={contract_address}",
+        "subgraph_url": ""
+    },
+    "polygon": {
+        "agent_registry_contract": "0x984cf72FDe8B5aA910e9e508aC5e007ae5BDcC9C",
+        "rpc_url": "https://polygon-bor-rpc.publicnode.com",
+        "wss_endpoint": "wss://polygon.gateway.tenderly.co",
+        "ledger_config": {
+            "address": "https://polygon-bor-rpc.publicnode.com",
+            "chain_id": 137,
+            "poa_chain": true,
+            "default_gas_price_strategy": "eip1559",
+            "is_gas_estimation_enabled": false
+        },
+        "gas_limit": 100000,
+        "contract_abi_url": "https://api.polygonscan.com/api?module=contract&action=getabi&address={contract_address}",
+        "subgraph_url": ""
+    },
+    "base": {
+        "agent_registry_contract": "0x88DE734655184a09B70700aE4F72364d1ad23728",
+        "rpc_url": "https://base.llamarpc.com",
+        "wss_endpoint": "wss://base.gateway.tenderly.co",
+        "ledger_config": {
+            "address": "https://base.llamarpc.com",
+            "chain_id": 8453,
+            "poa_chain": false,
+            "default_gas_price_strategy": "eip1559",
+            "is_gas_estimation_enabled": false
+        },
+        "gas_limit": 100000,
+        "contract_abi_url": "https://api.basescan.org/api?module=contract&action=getabi&address={contract_address}",
+        "subgraph_url": ""
+    },
+    "celo": {
+        "agent_registry_contract": "0xE49CB081e8d96920C38aA7AB90cb0294ab4Bc8EA",
+        "rpc_url": "https://forno.celo.org",
+        "wss_endpoint": "wss://forno.celo.org/ws",
+        "ledger_config": {
+            "address": "https://forno.celo.org",
+            "chain_id": 42220,
+            "poa_chain": false,
+            "default_gas_price_strategy": "eip1559",
+            "is_gas_estimation_enabled": false
+        },
+        "gas_limit": 100000,
+        "contract_abi_url": "https://api.celoscan.io/api?module=contract&action=getabi&address={contract_address}",
+        "subgraph_url": ""
+    },
+    "optimism": {
+        "agent_registry_contract": "0x75D529FAe220bC8db714F0202193726b46881B76",
+        "rpc_url": "https://mainnet.optimism.io",
+        "wss_endpoint": "wss://optimism.gateway.tenderly.co",
+        "ledger_config": {
+            "address": "https://mainnet.optimism.io",
+            "chain_id": 10,
+            "poa_chain": false,
+            "default_gas_price_strategy": "eip1559",
+            "is_gas_estimation_enabled": false
+        },
+        "gas_limit": 100000,
+        "contract_abi_url": "https://api-optimistic.etherscan.io/api?module=contract&action=getabi&address={contract_address}",
+        "subgraph_url": ""
+    }
+}

mech_client/interact.py

@@ -26,9 +26,12 @@ python client.py <prompt> <tool>
 """
 
 import asyncio
+import json
 import os
+import sys
 import time
 import warnings
+from dataclasses import asdict, dataclass
 from datetime import datetime
 from enum import Enum
 from pathlib import Path
@@ -41,47 +44,18 @@ from aea_ledger_ethereum import EthereumApi, EthereumCrypto
 from web3 import Web3
 from web3.contract import Contract as Web3Contract
 
-from mech_client.acn import (
-    watch_for_data_url_from_mech,
-    watch_for_data_url_from_mech_sync,
-)
+from mech_client.acn import watch_for_data_url_from_mech
 from mech_client.prompt_to_ipfs import push_metadata_to_ipfs
-from mech_client.subgraph import query_agent_address
+from mech_client.subgraph import query_agent_address, watch_for_data_url_from_subgraph
 from mech_client.wss import (
     register_event_handlers,
     watch_for_data_url_from_wss,
-    watch_for_data_url_from_wss_sync,
     watch_for_request_id,
 )
 
 
-AGENT_REGISTRY_CONTRACT = "0xE49CB081e8d96920C38aA7AB90cb0294ab4Bc8EA"
-MECHX_CHAIN_RPC = os.environ.get(
-    "MECHX_CHAIN_RPC",
-    "https://rpc.eu-central-2.gateway.fm/v4/gnosis/non-archival/mainnet",
-)
-LEDGER_CONFIG = {
-    "address": MECHX_CHAIN_RPC,
-    "chain_id": 100,
-    "poa_chain": False,
-    "default_gas_price_strategy": "eip1559",
-    "is_gas_estimation_enabled": False,
-}
 PRIVATE_KEY_FILE_PATH = "ethereum_private_key.txt"
-
-WSS_ENDPOINT = os.getenv(
-    "WEBSOCKET_ENDPOINT",
-    "wss://rpc.eu-central-2.gateway.fm/ws/v4/gnosis/non-archival/mainnet",
-)
-MANUAL_GAS_LIMIT = int(
-    os.getenv(
-        "MANUAL_GAS_LIMIT",
-        "100_000",
-    )
-)
-BLOCKSCOUT_API_URL = (
-    "https://gnosis.blockscout.com/api/v2/smart-contracts/{contract_address}"
-)
+MECH_CONFIGS = Path(__file__).parent / "configs" / "mechs.json"
 
 MAX_RETRIES = 3
 WAIT_SLEEP = 3.0
@@ -91,6 +65,80 @@ TIMEOUT = 60.0
 warnings.filterwarnings("ignore", "The log with transaction hash.*")
 
 
+@dataclass
+class LedgerConfig:
+    """Ledger configuration"""
+
+    address: str
+    chain_id: int
+    poa_chain: bool
+    default_gas_price_strategy: str
+    is_gas_estimation_enabled: bool
+
+    def __post_init__(self) -> None:
+        """Post initialization to override with environment variables."""
+        address = os.getenv("MECHX_LEDGER_ADDRESS")
+        if address:
+            self.address = address
+
+        chain_id = os.getenv("MECHX_LEDGER_CHAIN_ID")
+        if chain_id:
+            self.chain_id = int(chain_id)
+
+        poa_chain = os.getenv("MECHX_LEDGER_POA_CHAIN")
+        if poa_chain:
+            self.poa_chain = bool(poa_chain)
+
+        default_gas_price_strategy = os.getenv(
+            "MECHX_LEDGER_DEFAULT_GAS_PRICE_STRATEGY"
+        )
+        if default_gas_price_strategy:
+            self.default_gas_price_strategy = default_gas_price_strategy
+
+        is_gas_estimation_enabled = os.getenv("MECHX_LEDGER_IS_GAS_ESTIMATION_ENABLED")
+        if is_gas_estimation_enabled:
+            self.is_gas_estimation_enabled = bool(is_gas_estimation_enabled)
+
+
+@dataclass
+class MechConfig:
+    """Mech configuration"""
+
+    agent_registry_contract: str
+    rpc_url: str
+    wss_endpoint: str
+    ledger_config: LedgerConfig
+    gas_limit: int
+    contract_abi_url: str
+    subgraph_url: str
+
+    def __post_init__(self) -> None:
+        """Post initialization to override with environment variables."""
+        agent_registry_contract = os.getenv("MECHX_AGENT_REGISTRY_CONTRACT")
+        if agent_registry_contract:
+            self.agent_registry_contract = agent_registry_contract
+
+        rpc_url = os.getenv("MECHX_CHAIN_RPC")
+        if rpc_url:
+            self.rpc_url = rpc_url
+
+        wss_endpoint = os.getenv("MECHX_WSS_ENDPOINT")
+        if wss_endpoint:
+            self.wss_endpoint = wss_endpoint
+
+        gas_limit = os.getenv("MECHX_GAS_LIMIT")
+        if gas_limit:
+            self.gas_limit = int(gas_limit)
+
+        contract_abi_url = os.getenv("MECHX_CONTRACT_ABI_URL")
+        if contract_abi_url:
+            self.contract_abi_url = contract_abi_url
+
+        subgraph_url = os.getenv("MECHX_SUBGRAPH_URL")
+        if subgraph_url:
+            self.subgraph_url = subgraph_url
+
+
 class ConfirmationType(Enum):
     """Verification type."""
 
@@ -99,6 +147,21 @@ class ConfirmationType(Enum):
     WAIT_FOR_BOTH = "wait-for-both"
 
 
+def get_mech_config(chain_config: Optional[str] = None) -> MechConfig:
+    """Get `MechConfig` configuration"""
+    with open(MECH_CONFIGS, "r", encoding="UTF-8") as file:
+        data = json.load(file)
+
+        if chain_config is None:
+            chain_config = next(iter(data))
+
+        print(f"Chain configuration: {chain_config}")
+        entry = data[chain_config].copy()
+        ledger_config = LedgerConfig(**entry.pop("ledger_config"))
+        mech_config = MechConfig(**entry, ledger_config=ledger_config)
+        return mech_config
+
+
 def calculate_topic_id(event: Dict) -> str:
     """Caclulate topic ID"""
     text = event["name"]
@@ -124,11 +187,22 @@ def get_event_signatures(abi: List) -> Tuple[str, str]:
     return request, deliver
 
 
-def get_abi(contract_address: str) -> List:
+def get_abi(contract_address: str, contract_abi_url: str) -> List:
     """Get contract abi"""
-    abi_request_url = BLOCKSCOUT_API_URL.format(contract_address=contract_address)
+    abi_request_url = contract_abi_url.format(contract_address=contract_address)
     response = requests.get(abi_request_url).json()
-    return response["abi"]
+
+    if "result" in response:
+        result = response["result"]
+        try:
+            abi = json.loads(result)
+        except json.JSONDecodeError:
+            print("Error: Failed to parse 'result' field as JSON")
+            sys.exit(1)
+    else:
+        abi = response.get("abi")
+
+    return abi if abi else []
 
 
 def get_contract(
@@ -194,7 +268,11 @@ def _tool_selector_prompt(available_tools: List[str]) -> str:
 
 
 def verify_or_retrieve_tool(
-    agent_id: int, ledger_api: EthereumApi, tool: Optional[str] = None
+    agent_id: int,
+    ledger_api: EthereumApi,
+    agent_registry_contract: str,
+    contract_abi_url: str,
+    tool: Optional[str] = None,
 ) -> str:
     """
     Checks if the tool is valid and for what agent.
@@ -203,12 +281,21 @@ def verify_or_retrieve_tool(
     :type agent_id: int
     :param ledger_api: The Ethereum API used for interacting with the ledger.
     :type ledger_api: EthereumApi
+    :param agent_registry_contract: Agent registry contract address.
+    :type agent_registry_contract: str
+    :param contract_abi_url: Block explorer URL.
+    :type contract_abi_url: str
     :param tool: The tool to verify or retrieve (optional).
     :type tool: Optional[str]
     :return: The result of the verification or retrieval.
     :rtype: str
     """
-    available_tools = fetch_tools(agent_id=agent_id, ledger_api=ledger_api)
+    available_tools = fetch_tools(
+        agent_id=agent_id,
+        ledger_api=ledger_api,
+        agent_registry_contract=agent_registry_contract,
+        contract_abi_url=contract_abi_url,
+    )
     if tool is not None and tool not in available_tools:
         raise ValueError(
             f"Provided tool `{tool}` not in the list of available tools; Available tools={available_tools}"
@@ -218,11 +305,16 @@ def verify_or_retrieve_tool(
     return _tool_selector_prompt(available_tools=available_tools)
 
 
-def fetch_tools(agent_id: int, ledger_api: EthereumApi) -> List[str]:
+def fetch_tools(
+    agent_id: int,
+    ledger_api: EthereumApi,
+    agent_registry_contract: str,
+    contract_abi_url: str,
+) -> List[str]:
     """Fetch tools for specified agent ID."""
     mech_registry = get_contract(
-        contract_address=AGENT_REGISTRY_CONTRACT,
-        abi=get_abi(AGENT_REGISTRY_CONTRACT),
+        contract_address=agent_registry_contract,
+        abi=get_abi(agent_registry_contract, contract_abi_url),
         ledger_api=ledger_api,
     )
     token_uri = mech_registry.functions.tokenURI(agent_id).call()
@@ -234,13 +326,15 @@ def send_request(  # pylint: disable=too-many-arguments,too-many-locals
     crypto: EthereumCrypto,
     ledger_api: EthereumApi,
     mech_contract: Web3Contract,
+    gas_limit: int,
     prompt: str,
     tool: str,
+    extra_attributes: Optional[Dict[str, Any]] = None,
     price: int = 10_000_000_000_000_000,
     retries: Optional[int] = None,
     timeout: Optional[float] = None,
     sleep: Optional[float] = None,
-) -> None:
+) -> Optional[str]:
     """
     Sends a request to the mech.
 
@@ -250,10 +344,14 @@ def send_request(  # pylint: disable=too-many-arguments,too-many-locals
     :type ledger_api: EthereumApi
     :param mech_contract: The mech contract instance.
     :type mech_contract: Web3Contract
+    :param gas_limit: Gas limit.
+    :type gas_limit: int
     :param prompt: The request prompt.
     :type prompt: str
     :param tool: The requested tool.
     :type tool: str
+    :param extra_attributes: Extra attributes to be included in the request metadata.
+    :type extra_attributes: Optional[Dict[str,Any]]
     :param price: The price for the request (default: 10_000_000_000_000_000).
     :type price: int
     :param retries: Number of retries for sending a transaction
@@ -262,15 +360,19 @@ def send_request(  # pylint: disable=too-many-arguments,too-many-locals
     :type timeout: float
     :param sleep: Amount of sleep before retrying the transaction
     :type sleep: float
+    :return: The transaction hash.
+    :rtype: Optional[str]
     """
-    v1_file_hash_hex_truncated, v1_file_hash_hex = push_metadata_to_ipfs(prompt, tool)
+    v1_file_hash_hex_truncated, v1_file_hash_hex = push_metadata_to_ipfs(
+        prompt, tool, extra_attributes
+    )
     print(f"Prompt uploaded: https://gateway.autonolas.tech/ipfs/{v1_file_hash_hex}")
     method_name = "request"
     methord_args = {"data": v1_file_hash_hex_truncated}
     tx_args = {
         "sender_address": crypto.address,
         "value": price,
-        "gas": MANUAL_GAS_LIMIT,
+        "gas": gas_limit,
     }
 
     tries = 0
@@ -295,21 +397,24 @@ def send_request(  # pylint: disable=too-many-arguments,too-many-locals
                 raise_on_try=True,
             )
             print(f"Transaction sent: https://gnosisscan.io/tx/{transaction_digest}")
-            return
+            return transaction_digest
         except Exception as e:  # pylint: disable=broad-except
             print(
                 f"Error occured while sending the transaction: {e}; Retrying in {sleep}"
             )
             time.sleep(sleep)
+    return None
 
 
 def wait_for_data_url(  # pylint: disable=too-many-arguments
     request_id: str,
     wss: websocket.WebSocket,
     mech_contract: Web3Contract,
+    subgraph_url: str,
     deliver_signature: str,
     ledger_api: EthereumApi,
     crypto: Crypto,
+    confirmation_type: ConfirmationType = ConfirmationType.WAIT_FOR_BOTH,
 ) -> Any:
     """
     Wait for data from on-chain/off-chain.
@@ -320,32 +425,54 @@ def wait_for_data_url(  # pylint: disable=too-many-arguments
     :type wss: websocket.WebSocket
     :param mech_contract: The mech contract instance.
     :type mech_contract: Web3Contract
+    :param subgraph_url: Subgraph URL.
+    :type subgraph_url: str
     :param deliver_signature: Topic signature for Deliver event
     :type deliver_signature: str
     :param ledger_api: The Ethereum API used for interacting with the ledger.
     :type ledger_api: EthereumApi
     :param crypto: The cryptographic object.
     :type crypto: Crypto
+    :param confirmation_type: The confirmation type for the interaction (default: ConfirmationType.WAIT_FOR_BOTH).
+    :type confirmation_type: ConfirmationType
     :return: The data received from on-chain/off-chain.
     :rtype: Any
     """
     loop = asyncio.new_event_loop()
-    off_chain_task = loop.create_task(watch_for_data_url_from_mech(crypto=crypto))
-    on_chain_task = loop.create_task(
-        watch_for_data_url_from_wss(
-            request_id=request_id,
-            wss=wss,
-            mech_contract=mech_contract,
-            deliver_signature=deliver_signature,
-            ledger_api=ledger_api,
-            loop=loop,
+    tasks = []
+
+    if confirmation_type in (
+        ConfirmationType.OFF_CHAIN,
+        ConfirmationType.WAIT_FOR_BOTH,
+    ):
+        off_chain_task = loop.create_task(watch_for_data_url_from_mech(crypto=crypto))
+        tasks.append(off_chain_task)
+
+    if confirmation_type in (
+        ConfirmationType.ON_CHAIN,
+        ConfirmationType.WAIT_FOR_BOTH,
+    ):
+        on_chain_task = loop.create_task(
+            watch_for_data_url_from_wss(
+                request_id=request_id,
+                wss=wss,
+                mech_contract=mech_contract,
+                deliver_signature=deliver_signature,
+                ledger_api=ledger_api,
+                loop=loop,
+            )
         )
-    )
+        mech_task = loop.create_task(
+            watch_for_data_url_from_subgraph(request_id=request_id, url=subgraph_url)
+        )
+        tasks.append(mech_task)
+        tasks.append(on_chain_task)
 
     async def _wait_for_tasks() -> Any:  # type: ignore
         """Wait for tasks to finish."""
         (finished, *_), unfinished = await asyncio.wait(
-            [off_chain_task, on_chain_task], return_when=asyncio.FIRST_COMPLETED
+            tasks,
+            return_when=asyncio.FIRST_COMPLETED,
         )
         for task in unfinished:
             task.cancel()
@@ -360,11 +487,13 @@ def interact(  # pylint: disable=too-many-arguments,too-many-locals
     prompt: str,
     agent_id: int,
     tool: Optional[str] = None,
+    extra_attributes: Optional[Dict[str, Any]] = None,
     private_key_path: Optional[str] = None,
     confirmation_type: ConfirmationType = ConfirmationType.WAIT_FOR_BOTH,
     retries: Optional[int] = None,
     timeout: Optional[float] = None,
     sleep: Optional[float] = None,
+    chain_config: Optional[str] = None,
 ) -> Any:
     """
     Interact with agent mech contract.
@@ -375,6 +504,8 @@ def interact(  # pylint: disable=too-many-arguments,too-many-locals
     :type agent_id: int
     :param tool: The tool to interact with (optional).
     :type tool: Optional[str]
+    :param extra_attributes: Extra attributes to be included in the request metadata (optional).
+    :type extra_attributes: Optional[Dict[str, Any]]
     :param private_key_path: The path to the private key file (optional).
     :type private_key_path: Optional[str]
     :param confirmation_type: The confirmation type for the interaction (default: ConfirmationType.WAIT_FOR_BOTH).
@@ -386,9 +517,18 @@ def interact(  # pylint: disable=too-many-arguments,too-many-locals
     :type timeout: float
     :param sleep: Amount of sleep before retrying the transaction
     :type sleep: float
+    :param chain_config: Id of the mech's chain configuration (stored configs/mechs.json)
+    :type chain_config: str:
     :rtype: Any
     """
-    contract_address = query_agent_address(agent_id=agent_id, timeout=timeout)
+    mech_config = get_mech_config(chain_config)
+    ledger_config = mech_config.ledger_config
+    contract_address = query_agent_address(
+        agent_id=agent_id,
+        timeout=timeout,
+        url=mech_config.subgraph_url,
+        chain_config=chain_config,
+    )
     if contract_address is None:
         raise ValueError(f"Agent with ID {agent_id} does not exist!")
 
@@ -398,12 +538,21 @@ def interact(  # pylint: disable=too-many-arguments,too-many-locals
             f"Private key file `{private_key_path}` does not exist!"
         )
 
-    wss = websocket.create_connection(WSS_ENDPOINT)
+    wss = websocket.create_connection(mech_config.wss_endpoint)
     crypto = EthereumCrypto(private_key_path=private_key_path)
-    ledger_api = EthereumApi(**LEDGER_CONFIG)
+    ledger_api = EthereumApi(**asdict(ledger_config))
 
-    tool = verify_or_retrieve_tool(agent_id=agent_id, ledger_api=ledger_api, tool=tool)
-    abi = get_abi(contract_address=contract_address)
+    tool = verify_or_retrieve_tool(
+        agent_id=agent_id,
+        ledger_api=ledger_api,
+        tool=tool,
+        agent_registry_contract=mech_config.agent_registry_contract,
+        contract_abi_url=mech_config.contract_abi_url,
+    )
+    abi = get_abi(
+        contract_address=contract_address,
+        contract_abi_url=mech_config.contract_abi_url,
+    )
     mech_contract = get_contract(
         contract_address=contract_address, abi=abi, ledger_api=ledger_api
     )
@@ -419,12 +568,15 @@ def interact(  # pylint: disable=too-many-arguments,too-many-locals
         crypto=crypto,
         ledger_api=ledger_api,
         mech_contract=mech_contract,
+        gas_limit=mech_config.gas_limit,
         prompt=prompt,
         tool=tool,
+        extra_attributes=extra_attributes,
         retries=retries,
         timeout=timeout,
         sleep=sleep,
     )
+    print("Waiting for transaction receipt...")
     request_id = watch_for_request_id(
         wss=wss,
         mech_contract=mech_contract,
@@ -432,25 +584,17 @@ def interact(  # pylint: disable=too-many-arguments,too-many-locals
         request_signature=request_event_signature,
     )
     print(f"Created on-chain request with ID {request_id}")
-    if confirmation_type == ConfirmationType.OFF_CHAIN:
-        data_url = watch_for_data_url_from_mech_sync(crypto=crypto)
-    elif confirmation_type == ConfirmationType.ON_CHAIN:
-        data_url = watch_for_data_url_from_wss_sync(
-            request_id=request_id,
-            wss=wss,
-            deliver_signature=deliver_event_signature,
-            mech_contract=mech_contract,
-            ledger_api=ledger_api,
-        )
-    else:
-        data_url = wait_for_data_url(
-            request_id=request_id,
-            wss=wss,
-            mech_contract=mech_contract,
-            deliver_signature=deliver_event_signature,
-            ledger_api=ledger_api,
-            crypto=crypto,
-        )
+    data_url = wait_for_data_url(
+        request_id=request_id,
+        wss=wss,
+        mech_contract=mech_contract,
+        subgraph_url=mech_config.subgraph_url,
+        deliver_signature=deliver_event_signature,
+        ledger_api=ledger_api,
+        crypto=crypto,
+        confirmation_type=confirmation_type,
+    )
+
     print(f"Data arrived: {data_url}")
     data = requests.get(f"{data_url}/{request_id}").json()
     print(f"Data from agent: {data}")

mech_client/prompt_to_ipfs.py

@@ -29,12 +29,14 @@ import json
 import shutil
 import tempfile
 import uuid
-from typing import Tuple
+from typing import Any, Dict, Optional, Tuple
 
 from mech_client.push_to_ipfs import push_to_ipfs
 
 
-def push_metadata_to_ipfs(prompt: str, tool: str) -> Tuple[str, str]:
+def push_metadata_to_ipfs(
+    prompt: str, tool: str, extra_attributes: Optional[Dict[str, Any]] = None
+) -> Tuple[str, str]:
     """
     Pushes metadata object to IPFS.
 
@@ -42,10 +44,14 @@ def push_metadata_to_ipfs(prompt: str, tool: str) -> Tuple[str, str]:
     :type prompt: str
     :param tool: Tool string.
     :type tool: str
+    :param extra_attributes: Extra attributes to be included in the request metadata.
+    :type extra_attributes: Optional[Dict[str,Any]]
     :return: Tuple containing the IPFS hash and truncated IPFS hash.
     :rtype: Tuple[str, str]
     """
     metadata = {"prompt": prompt, "tool": tool, "nonce": str(uuid.uuid4())}
+    if extra_attributes:
+        metadata.update(extra_attributes)
     dirpath = tempfile.mkdtemp()
     file_name = dirpath + "metadata.json"
     with open(file_name, "w", encoding="utf-8") as f:

mech_client/subgraph.py

@@ -19,6 +19,7 @@
 
 """Subgraph client for mech."""
 
+import asyncio
 from string import Template
 from typing import Optional
 
@@ -26,7 +27,6 @@ from gql import Client, gql
 from gql.transport.aiohttp import AIOHTTPTransport
 
 
-MECH_SUBGRAPH_URL = "https://api.studio.thegraph.com/query/57238/mech/version/latest"
 AGENT_QUERY_TEMPLATE = Template(
     """{
     createMeches(where:{agentId:$agent_id}) {
@@ -35,22 +35,53 @@ AGENT_QUERY_TEMPLATE = Template(
 }
 """
 )
+DELIVER_QUERY_TEMPLATE = Template(
+    """{
+    delivers(
+        orderBy: blockTimestamp
+        where: {requestId:"$request_id"}
+        orderDirection: desc
+    ) {
+        ipfsHash
+  }
+}
+"""
+)
+DEFAULT_TIMEOUT = 600.0
 
 
-def query_agent_address(
-    agent_id: int, timeout: Optional[float] = None
+def query_agent_address(  # pylint: disable=too-many-return-statements
+    agent_id: int,
+    url: str,
+    timeout: Optional[float] = None,
+    chain_config: Optional[str] = None,
 ) -> Optional[str]:
     """
     Query agent address from subgraph.
 
     :param agent_id: The ID of the agent.
-    :param timeout: Timeout for the request.
     :type agent_id: int
+    :param url: Subgraph URL.
+    :type url: str
+    :param timeout: Timeout for the request.
+    :type timeout: Optional[float]
+    :type chain_config: Optional[str]:
     :return: The agent address if found, None otherwise.
     :rtype: Optional[str]
     """
+    # temporary hard coded until subgraph present
+    if chain_config == "base" and agent_id == 2:
+        return "0x111D7DB1B752AB4D2cC0286983D9bd73a49bac6c"
+    if chain_config == "arbitrum" and agent_id == 2:
+        return "0x1FDAD3a5af5E96e5a64Fc0662B1814458F114597"
+    if chain_config == "polygon" and agent_id == 2:
+        return "0xbF92568718982bf65ee4af4F7020205dE2331a8a"
+    if chain_config == "celo" and agent_id == 2:
+        return "0x230eD015735c0D01EA0AaD2786Ed6Bd3C6e75912"
+    if chain_config == "optimism" and agent_id == 2:
+        return "0xDd40E7D93c37eFD860Bd53Ab90b2b0a8D05cf71a"
     client = Client(
-        transport=AIOHTTPTransport(url=MECH_SUBGRAPH_URL),
+        transport=AIOHTTPTransport(url=url),
         execute_timeout=timeout or 30.0,
     )
     response = client.execute(
@@ -64,3 +95,66 @@ def query_agent_address(
 
     (record,) = mechs
     return record["mech"]
+
+
+async def query_deliver_hash(
+    request_id: str, url: str, timeout: Optional[float] = None
+) -> Optional[str]:
+    """
+    Query deliver IPFS hash from subgraph.
+
+    :param request_id: The ID of the mech request.
+    :type request_id: str
+    :param url: Subgraph URL.
+    :type url: str
+    :param timeout: Timeout for the request.
+    :type timeout: Optional[float]
+    :return: The deliver IPFS hash if found, None otherwise.
+    :rtype: Optional[str]
+    """
+    client = Client(
+        transport=AIOHTTPTransport(url=url),
+        execute_timeout=timeout or 30.0,
+    )
+    response = await client.execute_async(
+        document=gql(
+            request_string=DELIVER_QUERY_TEMPLATE.substitute({"request_id": request_id})
+        )
+    )
+    delivers = response["delivers"]  # pylint: disable=unsubscriptable-object
+    if len(delivers) == 0:
+        return None
+
+    (record,) = delivers
+    return record["ipfsHash"]
+
+
+async def watch_for_data_url_from_subgraph(
+    request_id: str, url: str, timeout: Optional[float] = None
+) -> Optional[str]:
+    """
+    Continuously query for data URL until it's available or timeout is reached.
+
+    :param request_id: The ID of the mech request.
+    :type request_id: str
+    :param url: Subgraph URL.
+    :type url: str
+    :param timeout: Maximum time to wait for the data URL in seconds. Defaults to DEFAULT_TIMEOUT.
+    :type timeout: Optional[float]
+    :return: Data URL if available within timeout, otherwise None.
+    :rtype: Optional[str]
+    """
+    timeout = timeout or DEFAULT_TIMEOUT
+    start_time = asyncio.get_event_loop().time()
+    while True:
+        response = await query_deliver_hash(request_id=request_id, url=url)
+        if response is not None:
+            return f"https://gateway.autonolas.tech/ipfs/{response}"
+
+        if asyncio.get_event_loop().time() - start_time >= timeout:
+            print(f"Error: No response received after {timeout} seconds.")
+            break
+
+        await asyncio.sleep(5)
+
+    return None

mech_client/wss.py

@@ -186,41 +186,3 @@ async def watch_for_data_url_from_wss(  # pylint: disable=too-many-arguments
             if request_id != str(rich_logs[0]["args"]["requestId"]):
                 continue
             return f"https://gateway.autonolas.tech/ipfs/f01701220{data.hex()}"
-
-
-def watch_for_data_url_from_wss_sync(
-    request_id: str,
-    wss: websocket.WebSocket,
-    mech_contract: Web3Contract,
-    deliver_signature: str,
-    ledger_api: EthereumApi,
-) -> Any:
-    """
-    Watches for data on-chain.
-
-    :param request_id: The ID of the request.
-    :type request_id: str
-    :param wss: The WebSocket connection object.
-    :type wss: websocket.WebSocket
-    :param mech_contract: The mech contract instance.
-    :type mech_contract: Web3Contract
-    :param deliver_signature: Topic signature for Deliver event
-    :type deliver_signature: str
-    :param ledger_api: The Ethereum API used for interacting with the ledger.
-    :type ledger_api: EthereumApi
-    :return: The data received from on-chain.
-    :rtype: Any
-    """
-    loop = asyncio.new_event_loop()
-    task = loop.create_task(
-        watch_for_data_url_from_wss(
-            request_id=request_id,
-            wss=wss,
-            mech_contract=mech_contract,
-            deliver_signature=deliver_signature,
-            ledger_api=ledger_api,
-            loop=loop,
-        )
-    )
-    loop.run_until_complete(task)
-    return task.result()

{mech_client-0.2.10.dist-info → mech_client-0.2.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mech-client
-Version: 0.2.10
+Version: 0.2.12
 Summary: Basic client to interact with a mech
 License: Apache-2.0
 Author: David Minarsch
@@ -31,10 +31,10 @@ Basic client to interact with a mech
 pip install mech-client
 ```
 
-Then, set a websocket endpoint for Gnosis RPC like so:
+Note: If you encounter an "Out of gas" error when executing the tool, you will need to increase the gas limit by setting, e.g.,
 
 ```bash
-export WEBSOCKET_ENDPOINT=<YOUR ENDPOINT>
+export MECHX_GAS_LIMIT=200000
 ```
 
 ## CLI:
@@ -103,6 +103,7 @@ mechx interact <prompt> <agent_id> --key <key_file>
 Example output:
 ```bash
 mechx interact "write a short poem" 3 --key ~/gnosis_key --tool openai-text-davinci-003
+Chain configuration: gnosis
 Prompt uploaded: https://gateway.autonolas.tech/ipfs/f01701220ad773628911d12e28f005e3f249e990d684e5dba07542259195602f9afed30bf
 Transaction sent: https://gnosisscan.io/tx/0x0d9209e32e965a820b9e80accfcd71ea3b1174b9758dd251c2e627a60ec426a5
 Created on-chain request with ID 111240237160304797537720810617416341148235899500021985333360197012735240803849
@@ -110,10 +111,11 @@ Data arrived: https://gateway.autonolas.tech/ipfs/bafybeifk2h35ncszlze7t64rpblfo
 Data from agent: {'requestId': 111240237160304797537720810617416341148235899500021985333360197012735240803849, 'result': "\n\nI am brave and I'm strong\nI don't hide away my song\nI am here and I'm proud\nMy voice will be heard loud!"}
 ```
 
-By default the client will wait for data to arrive from on-chain using the websocket subscription and off-chain using the ACN and show you the result which arrives first. You can specify the type of confirmation you want using `--confirm` flag like this
+By default the client will wait for data to arrive from on-chain using the websocket subscription and subgraph, and off-chain using the ACN and show you the result which arrives first. You can specify the type of confirmation you want using `--confirm` flag like this
 
 ```bash
 mechx interact "write a short poem" 3 --key ~/gnosis_key --tool openai-text-davinci-003 --confirm on-chain
+Chain configuration: gnosis
 Prompt uploaded: https://gateway.autonolas.tech/ipfs/f017012205e37f761221a8ba4005e91c36b94153e9432b8888ff2acae6b101dd5a5de6768
 Transaction sent: https://gnosisscan.io/tx/0xf1ef63f617717bbb8deb09699af99aa39f10155d33796de2fd7eb61c9c1458b6
 Created on-chain request with ID 81653153529124597849081567361606842861262371002932574194580478443414142139857
@@ -121,6 +123,30 @@ Data arrived: https://gateway.autonolas.tech/ipfs/f0170122069b55e077430a00f3cbc3
 Data from agent: {'requestId': 81653153529124597849081567361606842861262371002932574194580478443414142139857, 'result': "\n\nA summer breeze, so sweet,\nA gentle reminder of summer's heat.\nThe sky so blue, no cloud in sight,\nA perfect day, a wondrous sight."}
 ```
 
+### Chain configuration
+
+Configurations for different chains are stored in the file `configs/mechs.json`. By default, `mech interact` will choose the first configuration on the JSON. You can specify which config you want to use using the `--chain-config` flag, for example,
+
+```bash
+mechx interact <prompt> <agent_id> --chain-config gnosis
+```
+
+Additionally, you can override any configuration parameter by exporting any of the following environment variables:
+
+```bash
+MECHX_CHAIN_RPC
+MECHX_WSS_ENDPOINT
+MECHX_GAS_LIMIT
+MECHX_CONTRACT_ABI_URL
+MECHX_SUBGRAPH_URL
+
+MECHX_LEDGER_ADDRESS
+MECHX_LEDGER_CHAIN_ID
+MECHX_LEDGER_POA_CHAIN
+MECHX_LEDGER_DEFAULT_GAS_PRICE_STRATEGY
+MECHX_LEDGER_IS_GAS_ESTIMATION_ENABLED
+```
+
 ## Programmatic Usage:
 
 ```python
@@ -149,7 +175,7 @@ poetry install && poetry shell
 
 ## Release guide:
 
-- Bump versions in `pyproject.toml` and `mech_client/__init__.py`
+- Bump versions in `pyproject.toml`, `mech_client/__init__.py` and `SECURITY.md`
 - `poetry lock`
 - `rm -rf dist`
 - `autonomy packages sync --update-packages`

{mech_client-0.2.10.dist-info → mech_client-0.2.12.dist-info}/RECORD

@@ -1,6 +1,7 @@
-mech_client/__init__.py,sha256=No9VVJJY-aVrNiGRM83B1m0Bb-fXIOl_diX4tfBS_BM,43
-mech_client/acn.py,sha256=Cz93ykB8Vavd6QSEBnoNv0wylfw2RLOqqu7fIYo4YRY,5790
-mech_client/cli.py,sha256=e6trIN_uoprbvxz41A-x2aUu8kxlyxTAfYv_yZzxmOU,3897
+mech_client/__init__.py,sha256=s8E8bTccJTXUKsK6N8pSwD7FabU-dQUps-y98raJYZQ,43
+mech_client/acn.py,sha256=Rj_jLPvJ5loDQfGbu3a_O24cJC4SwIErLceSz_zVYS8,5356
+mech_client/cli.py,sha256=QnC3Z_vth__ZiU12chRl8q5LYDLjyjzaofB41mWlq8c,4608
+mech_client/configs/mechs.json,sha256=ed7mp5Z6qC8QuLIx4iqV9Y_u3KmIOhf3zMfpdZ951cQ,4026
 mech_client/helpers/__init__.py,sha256=f13zpwGDaKQUjML-5Iq66rRfzg8IS5UNK5I8gBr7w54,1028
 mech_client/helpers/acn/README.md,sha256=WMXR2Lk0IpWjr3vpZ8cxcTHk4gwsx4wC06UPkwj9dbQ,1641
 mech_client/helpers/acn/__init__.py,sha256=72WrGEDIuYKvlWQnTajFQ9bNrDy2sFfTYDP62he4doI,1141
@@ -29,14 +30,14 @@ mech_client/helpers/p2p_libp2p_client/README.md,sha256=6x9s6P7TdKkcvAS1wMFHXRz4a
 mech_client/helpers/p2p_libp2p_client/__init__.py,sha256=-GOP3D_JnmXTDomrMLCbnRk7vRQmihIqTYvyIPzx-q4,879
 mech_client/helpers/p2p_libp2p_client/connection.py,sha256=pvfHtI-NhgDbay1wLNit6m8InH4c0p00c3hQo0I2jwQ,27887
 mech_client/helpers/p2p_libp2p_client/connection.yaml,sha256=giYV5FwwugD7ha9IqFHJtvs-Oz1jC5og9rpkstrTqoc,1763
-mech_client/interact.py,sha256=Dy0WiiATpp6jdPe5iJ14UzXAnRz13GbNjn_UOHugs8Y,14925
-mech_client/prompt_to_ipfs.py,sha256=IR0NHBd-f4p9bj_HuindJSwrGcc08fdBxavJmpo6GKA,2250
+mech_client/interact.py,sha256=uRJEcJ8idIm-erGNNBugLGVgYwVO9HmSl2NKPvy248w,19631
+mech_client/prompt_to_ipfs.py,sha256=XqSIBko15MEkpWOQNT97fRI6jNxMF5EDBDEPOJFdhyk,2533
 mech_client/push_to_ipfs.py,sha256=IfvgaPU79N_ZmCPF9d7sPCYz2uduZH0KjT_HQ2LHXoQ,2059
-mech_client/subgraph.py,sha256=QR9yAxGSDQJDl3J3PeOwUYLMnCNMQyF4UZlNVTAKoMw,1955
+mech_client/subgraph.py,sha256=4vY6QFyUVs15gS0SvanJbvAxb3aie07IuxQnfMMnStc,4931
 mech_client/to_png.py,sha256=pjUcFJ63MJj_r73eqnfqCWMtlpsrj6H4ZmgvIEmRcFw,2581
-mech_client/wss.py,sha256=a9aKz1WADxjx67zH8I48w9L_z8J1N2xWRrBrtyk-UjY,7353
-mech_client-0.2.10.dist-info/LICENSE,sha256=mdBDB-mWKV5Cz4ejBzBiKqan6Z8zVLAh9xwM64O2FW4,11339
-mech_client-0.2.10.dist-info/METADATA,sha256=bPnUfuqr6OX-vv73FqH-Z0Ssnadk0Z8HX5TeMRQCruY,5583
-mech_client-0.2.10.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-mech_client-0.2.10.dist-info/entry_points.txt,sha256=SbRMRsayzD8XfNXhgwPuXEqQsdZ5Bw9XDPnUuaDExyY,45
-mech_client-0.2.10.dist-info/RECORD,,
+mech_client/wss.py,sha256=klvSOMoUbt8-NwVBNH1G3Tlu4Ll9192dgmr6fA1hGNc,6214
+mech_client-0.2.12.dist-info/LICENSE,sha256=mdBDB-mWKV5Cz4ejBzBiKqan6Z8zVLAh9xwM64O2FW4,11339
+mech_client-0.2.12.dist-info/METADATA,sha256=orPKVVfYHtc3tJn0u_FH258fNBiDWpEXddPyn5Buboo,6443
+mech_client-0.2.12.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+mech_client-0.2.12.dist-info/entry_points.txt,sha256=SbRMRsayzD8XfNXhgwPuXEqQsdZ5Bw9XDPnUuaDExyY,45
+mech_client-0.2.12.dist-info/RECORD,,