mech-client 0.6.0__py3-none-any.whl → 0.8.0__py3-none-any.whl

mech_client/mech_marketplace_tool_management.py

@@ -0,0 +1,223 @@
+"""Module for managing mechanical tools and their interactions with blockchain."""
+
+import json
+from dataclasses import asdict, dataclass
+from pathlib import Path
+from typing import Any, Dict, List, Optional, Tuple
+
+import requests
+from aea_ledger_ethereum import EthereumApi
+
+from mech_client.marketplace_interact import ADDRESS_ZERO, get_contract, get_mech_config
+
+
+ABI_DIR_PATH = Path(__file__).parent / "abis"
+COMPLEMENTARY_METADATA_HASH_ABI_PATH = (
+    ABI_DIR_PATH / "ComplementaryServiceMetadata.json"
+)
+ENCODING = "utf-8"
+DEFAULT_TIMEOUT = 10
+TOOLS = "tools"
+TOOL_METADATA = "toolMetadata"
+DEFAULT_CONFIG = "gnosis"
+
+
+@dataclass
+class ToolInfo:
+    """Tool info"""
+
+    tool_name: str
+    unique_identifier: str
+
+
+@dataclass
+class ToolsForMarketplaceMech:
+    """Tools info list"""
+
+    service_id: int
+    tools: List[ToolInfo]
+
+
+def fetch_tools(
+    service_id: int,
+    ledger_api: EthereumApi,
+    complementary_metadata_hash_address: str,
+    contract_abi_path: Path,
+) -> Dict[str, Any]:
+    """Fetch tools for specified mech's service ID."""
+    with open(contract_abi_path, encoding=ENCODING) as f:
+        abi = json.load(f)
+
+    metadata_contract = get_contract(
+        contract_address=complementary_metadata_hash_address,
+        abi=abi,
+        ledger_api=ledger_api,
+    )
+    metadata_uri = metadata_contract.functions.tokenURI(service_id).call()
+    return requests.get(metadata_uri, timeout=DEFAULT_TIMEOUT).json()
+
+
+def get_mech_tools(
+    service_id: int, chain_config: str = DEFAULT_CONFIG
+) -> Optional[Dict[str, Any]]:
+    """
+    Fetch tools for a given mech's service ID.
+
+    :param service_id: The service ID of the mech.
+    :param chain_config: The chain configuration to use (default is "gnosis").
+    :return: A dictionary containing the JSON response from the `tokenURI` contract call, typically including tools and metadata.
+    """
+    # Get the mech configuration
+    mech_config = get_mech_config(chain_config)
+    ledger_config = mech_config.ledger_config
+
+    # Setup Ethereum API
+    ledger_api = EthereumApi(**asdict(ledger_config))
+
+    if mech_config.complementary_metadata_hash_address == ADDRESS_ZERO:
+        print(f"Metadata hash not yet implemented on {chain_config}")
+        return None
+
+    try:
+        # Fetch tools for the given mech's service ID
+        return fetch_tools(
+            service_id=service_id,
+            ledger_api=ledger_api,
+            complementary_metadata_hash_address=mech_config.complementary_metadata_hash_address,
+            contract_abi_path=COMPLEMENTARY_METADATA_HASH_ABI_PATH,
+        )
+    except (json.JSONDecodeError, NotImplementedError) as e:
+        print(f"An error occurred while fetching tools for mech with {service_id}: {e}")
+        return None
+
+
+def get_tools_for_marketplace_mech(
+    service_id: int, chain_config: str = DEFAULT_CONFIG
+) -> ToolsForMarketplaceMech:
+    """
+    Retrieve tools for specified mech's service id.
+
+    :param service_id: specific mech's service ID to fetch tools for.
+    :param chain_config: The chain configuration to use.
+    :return: Dictionary of tools with identifiers or a mapping of service IDs to tools.
+    """
+    empty_response = ToolsForMarketplaceMech(service_id=service_id, tools=[])
+
+    try:
+        result = get_mech_tools(service_id, chain_config)
+        if result is None:
+            return empty_response
+
+        tools = result.get(TOOLS, [])
+        tool_metadata = result.get(TOOL_METADATA, {})
+        if not isinstance(tools, list) or not isinstance(tool_metadata, dict):
+            return empty_response
+
+        tools_with_ids = [
+            ToolInfo(tool_name=tool, unique_identifier=f"{service_id}-{tool}")
+            for tool in tools
+        ]
+        return ToolsForMarketplaceMech(service_id=service_id, tools=tools_with_ids)
+
+    except (json.JSONDecodeError, NotImplementedError) as e:
+        print(f"Error in get_tools_for_marketplace_mech: {str(e)}")
+        raise
+
+
+def get_tool_description(
+    unique_identifier: str, chain_config: str = DEFAULT_CONFIG
+) -> str:
+    """
+    Fetch the description of a specific tool based on a unique identifier.
+
+    :param unique_identifier: The unique identifier for the tool.
+    :param chain_config: The chain configuration to use.
+    :return: Description of the tool or a default message if not available.
+    """
+    default_response = "Description not available"
+
+    _, tool_info = _get_tool_metadata(unique_identifier, chain_config)
+    return (
+        tool_info.get("description", default_response)
+        if tool_info
+        else default_response
+    )
+
+
+def get_tool_io_schema(
+    unique_identifier: str, chain_config: str = DEFAULT_CONFIG
+) -> Dict[str, Any]:
+    """
+    Fetch the input and output schema along with tool name and description of a specific tool based on a unique identifier.
+
+    :param unique_identifier: The unique identifier for the tool.
+    :param chain_config: The chain configuration to use.
+    :return: Dictionary containing name, description, input and output schemas.
+    """
+    _, tool_info = _get_tool_metadata(unique_identifier, chain_config)
+    if tool_info:
+        return {
+            "name": tool_info.get("name", {}),
+            "description": tool_info.get("description", {}),
+            "input": tool_info.get("input", {}),
+            "output": tool_info.get("output", {}),
+        }
+
+    return {"input": {}, "output": {}}
+
+
+def _get_tool_metadata(
+    unique_identifier: str, chain_config: str = DEFAULT_CONFIG
+) -> Tuple[str, Optional[Dict[str, Any]]]:
+    """
+    Helper function to extract tool metadata from the chain config and unique identifier.
+
+    :param unique_identifier: The unique identifier in the format "<service_id>-<tool_name>".
+    :param chain_config: The chain configuration to use.
+    :return: Tuple of tool name and its metadata dictionary (or None if not found).
+    """
+    service_id_str, *tool_parts = unique_identifier.split("-")
+    try:
+        service_id = int(service_id_str)
+    except ValueError as exc:
+        raise ValueError(
+            f"Unexpected unique identifier format: {unique_identifier}"
+        ) from exc
+    tool_name = "-".join(tool_parts)
+
+    result = get_mech_tools(service_id, chain_config)
+
+    if isinstance(result, dict):
+        tool_metadata = result.get(TOOL_METADATA, {})
+        tool_info = tool_metadata.get(tool_name)
+        if isinstance(tool_info, dict):
+            return tool_name, tool_info
+
+    return tool_name, None
+
+
+def extract_input_schema(input_data: Dict[str, Any]) -> List[Tuple[str, Any]]:
+    """
+    Extract the schema from input data.
+
+    :param input_data: A dictionary representing the input data.
+    :return: A list of key-value pairs representing the input schema.
+    """
+    return [(key, input_data[key]) for key in input_data]
+
+
+def extract_output_schema(output_data: Dict[str, Any]) -> List[Tuple[str, str, str]]:
+    """
+    Extract the output schema from the output data.
+
+    :param output_data: A dictionary representing the output data.
+    :return: A list of list of tuples representing the output schema.
+    """
+    schema = output_data.get("schema", {})
+    if "properties" not in schema:
+        return []
+
+    return [
+        (key, value.get("type", ""), value.get("description", ""))
+        for key, value in schema["properties"].items()
+    ]

{mech_client-0.6.0.dist-info → mech_client-0.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mech-client
-Version: 0.6.0
+Version: 0.8.0
 Summary: Basic client to interact with a mech
 License: Apache-2.0
 Author: David Minarsch
@@ -116,12 +116,6 @@ The EOA you use must have enough funds to pay for the Mech requests, or alternat
 >    echo ethereum_private_key.txt >> .gitignore
 >    ```
 
-### Select the mech you are going to send requests to
-
-Mechs can receive requests via the [Mech Marketplace](https://github.com/valory-xyz/ai-registry-mech/) or directly. We call the last ones _Legacy Mechs_. 
-Mechs are deployed on several networks. Find the list of supported networks and corresponding mech addresses [here](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs). Additionally, on Gnosis you can find more available Mechs [here](https://mech.olas.network/) (click on the tab "Legacy Mech" in order to see Legacy Mech and "Mech Marketplace" for the ones which receive requests via the Mech Marketplace).
-
-
 ### API Keys
 
 In order to fetch on-chain data for Gnosis and Base, mech client requires an API key from a blockchain data provider. You can find them here for [GnosisScan](https://gnosisscan.io/) and [BaseScan](https://basescan.org/). Follow these steps to generate your API key if you are planning to use mech client for gnosis and base:
@@ -139,6 +133,11 @@ export MECHX_API_KEY=<your api key>
 
 ### Generate Mech requests
 
+#### Select the mech you are going to send requests to
+
+Mechs can receive requests via the [Mech Marketplace](https://github.com/valory-xyz/ai-registry-mech/) or directly. We call the last ones _Legacy Mechs_. 
+Mechs are deployed on several networks. Find the list of supported networks and corresponding mech addresses [here](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs). Additionally, you can find more available Mechs [here](https://mech.olas.network/) (click on the tab "Legacy Mech" in order to see Legacy Mech (available only on Gnosis) and "Mech Marketplace" for the ones which receive requests via the Mech Marketplace).
+
 #### Legacy Mechs
 
 The basic usage of the Mech Client is as follows:
@@ -221,7 +220,10 @@ For a Mech using Nevermined subscriptions, to make requests, it is necessary to
 mechx purchase-nvm-subscription --chain-config <chain_config>
 ```
 
-:warning: If you face issues with base RPC, please consider updating to a new one [here](https://github.com/valory-xyz/mech-client/blob/feat/nvm_sub_integration/scripts/nvm_subscription/resources/networks.json#L10).
+⚠️ To ensure optimal performance and reliability when using `purchase-nvm-subscription`, it is advisable to use a custom RPC provider as public RPC endpoints may be rate-limited or unreliable under high usage. You can configure your custom RPC URL in your environment variables using
+```bash
+export MECHX_CHAIN_RPC=
+```
 
 You can use the option `--key <private_key_file_path>` in order to customize the path to the private key file.
 
@@ -249,8 +251,9 @@ mechx interact --prompts <prompt-1> --prompts <prompt-2> --priority-mech <priori
 ```
 
 
-### List tools available for agents
+### 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.
 
 ```bash
@@ -291,8 +294,28 @@ 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.
+
+```bash
+mechx tools-for-marketplace-mech 1722 --chain-config gnosis
+```
+```bash
+You will see an output like this:
++---------------------------------------------+-----------------------------------------------+
+| Tool Name                                   | Unique Identifier                             |
++=============================================+===============================================+
+| claude-prediction-offline                   | 1722-claude-prediction-offline                |
++---------------------------------------------+-----------------------------------------------+
+| claude-prediction-online                    | 1722-claude-prediction-online                 |
++---------------------------------------------+-----------------------------------------------+
+| deepmind-optimization                       | 1722-deepmind-optimization                    |
++---------------------------------------------+-----------------------------------------------+
+```
+
 ### Get Tool Description
 
+#### For legacy mechs
 To get the description of a specific tool, use the `tool-description` command. You need to specify the unique identifier of the tool.
 
 ```bash
@@ -308,9 +331,26 @@ You will see an output like this:
 Description for tool 6-claude-prediction-offline: Makes a prediction using Claude
 ```
 
+#### For marketplace mechs
+To get the description of a specific tool, use the ` tool-description-for-marketplace-mech` command. You need to specify the unique identifier of the tool.
+
+```bash
+mechx  tool-description-for-marketplace-mech <unique_identifier> --chain-config <chain_config>
+```
+Example usage:
+
+```bash
+mechx  tool-description-for-marketplace-mech 1722-openai-gpt-4 --chain-config gnosis
+```
+You will see an output like this:
+```bash
+Description for tool 1722-openai-gpt-4: Performs a request to OpenAI's GPT-4 model.
+```
+
 
 ### Get Tool Input/Output Schema
 
+#### For legacy mechs
 To get the input/output schema of a specific tool, use the `tool_io_schema` command. You need to specify the unique identifier of the tool.
 
 ```bash
@@ -350,6 +390,47 @@ Output Schema:
 +-----------+---------+-----------------------------------------------+
 ```
 
+#### For marketplace mechs
+To get the input/output schema of a specific tool, use the `tool-io-schema-for-marketplace-mech` command. You need to specify the unique identifier of the tool.
+
+```bash
+mechx tool-io-schema-for-marketplace-mech <unique_identifier> --chain-config <chain_config>
+```
+
+Example usage:
+
+```bash
+mechx tool-io-schema-for-marketplace-mech 1722-openai-gpt-4 --chain-config gnosis
+```
+You will see an output like this:
+```bash
+Tool Details:
+Tool Details:
++------------------------+---------------------------------------------+
+| Tool Name              | Tool Description                            |
++========================+=============================================+
+| OpenAI Request (GPT-4) | Performs a request to OpenAI's GPT-4 model. |
++------------------------+---------------------------------------------+
+Input Schema:
++-------------+-----------------------------------------------+
+| Field       | Value                                         |
++=============+===============================================+
+| type        | text                                          |
++-------------+-----------------------------------------------+
+| description | The request to relay to OpenAI's GPT-4 model. |
++-------------+-----------------------------------------------+
+Output Schema:
++-----------+---------+-----------------------------------+
+| Field     | Type    | Description                       |
++===========+=========+===================================+
+| requestId | integer | Unique identifier for the request |
++-----------+---------+-----------------------------------+
+| result    | string  | Response from OpenAI              |
++-----------+---------+-----------------------------------+
+| prompt    | string  | User prompt to send to OpenAI     |
++-----------+---------+-----------------------------------+
+```
+
 > **:pencil2: Note** <br />
 > **If you encounter an "Out of gas" error when executing the Mech Client, you will need to increase the gas limit, e.g.,**
 >

{mech_client-0.6.0.dist-info → mech_client-0.8.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-mech_client/__init__.py,sha256=u1bXGPf2ZrokEsWfyYdYTo12ju14tZw8ZMC9qgLP3JU,42
+mech_client/__init__.py,sha256=n3fidwjHsp7I4xof_XnBP8phCtdOP1J0zbnnx8kEwDI,42
 mech_client/abis/AgentMech.json,sha256=IEbs_xBGunBu5h-uT5DvIty8Zw412QoPI46S_DUMYNw,18082
 mech_client/abis/AgentRegistry.json,sha256=2qmXeFINZWz9pyOma6Bq67kMDSUI1lD7WvgHLwuETD8,24723
 mech_client/abis/AgreementStoreManager.base.json,sha256=_ljdIZcfFGmFzBHUTfhA4X0382ZHHpkdr_CziTwUETo,34360
@@ -7,6 +7,7 @@ mech_client/abis/BalanceTrackerFixedPriceNative.json,sha256=MF5jDqSMoZztvMV4oc5i
 mech_client/abis/BalanceTrackerFixedPriceToken.json,sha256=kaXgResUkAb6u9bVTS3T_SNRPRP76hi-jTAhMiYwq4U,12408
 mech_client/abis/BalanceTrackerNvmSubscriptionNative.json,sha256=D23ibyhDsn4vjozFvzcKw-7wJpGM-R5GiqlcmyBIpcY,16536
 mech_client/abis/BalanceTrackerNvmSubscriptionToken.json,sha256=4Bra0DdEi_pQUSD4hGdELOvjNL013GaJc-dANr--5D8,16204
+mech_client/abis/ComplementaryServiceMetadata.json,sha256=ywbXSjIQhUchxKMClqKGdcHRhMb8Z9s93OjcHtRRYrY,4256
 mech_client/abis/DIDRegistry.base.json,sha256=l6UZe4SU9nMh0PvmTS5gfwd6bBM7_BT5mRyASOFyGxw,92562
 mech_client/abis/DIDRegistry.gnosis.json,sha256=piDWd8nipLcI3NkMu0o2RsQkTS9m7gjDp-yLtPpcjEc,92562
 mech_client/abis/EscrowPaymentCondition.base.json,sha256=Z0zr_E2Cxjfg_aHF-VLPeOQ9kAy51_aRcw-OuIPQ7zY,34475
@@ -23,12 +24,14 @@ mech_client/abis/NeverminedConfig.base.json,sha256=0p_GV87fsBvlN6VNDm_T1ykjzD4yZ
 mech_client/abis/NeverminedConfig.gnosis.json,sha256=3MT2dgUz5jAKvwItfHwz95VPvPwKxF3CG2rH8kE5eug,21221
 mech_client/abis/SubscriptionNFT.base.json,sha256=oYqkgejXaNQ2Pfc1OyWRJ7GlOl77B0UC16ziS6-Y76U,8811
 mech_client/abis/SubscriptionNFT.gnosis.json,sha256=vHW7ownS8qDcDLbLZMGthtLc8YdtyxaAvymfeizD-7o,8811
+mech_client/abis/SubscriptionProvider.base.json,sha256=KPtu23YQTpf2-EWtqIvFGtGQGOAdoQqV871IHiE4K1o,9367
+mech_client/abis/SubscriptionProvider.gnosis.json,sha256=K4VRk8wuviMqQ6P30qg5A1NZOTLJz7oC7PwCYybdios,9367
 mech_client/abis/SubscriptionToken.base.json,sha256=5StPEyfRvDMTqtQPO-KakXXZqobXZRuE6OCAeTM7bQc,39812
 mech_client/abis/TransferNFTCondition.base.json,sha256=71O_3itHBz9qPtoTLev8_a7KxlcQfIZSfxK2562lkqw,42540
 mech_client/abis/TransferNFTCondition.gnosis.json,sha256=-huhxV54eoNY8mR9WtQdmSgQDgaKiUi0PULJ4HEshWw,42540
 mech_client/acn.py,sha256=Rj_jLPvJ5loDQfGbu3a_O24cJC4SwIErLceSz_zVYS8,5356
-mech_client/cli.py,sha256=cTmamHI-_DJL4NHfkF9Vv8DbaQm-5x3bTzrfKnyiBzg,14035
-mech_client/configs/mechs.json,sha256=Sh-W0ZqkktSD8HokU5InoFIlqvKoq7nDlIY0fB8P6Y8,4887
+mech_client/cli.py,sha256=XezX27Y0VdnUq8HmHF6HxyhPmsC91YuLSuqAoi41UrE,17655
+mech_client/configs/mechs.json,sha256=Zv8JrY6yvNsSxTP7RchvR1yz2k3yjYUZkuSILnPbWzg,5445
 mech_client/fetch_ipfs_hash.py,sha256=tg_hYVf4deXl89x3SOBrGFUthaSeN_Vg_OHDtfjdbp4,2752
 mech_client/helpers/__init__.py,sha256=nmQig1EqBQ9EMOpgdykP3a6_2NWcoVH3-lnyHP5n0ws,1196
 mech_client/helpers/acn/README.md,sha256=WMXR2Lk0IpWjr3vpZ8cxcTHk4gwsx4wC06UPkwj9dbQ,1641
@@ -58,16 +61,17 @@ 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=b5jfcUeSoNrUw8DOSTCbK4DTi-N8bf2_pdogUOz0ep0,28606
 mech_client/helpers/p2p_libp2p_client/connection.yaml,sha256=nMiHnU_dv9EFjVNqZ-0SAnoATfadJSad-JsbDvk97Mk,1790
-mech_client/interact.py,sha256=h3li0N79M1MaVXggONFzs_rNEr6WcG8fof_UtykSZyQ,21243
+mech_client/interact.py,sha256=52UW5NysSTIC--APLpJde8VvrruWeYFCFzO02uRQpwc,21288
 mech_client/marketplace_interact.py,sha256=rRIHYLzuaXYW7vh4fvNh9KBbUY4tgoavmMxFaPg0Rkw,33045
+mech_client/mech_marketplace_tool_management.py,sha256=q_cXyJGI1rLXKB_Ds21eQLCzUhTYE9BHN48wqIw0w6g,7341
 mech_client/mech_tool_management.py,sha256=NQFmVzzGZsIkeHokDPWXGHwa8u-pyQIMPR1Q5H81bKw,7806
 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=MiyWiLPkqtXS9qayT75xYM6tz2pxd2Q6iE92yZxDugw,4700
 mech_client/to_png.py,sha256=pjUcFJ63MJj_r73eqnfqCWMtlpsrj6H4ZmgvIEmRcFw,2581
 mech_client/wss.py,sha256=N38eprKqwHyQpqGa6XZ9ZUwJ_YO50wlBJqJ5D1QCIj4,9888
-mech_client-0.6.0.dist-info/LICENSE,sha256=mdBDB-mWKV5Cz4ejBzBiKqan6Z8zVLAh9xwM64O2FW4,11339
-mech_client-0.6.0.dist-info/METADATA,sha256=B8JraHl2kGrhhFxUkk9zZTS9ijCgpuIsK2O58p9kh4U,21369
-mech_client-0.6.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-mech_client-0.6.0.dist-info/entry_points.txt,sha256=SbRMRsayzD8XfNXhgwPuXEqQsdZ5Bw9XDPnUuaDExyY,45
-mech_client-0.6.0.dist-info/RECORD,,
+mech_client-0.8.0.dist-info/LICENSE,sha256=mdBDB-mWKV5Cz4ejBzBiKqan6Z8zVLAh9xwM64O2FW4,11339
+mech_client-0.8.0.dist-info/METADATA,sha256=fnDXxPMc9n3V3ESKXfxZxDxFs7TS8JZ_9-DjSckVCbs,25165
+mech_client-0.8.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+mech_client-0.8.0.dist-info/entry_points.txt,sha256=SbRMRsayzD8XfNXhgwPuXEqQsdZ5Bw9XDPnUuaDExyY,45
+mech_client-0.8.0.dist-info/RECORD,,