mech-client 0.8.2__py3-none-any.whl → 0.10.0__py3-none-any.whl

mech_client/__init__.py

@@ -1,3 +1,3 @@
 """Mech client."""
 
-__version__ = "0.8.2"
+__version__ = "0.10.0"

mech_client/abis/MechMarketplace.json

@@ -303,7 +303,13 @@
             {
                 "indexed": false,
                 "internalType": "bytes",
-                "name": "data",
+                "name": "requestData",
+                "type": "bytes"
+            },
+            {
+                "indexed": false,
+                "internalType": "bytes",
+                "name": "deliveryData",
                 "type": "bytes"
             }
         ],
@@ -333,7 +339,7 @@
                 "type": "address"
             },
             {
-                "indexed": true,
+                "indexed": false,
                 "internalType": "address[]",
                 "name": "requesters",
                 "type": "address[]"
@@ -442,6 +448,12 @@
                 "internalType": "bytes32[]",
                 "name": "requestIds",
                 "type": "bytes32[]"
+            },
+            {
+                "indexed": false,
+                "internalType": "bytes[]",
+                "name": "requestDatas",
+                "type": "bytes[]"
             }
         ],
         "name": "MarketplaceRequest",

mech_client/cli.py

@@ -19,6 +19,7 @@
 
 """Mech client CLI module."""
 import json
+import os
 from typing import Any, Dict, List, Optional, Tuple
 
 import click
@@ -156,6 +157,12 @@ def interact(  # pylint: disable=too-many-arguments,too-many-locals
         use_offchain = use_offchain or False
         use_prepaid = use_prepaid or use_offchain
 
+        mech_offchain_url = os.getenv("MECHX_MECH_OFFCHAIN_URL")
+        if use_offchain and not mech_offchain_url:
+            raise Exception(
+                "To use offchain requests, please set MECHX_MECH_OFFCHAIN_URL"
+            )
+
         if agent_id is None:
             if len(prompts) != len(tools):
                 raise ClickException(
@@ -167,6 +174,7 @@ def interact(  # pylint: disable=too-many-arguments,too-many-locals
                 priority_mech=priority_mech,
                 use_prepaid=use_prepaid,
                 use_offchain=use_offchain,
+                mech_offchain_url=mech_offchain_url,
                 private_key_path=key,
                 tools=tools,
                 extra_attributes=extra_attributes_dict,

mech_client/marketplace_interact.py

@@ -50,6 +50,7 @@ from mech_client.interact import (
     get_event_signatures,
     get_mech_config,
 )
+from mech_client.mech_marketplace_tool_management import get_mech_tools
 from mech_client.prompt_to_ipfs import push_metadata_to_ipfs
 from mech_client.wss import (
     register_event_handlers,
@@ -74,6 +75,8 @@ class PaymentType(Enum):
 
 
 IPFS_URL_TEMPLATE = "https://gateway.autonolas.tech/ipfs/f01701220{}"
+MECH_OFFCHAIN_REQUEST_ENDPOINT = "send_signed_requests"
+MECH_OFFCHAIN_DELIVER_ENDPOINT = "fetch_offchain_info"
 ABI_DIR_PATH = Path(__file__).parent / "abis"
 IMECH_ABI_PATH = ABI_DIR_PATH / "IMech.json"
 ITOKEN_ABI_PATH = ABI_DIR_PATH / "IToken.json"
@@ -252,6 +255,9 @@ def fetch_requester_nvm_subscription_balance(
     nvm_balance_tracker_contract = get_contract(
         contract_address=mech_payment_balance_tracker, abi=abi, ledger_api=ledger_api
     )
+    requester_balance_tracker_balance = (
+        nvm_balance_tracker_contract.functions.mapRequesterBalances(requester).call()
+    )
     subscription_nft_address = (
         nvm_balance_tracker_contract.functions.subscriptionNFT().call()
     )
@@ -269,7 +275,7 @@ def fetch_requester_nvm_subscription_balance(
         requester, subscription_id
     ).call()
 
-    return requester_balance
+    return requester_balance_tracker_balance + requester_balance
 
 
 def send_marketplace_request(  # pylint: disable=too-many-arguments,too-many-locals
@@ -389,6 +395,7 @@ def send_marketplace_request(  # pylint: disable=too-many-arguments,too-many-loc
 def send_offchain_marketplace_request(  # pylint: disable=too-many-arguments,too-many-locals
     crypto: EthereumCrypto,
     marketplace_contract: Web3Contract,
+    mech_offchain_url: str,
     prompt: str,
     tool: str,
     method_args_data: MechMarketplaceRequestConfig,
@@ -405,6 +412,8 @@ def send_offchain_marketplace_request(  # pylint: disable=too-many-arguments,too
     :type crypto: EthereumCrypto
     :param marketplace_contract: The mech marketplace contract instance.
     :type marketplace_contract: Web3Contract
+    :param mech_offchain_url: mech url to connect to.
+    :type mech_offchain_url: str
     :param prompt: The request prompt.
     :type prompt: str
     :param tool: The requested tool.
@@ -469,9 +478,9 @@ def send_offchain_marketplace_request(  # pylint: disable=too-many-arguments,too
                 "nonce": nonce,
                 "ipfs_data": ipfs_data,
             }
-            # @todo changed hardcoded url
+            url = mech_offchain_url + MECH_OFFCHAIN_REQUEST_ENDPOINT
             response = requests.post(
-                "http://localhost:8000/send_signed_requests",
+                url=url,
                 data=payload,
                 headers={"Content-Type": "application/json"},
             ).json()
@@ -562,10 +571,12 @@ def wait_for_marketplace_data_url(  # pylint: disable=too-many-arguments, unused
     return result
 
 
-def wait_for_offchain_marketplace_data(request_id: str) -> Any:
+def wait_for_offchain_marketplace_data(mech_offchain_url: str, request_id: str) -> Any:
     """
     Watches for data off-chain on mech.
 
+    :param mech_offchain_url: mech url to connect to.
+    :type mech_offchain_url: str
     :param request_id: The ID of the request.
     :type request_id: str
     :return: The data returned by the mech.
@@ -573,15 +584,17 @@ def wait_for_offchain_marketplace_data(request_id: str) -> Any:
     """
     while True:
         try:
-            # @todo change hardcoded url
+            url = mech_offchain_url + MECH_OFFCHAIN_DELIVER_ENDPOINT
             response = requests.get(
-                "http://localhost:8000/fetch_offchain_info",
+                url=url,
                 data={"request_id": request_id},
             ).json()
             if response:
                 return response
+
+            time.sleep(WAIT_SLEEP)
         except Exception:  # pylint: disable=broad-except
-            time.sleep(1)
+            time.sleep(WAIT_SLEEP)
 
 
 def check_prepaid_balances(
@@ -633,11 +646,36 @@ def check_prepaid_balances(
             sys.exit(1)
 
 
+def verify_tools(tools: tuple, service_id: int, chain_config: Optional[str]) -> None:
+    """
+    Verifies user supplied tool(s) with the mech's metadata
+
+    :param tools: The user supplied tools.
+    :type tools: tuple
+    :param service_id: Service id of the mech.
+    :type service_id: int
+    :param chain_config: Id of the mech's chain configuration (stored configs/mechs.json)
+    :type chain_config: str
+    :rtype: None
+    """
+    mech_tools_data = get_mech_tools(service_id=service_id, chain_config=chain_config)
+    if not mech_tools_data:
+        raise ValueError("Error while fetching mech tools data")
+
+    mech_tools = mech_tools_data.get("tools", [])
+    invalid_tools = [tool for tool in tools if tool not in mech_tools]
+    if invalid_tools:
+        raise ValueError(
+            f"Tool(s) {invalid_tools} not found in mech tools: {mech_tools}"
+        )
+
+
 def marketplace_interact(  # pylint: disable=too-many-arguments, too-many-locals, too-many-statements, too-many-return-statements
     prompts: tuple,
     priority_mech: str,
     use_prepaid: bool = False,
     use_offchain: bool = False,
+    mech_offchain_url: str = "",
     tools: tuple = (),
     extra_attributes: Optional[Dict[str, Any]] = None,
     private_key_path: Optional[str] = None,
@@ -658,6 +696,8 @@ def marketplace_interact(  # pylint: disable=too-many-arguments, too-many-locals
     :type use_prepaid: bool
     :param use_offchain: Whether to use offchain model or not.
     :type use_offchain: bool
+    :param mech_offchain_url: mech url to connect to.
+    :type mech_offchain_url: str
     :param tools: The tools to interact with (optional).
     :type tools: tuple
     :param extra_attributes: Extra attributes to be included in the request metadata (optional).
@@ -732,7 +772,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,
@@ -744,6 +784,8 @@ 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
 
+    verify_tools(tools, service_id, chain_config)
+
     with open(IMECH_ABI_PATH, encoding="utf-8") as f:
         abi = json.load(f)
 
@@ -792,22 +834,29 @@ def marketplace_interact(  # pylint: disable=too-many-arguments, too-many-locals
             max_delivery_rate,
         )
 
-    if payment_type in [PaymentType.NATIVE_NVM.value, PaymentType.TOKEN_NVM.value]:
+    is_nvm_mech = payment_type in [
+        PaymentType.NATIVE_NVM.value,
+        PaymentType.TOKEN_NVM.value,
+    ]
+    if is_nvm_mech:
         nvm_mech_type = PaymentType(payment_type).name.lower()
         print(
             f"{nvm_mech_type} Nevermined Mech detected, subscription credits to be used"
         )
         requester = crypto.address
-        requester_balance = fetch_requester_nvm_subscription_balance(
+        requester_total_balance_before = fetch_requester_nvm_subscription_balance(
             requester, ledger_api, mech_payment_balance_tracker, payment_type
         )
-        if requester_balance < price:
+        if requester_total_balance_before < price:
             print(
-                f"  - Sender Subscription balance low. Needed: {price}, Actual: {requester_balance}"
+                f"  - Sender Subscription balance low. Needed: {price}, Actual: {requester_total_balance_before}"
             )
             print(f"  - Sender Address: {requester}")
             sys.exit(1)
 
+        print(
+            f"  - Sender Subscription balance before request: {requester_total_balance_before}"
+        )
         # set price 0 to not send any msg.value in request transaction for nvm type mech
         price = 0
 
@@ -868,6 +917,19 @@ def marketplace_interact(  # pylint: disable=too-many-arguments, too-many-locals
             )
 
             if data_url:
+                if is_nvm_mech:
+                    requester_total_balance_after = (
+                        fetch_requester_nvm_subscription_balance(
+                            requester,
+                            ledger_api,
+                            mech_payment_balance_tracker,
+                            payment_type,
+                        )
+                    )
+                    print(
+                        f"  - Sender Subscription balance after delivery: {requester_total_balance_after}"
+                    )
+
                 print(f"  - Data arrived: {data_url}")
                 data = requests.get(f"{data_url}/{request_id_int}", timeout=30).json()
                 print("  - Data from agent:")
@@ -882,6 +944,7 @@ def marketplace_interact(  # pylint: disable=too-many-arguments, too-many-locals
         response = send_offchain_marketplace_request(
             crypto=crypto,
             marketplace_contract=mech_marketplace_contract,
+            mech_offchain_url=mech_offchain_url,
             prompt=prompts[0],
             tool=tools[0],
             method_args_data=mech_marketplace_request_config,
@@ -910,6 +973,7 @@ def marketplace_interact(  # pylint: disable=too-many-arguments, too-many-locals
 
     for request_id in request_ids:
         data = wait_for_offchain_marketplace_data(
+            mech_offchain_url=mech_offchain_url,
             request_id=request_id,
         )
 

mech_client/mech_marketplace_tool_management.py

@@ -7,8 +7,9 @@ from typing import Any, Dict, List, Optional, Tuple
 
 import requests
 from aea_ledger_ethereum import EthereumApi
+from web3.constants import ADDRESS_ZERO
 
-from mech_client.marketplace_interact import ADDRESS_ZERO, get_contract, get_mech_config
+from mech_client.interact import get_contract, get_mech_config
 
 
 ABI_DIR_PATH = Path(__file__).parent / "abis"
@@ -58,7 +59,7 @@ def fetch_tools(
 
 
 def get_mech_tools(
-    service_id: int, chain_config: str = DEFAULT_CONFIG
+    service_id: int, chain_config: Optional[str] = DEFAULT_CONFIG
 ) -> Optional[Dict[str, Any]]:
     """
     Fetch tools for a given mech's service ID.

{mech_client-0.8.2.dist-info → mech_client-0.10.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mech-client
-Version: 0.8.2
+Version: 0.10.0
 Summary: Basic client to interact with a mech
 License: Apache-2.0
 Author: David Minarsch
@@ -237,6 +237,16 @@ Additionally to other options which are the same as for legacy Mechs, this usage
 
 `--use-prepaid <bool>`: use the prepaid method to send requests to a Mech via the Mech Marketplace. Defaults to False. <br>
 `--use-offchain <bool>`: use the off-chain method to send requests to a Mech via the Mech Marketplace. Defaults to False.
+> To use offchain requests using `--use-offchain` flag, export the `MECHX_MECH_OFFCHAIN_URL` env variable before sending requests. For example if you want to connect to a mech running locally, you can do the following
+```bash
+export MECHX_MECH_OFFCHAIN_URL="http://localhost:8000/"
+```
+If you want to use a Valory mech for offchain requests, below is the list of mechs and their address and offchain urls.
+
+| Service ID | Priority Mech Address                       | Offchain URL                                             |
+|    :---:   |                :---:                        |                        :---:                             |  
+|       2182 | 0xB3C6319962484602b00d5587e965946890b82101  | https://d19715222af5b940.agent.propel.autonolas.tech/    |
+
 
 The Mech Client can also be used to send batch requests. There are couple of different ways to achieve this: 
 

{mech_client-0.8.2.dist-info → mech_client-0.10.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-mech_client/__init__.py,sha256=Pkp7D9ID9xxFUuGrdGofoB2cTeMVMTpQeST3H0GcIps,42
+mech_client/__init__.py,sha256=zubatTm13iBIEOwOE74QFlqg6tpFL5v53x4lS6XYY0U,43
 mech_client/abis/AgentMech.json,sha256=IEbs_xBGunBu5h-uT5DvIty8Zw412QoPI46S_DUMYNw,18082
 mech_client/abis/AgentRegistry.json,sha256=2qmXeFINZWz9pyOma6Bq67kMDSUI1lD7WvgHLwuETD8,24723
 mech_client/abis/AgreementStoreManager.base.json,sha256=_ljdIZcfFGmFzBHUTfhA4X0382ZHHpkdr_CziTwUETo,34360
@@ -17,7 +17,7 @@ mech_client/abis/IMech.json,sha256=km0NMRyqBYh3jBQwPJCispsRfPwqNJ67kkZwYjuJci4,3
 mech_client/abis/IToken.json,sha256=VrzR6Rr1DmrUzy5DygN1rKm6df4ir2KGdWsunZnuRKo,19637
 mech_client/abis/LockPaymentCondition.base.json,sha256=mGOi_xYyH7gCzLyWu7nk_Ta46tpLNxoPAgbjQvKNQtA,43424
 mech_client/abis/LockPaymentCondition.gnosis.json,sha256=ofYQo6JYSE_7Q4LPHxoOZI2qFMddSWcfVoCW-6k9KnY,43424
-mech_client/abis/MechMarketplace.json,sha256=auKTxPTi07yD98Gz2RuwH1Gq5qRCyy8-C7QBNj3uto8,32104
+mech_client/abis/MechMarketplace.json,sha256=KPnF-H_UATb3wdb_7o6ky_hSp5xwgvckD-QqylsWJLg,32468
 mech_client/abis/NFTSalesTemplate.base.json,sha256=blheE2NNxCt3ttklcsAF9WrIcnsvywAZ8jICjGVl4lQ,37995
 mech_client/abis/NFTSalesTemplate.gnosis.json,sha256=6fKoxvTSQWOGQq_Yik09R8JTMRxXIPgoOC_HSAf5A7Q,37995
 mech_client/abis/NeverminedConfig.base.json,sha256=0p_GV87fsBvlN6VNDm_T1ykjzD4yZKlR9-jDpo1_RRU,21221
@@ -30,7 +30,7 @@ mech_client/abis/SubscriptionToken.base.json,sha256=5StPEyfRvDMTqtQPO-KakXXZqobX
 mech_client/abis/TransferNFTCondition.base.json,sha256=71O_3itHBz9qPtoTLev8_a7KxlcQfIZSfxK2562lkqw,42540
 mech_client/abis/TransferNFTCondition.gnosis.json,sha256=-huhxV54eoNY8mR9WtQdmSgQDgaKiUi0PULJ4HEshWw,42540
 mech_client/acn.py,sha256=Rj_jLPvJ5loDQfGbu3a_O24cJC4SwIErLceSz_zVYS8,5356
-mech_client/cli.py,sha256=XezX27Y0VdnUq8HmHF6HxyhPmsC91YuLSuqAoi41UrE,17655
+mech_client/cli.py,sha256=CgpembCl3JTubCgUYw7-one6cuge8YlUTHfoIkhbZu4,17957
 mech_client/configs/mechs.json,sha256=Zv8JrY6yvNsSxTP7RchvR1yz2k3yjYUZkuSILnPbWzg,5445
 mech_client/fetch_ipfs_hash.py,sha256=tg_hYVf4deXl89x3SOBrGFUthaSeN_Vg_OHDtfjdbp4,2752
 mech_client/helpers/__init__.py,sha256=nmQig1EqBQ9EMOpgdykP3a6_2NWcoVH3-lnyHP5n0ws,1196
@@ -62,8 +62,8 @@ mech_client/helpers/p2p_libp2p_client/__init__.py,sha256=-GOP3D_JnmXTDomrMLCbnRk
 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=52UW5NysSTIC--APLpJde8VvrruWeYFCFzO02uRQpwc,21288
-mech_client/marketplace_interact.py,sha256=rRIHYLzuaXYW7vh4fvNh9KBbUY4tgoavmMxFaPg0Rkw,33045
-mech_client/mech_marketplace_tool_management.py,sha256=q_cXyJGI1rLXKB_Ds21eQLCzUhTYE9BHN48wqIw0w6g,7341
+mech_client/marketplace_interact.py,sha256=24louKzqpgDVYmuOIwZQzIVnZwPLXhkF2LPSQVrEuvE,35554
+mech_client/mech_marketplace_tool_management.py,sha256=G1O0ajbeltRM5FpqPfmn2C4QRrwqf5HfWKUH2VKn6UA,7365
 mech_client/mech_tool_management.py,sha256=NQFmVzzGZsIkeHokDPWXGHwa8u-pyQIMPR1Q5H81bKw,7806
 mech_client/prompt_to_ipfs.py,sha256=XqSIBko15MEkpWOQNT97fRI6jNxMF5EDBDEPOJFdhyk,2533
 mech_client/push_to_ipfs.py,sha256=IfvgaPU79N_ZmCPF9d7sPCYz2uduZH0KjT_HQ2LHXoQ,2059
@@ -92,8 +92,8 @@ scripts/nvm_subscription/manager.py,sha256=y0Qh0aVAmOPB4Ytt93alIarSvhrQpC-lRYNAY
 scripts/nvm_subscription/resources/networks.json,sha256=xH0P3YkgkMTkQdahVKO0kI9m6ybJ67iwHApstUlfRmw,2359
 scripts/utils.py,sha256=lXjY3s1HvNHT2fXm2fBpZtVvlQaqW288Y2S-s3rpSDM,3248
 scripts/whitelist.py,sha256=-TF4fcojBmF6a7fXleBk96DvJ-xWkNGoN0s_8r8J20Q,289
-mech_client-0.8.2.dist-info/LICENSE,sha256=mdBDB-mWKV5Cz4ejBzBiKqan6Z8zVLAh9xwM64O2FW4,11339
-mech_client-0.8.2.dist-info/METADATA,sha256=SUPx34q_S9D-15xJ8rGTgwPTBiZ7VL5VvBCkWKayBPA,25165
-mech_client-0.8.2.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-mech_client-0.8.2.dist-info/entry_points.txt,sha256=SbRMRsayzD8XfNXhgwPuXEqQsdZ5Bw9XDPnUuaDExyY,45
-mech_client-0.8.2.dist-info/RECORD,,
+mech_client-0.10.0.dist-info/LICENSE,sha256=mdBDB-mWKV5Cz4ejBzBiKqan6Z8zVLAh9xwM64O2FW4,11339
+mech_client-0.10.0.dist-info/METADATA,sha256=wXMRgH_HN3Kg0yt4k9rsfySvc6XL-TmQkyqKQ-3rtto,25936
+mech_client-0.10.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+mech_client-0.10.0.dist-info/entry_points.txt,sha256=SbRMRsayzD8XfNXhgwPuXEqQsdZ5Bw9XDPnUuaDExyY,45
+mech_client-0.10.0.dist-info/RECORD,,