Merge pull request #73 from valory-xyz/updates/readme

Updates/readme

Author: Adamantios

README.md

@@ -98,6 +98,22 @@ The EOA you use must have enough funds to pay for the Mech requests, or alternat
 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
@@ -164,12 +180,19 @@ Data from agent: {'requestId': 1004074058566339663950817114309409628095686850319
 With the Mech Marketplace, the basic usage of the Mech Client is as follows.
 
 ```bash
-mechx interact <prompt> --chain-config <chain_config>
+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>
 ```
 
-The Mech agent which corresponds to the `priority_mech_address` in `<chain_config>` will process `<prompt>` with the default options. Additionally to other options which are the same as for legacy Mechs, this usage has the following option:
+Additionally to other options which are the same as for legacy Mechs, this usage has the following option:
 
-`--use-offchain <bool>`: use the off-chain method to send requests to a Mech via the Mech Marketplace. Set to False in order to use the on-chain method.
+`--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
 

mech_client/marketplace_interact.py

@@ -48,7 +48,6 @@
     calculate_topic_id,
     get_contract,
     get_mech_config,
-    verify_or_retrieve_tool,
 )
 from mech_client.prompt_to_ipfs import push_metadata_to_ipfs
 from mech_client.wss import (
@@ -621,7 +620,7 @@ def marketplace_interact(  # pylint: disable=too-many-arguments, too-many-locals
     priority_mech: str,
     use_prepaid: bool = False,
     use_offchain: bool = False,
-    tool: Optional[str] = None,
+    tool: str = "",
     extra_attributes: Optional[Dict[str, Any]] = None,
     private_key_path: Optional[str] = None,
     confirmation_type: ConfirmationType = ConfirmationType.WAIT_FOR_BOTH,
@@ -642,7 +641,7 @@ def marketplace_interact(  # pylint: disable=too-many-arguments, too-many-locals
     :param use_offchain: Whether to use offchain model or not.
     :type use_offchain: bool
     :param tool: The tool to interact with (optional).
-    :type tool: Optional[str]
+    :type tool: str
     :param extra_attributes: Extra attributes to be included in the request metadata (optional).
     :type extra_attributes: Optional[Dict[str, Any]]
     :param private_key_path: The path to the private key file (optional).
@@ -715,7 +714,7 @@ def marketplace_interact(  # pylint: disable=too-many-arguments, too-many-locals
     )
     (
         payment_type,
-        service_id,
+        _,
         max_delivery_rate,
         mech_payment_balance_tracker,
         mech_contract,
@@ -727,16 +726,6 @@ def marketplace_interact(  # pylint: disable=too-many-arguments, too-many-locals
     mech_marketplace_request_config.delivery_rate = max_delivery_rate
     mech_marketplace_request_config.payment_type = payment_type
 
-    # Expected parameters: agent id and agent registry contract address
-    # Note: passing service id and service registry contract address as internal function calls are same
-    tool = verify_or_retrieve_tool(
-        agent_id=cast(int, service_id),
-        ledger_api=ledger_api,
-        tool=tool,
-        agent_registry_contract=mech_config.service_registry_contract,
-        contract_abi_url=mech_config.contract_abi_url,
-    )
-
     (
         marketplace_request_event_signature,
         marketplace_deliver_event_signature,