mech-client 0.14.0__py3-none-any.whl → 0.15.0__py3-none-any.whl

scripts/nvm_subscription/manager.py

@@ -4,12 +4,10 @@ import json
 import logging
 import os
 import sys
-import requests
 
 import uuid
-from typing import Any, Dict, List, Literal, Union
+from typing import Any, Dict, Optional, Tuple
 from web3 import Web3
-from eth_account import Account
 from eth_typing import ChecksumAddress
 
 from .contracts.did_registry import DIDRegistryContract
@@ -22,6 +20,8 @@ from .contracts.token import SubscriptionToken
 from .contracts.nft import SubscriptionNFT
 from .contracts.subscription_provider import SubscriptionProvider
 
+from mech_client.safe import EthereumClient, get_safe_nonce, send_safe_tx
+
 logger = logging.getLogger(__name__)
 
 BASE_DIR = os.path.dirname(os.path.abspath(__file__))
@@ -32,6 +32,10 @@ class Network(Enum):
     GNOSIS = "GNOSIS"
     BASE = "BASE"
 
+class ChainId(Enum):
+    GNOSIS = 100
+    BASE = 8453
+
 
 def get_variable_value(variable: str) -> str:
     try:
@@ -49,16 +53,19 @@ class NVMSubscriptionManager:
     using a series of smart contracts.
     """
 
-    def __init__(self, network: str, private_key: str):
+    def __init__(self, network: str, sender: str, agent_mode: bool, safe_address: Optional[str]):
         """
         Initialize the SubscriptionManager, including contract instances
         and Web3 connection.
         """
-        self.url = os.getenv("MECHX_CHAIN_RPC", CONFIGS[network]["nvm"]['web3ProviderUri'])
+        self.url = os.getenv("MECHX_RPC_URL", CONFIGS[network]["nvm"]['web3ProviderUri'])
         self.web3 = Web3(Web3.HTTPProvider(self.url))
+        self.agent_mode = agent_mode
+        if self.agent_mode:
+            self.safe_address = str(safe_address)
+        self.ethereum_client = EthereumClient(self.url)
 
-        self.account = Account.from_key(private_key)
-        self.sender: ChecksumAddress = self.web3.to_checksum_address(self.account.address)
+        self.sender: ChecksumAddress = self.web3.to_checksum_address(sender)
 
         self.did_registry = DIDRegistryContract(self.web3)
         self.nft_sales = NFTSalesTemplateContract(self.web3)
@@ -99,6 +106,12 @@ class NVMSubscriptionManager:
         Returns:
             Dict[str, Any]: A dictionary containing transaction status and receipt.
         """
+        print(f"Checking {self.sender} balance for purchasing subscription...")       
+        is_enough, message = self.check_sufficient_sender_balance()
+        if not is_enough:
+            print(message)
+            sys.exit(1)
+
         logger.info(f"Creating subscription for DID: {did}")
 
         did = did.replace("did:nv:", "0x")
@@ -152,18 +165,36 @@ class NVMSubscriptionManager:
 
         # we set value as xdai is used as subscription for gnosis
         value_eth = 1
-        if chain_id == 8453:
+        if chain_id == ChainId.BASE.value:
             # for base, usdc is used and so we don't send any value
             value_eth = 0
 
+            if not self.agent_mode:
+                nonce = self.web3.eth.get_transaction_count(self.sender)
+            else:
+                nonce = get_safe_nonce(self.ethereum_client, self.safe_address)
+
             approve_tx = self.subscription_token.build_approve_token_tx(
                 sender=self.sender,
                 to=self.lock_payment.address,
                 amount=10**6,
+                nonce=nonce,
                 chain_id=chain_id,
             )
-            signed_tx = self.web3.eth.account.sign_transaction(approve_tx, private_key=wallet_pvt_key)
-            tx_hash = self.web3.eth.send_raw_transaction(signed_tx.rawTransaction)
+
+            if not self.agent_mode:
+                signed_tx = self.web3.eth.account.sign_transaction(approve_tx, private_key=wallet_pvt_key)
+                tx_hash = self.web3.eth.send_raw_transaction(signed_tx.rawTransaction)
+            else:
+                tx_hash = send_safe_tx(
+                    ethereum_client=self.ethereum_client,
+                    tx_data=approve_tx["data"],
+                    to_adress=self.subscription_token.address,
+                    safe_address=self.safe_address,
+                    signer_pkey=wallet_pvt_key,
+                    value=0,
+                )
+
             receipt = self.web3.eth.wait_for_transaction_receipt(tx_hash)
 
             if receipt["status"] == 1:
@@ -173,6 +204,12 @@ class NVMSubscriptionManager:
                 logger.error("Approve transaction failed")
                 return {"status": "failed", "receipt": dict(receipt)}
 
+
+        if not self.agent_mode:
+            nonce = self.web3.eth.get_transaction_count(self.sender)
+        else:
+            nonce = get_safe_nonce(self.ethereum_client, self.safe_address)
+
         # Build transaction
         tx = self.nft_sales.build_create_agreement_tx(
             agreement_id_seed=agreement_id_seed,
@@ -187,12 +224,24 @@ class NVMSubscriptionManager:
             amounts=self.amounts,
             receivers=receivers,
             sender=self.sender,
+            nonce=nonce,
             value_eth=value_eth,
             chain_id=chain_id
         )
 
-        signed_tx = self.web3.eth.account.sign_transaction(tx, private_key=wallet_pvt_key)
-        tx_hash = self.web3.eth.send_raw_transaction(signed_tx.rawTransaction)
+        if not self.agent_mode:
+            signed_tx = self.web3.eth.account.sign_transaction(tx, private_key=wallet_pvt_key)
+            tx_hash = self.web3.eth.send_raw_transaction(signed_tx.rawTransaction)
+        else:
+            tx_hash = send_safe_tx(
+                ethereum_client=self.ethereum_client,
+                tx_data=tx["data"],
+                to_adress=self.nft_sales.address,
+                safe_address=self.safe_address,
+                signer_pkey=wallet_pvt_key,
+                value=self.web3.to_wei(value_eth, "ether"),
+            )
+
         receipt = self.web3.eth.wait_for_transaction_receipt(transaction_hash=tx_hash)
 
         if receipt["status"] == 1:
@@ -236,20 +285,37 @@ class NVMSubscriptionManager:
             "0x" + transfer_id.hex(),
         )
 
+        if not self.agent_mode:
+            nonce = self.web3.eth.get_transaction_count(self.sender)
+        else:
+            nonce = get_safe_nonce(self.ethereum_client, self.safe_address)
+
         fulfill_tx = self.subscription_provider.build_create_fulfill_tx(
             agreement_id_seed="0x" + agreement_id.hex(),
             did=did,
             fulfill_for_delegate_params=fulfill_for_delegate_params,
             fulfill_params=fulfill_params,
             sender=self.sender,
+            nonce=nonce,
             value_eth=0,
             chain_id=chain_id,
         )
 
-        signed_tx = self.web3.eth.account.sign_transaction(
-            fulfill_tx, private_key=wallet_pvt_key
-        )
-        tx_hash = self.web3.eth.send_raw_transaction(signed_tx.rawTransaction)
+        if not self.agent_mode:
+            signed_tx = self.web3.eth.account.sign_transaction(
+                fulfill_tx, private_key=wallet_pvt_key
+            )
+            tx_hash = self.web3.eth.send_raw_transaction(signed_tx.rawTransaction)
+        else:
+            tx_hash = send_safe_tx(
+                ethereum_client=self.ethereum_client,
+                tx_data=fulfill_tx["data"],
+                to_adress=self.subscription_provider.address,
+                safe_address=self.safe_address,
+                signer_pkey=wallet_pvt_key,
+                value=0,
+            )
+
         receipt = self.web3.eth.wait_for_transaction_receipt(transaction_hash=tx_hash)
 
         user_credit_balance_after = self.subscription_nft.get_balance(
@@ -263,3 +329,30 @@ class NVMSubscriptionManager:
         else:
             logger.error("Subscription purchase transaction failed")
             return {"status": "failed", "receipt": dict(receipt)}
+
+
+    def check_sufficient_sender_balance(self) -> Tuple[bool, str]:
+        w3 = self.web3
+        sender = self.sender
+        chain_id = w3.eth.chain_id
+
+        # For gnosis, native xdai is used for purchase 
+        if chain_id == ChainId.GNOSIS.value:
+            required_balance = w3.from_wei(10**18, unit='ether')
+            native_balance = w3.from_wei(w3.eth.get_balance(sender), unit='ether')
+            return (
+                native_balance >= required_balance,
+                f"Not enough balance. Required: {required_balance} xdai, Found: {native_balance} xdai",
+            )
+        
+        # For base, usdc is used for purchase (decimal 6)
+        if chain_id == ChainId.BASE.value:
+            required_balance = w3.from_wei(10**6, unit='mwei')
+            usdc_balance = w3.from_wei(self.subscription_token.get_balance(sender), unit='mwei')
+            usdc_address = self.subscription_token.address
+            return (
+                usdc_balance >= required_balance,
+                f"Not enough balance. Required: {required_balance} usdc (token {usdc_address}), Found: {usdc_balance} usdc",
+            )
+        
+        return False, f"Unsupported chain: {chain_id}"

scripts/utils.py

@@ -18,7 +18,7 @@ VALID_CHAINS = [
 CHAIN_TO_NATIVE_BALANCE_TRACKER = {
     100: "0x21cE6799A22A3Da84B7c44a814a9c79ab1d2A50D",
     42161: "",
-    137: "",
+    137: "0x0000000000000000000000000000000000001010",
     8453: "0xB3921F8D8215603f0Bd521341Ac45eA8f2d274c1",
     42220: "",
     10: "",
@@ -27,7 +27,7 @@ CHAIN_TO_NATIVE_BALANCE_TRACKER = {
 CHAIN_TO_TOKEN_BALANCE_TRACKER = {
     100: "0x53Bd432516707a5212A70216284a99A563aAC1D1",
     42161: "",
-    137: "",
+    137: "0x0000000000000000000000000000000000001010",
     8453: "0x43fB32f25dce34EB76c78C7A42C8F40F84BCD237",
     42220: "",
     10: "",

scripts/whitelist.py

@@ -2,4 +2,12 @@ directory # unused attribute (mech_client/acn.py:85)
 directory # unused attribute (mech_client/acn.py:100)
 directory # unused attribute (mech_client/acn.py:116)
 payment_data # unused variable (mech_client/interact.py:111)
-AGENT_QUERY_TEMPLATE # unused variable (mech_client/subgraph.py:30)
+AGENT_QUERY_TEMPLATE # unused variable (mech_client/subgraph.py:30)
+principal_chain # unused variable (mech_client/cli.py:92)
+configure_local_config # unused variable (mech_client/cli.py:162)
+verify_tools #unused function
+
+# Existing entries...
+send_marketplace_request_nonblocking  # used in tests/locustfile.py
+delivery_consumer_loop_status_only    # used in tests/locustfile.py
+

mech_client/helpers/acn/README.md

@@ -1,76 +0,0 @@
-# ACN Protocol
-
-## Description
-
-This is a protocol for ACN (agent communication network) envelope delivery.
-
-## Specification
-
-```yaml
----
-name: acn
-author: valory
-version: 1.1.0
-description: The protocol used for envelope delivery on the ACN.
-license: Apache-2.0
-aea_version: '>=1.0.0, <2.0.0'
-protocol_specification_id: aea/acn:1.0.0
-speech_acts:
-  register:
-    record: ct:AgentRecord
-  lookup_request:
-    agent_address: pt:str
-  lookup_response:
-    record: ct:AgentRecord
-  aea_envelope:
-    envelope: pt:bytes
-    record: ct:AgentRecord
-  status:
-    body: ct:StatusBody
-...
----
-ct:AgentRecord:
-  string service_id = 1;
-  string ledger_id = 2;
-  string address = 3;
-  string public_key = 4;
-  string peer_public_key = 5;
-  string signature = 6;
-  string not_before = 7;
-  string not_after = 8;
-ct:StatusBody: |
-  enum StatusCodeEnum {
-    // common (0x)
-    SUCCESS = 0;
-    ERROR_UNSUPPORTED_VERSION = 1;
-    ERROR_UNEXPECTED_PAYLOAD = 2;
-    ERROR_GENERIC = 3;
-    ERROR_DECODE = 4;
-    // register (1x)
-    ERROR_WRONG_AGENT_ADDRESS = 10;
-    ERROR_WRONG_PUBLIC_KEY = 11;
-    ERROR_INVALID_PROOF = 12;
-    ERROR_UNSUPPORTED_LEDGER = 13;
-    // lookup & delivery (2x) 
-    ERROR_UNKNOWN_AGENT_ADDRESS = 20;
-    ERROR_AGENT_NOT_READY = 21;
-  }
-  StatusCodeEnum code = 1;
-  repeated string msgs = 2;
-...
----
-initiation: [register, lookup_request, aea_envelope]
-reply:
-  register: [status]
-  lookup_request: [lookup_response, status]
-  aea_envelope: [status]
-  status: []
-  lookup_response: []
-termination: [status, lookup_response]
-roles: {node}
-end_states: [successful, failed]
-keep_terminal_state_dialogues: false
-...
-```
-
-## Links

mech_client/helpers/acn/__init__.py

@@ -1,30 +0,0 @@
-# -*- coding: utf-8 -*-
-# ------------------------------------------------------------------------------
-#
-#   Copyright 2024 valory
-#
-#   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 module contains the support resources for the acn protocol.
-
-It was created with protocol buffer compiler version `libprotoc 24.3` and aea protocol generator version `1.0.0`.
-"""
-
-from packages.valory.protocols.acn.message import AcnMessage
-from packages.valory.protocols.acn.serialization import AcnSerializer
-
-
-AcnMessage.serializer = AcnSerializer

mech_client/helpers/acn/acn.proto

@@ -1,71 +0,0 @@
-syntax = "proto3";
-
-package aea.aea.acn.v1_0_0;
-
-message AcnMessage{
-
-  // Custom Types
-  message AgentRecord{
-    string service_id = 1;
-    string ledger_id = 2;
-    string address = 3;
-    string public_key = 4;
-    string peer_public_key = 5;
-    string signature = 6;
-    string not_before = 7;
-    string not_after = 8;
-  }
-
-  message StatusBody{
-    enum StatusCodeEnum {
-      // common (0x)
-      SUCCESS = 0;
-      ERROR_UNSUPPORTED_VERSION = 1;
-      ERROR_UNEXPECTED_PAYLOAD = 2;
-      ERROR_GENERIC = 3;
-      ERROR_DECODE = 4;
-      // register (1x)
-      ERROR_WRONG_AGENT_ADDRESS = 10;
-      ERROR_WRONG_PUBLIC_KEY = 11;
-      ERROR_INVALID_PROOF = 12;
-      ERROR_UNSUPPORTED_LEDGER = 13;
-      // lookup & delivery (2x) 
-      ERROR_UNKNOWN_AGENT_ADDRESS = 20;
-      ERROR_AGENT_NOT_READY = 21;
-    }
-    StatusCodeEnum code = 1;
-    repeated string msgs = 2;
-  }
-
-
-  // Performatives and contents
-  message Register_Performative{
-    AgentRecord record = 1;
-  }
-
-  message Lookup_Request_Performative{
-    string agent_address = 1;
-  }
-
-  message Lookup_Response_Performative{
-    AgentRecord record = 1;
-  }
-
-  message Aea_Envelope_Performative{
-    bytes envelope = 1;
-    AgentRecord record = 2;
-  }
-
-  message Status_Performative{
-    StatusBody body = 1;
-  }
-
-
-  oneof performative{
-    Aea_Envelope_Performative aea_envelope = 5;
-    Lookup_Request_Performative lookup_request = 6;
-    Lookup_Response_Performative lookup_response = 7;
-    Register_Performative register = 8;
-    Status_Performative status = 9;
-  }
-}

mech_client/helpers/acn/acn_pb2.py

@@ -1,42 +0,0 @@
-# -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: acn.proto
-"""Generated protocol buffer code."""
-from google.protobuf import descriptor as _descriptor
-from google.protobuf import descriptor_pool as _descriptor_pool
-from google.protobuf import symbol_database as _symbol_database
-from google.protobuf.internal import builder as _builder
-
-# @@protoc_insertion_point(imports)
-
-_sym_db = _symbol_database.Default()
-
-
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(
-    b'\n\tacn.proto\x12\x12\x61\x65\x61.aea.acn.v1_0_0"\x92\x0b\n\nAcnMessage\x12P\n\x0c\x61\x65\x61_envelope\x18\x05 \x01(\x0b\x32\x38.aea.aea.acn.v1_0_0.AcnMessage.Aea_Envelope_PerformativeH\x00\x12T\n\x0elookup_request\x18\x06 \x01(\x0b\x32:.aea.aea.acn.v1_0_0.AcnMessage.Lookup_Request_PerformativeH\x00\x12V\n\x0flookup_response\x18\x07 \x01(\x0b\x32;.aea.aea.acn.v1_0_0.AcnMessage.Lookup_Response_PerformativeH\x00\x12H\n\x08register\x18\x08 \x01(\x0b\x32\x34.aea.aea.acn.v1_0_0.AcnMessage.Register_PerformativeH\x00\x12\x44\n\x06status\x18\t \x01(\x0b\x32\x32.aea.aea.acn.v1_0_0.AcnMessage.Status_PerformativeH\x00\x1a\xac\x01\n\x0b\x41gentRecord\x12\x12\n\nservice_id\x18\x01 \x01(\t\x12\x11\n\tledger_id\x18\x02 \x01(\t\x12\x0f\n\x07\x61\x64\x64ress\x18\x03 \x01(\t\x12\x12\n\npublic_key\x18\x04 \x01(\t\x12\x17\n\x0fpeer_public_key\x18\x05 \x01(\t\x12\x11\n\tsignature\x18\x06 \x01(\t\x12\x12\n\nnot_before\x18\x07 \x01(\t\x12\x11\n\tnot_after\x18\x08 \x01(\t\x1a\x92\x03\n\nStatusBody\x12\x46\n\x04\x63ode\x18\x01 \x01(\x0e\x32\x38.aea.aea.acn.v1_0_0.AcnMessage.StatusBody.StatusCodeEnum\x12\x0c\n\x04msgs\x18\x02 \x03(\t"\xad\x02\n\x0eStatusCodeEnum\x12\x0b\n\x07SUCCESS\x10\x00\x12\x1d\n\x19\x45RROR_UNSUPPORTED_VERSION\x10\x01\x12\x1c\n\x18\x45RROR_UNEXPECTED_PAYLOAD\x10\x02\x12\x11\n\rERROR_GENERIC\x10\x03\x12\x10\n\x0c\x45RROR_DECODE\x10\x04\x12\x1d\n\x19\x45RROR_WRONG_AGENT_ADDRESS\x10\n\x12\x1a\n\x16\x45RROR_WRONG_PUBLIC_KEY\x10\x0b\x12\x17\n\x13\x45RROR_INVALID_PROOF\x10\x0c\x12\x1c\n\x18\x45RROR_UNSUPPORTED_LEDGER\x10\r\x12\x1f\n\x1b\x45RROR_UNKNOWN_AGENT_ADDRESS\x10\x14\x12\x19\n\x15\x45RROR_AGENT_NOT_READY\x10\x15\x1aS\n\x15Register_Performative\x12:\n\x06record\x18\x01 \x01(\x0b\x32*.aea.aea.acn.v1_0_0.AcnMessage.AgentRecord\x1a\x34\n\x1bLookup_Request_Performative\x12\x15\n\ragent_address\x18\x01 \x01(\t\x1aZ\n\x1cLookup_Response_Performative\x12:\n\x06record\x18\x01 \x01(\x0b\x32*.aea.aea.acn.v1_0_0.AcnMessage.AgentRecord\x1ai\n\x19\x41\x65\x61_Envelope_Performative\x12\x10\n\x08\x65nvelope\x18\x01 \x01(\x0c\x12:\n\x06record\x18\x02 \x01(\x0b\x32*.aea.aea.acn.v1_0_0.AcnMessage.AgentRecord\x1aN\n\x13Status_Performative\x12\x37\n\x04\x62ody\x18\x01 \x01(\x0b\x32).aea.aea.acn.v1_0_0.AcnMessage.StatusBodyB\x0e\n\x0cperformativeb\x06proto3'
-)
-
-_globals = globals()
-_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
-_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, "acn_pb2", _globals)
-if _descriptor._USE_C_DESCRIPTORS == False:
-    DESCRIPTOR._options = None
-    _globals["_ACNMESSAGE"]._serialized_start = 34
-    _globals["_ACNMESSAGE"]._serialized_end = 1460
-    _globals["_ACNMESSAGE_AGENTRECORD"]._serialized_start = 449
-    _globals["_ACNMESSAGE_AGENTRECORD"]._serialized_end = 621
-    _globals["_ACNMESSAGE_STATUSBODY"]._serialized_start = 624
-    _globals["_ACNMESSAGE_STATUSBODY"]._serialized_end = 1026
-    _globals["_ACNMESSAGE_STATUSBODY_STATUSCODEENUM"]._serialized_start = 725
-    _globals["_ACNMESSAGE_STATUSBODY_STATUSCODEENUM"]._serialized_end = 1026
-    _globals["_ACNMESSAGE_REGISTER_PERFORMATIVE"]._serialized_start = 1028
-    _globals["_ACNMESSAGE_REGISTER_PERFORMATIVE"]._serialized_end = 1111
-    _globals["_ACNMESSAGE_LOOKUP_REQUEST_PERFORMATIVE"]._serialized_start = 1113
-    _globals["_ACNMESSAGE_LOOKUP_REQUEST_PERFORMATIVE"]._serialized_end = 1165
-    _globals["_ACNMESSAGE_LOOKUP_RESPONSE_PERFORMATIVE"]._serialized_start = 1167
-    _globals["_ACNMESSAGE_LOOKUP_RESPONSE_PERFORMATIVE"]._serialized_end = 1257
-    _globals["_ACNMESSAGE_AEA_ENVELOPE_PERFORMATIVE"]._serialized_start = 1259
-    _globals["_ACNMESSAGE_AEA_ENVELOPE_PERFORMATIVE"]._serialized_end = 1364
-    _globals["_ACNMESSAGE_STATUS_PERFORMATIVE"]._serialized_start = 1366
-    _globals["_ACNMESSAGE_STATUS_PERFORMATIVE"]._serialized_end = 1444
-# @@protoc_insertion_point(module_scope)