mech-client 0.2.21__tar.gz → 0.4.0__tar.gz

{mech_client-0.2.21 → mech_client-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mech-client
-Version: 0.2.21
+Version: 0.4.0
 Summary: Basic client to interact with a mech
 License: Apache-2.0
 Author: David Minarsch
@@ -16,7 +16,6 @@ Requires-Dist: open-aea-cli-ipfs (>=1.53.0,<2.0.0)
 Requires-Dist: open-aea-ledger-cosmos (>=1.53.0,<2.0.0)
 Requires-Dist: open-aea-ledger-ethereum (>=1.53.0,<2.0.0)
 Requires-Dist: open-aea[cli] (>=1.53.0,<2.0.0)
-Requires-Dist: setuptools (>=75.8.0,<76.0.0)
 Requires-Dist: tabulate (>=0.9.0,<0.10.0)
 Requires-Dist: websocket-client (>=0.32.0,<1)
 Description-Content-Type: text/markdown
@@ -118,14 +117,33 @@ The EOA you use must have enough funds to pay for the Mech requests, or alternat
 
 ### Select the mech you are going to send requests to
 
-Mechs are deployed to several networks. Find the list of supported networks and corresponging mech addresses [here](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-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, 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:
+
+1. Sign up or log in 
+2. Go to API Dashboard on the left menu
+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.
+
+```bash
+export MECHX_API_KEY=<your api key>
+```
 
 ### Generate Mech requests
 
+#### Legacy Mechs
+
 The basic usage of the Mech Client is as follows:
 
 ```bash
-mechx interact <prompt> <agent_id>
+mechx interact <prompt> --agent_id <agent_id>
 ```
 
 where agent with `<agent_id>` will process `<prompt>` with the 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).
@@ -164,7 +182,7 @@ Some useful options:
 Example of a request specifying a key file and tool:
 
 ```bash
-mechx interact "write a short poem" 6 --key ~/ethereum_private_key.txt --tool openai-gpt-3.5-turbo --chain-config gnosis --confirm on-chain
+mechx interact "write a short poem" --agent_id 6 --key ~/ethereum_private_key.txt --tool openai-gpt-3.5-turbo --chain-config gnosis --confirm on-chain
 ```
 
 You will see an output like this:
@@ -179,6 +197,24 @@ Data arrived: https://gateway.autonolas.tech/ipfs/f01701220a462120d5bb03f406fa5e
 Data from agent: {'requestId': 100407405856633966395081711430940962809568685031934329025999216833965518452765, 'result': "In a world of chaos and strife,\nThere's beauty in the simplest of life.\nA gentle breeze whispers through the trees,\nAnd birds sing melodies with ease.\n\nThe sun sets in a fiery hue,\nPainting the sky in shades of blue.\nStars twinkle in the darkness above,\nGuiding us with their light and love.\n\nSo take a moment to pause and see,\nThe wonders of this world so free.\nEmbrace the joy that each day brings,\nAnd let your heart soar on gentle wings.", 'prompt': 'write a short poem', 'cost_dict': {}, 'metadata': {'model': None, 'tool': 'openai-gpt-3.5-turbo'}}
 ```
 
+#### With the Mech Marketplace
+
+With the Mech Marketplace, the basic usage of the Mech Client is as follows.
+
+```bash
+mechx interact <prompt> --tool openai-gpt-3.5-turbo --chain-config <chain_config>
+```
+
+To use a custom mech to send requests to, use the  `priority-mech` flag while sending the requests
+
+```bash
+mechx interact <prompt> --priority-mech <priority mech address> --tool openai-gpt-3.5-turbo --chain-config <chain_config>
+```
+
+Additionally to other options which are the same as for legacy Mechs, this usage has the following option:
+
+`--use-prepaid <bool>`: use the prepaid method to send requests to a Mech via the Mech Marketplace. Defaults to False.
+`--use-offchain <bool>`: use the off-chain method to send requests to a Mech via the Mech Marketplace. Defaults to False.
 
 ### List tools available for agents
 
@@ -290,6 +326,8 @@ Output Schema:
 
 ### Chain configuration
 
+#### For legacy Mechs
+
 Default configurations for different chains are stored in the file [configs/mechs.json](./mech_client/configs/mechs.json). If `--chain-config` parameter is not specified, the Mech Client will choose the first configuration on the JSON.
 
 Additionally, you can override any configuration parameter by exporting any of the following environment variables:
@@ -382,6 +420,11 @@ This script will:
 - Retrieve and display the description of a specific tool using its unique identifier.
 - Retrieve and display the input and output schema of a specific tool using its unique identifier.
 
+#### 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, 
+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
 
 To setup the development environment for this project, clone the repository and run the following commands:

{mech_client-0.2.21 → mech_client-0.4.0}/README.md

@@ -95,14 +95,33 @@ The EOA you use must have enough funds to pay for the Mech requests, or alternat
 
 ### Select the mech you are going to send requests to
 
-Mechs are deployed to several networks. Find the list of supported networks and corresponging mech addresses [here](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-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, 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:
+
+1. Sign up or log in 
+2. Go to API Dashboard on the left menu
+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.
+
+```bash
+export MECHX_API_KEY=<your api key>
+```
 
 ### Generate Mech requests
 
+#### Legacy Mechs
+
 The basic usage of the Mech Client is as follows:
 
 ```bash
-mechx interact <prompt> <agent_id>
+mechx interact <prompt> --agent_id <agent_id>
 ```
 
 where agent with `<agent_id>` will process `<prompt>` with the 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).
@@ -141,7 +160,7 @@ Some useful options:
 Example of a request specifying a key file and tool:
 
 ```bash
-mechx interact "write a short poem" 6 --key ~/ethereum_private_key.txt --tool openai-gpt-3.5-turbo --chain-config gnosis --confirm on-chain
+mechx interact "write a short poem" --agent_id 6 --key ~/ethereum_private_key.txt --tool openai-gpt-3.5-turbo --chain-config gnosis --confirm on-chain
 ```
 
 You will see an output like this:
@@ -156,6 +175,24 @@ Data arrived: https://gateway.autonolas.tech/ipfs/f01701220a462120d5bb03f406fa5e
 Data from agent: {'requestId': 100407405856633966395081711430940962809568685031934329025999216833965518452765, 'result': "In a world of chaos and strife,\nThere's beauty in the simplest of life.\nA gentle breeze whispers through the trees,\nAnd birds sing melodies with ease.\n\nThe sun sets in a fiery hue,\nPainting the sky in shades of blue.\nStars twinkle in the darkness above,\nGuiding us with their light and love.\n\nSo take a moment to pause and see,\nThe wonders of this world so free.\nEmbrace the joy that each day brings,\nAnd let your heart soar on gentle wings.", 'prompt': 'write a short poem', 'cost_dict': {}, 'metadata': {'model': None, 'tool': 'openai-gpt-3.5-turbo'}}
 ```
 
+#### With the Mech Marketplace
+
+With the Mech Marketplace, the basic usage of the Mech Client is as follows.
+
+```bash
+mechx interact <prompt> --tool openai-gpt-3.5-turbo --chain-config <chain_config>
+```
+
+To use a custom mech to send requests to, use the  `priority-mech` flag while sending the requests
+
+```bash
+mechx interact <prompt> --priority-mech <priority mech address> --tool openai-gpt-3.5-turbo --chain-config <chain_config>
+```
+
+Additionally to other options which are the same as for legacy Mechs, this usage has the following option:
+
+`--use-prepaid <bool>`: use the prepaid method to send requests to a Mech via the Mech Marketplace. Defaults to False.
+`--use-offchain <bool>`: use the off-chain method to send requests to a Mech via the Mech Marketplace. Defaults to False.
 
 ### List tools available for agents
 
@@ -267,6 +304,8 @@ Output Schema:
 
 ### Chain configuration
 
+#### For legacy Mechs
+
 Default configurations for different chains are stored in the file [configs/mechs.json](./mech_client/configs/mechs.json). If `--chain-config` parameter is not specified, the Mech Client will choose the first configuration on the JSON.
 
 Additionally, you can override any configuration parameter by exporting any of the following environment variables:
@@ -359,6 +398,11 @@ This script will:
 - Retrieve and display the description of a specific tool using its unique identifier.
 - Retrieve and display the input and output schema of a specific tool using its unique identifier.
 
+#### 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, 
+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
 
 To setup the development environment for this project, clone the repository and run the following commands:

mech_client-0.4.0/mech_client/__init__.py

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