-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #60 from KahanMajmudar/feat/mech-marketplace-support
WIP: adds support to send request to the mech marketplace
- Loading branch information
Showing
4 changed files
with
280 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,235 @@ | ||
| import time | ||
| from dataclasses import asdict | ||
| from datetime import datetime | ||
| from pathlib import Path | ||
| from typing import Any, Dict, Optional, List, Tuple | ||
|
|
||
| import websocket | ||
| from aea_ledger_ethereum import EthereumApi, EthereumCrypto | ||
| from web3.contract import Contract as Web3Contract | ||
| from web3.constants import ADDRESS_ZERO | ||
|
|
||
| from mech_client.prompt_to_ipfs import push_metadata_to_ipfs | ||
| from mech_client.wss import ( | ||
| register_event_handlers, | ||
| ) | ||
| from mech_client.interact import ( | ||
| PRIVATE_KEY_FILE_PATH, | ||
| MECH_CONFIGS, | ||
| MAX_RETRIES, | ||
| WAIT_SLEEP, | ||
| TIMEOUT, | ||
| ConfirmationType, | ||
| calculate_topic_id, | ||
| get_mech_config, | ||
| get_abi, | ||
| get_contract, | ||
| ) | ||
|
|
||
|
|
||
| def get_event_signatures(abi: List) -> Tuple[str, str]: | ||
| """Calculate `Marketplace Request` and `Marketplace Deliver` event topics""" | ||
| marketplace_request, marketplace_deliver = "", "" | ||
| for obj in abi: | ||
| if obj["type"] != "event": | ||
| continue | ||
| if obj["name"] == "MarketplaceDeliver": | ||
| marketplace_deliver = calculate_topic_id(event=obj) | ||
| if obj["name"] == "MarketplaceRequest": | ||
| marketplace_request = calculate_topic_id(event=obj) | ||
| return marketplace_request, marketplace_deliver | ||
|
|
||
|
|
||
| def send_marketplace_request( # pylint: disable=too-many-arguments,too-many-locals | ||
| crypto: EthereumCrypto, | ||
| ledger_api: EthereumApi, | ||
| marketplace_contract: Web3Contract, | ||
| gas_limit: int, | ||
| prompt: str, | ||
| tool: str, | ||
| extra_attributes: Optional[Dict[str, Any]] = None, | ||
| price: int = 10_000_000_000_000_000, | ||
| retries: Optional[int] = None, | ||
| timeout: Optional[float] = None, | ||
| sleep: Optional[float] = None, | ||
| ) -> Optional[str]: | ||
| """ | ||
| Sends a request to the mech. | ||
| :param crypto: The Ethereum crypto object. | ||
| :type crypto: EthereumCrypto | ||
| :param ledger_api: The Ethereum API used for interacting with the ledger. | ||
| :type ledger_api: EthereumApi | ||
| :param marketplace_contract: The mech marketplace contract instance. | ||
| :type marketplace_contract: Web3Contract | ||
| :param gas_limit: Gas limit. | ||
| :type gas_limit: int | ||
| :param prompt: The request prompt. | ||
| :type prompt: str | ||
| :param tool: The requested tool. | ||
| :type tool: str | ||
| :param extra_attributes: Extra attributes to be included in the request metadata. | ||
| :type extra_attributes: Optional[Dict[str,Any]] | ||
| :param price: The price for the request (default: 10_000_000_000_000_000). | ||
| :type price: int | ||
| :param retries: Number of retries for sending a transaction | ||
| :type retries: int | ||
| :param timeout: Timeout to wait for the transaction | ||
| :type timeout: float | ||
| :param sleep: Amount of sleep before retrying the transaction | ||
| :type sleep: float | ||
| :return: The transaction hash. | ||
| :rtype: Optional[str] | ||
| """ | ||
| v1_file_hash_hex_truncated, v1_file_hash_hex = push_metadata_to_ipfs( | ||
| prompt, tool, extra_attributes | ||
| ) | ||
| print( | ||
| f" - Prompt uploaded: https://gateway.autonolas.tech/ipfs/{v1_file_hash_hex}" | ||
| ) | ||
| method_name = "request" | ||
| methord_args = { | ||
| "data": v1_file_hash_hex_truncated, | ||
| "priorityMech": ADDRESS_ZERO, | ||
| "priorityMechStakingInstance": ADDRESS_ZERO, | ||
| "priorityMechServiceId": 0, | ||
| "requesterStakingInstance": ADDRESS_ZERO, | ||
| "requesterServiceId": 0, | ||
| "responseTimeout": 300, | ||
| } | ||
| tx_args = { | ||
| "sender_address": crypto.address, | ||
| "value": price, | ||
| "gas": gas_limit, | ||
| } | ||
|
|
||
| tries = 0 | ||
| retries = retries or MAX_RETRIES | ||
| timeout = timeout or TIMEOUT | ||
| sleep = sleep or WAIT_SLEEP | ||
| deadline = datetime.now().timestamp() + timeout | ||
|
|
||
| while tries < retries and datetime.now().timestamp() < deadline: | ||
| tries += 1 | ||
| try: | ||
| raw_transaction = ledger_api.build_transaction( | ||
| contract_instance=marketplace_contract, | ||
| method_name=method_name, | ||
| method_args=methord_args, | ||
| tx_args=tx_args, | ||
| raise_on_try=True, | ||
| ) | ||
| signed_transaction = crypto.sign_transaction(raw_transaction) | ||
| transaction_digest = ledger_api.send_signed_transaction( | ||
| signed_transaction, | ||
| raise_on_try=True, | ||
| ) | ||
| return transaction_digest | ||
| except Exception as e: # pylint: disable=broad-except | ||
| print( | ||
| f"Error occured while sending the transaction: {e}; Retrying in {sleep}" | ||
| ) | ||
| time.sleep(sleep) | ||
| return None | ||
|
|
||
|
|
||
| def marketplace_interact( | ||
| prompt: str, | ||
| tool: Optional[str] = None, | ||
| extra_attributes: Optional[Dict[str, Any]] = None, | ||
| private_key_path: Optional[str] = None, | ||
| confirmation_type: ConfirmationType = ConfirmationType.WAIT_FOR_BOTH, | ||
| retries: Optional[int] = None, | ||
| timeout: Optional[float] = None, | ||
| sleep: Optional[float] = None, | ||
| chain_config: Optional[str] = None, | ||
| ) -> Any: | ||
| """ | ||
| Interact with mech marketplace contract. | ||
| :param prompt: The interaction prompt. | ||
| :type prompt: str | ||
| :param tool: The tool to interact with (optional). | ||
| :type tool: Optional[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). | ||
| :type private_key_path: Optional[str] | ||
| :param confirmation_type: The confirmation type for the interaction (default: ConfirmationType.WAIT_FOR_BOTH). | ||
| :type confirmation_type: ConfirmationType | ||
| :return: The data received from on-chain/off-chain. | ||
| :param retries: Number of retries for sending a transaction | ||
| :type retries: int | ||
| :param timeout: Timeout to wait for the transaction | ||
| :type timeout: float | ||
| :param sleep: Amount of sleep before retrying the transaction | ||
| :type sleep: float | ||
| :param chain_config: Id of the mech's chain configuration (stored configs/mechs.json) | ||
| :type chain_config: str: | ||
| :rtype: Any | ||
| """ | ||
|
|
||
| mech_config = get_mech_config(chain_config) | ||
| ledger_config = mech_config.ledger_config | ||
| contract_address = mech_config.mech_marketplace_contract | ||
| if contract_address is None: | ||
| raise ValueError(f"Mech Marketplace does not exist!") | ||
|
|
||
| private_key_path = private_key_path or PRIVATE_KEY_FILE_PATH | ||
| if not Path(private_key_path).exists(): | ||
| raise FileNotFoundError( | ||
| f"Private key file `{private_key_path}` does not exist!" | ||
| ) | ||
|
|
||
| wss = websocket.create_connection(mech_config.wss_endpoint) | ||
| crypto = EthereumCrypto(private_key_path=private_key_path) | ||
| ledger_api = EthereumApi(**asdict(ledger_config)) | ||
|
|
||
| abi = get_abi( | ||
| contract_address=contract_address, | ||
| contract_abi_url=mech_config.contract_abi_url, | ||
| ) | ||
| mech_marketplace_contract = get_contract( | ||
| contract_address=contract_address, abi=abi, ledger_api=ledger_api | ||
| ) | ||
|
|
||
| marketplace_request_event_signature, marketplace_deliver_event_signature = ( | ||
| get_event_signatures(abi=abi) | ||
| ) | ||
|
|
||
| register_event_handlers( | ||
| wss=wss, | ||
| contract_address=contract_address, | ||
| crypto=crypto, | ||
| request_signature=marketplace_request_event_signature, | ||
| deliver_signature=marketplace_deliver_event_signature, | ||
| ) | ||
|
|
||
| print("Sending Mech Marketplace request...") | ||
| price = mech_config.price or 10_000_000_000_000_000 | ||
|
|
||
| transaction_digest = send_marketplace_request( | ||
| crypto=crypto, | ||
| ledger_api=ledger_api, | ||
| marketplace_contract=mech_marketplace_contract, | ||
| gas_limit=mech_config.gas_limit, | ||
| price=price, | ||
| prompt=prompt, | ||
| tool=tool, | ||
| extra_attributes=extra_attributes, | ||
| retries=retries, | ||
| timeout=timeout, | ||
| sleep=sleep, | ||
| ) | ||
|
|
||
| if not transaction_digest: | ||
| print("Unable to send request") | ||
| return None | ||
|
|
||
| transaction_url_formatted = mech_config.transaction_url.format( | ||
| transaction_digest=transaction_digest | ||
| ) | ||
| print(f" - Transaction sent: {transaction_url_formatted}") | ||
| print(" - Waiting for transaction receipt...") | ||
|
|
||
| return |