mech-client 0.6.0__tar.gz → 0.8.0__tar.gz

{mech_client-0.6.0 → mech_client-0.8.0}/PKG-INFO

@@ -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 → mech_client-0.8.0}/README.md

@@ -93,12 +93,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:
@@ -116,6 +110,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:
@@ -198,7 +197,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.
 
@@ -226,8 +228,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
@@ -268,8 +271,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
@@ -285,9 +308,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
@@ -327,6 +367,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.8.0/mech_client/__init__.py

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

mech_client-0.8.0/mech_client/abis/ComplementaryServiceMetadata.json

@@ -0,0 +1,185 @@
+[
+    {
+        "inputs": [
+            {
+                "internalType": "address",
+                "name": "_serviceRegistry",
+                "type": "address"
+            }
+        ],
+        "stateMutability": "nonpayable",
+        "type": "constructor"
+    },
+    {
+        "inputs": [],
+        "name": "ReentrancyGuard",
+        "type": "error"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "address",
+                "name": "account",
+                "type": "address"
+            }
+        ],
+        "name": "UnauthorizedAccount",
+        "type": "error"
+    },
+    {
+        "inputs": [],
+        "name": "ZeroAddress",
+        "type": "error"
+    },
+    {
+        "anonymous": false,
+        "inputs": [
+            {
+                "indexed": true,
+                "internalType": "uint256",
+                "name": "serviceId",
+                "type": "uint256"
+            },
+            {
+                "indexed": true,
+                "internalType": "bytes32",
+                "name": "hash",
+                "type": "bytes32"
+            }
+        ],
+        "name": "ComplementaryMetadataUpdated",
+        "type": "event"
+    },
+    {
+        "inputs": [],
+        "name": "CID_PREFIX",
+        "outputs": [
+            {
+                "internalType": "string",
+                "name": "",
+                "type": "string"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [],
+        "name": "VERSION",
+        "outputs": [
+            {
+                "internalType": "string",
+                "name": "",
+                "type": "string"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [],
+        "name": "baseURI",
+        "outputs": [
+            {
+                "internalType": "string",
+                "name": "",
+                "type": "string"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "uint256",
+                "name": "serviceId",
+                "type": "uint256"
+            },
+            {
+                "internalType": "bytes32",
+                "name": "hash",
+                "type": "bytes32"
+            }
+        ],
+        "name": "changeHash",
+        "outputs": [],
+        "stateMutability": "nonpayable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "address",
+                "name": "account",
+                "type": "address"
+            },
+            {
+                "internalType": "uint256",
+                "name": "serviceId",
+                "type": "uint256"
+            }
+        ],
+        "name": "isAbleChangeHash",
+        "outputs": [
+            {
+                "internalType": "bool",
+                "name": "",
+                "type": "bool"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "uint256",
+                "name": "",
+                "type": "uint256"
+            }
+        ],
+        "name": "mapServiceHashes",
+        "outputs": [
+            {
+                "internalType": "bytes32",
+                "name": "",
+                "type": "bytes32"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [],
+        "name": "serviceRegistry",
+        "outputs": [
+            {
+                "internalType": "address",
+                "name": "",
+                "type": "address"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "uint256",
+                "name": "serviceId",
+                "type": "uint256"
+            }
+        ],
+        "name": "tokenURI",
+        "outputs": [
+            {
+                "internalType": "string",
+                "name": "",
+                "type": "string"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    }
+]