mech-client 0.10.0__tar.gz → 0.11.0__tar.gz

{mech_client-0.10.0 → mech_client-0.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mech-client
-Version: 0.10.0
+Version: 0.11.0
 Summary: Basic client to interact with a mech
 License: Apache-2.0
 Author: David Minarsch
@@ -32,6 +32,12 @@ A basic client to interact with an AI Mech. [AI Mechs](https://github.com/valory
 
 - Python >=3.10
 
+## 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.
+
+Only continue reading this README if you know what you are doing and you are specifically interested in this repo.
+
 ## Installation
 
 Find the latest available release on [PyPi](https://pypi.org/project/mech-client/#description).
@@ -120,9 +126,9 @@ The EOA you use must have enough funds to pay for the Mech requests, or alternat
 
 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:
 
-1. Sign up or log in 
+1. Sign up or log in
 2. Go to API Dashboard on the left menu
-3. Add a new API key 
+3. Add a new API key
 4. Once generated copy your API key
 
 Once you have your API key, you'll need to configure it in your environment. Use the following command to set it for your environment.
@@ -135,7 +141,7 @@ export MECHX_API_KEY=<your api key>
 
 #### 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 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
@@ -201,22 +207,22 @@ Data from agent: {'requestId': 1004074058566339663950817114309409628095686850319
 
 #### With the Mech Marketplace
 
-With the Mech Marketplace, in order to pay for the Mech fees, you can make a deposit before sending requests. The deposit depends on the 
-payment model of the Mech. For a fixed price Mech receiving payments in native token, use the following: 
+With the Mech Marketplace, in order to pay for the Mech fees, you can make a deposit before sending requests. The deposit depends on the
+payment model of the Mech. For a fixed price Mech receiving payments in native token, use the following:
 
 ```bash
 mechx deposit-native --chain-config <chain_config> <amount>
 ```
 
-For a fixed price Mech receiving payments in OLAS, use the following (the amount is in ether): 
+For a fixed price Mech receiving payments in OLAS, use the following (the amount is in ether):
 
 ```bash
 mechx deposit-token --chain-config <chain_config> <amount>
 ```
 
-For a Mech using Nevermined subscriptions, to make requests, it is necessary to buy a subscription. To do that you can use the following command: 
+For a Mech using Nevermined subscriptions, to make requests, it is necessary to buy a subscription. To do that you can use the following command:
 
-```bash 
+```bash
 mechx purchase-nvm-subscription --chain-config <chain_config>
 ```
 
@@ -244,11 +250,11 @@ 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                                             |
-|    :---:   |                :---:                        |                        :---:                             |  
+|    :---:   |                :---:                        |                        :---:                             |
 |       2182 | 0xB3C6319962484602b00d5587e965946890b82101  | https://d19715222af5b940.agent.propel.autonolas.tech/    |
 
 
-The Mech Client can also be used to send batch requests. There are couple of different ways to achieve this: 
+The Mech Client can also be used to send batch requests. There are couple of different ways to achieve this:
 
 ```bash
 mechx interact --prompts={<prompt-1>,<prompt-2>} --priority-mech <priority mech address> --tools={<tool-1>,<tool-2>} --chain-config <chain_config>
@@ -260,6 +266,27 @@ or <br>
 mechx interact --prompts <prompt-1> --prompts <prompt-2> --priority-mech <priority mech address> --tools <tool-1> --tools <tool-2> --chain-config <chain_config>
 ```
 
+### List marketplace mechs
+To list the top marketplace mechs based on deliveries, use the `fetch-mm-mechs-info` command. You can specify the chain you want to query. Please note that only the first 20 mechs sorted by number of deliveries will be shown.
+Currently supported chains are gnosis and base
+```bash
+mechx fetch-mm-mechs-info --chain-config gnosis
+```
+```bash
++--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
+|   Service Id | Mech Type          | Mech Address                               |   Total Deliveries | Metadata Link                                                                                                 |
++==============+====================+============================================+====================+===============================================================================================================+
+|         2182 | Fixed Price Native | 0xc05e7412439bd7e91730a6880e18d5d5873f632c |              41246 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
++--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
+|         2235 | Fixed Price Native | 0xb3c6319962484602b00d5587e965946890b82101 |              10127 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
++--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
+|         2198 | Fixed Price Native | 0x601024e27f1c67b28209e24272ced8a31fc8151f |               5714 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
++--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
+|         1722 | Fixed Price Token  | 0x13f36b1a516290b7563b1de574a02ebeb48926a1 |                399 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
++--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
+|         2135 | Fixed Price Native | 0xbead38e4c4777341bb3fd44e8cd4d1ba1a7ad9d7 |                353 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
++--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
+```
 
 ### List tools available for legacy mechs and marketplace mechs
 
@@ -287,7 +314,7 @@ You will see an output like this:
 ```bash
 mechx tools-for-agents --agent-id "agent_id"
 ```
-Eaxmple usage 
+Eaxmple usage
 ```bash
 mechx tools-for-agents --agent-id 6
 ```
@@ -545,7 +572,7 @@ This script will:
 
 #### For Mechs receiving requests via the Mech Marketplace
 
-In this case, the script is the same, except for the function result. When this function has no argument agent_id, 
+In this case, the script is the same, except for the function result. When this function has no argument agent_id,
 the request is sent to the Mech Marketplace. The target Mech to which the request is relayed should be in the chain_config file (key `priority_mech_address`).
 
 ## Developer installation

{mech_client-0.10.0 → mech_client-0.11.0}/README.md

@@ -9,6 +9,12 @@ A basic client to interact with an AI Mech. [AI Mechs](https://github.com/valory
 
 - Python >=3.10
 
+## 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.
+
+Only continue reading this README if you know what you are doing and you are specifically interested in this repo.
+
 ## Installation
 
 Find the latest available release on [PyPi](https://pypi.org/project/mech-client/#description).
@@ -97,9 +103,9 @@ The EOA you use must have enough funds to pay for the Mech requests, or alternat
 
 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:
 
-1. Sign up or log in 
+1. Sign up or log in
 2. Go to API Dashboard on the left menu
-3. Add a new API key 
+3. Add a new API key
 4. Once generated copy your API key
 
 Once you have your API key, you'll need to configure it in your environment. Use the following command to set it for your environment.
@@ -112,7 +118,7 @@ export MECHX_API_KEY=<your api key>
 
 #### 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 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
@@ -178,22 +184,22 @@ Data from agent: {'requestId': 1004074058566339663950817114309409628095686850319
 
 #### With the Mech Marketplace
 
-With the Mech Marketplace, in order to pay for the Mech fees, you can make a deposit before sending requests. The deposit depends on the 
-payment model of the Mech. For a fixed price Mech receiving payments in native token, use the following: 
+With the Mech Marketplace, in order to pay for the Mech fees, you can make a deposit before sending requests. The deposit depends on the
+payment model of the Mech. For a fixed price Mech receiving payments in native token, use the following:
 
 ```bash
 mechx deposit-native --chain-config <chain_config> <amount>
 ```
 
-For a fixed price Mech receiving payments in OLAS, use the following (the amount is in ether): 
+For a fixed price Mech receiving payments in OLAS, use the following (the amount is in ether):
 
 ```bash
 mechx deposit-token --chain-config <chain_config> <amount>
 ```
 
-For a Mech using Nevermined subscriptions, to make requests, it is necessary to buy a subscription. To do that you can use the following command: 
+For a Mech using Nevermined subscriptions, to make requests, it is necessary to buy a subscription. To do that you can use the following command:
 
-```bash 
+```bash
 mechx purchase-nvm-subscription --chain-config <chain_config>
 ```
 
@@ -221,11 +227,11 @@ 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                                             |
-|    :---:   |                :---:                        |                        :---:                             |  
+|    :---:   |                :---:                        |                        :---:                             |
 |       2182 | 0xB3C6319962484602b00d5587e965946890b82101  | https://d19715222af5b940.agent.propel.autonolas.tech/    |
 
 
-The Mech Client can also be used to send batch requests. There are couple of different ways to achieve this: 
+The Mech Client can also be used to send batch requests. There are couple of different ways to achieve this:
 
 ```bash
 mechx interact --prompts={<prompt-1>,<prompt-2>} --priority-mech <priority mech address> --tools={<tool-1>,<tool-2>} --chain-config <chain_config>
@@ -237,6 +243,27 @@ or <br>
 mechx interact --prompts <prompt-1> --prompts <prompt-2> --priority-mech <priority mech address> --tools <tool-1> --tools <tool-2> --chain-config <chain_config>
 ```
 
+### List marketplace mechs
+To list the top marketplace mechs based on deliveries, use the `fetch-mm-mechs-info` command. You can specify the chain you want to query. Please note that only the first 20 mechs sorted by number of deliveries will be shown.
+Currently supported chains are gnosis and base
+```bash
+mechx fetch-mm-mechs-info --chain-config gnosis
+```
+```bash
++--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
+|   Service Id | Mech Type          | Mech Address                               |   Total Deliveries | Metadata Link                                                                                                 |
++==============+====================+============================================+====================+===============================================================================================================+
+|         2182 | Fixed Price Native | 0xc05e7412439bd7e91730a6880e18d5d5873f632c |              41246 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
++--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
+|         2235 | Fixed Price Native | 0xb3c6319962484602b00d5587e965946890b82101 |              10127 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
++--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
+|         2198 | Fixed Price Native | 0x601024e27f1c67b28209e24272ced8a31fc8151f |               5714 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
++--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
+|         1722 | Fixed Price Token  | 0x13f36b1a516290b7563b1de574a02ebeb48926a1 |                399 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
++--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
+|         2135 | Fixed Price Native | 0xbead38e4c4777341bb3fd44e8cd4d1ba1a7ad9d7 |                353 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
++--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
+```
 
 ### List tools available for legacy mechs and marketplace mechs
 
@@ -264,7 +291,7 @@ You will see an output like this:
 ```bash
 mechx tools-for-agents --agent-id "agent_id"
 ```
-Eaxmple usage 
+Eaxmple usage
 ```bash
 mechx tools-for-agents --agent-id 6
 ```
@@ -522,7 +549,7 @@ This script will:
 
 #### For Mechs receiving requests via the Mech Marketplace
 
-In this case, the script is the same, except for the function result. When this function has no argument agent_id, 
+In this case, the script is the same, except for the function result. When this function has no argument agent_id,
 the request is sent to the Mech Marketplace. The target Mech to which the request is relayed should be in the chain_config file (key `priority_mech_address`).
 
 ## Developer installation

mech_client-0.11.0/mech_client/__init__.py

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

{mech_client-0.10.0 → mech_client-0.11.0}/mech_client/cli.py

@@ -29,9 +29,11 @@ from tabulate import tabulate  # type: ignore
 from mech_client import __version__
 from mech_client.interact import ConfirmationType
 from mech_client.interact import interact as interact_
+from mech_client.marketplace_interact import IPFS_URL_TEMPLATE
 from mech_client.marketplace_interact import (
     marketplace_interact as marketplace_interact_,
 )
+from mech_client.mech_marketplace_subgraph import query_mm_mechs_info
 from mech_client.mech_marketplace_tool_management import (
     extract_input_schema,
     extract_output_schema,
@@ -515,6 +517,54 @@ def nvm_subscribe(
     nvm_subscribe_main(private_key_path=key, chain_config=chain_config)
 
 
+@click.command(name="fetch-mm-mechs-info")
+@click.option(
+    "--chain-config",
+    type=str,
+    help="Id of the mech's chain configuration (stored configs/mechs.json)",
+)
+def query_mm_mechs_info_cli(
+    chain_config: str,
+) -> None:
+    """Fetches info of mm mechs"""
+    try:
+        mech_list = query_mm_mechs_info(chain_config=chain_config)
+        if mech_list is None:
+            print("No mechs found")
+            return None
+
+        headers = [
+            "Service Id",
+            "Mech Type",
+            "Mech Address",
+            "Total Deliveries",
+            "Metadata Link",
+        ]
+
+        data = [
+            (
+                items["service"]["id"],
+                items["mech_type"],
+                items["address"],
+                items["service"]["totalDeliveries"],
+                (
+                    IPFS_URL_TEMPLATE.format(
+                        items["service"]["metadata"]["metadata"][2:]
+                    )
+                    if items["service"].get("metadata") is not None
+                    else None
+                ),
+            )
+            for items in mech_list
+        ]
+
+        click.echo(tabulate(data, headers=headers, tablefmt="grid"))
+        return None
+    except Exception as e:  # pylint: disable=broad-except
+        click.echo(f"Error: {str(e)}")
+        return None
+
+
 cli.add_command(interact)
 cli.add_command(prompt_to_ipfs)
 cli.add_command(push_to_ipfs)
@@ -528,6 +578,7 @@ cli.add_command(tool_description_for_marketplace_mech)
 cli.add_command(deposit_native)
 cli.add_command(deposit_token)
 cli.add_command(nvm_subscribe)
+cli.add_command(query_mm_mechs_info_cli)
 
 
 if __name__ == "__main__":

{mech_client-0.10.0 → mech_client-0.11.0}/mech_client/configs/mechs.json

@@ -16,7 +16,7 @@
         "gas_limit": 500000,
         "price": 10000000000000000,
         "transaction_url": "https://gnosisscan.io/tx/{transaction_digest}",
-        "subgraph_url": ""
+        "subgraph_url": "https://api.studio.thegraph.com/query/89372/olas-gnosis-mech-marketplace/v0.0.2"
     },
     "arbitrum": {
         "agent_registry_contract": "0xa4799B083E0068732456EF45ff9fe5c683658327",
@@ -73,7 +73,7 @@
         "gas_limit": 500000,
         "price": 3000000000000,
         "transaction_url": "https://basescan.org/tx/{transaction_digest}",
-        "subgraph_url": ""
+        "subgraph_url": "https://api.studio.thegraph.com/query/89372/olas-base-mech-marketplace/v0.0.2"
     },
     "celo": {
         "agent_registry_contract": "0xE49CB081e8d96920C38aA7AB90cb0294ab4Bc8EA",

mech_client-0.11.0/mech_client/mech_marketplace_subgraph.py

@@ -0,0 +1,94 @@
+# -*- 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.
+#
+# ------------------------------------------------------------------------------
+
+"""Subgraph client for mech."""
+
+from typing import List, Optional
+
+from gql import Client, gql
+from gql.transport.aiohttp import AIOHTTPTransport
+
+from mech_client.interact import get_mech_config
+
+
+RESULTS_LIMIT = 20
+CHAIN_TO_MECH_FACTORY_TO_MECH_TYPE = {
+    "gnosis": {
+        "0x8b299c20F87e3fcBfF0e1B86dC0acC06AB6993EF": "Fixed Price Native",
+        "0x31ffDC795FDF36696B8eDF7583A3D115995a45FA": "Fixed Price Token",
+        "0x65fd74C29463afe08c879a3020323DD7DF02DA57": "NvmSubscription Native",
+    },
+    "base": {
+        "0x2E008211f34b25A7d7c102403c6C2C3B665a1abe": "Fixed Price Native",
+        "0x97371B1C0cDA1D04dFc43DFb50a04645b7Bc9BEe": "Fixed Price Token",
+        "0x847bBE8b474e0820215f818858e23F5f5591855A": "NvmSubscription Native",
+        "0x7beD01f8482fF686F025628e7780ca6C1f0559fc": "NvmSubscription Token USDC",
+    },
+}
+
+
+MM_MECHS_INFO_QUERY = """
+query MechsOrderedByServiceDeliveries {
+  meches(orderBy: service__totalDeliveries, orderDirection: desc) {
+    address
+    mechFactory
+    service {
+      id
+      totalDeliveries
+      metadata {
+        metadata
+      }
+    }
+  }
+}
+"""
+
+DEFAULT_TIMEOUT = 600.0
+
+
+def query_mm_mechs_info(chain_config: str) -> Optional[List]:
+    """
+    Query MM mechs and related info from subgraph.
+
+    :param chain_config: Id of the mech's chain configuration (stored configs/mechs.json)
+    :type chain_config: str
+    :return: The return list of data if found, None otherwise.
+    :rtype: Optional[List]
+    """
+    mech_config = get_mech_config(chain_config)
+    if not mech_config.subgraph_url:
+        raise Exception(f"Subgraph URL not set for chain config: {chain_config}")
+
+    client = Client(
+        transport=AIOHTTPTransport(url=mech_config.subgraph_url),
+        execute_timeout=DEFAULT_TIMEOUT,
+    )
+    response = client.execute(document=gql(request_string=MM_MECHS_INFO_QUERY))
+
+    mech_factory_to_mech_type = {
+        k.lower(): v
+        for k, v in CHAIN_TO_MECH_FACTORY_TO_MECH_TYPE[chain_config].items()
+    }
+    filtered_mechs_data = []
+    for item in response["meches"]:  # pylint: disable=unsubscriptable-object
+        if item.get("service") and int(item["service"]["totalDeliveries"]) > 0:
+            item["mech_type"] = mech_factory_to_mech_type[item["mechFactory"].lower()]
+            filtered_mechs_data.append(item)
+
+    return filtered_mechs_data[:RESULTS_LIMIT]

{mech_client-0.10.0 → mech_client-0.11.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mech-client"
-version = "0.10.0"
+version = "0.11.0"
 description = "Basic client to interact with a mech"
 authors = ["David Minarsch <david.minarsch@googlemail.com>"]
 readme = "README.md"

mech_client-0.10.0/mech_client/__init__.py

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