mech-client 0.2.12__py3-none-any.whl → 0.2.13__py3-none-any.whl

mech_client/configs/mechs.json

@@ -12,6 +12,7 @@
         },
         "gas_limit": 100000,
         "contract_abi_url": "https://gnosis.blockscout.com/api/v2/smart-contracts/{contract_address}",
+        "transaction_url": "https://gnosisscan.io/tx/{transaction_digest}",
         "subgraph_url": "https://api.studio.thegraph.com/query/57238/mech/version/latest"
     },
     "arbitrum": {
@@ -27,6 +28,7 @@
         },
         "gas_limit": 100000,
         "contract_abi_url": "https://api.arbiscan.io/api?module=contract&action=getabi&address={contract_address}",
+        "transaction_url": "https://arbiscan.io/tx/{transaction_digest}",
         "subgraph_url": ""
     },
     "polygon": {
@@ -42,6 +44,7 @@
         },
         "gas_limit": 100000,
         "contract_abi_url": "https://api.polygonscan.com/api?module=contract&action=getabi&address={contract_address}",
+        "transaction_url": "https://polygonscan.com/tx/{transaction_digest}",
         "subgraph_url": ""
     },
     "base": {
@@ -57,6 +60,7 @@
         },
         "gas_limit": 100000,
         "contract_abi_url": "https://api.basescan.org/api?module=contract&action=getabi&address={contract_address}",
+        "transaction_url": "https://basescan.org/tx/{transaction_digest}",
         "subgraph_url": ""
     },
     "celo": {
@@ -66,12 +70,13 @@
         "ledger_config": {
             "address": "https://forno.celo.org",
             "chain_id": 42220,
-            "poa_chain": false,
+            "poa_chain": true,
             "default_gas_price_strategy": "eip1559",
             "is_gas_estimation_enabled": false
         },
-        "gas_limit": 100000,
+        "gas_limit": 250000,
         "contract_abi_url": "https://api.celoscan.io/api?module=contract&action=getabi&address={contract_address}",
+        "transaction_url": "https://celoscan.io/tx/{transaction_digest}",
         "subgraph_url": ""
     },
     "optimism": {
@@ -87,6 +92,7 @@
         },
         "gas_limit": 100000,
         "contract_abi_url": "https://api-optimistic.etherscan.io/api?module=contract&action=getabi&address={contract_address}",
+        "transaction_url": "https://optimistic.etherscan.io/tx/{transaction_digest}",
         "subgraph_url": ""
     }
 }

mech_client/interact.py

@@ -101,7 +101,7 @@ class LedgerConfig:
 
 
 @dataclass
-class MechConfig:
+class MechConfig:  # pylint: disable=too-many-instance-attributes
     """Mech configuration"""
 
     agent_registry_contract: str
@@ -110,6 +110,7 @@ class MechConfig:
     ledger_config: LedgerConfig
     gas_limit: int
     contract_abi_url: str
+    transaction_url: str
     subgraph_url: str
 
     def __post_init__(self) -> None:
@@ -134,6 +135,10 @@ class MechConfig:
         if contract_abi_url:
             self.contract_abi_url = contract_abi_url
 
+        transaction_url = os.getenv("MECHX_TRANSACTION_URL")
+        if transaction_url:
+            self.transaction_url = transaction_url
+
         subgraph_url = os.getenv("MECHX_SUBGRAPH_URL")
         if subgraph_url:
             self.subgraph_url = subgraph_url
@@ -396,7 +401,6 @@ def send_request(  # pylint: disable=too-many-arguments,too-many-locals
                 signed_transaction,
                 raise_on_try=True,
             )
-            print(f"Transaction sent: https://gnosisscan.io/tx/{transaction_digest}")
             return transaction_digest
         except Exception as e:  # pylint: disable=broad-except
             print(
@@ -462,12 +466,16 @@ def wait_for_data_url(  # pylint: disable=too-many-arguments
                 loop=loop,
             )
         )
-        mech_task = loop.create_task(
-            watch_for_data_url_from_subgraph(request_id=request_id, url=subgraph_url)
-        )
-        tasks.append(mech_task)
         tasks.append(on_chain_task)
 
+        if subgraph_url:
+            mech_task = loop.create_task(
+                watch_for_data_url_from_subgraph(
+                    request_id=request_id, url=subgraph_url
+                )
+            )
+            tasks.append(mech_task)
+
     async def _wait_for_tasks() -> Any:  # type: ignore
         """Wait for tasks to finish."""
         (finished, *_), unfinished = await asyncio.wait(
@@ -476,7 +484,8 @@ def wait_for_data_url(  # pylint: disable=too-many-arguments
         )
         for task in unfinished:
             task.cancel()
-        await asyncio.wait(unfinished)
+        if unfinished:
+            await asyncio.wait(unfinished)
         return finished.result()
 
     result = loop.run_until_complete(_wait_for_tasks())
@@ -564,7 +573,8 @@ def interact(  # pylint: disable=too-many-arguments,too-many-locals
         request_signature=request_event_signature,
         deliver_signature=deliver_event_signature,
     )
-    send_request(
+    print("Sending request...")
+    transaction_digest = send_request(
         crypto=crypto,
         ledger_api=ledger_api,
         mech_contract=mech_contract,
@@ -576,6 +586,10 @@ def interact(  # pylint: disable=too-many-arguments,too-many-locals
         timeout=timeout,
         sleep=sleep,
     )
+    transaction_url_formatted = mech_config.transaction_url.format(
+        transaction_digest=transaction_digest
+    )
+    print(f"Transaction sent: {transaction_url_formatted}")
     print("Waiting for transaction receipt...")
     request_id = watch_for_request_id(
         wss=wss,
@@ -584,6 +598,7 @@ def interact(  # pylint: disable=too-many-arguments,too-many-locals
         request_signature=request_event_signature,
     )
     print(f"Created on-chain request with ID {request_id}")
+    print("Waiting for Mech response...")
     data_url = wait_for_data_url(
         request_id=request_id,
         wss=wss,
@@ -594,8 +609,9 @@ def interact(  # pylint: disable=too-many-arguments,too-many-locals
         crypto=crypto,
         confirmation_type=confirmation_type,
     )
-
-    print(f"Data arrived: {data_url}")
-    data = requests.get(f"{data_url}/{request_id}").json()
-    print(f"Data from agent: {data}")
-    return data
+    if data_url:
+        print(f"Data arrived: {data_url}")
+        data = requests.get(f"{data_url}/{request_id}").json()
+        print(f"Data from agent: {data}")
+        return data
+    return None

mech_client/wss.py

@@ -170,19 +170,26 @@ async def watch_for_data_url_from_wss(  # pylint: disable=too-many-arguments
     :rtype: Any
     """
     with ThreadPoolExecutor() as executor:
-        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
+        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
+                )
+                event_signature = tx_receipt["logs"][0]["topics"][0].hex()
+                if event_signature != deliver_signature:
+                    continue
+
+                rich_logs = mech_contract.events.Deliver().process_receipt(tx_receipt)
+                data = cast(bytes, rich_logs[0]["args"]["data"])
+                if request_id != str(rich_logs[0]["args"]["requestId"]):
+                    continue
+                return f"https://gateway.autonolas.tech/ipfs/f01701220{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."
             )
-            event_signature = tx_receipt["logs"][0]["topics"][0].hex()
-            if event_signature != deliver_signature:
-                continue
-
-            rich_logs = mech_contract.events.Deliver().process_receipt(tx_receipt)
-            data = cast(bytes, rich_logs[0]["args"]["data"])
-            if request_id != str(rich_logs[0]["args"]["requestId"]):
-                continue
-            return f"https://gateway.autonolas.tech/ipfs/f01701220{data.hex()}"
+            return None

mech_client-0.2.13.dist-info/METADATA

@@ -0,0 +1,293 @@
+Metadata-Version: 2.1
+Name: mech-client
+Version: 0.2.13
+Summary: Basic client to interact with a mech
+License: Apache-2.0
+Author: David Minarsch
+Author-email: david.minarsch@googlemail.com
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: asn1crypto (>=1.4.0,<1.5.0)
+Requires-Dist: gql (>=3.4.1)
+Requires-Dist: open-aea-cli-ipfs (==1.50.0)
+Requires-Dist: open-aea-ledger-cosmos (==1.50.0)
+Requires-Dist: open-aea-ledger-ethereum (==1.50.0)
+Requires-Dist: open-aea[cli] (==1.50.0)
+Requires-Dist: websocket-client (>=0.32.0,<1)
+Description-Content-Type: text/markdown
+
+# Mech Client
+
+A basic client to interact with an AI Mech. [AI Mechs](https://github.com/valory-xyz/mech) allow users to post requests for AI tasks on-chain, and get their result delivered.
+
+> **:warning: Warning** <br />
+> **This is a *hacky* alpha version of the client. Don't rely on it as production software.**
+
+## Requirements
+
+- Python >=3.10
+
+## Installation
+
+Find the latest available release on [PyPi](https://pypi.org/project/mech-client/#description).
+
+We recommend that you create a virtual Python environment using [Poetry](https://python-poetry.org/). Set up your virtual environment as follows:
+
+```bash
+poetry new my_project
+cd my_project
+poetry shell
+poetry add mech-client
+```
+
+Alternatively, you can also install the Mech Client in your local Python installation:
+
+```bash
+pip install mech-client
+```
+
+If you require to use the Mech Client programmatically, please see [this section](#programmatic-usage) below.
+
+## CLI Usage
+
+Display the available options:
+
+```bash
+mechx --help
+```
+
+```bash
+Usage: mechx [OPTIONS] COMMAND [ARGS]...
+
+  Command-line tool for interacting with mechs.
+
+Options:
+  --version  Show the version and exit.
+  --help     Show this message and exit.
+
+Commands:
+  interact        Interact with a mech specifying a prompt and tool.
+  prompt-to-ipfs  Upload a prompt and tool to IPFS as metadata.
+  push-to-ipfs    Upload a file to IPFS.
+  to-png          Convert a stability AI API's diffusion model output...
+ ```
+
+### Set up the EOA and private key
+
+To use the Mech Client you need an EOA account and its associated private key stored in a text file `ethereum_private_key.txt`. You can set it up in two ways:
+
+- Use any software of your choice (e.g., [Metamask](https://metamask.io/)) and copy the private key:
+
+  ```bash
+  echo -n YOUR_PRIVATE_KEY > ethereum_private_key.txt
+  ```
+
+  Do not include any leading or trailing spaces, tabs or newlines, or any other character in the file `ethereum_private_key.txt`.
+
+- Alternatively, use the Open AEA command `generate-key` (you'll need to install [Open AEA](https://pypi.org/project/open-aea/) and its [Ethereum ledger plugin](https://pypi.org/project/open-aea-ledger-ethereum/)):
+
+  ```bash
+  aea generate-key ethereum
+  ```
+
+  and display the corresponding EOA:
+
+  ```bash
+  python -c "from web3 import Web3; print(Web3().eth.account.from_key(open('ethereum_private_key.txt').read()).address)"
+  ```
+
+The EOA you use must have enough funds to pay for the Mech requests, or alternatively, use a Nevermined subscription.
+
+> **:warning: Warning** <br />
+> * **If the generated EOA account is for development purposes, make sure it does not contain large amounts of funds.**
+>
+> * **If you store the key file in a local Git repository, we recommend that you add it to `.gitignore` in order to avoid publishing it unintentionally:**
+>
+>    ```bash
+>    echo ethereum_private_key.txt >> .gitignore
+>    ```
+
+### 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).
+
+### Generate Mech requests
+
+The basic usage of the Mech Client is as follows:
+
+```bash
+mechx interact <prompt> <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).
+
+Some useful options:
+
+- `--key <private_key_path>`: Specifies the path of the private key. The default value is `./ethereum_private_key.txt`.
+- `--tool  <name>`: Name of the tool to process the prompt. If you are aware about the tools that are provided by an agent you can directly provide its name using this option. If not provided, it will show a list of available tools for the agent so that you can select which one you want to use:
+
+  ```text
+  Select prompting tool
+  |--------------------------------------------------|
+  | ID | Tool                                        |
+  |--------------------------------------------------|
+  | 0  | openai-text-davinci-002                     |
+  | ...| ...                                         |
+  |--------------------------------------------------|
+  Tool ID >
+  ```
+
+- `--chain-config <name>`: Use default chain configuration parameters (RPC, WSS, ...). [See below](#chain-configuration) for more details. Available values are
+  - `arbitrum`
+  - `base`
+  - `celo`
+  - `gnosis` (Default)
+  - `optimism`
+  - `polygon`
+
+- `--confirm <type>`: Specify how to wait for the result of your request:
+  - `off-chain`: Wait for the result using the ACN.
+  - `on-chain`: Wait for the result using the Subgraph and the Websocket subscription (whichever arrives first).
+  - `wait-for-both` (Default): Wait for the result using both `off-chain` and `on-chain` (whichever arrives first).
+
+### Example
+
+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
+```
+
+You will see an output like this:
+
+```bash
+Chain configuration: gnosis
+Prompt uploaded: https://gateway.autonolas.tech/ipfs/f01701220af9e4e8b4bd62d76394064f493081917bcc0b9c34a4aff60f82623b717617279
+Transaction sent: https://gnosisscan.io/tx/0x61359f9cc6a1debb07d34ce1038f6aa30d25257c17edeb2b161741805e43e8d0
+Waiting for transaction receipt...
+Created on-chain request with ID 100407405856633966395081711430940962809568685031934329025999216833965518452765
+Data arrived: https://gateway.autonolas.tech/ipfs/f01701220a462120d5bb03f406fa5ef3573df77184a20ab6343d7bade76bd321654aa7251
+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'}}
+```
+
+> **: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.,**
+>
+> ```bash
+> export MECHX_GAS_LIMIT=200000
+> ```
+
+### Chain configuration
+
+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:
+
+```bash
+MECHX_CHAIN_RPC
+MECHX_WSS_ENDPOINT
+MECHX_GAS_LIMIT
+MECHX_CONTRACT_ABI_URL
+MECHX_TRANSACTION_URL
+MECHX_SUBGRAPH_URL
+
+MECHX_LEDGER_ADDRESS
+MECHX_LEDGER_CHAIN_ID
+MECHX_LEDGER_POA_CHAIN
+MECHX_LEDGER_DEFAULT_GAS_PRICE_STRATEGY
+MECHX_LEDGER_IS_GAS_ESTIMATION_ENABLED
+```
+
+## Programmatic usage
+
+You can also use the Mech Client as a library on your Python project.
+
+1. Set up the private key as specified [above](#set-up-the-private-key). Store the resulting key file (e.g., `ethereum_private_key.txt`) in a convenient and secure location.
+
+2. Create Python script `my_script.py`:
+
+    ```bash
+    touch my_script.py
+    ```
+
+3. Edit `my_script.py` as follows:
+
+    ```python
+    from mech_client.interact import interact, ConfirmationType
+
+    prompt_text = 'Will Gnosis pay reach 100k cards in 2024?'
+    agent_id = 6
+    tool_name = "prediction-online"
+    chain_config = "gnosis"
+    private_key_path="ethereum_private_key.txt"
+
+    result = interact(
+        prompt=prompt_text,
+        agent_id=agent_id,
+        tool=tool_name,
+        chain_config=chain_config,
+        confirmation_type=ConfirmationType.ON_CHAIN,
+        private_key_path=private_key_path
+    )
+    print(result)
+    ```
+
+## Developer installation
+
+To setup the development environment for this project, clone the repository and run the following commands:
+
+```bash
+poetry install
+poetry shell
+```
+
+## Release guide
+
+- Bump versions in `pyproject.toml`.`mech_client/__init__.py` and `SECURITY.md`
+- `poetry lock`
+- `rm -rf dist`
+- `autonomy packages sync --update-packages`
+- `make eject-packages`
+- Then, create a release PR and tag the release.
+
+## FAQ
+
+<details>
+
+<summary><b>On which chains are AI Mechs deployed?</b></summary>
+
+The [Mech repository](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs) contains the latest information on deployed Mechs.
+
+</details>
+
+<details>
+
+<summary><b>Are AI Mechs deployed on testnets?</b></summary>
+
+No. AI Mechs are currently deployed only on mainnets.
+
+</details>
+
+<details>
+
+<summary><b>Where can I find the agent ID?</b></summary>
+
+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).
+
+</details>
+
+<details>
+
+<summary><b>How do I access an AI Mech on a different chain?</b></summary>
+
+Use the `--chain-config <name>` parameter together with a valid `<agent_id>`, for example:
+
+```bash
+mechx interact "write a short poem" 2 --key ./ethereum_private_key.txt --tool openai-gpt-4 --chain-config celo --confirm on-chain
+```
+
+</details>
+

{mech_client-0.2.12.dist-info → mech_client-0.2.13.dist-info}/RECORD

@@ -1,7 +1,7 @@
 mech_client/__init__.py,sha256=s8E8bTccJTXUKsK6N8pSwD7FabU-dQUps-y98raJYZQ,43
 mech_client/acn.py,sha256=Rj_jLPvJ5loDQfGbu3a_O24cJC4SwIErLceSz_zVYS8,5356
 mech_client/cli.py,sha256=QnC3Z_vth__ZiU12chRl8q5LYDLjyjzaofB41mWlq8c,4608
-mech_client/configs/mechs.json,sha256=ed7mp5Z6qC8QuLIx4iqV9Y_u3KmIOhf3zMfpdZ951cQ,4026
+mech_client/configs/mechs.json,sha256=IABnne1lWi62l84Hzqh3XrP659uPKme2k32yAI0HBrg,4488
 mech_client/helpers/__init__.py,sha256=f13zpwGDaKQUjML-5Iq66rRfzg8IS5UNK5I8gBr7w54,1028
 mech_client/helpers/acn/README.md,sha256=WMXR2Lk0IpWjr3vpZ8cxcTHk4gwsx4wC06UPkwj9dbQ,1641
 mech_client/helpers/acn/__init__.py,sha256=72WrGEDIuYKvlWQnTajFQ9bNrDy2sFfTYDP62he4doI,1141
@@ -30,14 +30,14 @@ 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=pvfHtI-NhgDbay1wLNit6m8InH4c0p00c3hQo0I2jwQ,27887
 mech_client/helpers/p2p_libp2p_client/connection.yaml,sha256=giYV5FwwugD7ha9IqFHJtvs-Oz1jC5og9rpkstrTqoc,1763
-mech_client/interact.py,sha256=uRJEcJ8idIm-erGNNBugLGVgYwVO9HmSl2NKPvy248w,19631
+mech_client/interact.py,sha256=E9AW_gRMkz8fRDeQSl9Dd97X_405GodA8Xylv5ZavzQ,20189
 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=4vY6QFyUVs15gS0SvanJbvAxb3aie07IuxQnfMMnStc,4931
 mech_client/to_png.py,sha256=pjUcFJ63MJj_r73eqnfqCWMtlpsrj6H4ZmgvIEmRcFw,2581
-mech_client/wss.py,sha256=klvSOMoUbt8-NwVBNH1G3Tlu4Ll9192dgmr6fA1hGNc,6214
-mech_client-0.2.12.dist-info/LICENSE,sha256=mdBDB-mWKV5Cz4ejBzBiKqan6Z8zVLAh9xwM64O2FW4,11339
-mech_client-0.2.12.dist-info/METADATA,sha256=orPKVVfYHtc3tJn0u_FH258fNBiDWpEXddPyn5Buboo,6443
-mech_client-0.2.12.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-mech_client-0.2.12.dist-info/entry_points.txt,sha256=SbRMRsayzD8XfNXhgwPuXEqQsdZ5Bw9XDPnUuaDExyY,45
-mech_client-0.2.12.dist-info/RECORD,,
+mech_client/wss.py,sha256=hRInQjjsyOrs8dmgBb2VpJvpNt6Tx0aEiY3OhOPQvIs,6600
+mech_client-0.2.13.dist-info/LICENSE,sha256=mdBDB-mWKV5Cz4ejBzBiKqan6Z8zVLAh9xwM64O2FW4,11339
+mech_client-0.2.13.dist-info/METADATA,sha256=cTHX-evOL7lNFFgPhDA0Iyt3jFEW-Fd6zB-IjNyPlRU,10544
+mech_client-0.2.13.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+mech_client-0.2.13.dist-info/entry_points.txt,sha256=SbRMRsayzD8XfNXhgwPuXEqQsdZ5Bw9XDPnUuaDExyY,45
+mech_client-0.2.13.dist-info/RECORD,,

mech_client-0.2.12.dist-info/METADATA

@@ -1,184 +0,0 @@
-Metadata-Version: 2.1
-Name: mech-client
-Version: 0.2.12
-Summary: Basic client to interact with a mech
-License: Apache-2.0
-Author: David Minarsch
-Author-email: david.minarsch@googlemail.com
-Requires-Python: >=3.10,<4.0
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: asn1crypto (>=1.4.0,<1.5.0)
-Requires-Dist: gql (>=3.4.1)
-Requires-Dist: open-aea-cli-ipfs (==1.50.0)
-Requires-Dist: open-aea-ledger-cosmos (==1.50.0)
-Requires-Dist: open-aea-ledger-ethereum (==1.50.0)
-Requires-Dist: open-aea[cli] (==1.50.0)
-Requires-Dist: websocket-client (>=0.32.0,<1)
-Description-Content-Type: text/markdown
-
-# mech-client
-Basic client to interact with a mech
-
-> **Warning**<br />
-> **This is a hacky alpha version of the client - don't rely on it as production software.**
-
-## Installation
-
-```bash
-pip install mech-client
-```
-
-Note: If you encounter an "Out of gas" error when executing the tool, you will need to increase the gas limit by setting, e.g.,
-
-```bash
-export MECHX_GAS_LIMIT=200000
-```
-
-## CLI:
-
-```bash
-Usage: mechx [OPTIONS] COMMAND [ARGS]...
-
-  Command-line tool for interacting with mechs.
-
-Options:
-  --version  Show the version and exit.
-  --help     Show this message and exit.
-
-Commands:
-  interact        Interact with a mech specifying a prompt and tool.
-  prompt-to-ipfs  Upload a prompt and tool to IPFS as metadata.
-  push-to-ipfs    Upload a file to IPFS.
- ```
-
-## CLI Usage:
-
-First, create a private key in file `ethereum_private_key.txt` with this command:
-
-```bash
-aea generate-key ethereum
-```
-Ensure the private key carries funds on Gnosis Chain.
-
-A keyfile is just a file with your ethereum private key as a hex-string, example:
-```
-0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcd
-```
-In case you add your own, make sure you don't have any extra characters in the file, like newlines or spaces.
-
-Second, run the following command to instruct the mech with `<prompt>` and `<agent_id>`:
-
-```bash
-mechx interact <prompt> <agent_id>
-```
-
-The command will prompt you with all available tools for the agent and you can select which tool you want to use
-
-```
-Select prompting tool
-|--------------------------------------------------|
-| ID | Tool                                        |
-|--------------------------------------------------|
-| 0  | openai-text-davinci-002                     |
-| ...| ...                                         |
-|--------------------------------------------------|
-Tool ID > 
-```
-
-If you are aware about the tools that are provided by an agent you can directly provide tool as a command line argument
-
-```bash
-mechx interact <prompt> <agent_id> --tool <tool>
-```
-
-If you already have a funded key file on locally you can provide path the key using `--key` flag.
-
-```bash
-mechx interact <prompt> <agent_id> --key <key_file>
-```
-
-Example output:
-```bash
-mechx interact "write a short poem" 3 --key ~/gnosis_key --tool openai-text-davinci-003
-Chain configuration: gnosis
-Prompt uploaded: https://gateway.autonolas.tech/ipfs/f01701220ad773628911d12e28f005e3f249e990d684e5dba07542259195602f9afed30bf
-Transaction sent: https://gnosisscan.io/tx/0x0d9209e32e965a820b9e80accfcd71ea3b1174b9758dd251c2e627a60ec426a5
-Created on-chain request with ID 111240237160304797537720810617416341148235899500021985333360197012735240803849
-Data arrived: https://gateway.autonolas.tech/ipfs/bafybeifk2h35ncszlze7t64rpblfo45rezc33xzbya3cjiyumtaioyat3e
-Data from agent: {'requestId': 111240237160304797537720810617416341148235899500021985333360197012735240803849, 'result': "\n\nI am brave and I'm strong\nI don't hide away my song\nI am here and I'm proud\nMy voice will be heard loud!"}
-```
-
-By default the client will wait for data to arrive from on-chain using the websocket subscription and subgraph, and off-chain using the ACN and show you the result which arrives first. You can specify the type of confirmation you want using `--confirm` flag like this
-
-```bash
-mechx interact "write a short poem" 3 --key ~/gnosis_key --tool openai-text-davinci-003 --confirm on-chain
-Chain configuration: gnosis
-Prompt uploaded: https://gateway.autonolas.tech/ipfs/f017012205e37f761221a8ba4005e91c36b94153e9432b8888ff2acae6b101dd5a5de6768
-Transaction sent: https://gnosisscan.io/tx/0xf1ef63f617717bbb8deb09699af99aa39f10155d33796de2fd7eb61c9c1458b6
-Created on-chain request with ID 81653153529124597849081567361606842861262371002932574194580478443414142139857
-Data arrived: https://gateway.autonolas.tech/ipfs/f0170122069b55e077430a00f3cbc3b069347e901396f978ff160eb2b0a947872be1848b7
-Data from agent: {'requestId': 81653153529124597849081567361606842861262371002932574194580478443414142139857, 'result': "\n\nA summer breeze, so sweet,\nA gentle reminder of summer's heat.\nThe sky so blue, no cloud in sight,\nA perfect day, a wondrous sight."}
-```
-
-### Chain configuration
-
-Configurations for different chains are stored in the file `configs/mechs.json`. By default, `mech interact` will choose the first configuration on the JSON. You can specify which config you want to use using the `--chain-config` flag, for example,
-
-```bash
-mechx interact <prompt> <agent_id> --chain-config gnosis
-```
-
-Additionally, you can override any configuration parameter by exporting any of the following environment variables:
-
-```bash
-MECHX_CHAIN_RPC
-MECHX_WSS_ENDPOINT
-MECHX_GAS_LIMIT
-MECHX_CONTRACT_ABI_URL
-MECHX_SUBGRAPH_URL
-
-MECHX_LEDGER_ADDRESS
-MECHX_LEDGER_CHAIN_ID
-MECHX_LEDGER_POA_CHAIN
-MECHX_LEDGER_DEFAULT_GAS_PRICE_STRATEGY
-MECHX_LEDGER_IS_GAS_ESTIMATION_ENABLED
-```
-
-## Programmatic Usage:
-
-```python
-from mech_client.interact import interact, ConfirmationType
-
-prompt_text = 'Will gnosis pay reach 100k cards in 2024?'
-agent_id = 3
-tool_name = "prediction-online"
-
-result = interact(
-    prompt=prompt_text,
-    agent_id=agent_id,
-    tool=tool_name,
-    confirmation_type=ConfirmationType.ON_CHAIN,
-    private_key_path='PATH_HERE'
-)
-print(result)
-```
-
-# Developer installation
-To setup the development environment, run the following commands:
-
-```bash
-poetry install && poetry shell
-```
-
-## Release guide:
-
-- Bump versions in `pyproject.toml`, `mech_client/__init__.py` and `SECURITY.md`
-- `poetry lock`
-- `rm -rf dist`
-- `autonomy packages sync --update-packages`
-- `make eject-packages`
-- then create release PR and tag release
-