mech-client 0.12.1__tar.gz → 0.14.1__tar.gz

{mech_client-0.12.1 → mech_client-0.14.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mech-client
-Version: 0.12.1
+Version: 0.14.1
 Summary: Basic client to interact with a mech
 License: Apache-2.0
 Author: David Minarsch
@@ -34,7 +34,7 @@ A basic client to interact with an AI Mech. [AI Mechs](https://github.com/valory
 
 ## Developing, running and deploying Mechs and Mech tools
 
-The easiest way to create, run, deploy and test your own Mech and Mech tools is to follow the Mech and Mech tool docs [here](https://open-autonomy.docs.autonolas.tech/mech-tools-dev/). The [Mech tools dev repo](https://github.com/valory-xyz/mech-tools-dev) used in those docs greatly simplifies the development flow and dev experience.
+The easiest way to create, run, deploy and test your own Mech and Mech tools is to follow the Mech and Mech tool docs [here](https://stack.olas.network/open-autonomy/mech-tools-dev/). The [Mech tools dev repo](https://github.com/valory-xyz/mech-tools-dev) used in those docs greatly simplifies the development flow and dev experience.
 
 Only continue reading this README if you know what you are doing and you are specifically interested in this repo.
 
@@ -152,7 +152,7 @@ The basic usage of the Mech Client is as follows:
 mechx interact --prompts <prompt> --tools <tool> --agent_id <agent_id>
 ```
 
-where agent with `<agent_id>` will process `<prompt>` with the `<tool>` and default options. Each chain has its own set of Mech agents. You can find the agent IDs for each chain on the [Mech Hub](https://aimechs.autonolas.network/registry) or on the [Mech repository](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs).
+where agent blueprint with `<agent_id>` will process `<prompt>` with the `<tool>` and default options. Each chain has its own set of Mech agents. You can find the agent blueprint IDs for each chain on the [Mech Hub](https://aimechs.autonolas.network/registry) or on the [Mech repository](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs).
 
 ⚠️ Batch requests and tools are not supported for legacy mechs
 
@@ -249,7 +249,7 @@ export MECHX_MECH_OFFCHAIN_URL="http://localhost:8000/"
 ```
 If you want to use a Valory mech for offchain requests, below is the list of mechs and their address and offchain urls.
 
-| Service ID | Priority Mech Address                       | Offchain URL                                             |
+| AI agent ID | Priority Mech Address                       | Offchain URL                                             |
 |    :---:   |                :---:                        |                        :---:                             |
 |       2182 | 0xB3C6319962484602b00d5587e965946890b82101  | https://d19715222af5b940.agent.propel.autonolas.tech/    |
 
@@ -274,7 +274,7 @@ mechx fetch-mm-mechs-info --chain-config gnosis
 ```
 ```bash
 +--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
-|   Service Id | Mech Type          | Mech Address                               |   Total Deliveries | Metadata Link                                                                                                 |
+|   AI agent Id | Mech Type          | Mech Address                               |   Total Deliveries | Metadata Link                                                                                                 |
 +==============+====================+============================================+====================+===============================================================================================================+
 |         2182 | Fixed Price Native | 0xc05e7412439bd7e91730a6880e18d5d5873f632c |              41246 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
 +--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
@@ -291,7 +291,7 @@ mechx fetch-mm-mechs-info --chain-config gnosis
 ### List tools available for legacy mechs and marketplace mechs
 
 #### For legacy mechs
-To list the tools available for a specific agent or for all agents, use the `tools-for-agents` command. You can specify an agent ID to get tools for a specific agent, or omit it to list tools for all agents.
+To list the tools available for a specific agent or for all agents, use the `tools-for-agents` command. You can specify an agent blueprint ID to get tools for a specific agent, or omit it to list tools for all agents.
 
 ```bash
 mechx tools-for-agents
@@ -332,7 +332,7 @@ You will see an output like this:
 ```
 
 #### For marketplace mechs
-To list the tools available for a specific marketplace mech, use the `tools-for-marketplace-mech` command. You can specify a service ID to get tools for a specific mech.
+To list the tools available for a specific marketplace mech, use the `tools-for-marketplace-mech` command. You can specify an AI agent ID to get tools for a specific mech.
 
 ```bash
 mechx tools-for-marketplace-mech 1722 --chain-config gnosis
@@ -547,7 +547,7 @@ You can also use the Mech Client to programmatically fetch tools for agents in y
     from mech_client.mech_tool_management import get_tools_for_agents, get_tool_description, get_tool_io_schema
 
     # Fetching tools for a specific agent or all agents
-    agent_id = 6  # Specify the agent ID or set to None to fetch tools for all agents
+    agent_id = 6  # Specify the agent blueprint ID or set to None to fetch tools for all agents
     chain_config = "gnosis"  # Specify the chain configuration
     tools = get_tools_for_agents(agent_id=agent_id, chain_config=chain_config)
     print(f"Tools for agent {agent_id}:", tools)
@@ -613,9 +613,9 @@ No. AI Mechs are currently deployed only on mainnets.
 
 <details>
 
-<summary><b>Where can I find the agent ID?</b></summary>
+<summary><b>Where can I find the agent blueprint ID?</b></summary>
 
-You can find the agent IDs for each chain on the [Mech Hub](https://aimechs.autonolas.network/registry) or on the [Mech repository](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs).
+You can find the agent blueprint IDs for each chain on the [Mech Hub](https://aimechs.autonolas.network/registry) or on the [Mech repository](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs).
 
 </details>
 

{mech_client-0.12.1 → mech_client-0.14.1}/README.md

@@ -11,7 +11,7 @@ A basic client to interact with an AI Mech. [AI Mechs](https://github.com/valory
 
 ## Developing, running and deploying Mechs and Mech tools
 
-The easiest way to create, run, deploy and test your own Mech and Mech tools is to follow the Mech and Mech tool docs [here](https://open-autonomy.docs.autonolas.tech/mech-tools-dev/). The [Mech tools dev repo](https://github.com/valory-xyz/mech-tools-dev) used in those docs greatly simplifies the development flow and dev experience.
+The easiest way to create, run, deploy and test your own Mech and Mech tools is to follow the Mech and Mech tool docs [here](https://stack.olas.network/open-autonomy/mech-tools-dev/). The [Mech tools dev repo](https://github.com/valory-xyz/mech-tools-dev) used in those docs greatly simplifies the development flow and dev experience.
 
 Only continue reading this README if you know what you are doing and you are specifically interested in this repo.
 
@@ -129,7 +129,7 @@ The basic usage of the Mech Client is as follows:
 mechx interact --prompts <prompt> --tools <tool> --agent_id <agent_id>
 ```
 
-where agent with `<agent_id>` will process `<prompt>` with the `<tool>` and default options. Each chain has its own set of Mech agents. You can find the agent IDs for each chain on the [Mech Hub](https://aimechs.autonolas.network/registry) or on the [Mech repository](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs).
+where agent blueprint with `<agent_id>` will process `<prompt>` with the `<tool>` and default options. Each chain has its own set of Mech agents. You can find the agent blueprint IDs for each chain on the [Mech Hub](https://aimechs.autonolas.network/registry) or on the [Mech repository](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs).
 
 ⚠️ Batch requests and tools are not supported for legacy mechs
 
@@ -226,7 +226,7 @@ export MECHX_MECH_OFFCHAIN_URL="http://localhost:8000/"
 ```
 If you want to use a Valory mech for offchain requests, below is the list of mechs and their address and offchain urls.
 
-| Service ID | Priority Mech Address                       | Offchain URL                                             |
+| AI agent ID | Priority Mech Address                       | Offchain URL                                             |
 |    :---:   |                :---:                        |                        :---:                             |
 |       2182 | 0xB3C6319962484602b00d5587e965946890b82101  | https://d19715222af5b940.agent.propel.autonolas.tech/    |
 
@@ -251,7 +251,7 @@ mechx fetch-mm-mechs-info --chain-config gnosis
 ```
 ```bash
 +--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
-|   Service Id | Mech Type          | Mech Address                               |   Total Deliveries | Metadata Link                                                                                                 |
+|   AI agent Id | Mech Type          | Mech Address                               |   Total Deliveries | Metadata Link                                                                                                 |
 +==============+====================+============================================+====================+===============================================================================================================+
 |         2182 | Fixed Price Native | 0xc05e7412439bd7e91730a6880e18d5d5873f632c |              41246 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
 +--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
@@ -268,7 +268,7 @@ mechx fetch-mm-mechs-info --chain-config gnosis
 ### List tools available for legacy mechs and marketplace mechs
 
 #### For legacy mechs
-To list the tools available for a specific agent or for all agents, use the `tools-for-agents` command. You can specify an agent ID to get tools for a specific agent, or omit it to list tools for all agents.
+To list the tools available for a specific agent or for all agents, use the `tools-for-agents` command. You can specify an agent blueprint ID to get tools for a specific agent, or omit it to list tools for all agents.
 
 ```bash
 mechx tools-for-agents
@@ -309,7 +309,7 @@ You will see an output like this:
 ```
 
 #### For marketplace mechs
-To list the tools available for a specific marketplace mech, use the `tools-for-marketplace-mech` command. You can specify a service ID to get tools for a specific mech.
+To list the tools available for a specific marketplace mech, use the `tools-for-marketplace-mech` command. You can specify an AI agent ID to get tools for a specific mech.
 
 ```bash
 mechx tools-for-marketplace-mech 1722 --chain-config gnosis
@@ -524,7 +524,7 @@ You can also use the Mech Client to programmatically fetch tools for agents in y
     from mech_client.mech_tool_management import get_tools_for_agents, get_tool_description, get_tool_io_schema
 
     # Fetching tools for a specific agent or all agents
-    agent_id = 6  # Specify the agent ID or set to None to fetch tools for all agents
+    agent_id = 6  # Specify the agent blueprint ID or set to None to fetch tools for all agents
     chain_config = "gnosis"  # Specify the chain configuration
     tools = get_tools_for_agents(agent_id=agent_id, chain_config=chain_config)
     print(f"Tools for agent {agent_id}:", tools)
@@ -590,9 +590,9 @@ No. AI Mechs are currently deployed only on mainnets.
 
 <details>
 
-<summary><b>Where can I find the agent ID?</b></summary>
+<summary><b>Where can I find the agent blueprint ID?</b></summary>
 
-You can find the agent IDs for each chain on the [Mech Hub](https://aimechs.autonolas.network/registry) or on the [Mech repository](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs).
+You can find the agent blueprint IDs for each chain on the [Mech Hub](https://aimechs.autonolas.network/registry) or on the [Mech repository](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs).
 
 </details>
 

mech_client-0.14.1/mech_client/__init__.py

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

{mech_client-0.12.1 → mech_client-0.14.1}/mech_client/cli.py

@@ -180,11 +180,6 @@ def interact(  # pylint: disable=too-many-arguments,too-many-locals
                 private_key_path=key,
                 tools=tools,
                 extra_attributes=extra_attributes_dict,
-                confirmation_type=(
-                    ConfirmationType(confirm)
-                    if confirm is not None
-                    else ConfirmationType.WAIT_FOR_BOTH
-                ),
                 retries=retries,
                 timeout=timeout,
                 sleep=sleep,

mech_client-0.14.1/mech_client/delivery.py

@@ -0,0 +1,156 @@
+# -*- 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.
+#
+# ------------------------------------------------------------------------------
+
+"""Onchain delivery helpers."""
+
+import time
+from typing import Any, Dict, List, Optional, Tuple
+
+from aea_ledger_ethereum import EthereumApi
+from eth_abi import decode
+from web3.constants import ADDRESS_ZERO
+from web3.contract import Contract as Web3Contract
+
+
+WAIT_SLEEP = 3.0
+DELIVERY_MECH_INDEX = 1
+DEFAULT_TIMEOUT = 900.0  # 15mins
+IPFS_URL_TEMPLATE = "https://gateway.autonolas.tech/ipfs/f01701220{}"
+
+
+async def watch_for_marketplace_data(  # pylint: disable=too-many-arguments, unused-argument, too-many-locals
+    request_ids: List[str],
+    marketplace_contract: Web3Contract,
+    timeout: Optional[float] = None,
+) -> Any:
+    """
+    Watches for data on-chain.
+
+    :param request_ids: The IDs of the request.
+    :type request_ids: List[str]
+    :param marketplace_contract: The marketplace contract instance.
+    :type marketplace_contract: Web3Contract
+    :param timeout: Timeout to wait for the onchain data
+    :type timeout: float
+    :return: The data received from on-chain.
+    :rtype: Any
+    """
+    request_ids_data: Dict = {}
+    start_time = time.time()
+    # either use the timeout supplied by user or the default timeout of 15mins
+    timeout = timeout or DEFAULT_TIMEOUT
+    while True:
+        for request_id in request_ids:
+            request_id_info = marketplace_contract.functions.mapRequestIdInfos(
+                bytes.fromhex(request_id)
+            ).call()
+
+            # return empty data which is handled in the main method
+            if len(request_id_info) <= DELIVERY_MECH_INDEX:
+                return request_ids_data
+
+            delivery_mech = request_id_info[DELIVERY_MECH_INDEX]
+            if not isinstance(delivery_mech, str) or not delivery_mech.startswith("0x"):
+                return request_id_info
+
+            if delivery_mech != ADDRESS_ZERO:
+                request_ids_data.update({request_id: delivery_mech})
+
+            time.sleep(WAIT_SLEEP)
+
+            elapsed_time = time.time() - start_time
+            if elapsed_time >= timeout:
+                print("Timeout reached. Breaking the loop and returning empty data.")
+                return request_ids_data
+
+        if len(request_ids_data) == len(request_ids):
+            return request_ids_data
+
+
+async def watch_for_mech_data_url(  # pylint: disable=too-many-arguments, unused-argument, too-many-locals
+    request_ids: List[str],
+    from_block: int,
+    mech_contract_address: str,
+    mech_deliver_signature: str,
+    ledger_api: EthereumApi,
+    timeout: Optional[float] = None,
+) -> Any:
+    """
+    Watches for data on-chain.
+
+    :param request_ids: The IDs of the request.
+    :type request_ids: List[str]
+    :param from_block: The from block to start searching logs.
+    :type from_block: int
+    :param mech_contract_address: The mech contract instance.
+    :type mech_contract_address: str
+    :param mech_deliver_signature: Topic signature for Deliver event
+    :type mech_deliver_signature: str
+    :param ledger_api: The Ethereum API used for interacting with the ledger.
+    :type ledger_api: EthereumApi
+    :param timeout: Timeout to wait for the onchain data
+    :type timeout: float
+    :return: The data received from on-chain.
+    :rtype: Any
+    """
+
+    results = {}
+    start_time = time.time()
+    # either use the timeout supplied by user or the default timeout of 15mins
+    timeout = timeout or DEFAULT_TIMEOUT
+
+    def get_logs(from_block_: int) -> List:
+        logs = ledger_api.api.eth.get_logs(
+            {
+                "fromBlock": from_block_,
+                "toBlock": "latest",
+                "address": mech_contract_address,
+                "topics": ["0x" + mech_deliver_signature],
+            }
+        )
+        return logs
+
+    def get_event_data(log: Dict) -> Tuple:
+        data_types = ["bytes32", "uint256", "bytes"]
+        data_bytes = bytes(log["data"])
+        request_id_bytes, _, delivery_data_bytes = decode(data_types, data_bytes)
+        return request_id_bytes, delivery_data_bytes
+
+    while True:
+        logs = get_logs(from_block)
+        latest_block = from_block
+        for log in logs:
+            latest_block = max(latest_block, log["blockNumber"])
+            event_data = get_event_data(log)
+            request_id, delivery_data = (data.hex() for data in event_data)
+            if request_id in results:
+                continue
+
+            if request_id in request_ids:
+                results[request_id] = IPFS_URL_TEMPLATE.format(delivery_data)
+
+            if len(results) == len(request_ids):
+                return results
+
+        from_block = latest_block + 1
+        time.sleep(WAIT_SLEEP)
+        elapsed_time = time.time() - start_time
+        if elapsed_time >= timeout:
+            print("Timeout reached. Breaking the loop and returning empty data.")
+            return results

{mech_client-0.12.1 → mech_client-0.14.1}/mech_client/interact.py

@@ -200,7 +200,7 @@ def calculate_topic_id(event: Dict) -> str:
     return Web3.keccak(text=text).hex()
 
 
-def get_event_signatures(abi: List) -> Tuple[str, str]:
+def get_mech_event_signatures(abi: List) -> Tuple[str, str]:
     """Calculate `Request` and `Deliver` event topics"""
     request, deliver = "", ""
     for obj in abi:
@@ -576,13 +576,16 @@ def interact(  # pylint: disable=too-many-arguments,too-many-locals
     mech_contract = get_contract(
         contract_address=contract_address, abi=abi, ledger_api=ledger_api
     )
-    request_event_signature, deliver_event_signature = get_event_signatures(abi=abi)
+    request_event_signature, deliver_event_signature = get_mech_event_signatures(
+        abi=abi
+    )
     register_event_handlers(
         wss=wss,
-        contract_address=contract_address,
+        mech_contract_address=contract_address,
+        marketplace_contract_address=contract_address,
         crypto=crypto,
-        request_signature=request_event_signature,
-        deliver_signature=deliver_event_signature,
+        mech_request_signature=request_event_signature,
+        marketplace_deliver_signature=deliver_event_signature,
     )
     print("Sending Mech request...")
     price = mech_config.price or 10_000_000_000_000_000