mech-client 0.2.21__py3-none-any.whl → 0.3.0__py3-none-any.whl

mech_client/wss.py

@@ -143,6 +143,36 @@ def watch_for_request_id(  # pylint: disable=too-many-arguments
         return request_id
 
 
+def watch_for_marketplace_request_id(  # pylint: disable=too-many-arguments, unused-argument
+    marketplace_contract: Web3Contract,
+    ledger_api: EthereumApi,
+    tx_hash: str,
+) -> str:
+    """
+    Watches for events on mech.
+
+    :param marketplace_contract: The marketplace contract instance.
+    :type marketplace_contract: Web3Contract
+    :param ledger_api: The Ethereum API used for interacting with the ledger.
+    :type ledger_api: EthereumApi
+    :param tx_hash: Tx hash to wait for
+    :type tx_hash: str
+    :return: The requested ID.
+    :rtype: str
+    """
+    while True:
+        tx_receipt = wait_for_receipt(tx_hash=tx_hash, ledger_api=ledger_api)
+
+        rich_logs = marketplace_contract.events.MarketplaceRequest().process_receipt(
+            tx_receipt
+        )
+        if len(rich_logs) == 0:
+            return "Empty Logs"
+
+        request_id = rich_logs[0]["args"]["requestIds"][0]
+        return request_id.hex()
+
+
 async def watch_for_data_url_from_wss(  # pylint: disable=too-many-arguments
     request_id: str,
     wss: websocket.WebSocket,
@@ -193,3 +223,62 @@ async def watch_for_data_url_from_wss(  # pylint: disable=too-many-arguments
                 "Error: The WSS connection was likely closed by the remote party. Please, try using another WSS provider."
             )
             return None
+
+
+async def watch_for_marketplace_data_url_from_wss(  # pylint: disable=too-many-arguments, unused-argument
+    request_id: str,
+    wss: websocket.WebSocket,
+    mech_contract: Web3Contract,
+    deliver_signature: str,
+    ledger_api: EthereumApi,
+    loop: asyncio.AbstractEventLoop,
+) -> Any:
+    """
+    Watches for data on-chain.
+
+    :param request_id: The ID of the request.
+    :type request_id: str
+    :param wss: The WebSocket connection object.
+    :type wss: websocket.WebSocket
+    :param mech_contract: The mech contract instance.
+    :type mech_contract: Web3Contract
+    :param deliver_signature: Topic signature for Deliver event
+    :type deliver_signature: str
+    :param ledger_api: The Ethereum API used for interacting with the ledger.
+    :type ledger_api: EthereumApi
+    :param loop: The event loop used for asynchronous operations.
+    :type loop: asyncio.AbstractEventLoop
+    :return: The data received from on-chain.
+    :rtype: Any
+    """
+    with ThreadPoolExecutor() as executor:
+        try:
+            while True:
+                msg = await loop.run_in_executor(executor=executor, func=wss.recv)
+                data = json.loads(msg)
+                tx_hash = data["params"]["result"]["transactionHash"]
+                tx_receipt = await loop.run_in_executor(
+                    executor, wait_for_receipt, tx_hash, ledger_api
+                )
+
+                rich_logs = mech_contract.events.Deliver().process_receipt(tx_receipt)
+                if len(rich_logs) == 0:
+                    print("Empty logs")
+                    return None
+
+                data = rich_logs[0]["args"]
+                tx_request_id = data["requestId"]
+                deliver_data = data["data"]
+
+                if request_id != tx_request_id.hex():
+                    continue
+
+                return (
+                    f"https://gateway.autonolas.tech/ipfs/f01701220{deliver_data.hex()}"
+                )
+        except websocket.WebSocketConnectionClosedException as e:
+            print(f"WebSocketConnectionClosedException {repr(e)}")
+            print(
+                "Error: The WSS connection was likely closed by the remote party. Please, try using another WSS provider."
+            )
+            return None

{mech_client-0.2.21.dist-info → mech_client-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mech-client
-Version: 0.2.21
+Version: 0.3.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.dist-info → mech_client-0.3.0.dist-info}/RECORD

@@ -1,8 +1,16 @@
-mech_client/__init__.py,sha256=XYldmBbSu5oGgmBiVbWa2eQ1MXbFxzTpbi9zVl9wt5c,43
+mech_client/__init__.py,sha256=Fv_rB4SSlUfKkC4yVa0VynPADc604qwxEG5c-jAgNic,42
+mech_client/abis/BalanceTrackerFixedPriceNative.json,sha256=MF5jDqSMoZztvMV4oc5ij-Qn1DAZ1Nyz9EOFRb9wSQ0,12478
+mech_client/abis/BalanceTrackerFixedPriceToken.json,sha256=kaXgResUkAb6u9bVTS3T_SNRPRP76hi-jTAhMiYwq4U,12408
+mech_client/abis/BalanceTrackerNvmSubscriptionNative.json,sha256=D23ibyhDsn4vjozFvzcKw-7wJpGM-R5GiqlcmyBIpcY,16536
+mech_client/abis/IERC1155.json,sha256=2xOx44MrKRk5oDEZ8PhCUgW7A4puK-GQizPKff-Fn1E,7459
+mech_client/abis/IMech.json,sha256=km0NMRyqBYh3jBQwPJCispsRfPwqNJ67kkZwYjuJci4,3989
+mech_client/abis/IToken.json,sha256=VrzR6Rr1DmrUzy5DygN1rKm6df4ir2KGdWsunZnuRKo,19637
+mech_client/abis/MechMarketplace.json,sha256=auKTxPTi07yD98Gz2RuwH1Gq5qRCyy8-C7QBNj3uto8,32104
 mech_client/acn.py,sha256=Rj_jLPvJ5loDQfGbu3a_O24cJC4SwIErLceSz_zVYS8,5356
-mech_client/cli.py,sha256=cJ3QAP29QsbsyITVZbCVxZ7378ql2VPaEjar9Iotj0U,9555
-mech_client/configs/mechs.json,sha256=PssCmIWetrZaC5v1hD0ynSqc53VG2kIXxLLMOQjWeNE,4727
-mech_client/helpers/__init__.py,sha256=f13zpwGDaKQUjML-5Iq66rRfzg8IS5UNK5I8gBr7w54,1028
+mech_client/cli.py,sha256=PWkUBwirP8DMxNG-lYmh-QAJhNPX_k6yCtfjTh7iXs8,11322
+mech_client/configs/mechs.json,sha256=ihF23WakBh1Jbnb45OJvPjDzZ572eud3s0Gx4qNGWwQ,5699
+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
 mech_client/helpers/acn/__init__.py,sha256=3Yd1hUTcrtp0Kb1VmnOTC3_r-_69ozhzMqLlkNC6MkU,1141
 mech_client/helpers/acn/acn.proto,sha256=Ev0f8tQJjnTaK-mdpNLItVRgJ7VibtCeGBTcKz8nfX4,1543
@@ -30,15 +38,16 @@ 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=Paf8kne8sQbvEiCsiN9qC6sZWNqZqD1npVaOfT9vR6k,21219
+mech_client/interact.py,sha256=zQ7UhlnZOfM4hnZBaRQ5efkfw6Rl-s7Kh6lciyoZL70,22028
+mech_client/marketplace_interact.py,sha256=DgDU1xY2zJO3MfxkWNFtJ8iZkjGBfP8MYL4vAEDRKWE,31418
 mech_client/mech_tool_management.py,sha256=XWQDcFStTK66-3ZzOwKtMo5c66KDjvbeDsIXHIP4SuU,7810
 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=6hkF8l0qxWRJ0UcdxfML6JnjYBu5BuBA6EHsHJ2nHVI,5149
 mech_client/to_png.py,sha256=pjUcFJ63MJj_r73eqnfqCWMtlpsrj6H4ZmgvIEmRcFw,2581
-mech_client/wss.py,sha256=hRInQjjsyOrs8dmgBb2VpJvpNt6Tx0aEiY3OhOPQvIs,6600
-mech_client-0.2.21.dist-info/LICENSE,sha256=mdBDB-mWKV5Cz4ejBzBiKqan6Z8zVLAh9xwM64O2FW4,11339
-mech_client-0.2.21.dist-info/METADATA,sha256=cPQGseRA8LKUQVnkmtHx5Fifs1YijfTMK7AJ3GMW76k,17727
-mech_client-0.2.21.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-mech_client-0.2.21.dist-info/entry_points.txt,sha256=SbRMRsayzD8XfNXhgwPuXEqQsdZ5Bw9XDPnUuaDExyY,45
-mech_client-0.2.21.dist-info/RECORD,,
+mech_client/wss.py,sha256=toD_9-gNsQAoK13Zh5mQCKbmkT2Gcqz5XaNiUGyb5Js,9801
+mech_client-0.3.0.dist-info/LICENSE,sha256=mdBDB-mWKV5Cz4ejBzBiKqan6Z8zVLAh9xwM64O2FW4,11339
+mech_client-0.3.0.dist-info/METADATA,sha256=2YFbNhpBXix_HZBGf-CSW7wspGdH53EQjqWjUK6PBLc,19911
+mech_client-0.3.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+mech_client-0.3.0.dist-info/entry_points.txt,sha256=SbRMRsayzD8XfNXhgwPuXEqQsdZ5Bw9XDPnUuaDExyY,45
+mech_client-0.3.0.dist-info/RECORD,,