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

mech_client/cli.py

@@ -27,6 +27,9 @@ from tabulate import tabulate  # type: ignore
 from mech_client import __version__
 from mech_client.interact import ConfirmationType
 from mech_client.interact import interact as interact_
+from mech_client.marketplace_interact import (
+    marketplace_interact as marketplace_interact_,
+)
 from mech_client.mech_tool_management import (
     get_tool_description,
     get_tool_io_schema,
@@ -45,7 +48,22 @@ def cli() -> None:
 
 @click.command()
 @click.argument("prompt")
-@click.argument("agent_id", type=int)
+@click.option("--agent_id", type=int, help="Id of the agent to be used")
+@click.option(
+    "--priority-mech",
+    type=str,
+    help="Priority Mech to be used for Marketplace Requests",
+)
+@click.option(
+    "--use-prepaid",
+    type=bool,
+    help="Uses the prepaid model for marketplace requests",
+)
+@click.option(
+    "--use-offchain",
+    type=bool,
+    help="Uses the offchain model for marketplace requests",
+)
 @click.option(
     "--key",
     type=click.Path(exists=True, file_okay=True, dir_okay=False),
@@ -90,9 +108,12 @@ def cli() -> None:
     type=str,
     help="Id of the mech's chain configuration (stored configs/mechs.json)",
 )
-def interact(  # pylint: disable=too-many-arguments
+def interact(  # pylint: disable=too-many-arguments,too-many-locals
     prompt: str,
     agent_id: int,
+    priority_mech: str,
+    use_prepaid: bool,
+    use_offchain: bool,
     key: Optional[str],
     tool: Optional[str],
     extra_attribute: Optional[List[str]] = None,
@@ -110,23 +131,57 @@ def interact(  # pylint: disable=too-many-arguments
                 k, v = pair.split("=")
                 extra_attributes_dict[k] = v
 
-        interact_(
-            prompt=prompt,
-            agent_id=agent_id,
-            private_key_path=key,
-            tool=tool,
-            extra_attributes=extra_attributes_dict,
-            confirmation_type=(
-                ConfirmationType(confirm)
-                if confirm is not None
-                else ConfirmationType.WAIT_FOR_BOTH
-            ),
-            retries=retries,
-            timeout=timeout,
-            sleep=sleep,
-            chain_config=chain_config,
-        )
-    except (ValueError, FileNotFoundError) as e:
+        use_offchain = use_offchain or False
+        use_prepaid = use_prepaid or use_offchain
+
+        if agent_id is None:
+            marketplace_interact_(
+                prompt=prompt,
+                priority_mech=priority_mech,
+                use_prepaid=use_prepaid,
+                use_offchain=use_offchain,
+                private_key_path=key,
+                tool=tool,
+                extra_attributes=extra_attributes_dict,
+                confirmation_type=(
+                    ConfirmationType(confirm)
+                    if confirm is not None
+                    else ConfirmationType.WAIT_FOR_BOTH
+                ),
+                retries=retries,
+                timeout=timeout,
+                sleep=sleep,
+                chain_config=chain_config,
+            )
+
+        else:
+            if use_prepaid:
+                raise Exception(
+                    "Prepaid model can only be used for marketplace requests"
+                )
+
+            if use_offchain:
+                raise Exception(
+                    "Offchain model can only be used for marketplace requests"
+                )
+
+            interact_(
+                prompt=prompt,
+                agent_id=agent_id,
+                private_key_path=key,
+                tool=tool,
+                extra_attributes=extra_attributes_dict,
+                confirmation_type=(
+                    ConfirmationType(confirm)
+                    if confirm is not None
+                    else ConfirmationType.WAIT_FOR_BOTH
+                ),
+                retries=retries,
+                timeout=timeout,
+                sleep=sleep,
+                chain_config=chain_config,
+            )
+    except (ValueError, FileNotFoundError, Exception) as e:
         raise click.ClickException(str(e)) from e
 
 

mech_client/configs/mechs.json

@@ -1,8 +1,10 @@
 {
     "gnosis": {
         "agent_registry_contract": "0xE49CB081e8d96920C38aA7AB90cb0294ab4Bc8EA",
+        "service_registry_contract": "0x9338b5153AE39BB89f50468E608eD9d764B755fD",
+        "mech_marketplace_contract": "0x735FAAb1c4Ec41128c367AFb5c3baC73509f70bB",
         "rpc_url": "https://rpc.eu-central-2.gateway.fm/v4/gnosis/non-archival/mainnet",
-        "wss_endpoint": "wss://rpc.eu-central-2.gateway.fm/ws/v4/gnosis/non-archival/mainnet",
+        "wss_endpoint": "wss://rpc.gnosischain.com/wss",
         "ledger_config": {
             "address": "https://rpc.eu-central-2.gateway.fm/v4/gnosis/non-archival/mainnet",
             "chain_id": 100,
@@ -10,14 +12,16 @@
             "default_gas_price_strategy": "eip1559",
             "is_gas_estimation_enabled": false
         },
-        "gas_limit": 100000,
+        "gas_limit": 500000,
         "price": 10000000000000000,
-        "contract_abi_url": "https://gnosis.blockscout.com/api/v2/smart-contracts/{contract_address}",
+        "contract_abi_url": "https://api.gnosisscan.io/api?module=contract&action=getabi&address={contract_address}&apikey={api_key}",
         "transaction_url": "https://gnosisscan.io/tx/{transaction_digest}",
         "subgraph_url": "https://api.studio.thegraph.com/query/57238/mech/version/latest"
     },
     "arbitrum": {
         "agent_registry_contract": "0xa4799B083E0068732456EF45ff9fe5c683658327",
+        "service_registry_contract": "0xE3607b00E75f6405248323A9417ff6b39B244b50",
+        "mech_marketplace_contract": "0x0000000000000000000000000000000000000000",
         "rpc_url": "https://arbitrum.llamarpc.com",
         "wss_endpoint": "wss://arbitrum.gateway.tenderly.co",
         "ledger_config": {
@@ -35,6 +39,8 @@
     },
     "polygon": {
         "agent_registry_contract": "0x984cf72FDe8B5aA910e9e508aC5e007ae5BDcC9C",
+        "service_registry_contract": "0xE3607b00E75f6405248323A9417ff6b39B244b50",
+        "mech_marketplace_contract": "0x0000000000000000000000000000000000000000",
         "rpc_url": "https://polygon-bor-rpc.publicnode.com",
         "wss_endpoint": "wss://polygon.gateway.tenderly.co",
         "ledger_config": {
@@ -52,6 +58,8 @@
     },
     "base": {
         "agent_registry_contract": "0x88DE734655184a09B70700aE4F72364d1ad23728",
+        "service_registry_contract": "0x3C1fF68f5aa342D296d4DEe4Bb1cACCA912D95fE",
+        "mech_marketplace_contract": "0xf24eE42edA0fc9b33B7D41B06Ee8ccD2Ef7C5020",
         "rpc_url": "https://base.llamarpc.com",
         "wss_endpoint": "wss://base.gateway.tenderly.co",
         "ledger_config": {
@@ -61,7 +69,7 @@
             "default_gas_price_strategy": "eip1559",
             "is_gas_estimation_enabled": false
         },
-        "gas_limit": 250000,
+        "gas_limit": 500000,
         "price": 3000000000000,
         "contract_abi_url": "https://api.basescan.org/api?module=contract&action=getabi&address={contract_address}&apikey={api_key}",
         "transaction_url": "https://basescan.org/tx/{transaction_digest}",
@@ -69,6 +77,8 @@
     },
     "celo": {
         "agent_registry_contract": "0xE49CB081e8d96920C38aA7AB90cb0294ab4Bc8EA",
+        "service_registry_contract": "0xE3607b00E75f6405248323A9417ff6b39B244b50",
+        "mech_marketplace_contract": "0x0000000000000000000000000000000000000000",
         "rpc_url": "https://forno.celo.org",
         "wss_endpoint": "wss://forno.celo.org/ws",
         "ledger_config": {
@@ -80,12 +90,14 @@
         },
         "gas_limit": 250000,
         "price": 10000000000000000,
-        "contract_abi_url": "https://api.celoscan.io/api?module=contract&action=getabi&address={contract_address}&apikey={api_key}",
+        "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": {
         "agent_registry_contract": "0x75D529FAe220bC8db714F0202193726b46881B76",
+        "service_registry_contract": "0x3d77596beb0f130a4415df3D2D8232B3d3D31e44",
+        "mech_marketplace_contract": "0x0000000000000000000000000000000000000000",
         "rpc_url": "https://mainnet.optimism.io",
         "wss_endpoint": "wss://optimism.gateway.tenderly.co",
         "ledger_config": {
@@ -101,4 +113,4 @@
         "transaction_url": "https://optimistic.etherscan.io/tx/{transaction_digest}",
         "subgraph_url": ""
     }
-}
+}

mech_client/fetch_ipfs_hash.py

@@ -0,0 +1,88 @@
+# -*- coding: utf-8 -*-
+# ------------------------------------------------------------------------------
+#
+#   Copyright 2023 Valory AG
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+# ------------------------------------------------------------------------------
+
+"""
+This script allows fetching ipfs hash of data without uploading to IPFS.
+
+Usage:
+
+python fetch_ipfs_hash.py <data>
+"""
+
+import json
+import shutil
+import tempfile
+import uuid
+from typing import Any, Dict, Optional, Tuple
+
+from aea.helpers.ipfs.base import IPFSHashOnly
+from multibase import multibase
+from multicodec import multicodec
+
+
+def fetch_ipfs_hash(
+    prompt: str, tool: str, extra_attributes: Optional[Dict[str, Any]] = None
+) -> Tuple[Any, Any, bytes]:
+    """
+    Fetches IPFS hash of the data.
+
+    :param prompt: Prompt string.
+    :type prompt: str
+    :param tool: Tool string.
+    :type tool: str
+    :param extra_attributes: Extra attributes to be included in the request metadata.
+    :type extra_attributes: Optional[Dict[str,Any]]
+    :return: Tuple containing the IPFS hash, truncated IPFS hash and the metadata for which the hash was calculated.
+    :rtype: Tuple[str, str, bytes]
+    """
+    metadata = {"prompt": prompt, "tool": tool, "nonce": str(uuid.uuid4())}
+    if extra_attributes:
+        metadata.update(extra_attributes)
+
+    dirpath = tempfile.mkdtemp()
+    file_name = "metadata.json"
+    with open(file_name, "w", encoding="utf-8") as f:
+        json.dump(metadata, f, separators=(",", ":"))
+
+    v1_file_hash = IPFSHashOnly.get(file_name, wrap=True)
+
+    with open(file_name, "rb") as f:
+        ipfs_data = f.read()
+
+    shutil.rmtree(dirpath)
+
+    cid_bytes = multibase.decode(v1_file_hash)
+    multihash_bytes = multicodec.remove_prefix(cid_bytes)
+    v1_file_hash_hex = "f01" + multihash_bytes.hex()
+
+    return "0x" + v1_file_hash_hex[9:], v1_file_hash_hex, ipfs_data
+
+
+def main(prompt: str, tool: str) -> None:
+    """
+    Prints the IPFS hash and truncated IPFS hash for the metadata object.
+
+    :param prompt: Prompt string.
+    :type prompt: str
+    :param tool: Tool string.
+    :type tool: str
+    """
+
+    v1_file_hash, _, _ = fetch_ipfs_hash(prompt, tool)
+    print("IPFS file hash v1: {}".format(v1_file_hash))

mech_client/helpers/__init__.py

@@ -22,6 +22,16 @@
 from pathlib import Path
 
 
-ACN_PROTOCOL_PACKAGE = Path(__file__).parent / "acn"
-P2P_CLIENT_PACKAGE = Path(__file__).parent / "p2p_libp2p_client"
-ACN_DATA_SHARE_PROTOCOL_PACKAGE = Path(__file__).parent / "acn_data_share"
+ACN_PROTOCOL_PACKAGE = (
+    Path(__file__).parents[2] / "packages" / "valory" / "protocols" / "acn"
+)
+P2P_CLIENT_PACKAGE = (
+    Path(__file__).parents[2]
+    / "packages"
+    / "valory"
+    / "connections"
+    / "p2p_libp2p_client"
+)
+ACN_DATA_SHARE_PROTOCOL_PACKAGE = (
+    Path(__file__).parents[2] / "packages" / "valory" / "protocols" / "acn_data_share"
+)

mech_client/interact.py

@@ -31,7 +31,7 @@ import os
 import sys
 import time
 import warnings
-from dataclasses import asdict, dataclass
+from dataclasses import asdict, dataclass, field
 from datetime import datetime
 from enum import Enum
 from pathlib import Path
@@ -100,11 +100,24 @@ class LedgerConfig:
             self.is_gas_estimation_enabled = bool(is_gas_estimation_enabled)
 
 
+@dataclass
+class MechMarketplaceRequestConfig:
+    """Mech Marketplace Request Config"""
+
+    mech_marketplace_contract: Optional[str] = field(default=None)
+    priority_mech_address: Optional[str] = field(default=None)
+    delivery_rate: Optional[int] = field(default=None)
+    payment_type: Optional[str] = field(default=None)
+    response_timeout: Optional[int] = field(default=None)
+    payment_data: Optional[str] = field(default=None)
+
+
 @dataclass
 class MechConfig:  # pylint: disable=too-many-instance-attributes
     """Mech configuration"""
 
     agent_registry_contract: str
+    service_registry_contract: str
     rpc_url: str
     wss_endpoint: str
     ledger_config: LedgerConfig
@@ -113,6 +126,8 @@ class MechConfig:  # pylint: disable=too-many-instance-attributes
     transaction_url: str
     subgraph_url: str
     price: int
+    mech_marketplace_contract: str
+    priority_mech_address: Optional[str] = field(default=None)
 
     def __post_init__(self) -> None:
         """Post initialization to override with environment variables."""
@@ -120,6 +135,10 @@ class MechConfig:  # pylint: disable=too-many-instance-attributes
         if agent_registry_contract:
             self.agent_registry_contract = agent_registry_contract
 
+        service_registry_contract = os.getenv("MECHX_SERVICE_REGISTRY_CONTRACT")
+        if service_registry_contract:
+            self.service_registry_contract = service_registry_contract
+
         rpc_url = os.getenv("MECHX_CHAIN_RPC")
         if rpc_url:
             self.rpc_url = rpc_url
@@ -170,8 +189,11 @@ def get_mech_config(chain_config: Optional[str] = None) -> MechConfig:
 
         entry = data[chain_config].copy()
         ledger_config = LedgerConfig(**entry.pop("ledger_config"))
-        mech_config = MechConfig(**entry, ledger_config=ledger_config)
 
+        mech_config = MechConfig(
+            **entry,
+            ledger_config=ledger_config,
+        )
         return mech_config