olas-operate-middleware 0.13.2__py3-none-any.whl → 0.13.4__py3-none-any.whl

operate/keys.py

@@ -144,9 +144,11 @@ class KeysManager:
         key = Key(
             ledger=LedgerType.ETHEREUM,
             address=crypto.address,
-            private_key=crypto.encrypt(password=self.password)
-            if self.password is not None
-            else crypto.private_key,
+            private_key=(
+                crypto.encrypt(password=self.password)
+                if self.password is not None
+                else crypto.private_key
+            ),
         )
         for path in (
             self.path / f"{crypto.address}.bak",

operate/ledger/__init__.py

@@ -27,7 +27,6 @@ from math import ceil
 from aea.crypto.base import LedgerApi
 from aea.crypto.registries import make_ledger_api
 from aea_ledger_ethereum import DEFAULT_GAS_PRICE_STRATEGIES, EIP1559, GWEI, to_wei
-from web3.middleware import geth_poa_middleware
 
 from operate.operate_types import Chain
 
@@ -133,12 +132,9 @@ def make_chain_ledger_api(
         address=rpc or get_default_rpc(chain=chain),
         chain_id=chain.id,
         gas_price_strategies=gas_price_strategies,
-        poa_chain=chain == Chain.POLYGON,
+        poa_chain=chain in (Chain.OPTIMISM, Chain.POLYGON),
     )
 
-    if chain == Chain.OPTIMISM:
-        ledger_api.api.middleware_onion.inject(geth_poa_middleware, layer=0)
-
     return ledger_api
 
 
@@ -183,7 +179,6 @@ def update_tx_with_gas_pricing(tx: t.Dict, ledger_api: LedgerApi) -> None:
 # TODO This gas management should be done at a lower level in the library
 def update_tx_with_gas_estimate(tx: t.Dict, ledger_api: LedgerApi) -> None:
     """Update transaction with gas estimate."""
-    print(f"[LEDGER] Trying to update transaction gas {tx['from']=} {tx['gas']=}.")
     original_from = tx["from"]
     original_gas = tx.get("gas", 1)
 
@@ -192,7 +187,6 @@ def update_tx_with_gas_estimate(tx: t.Dict, ledger_api: LedgerApi) -> None:
         tx["gas"] = 1
         ledger_api.update_with_gas_estimate(tx)
         if tx["gas"] > 1:
-            print(f"[LEDGER] Gas estimated successfully {tx['from']=} {tx['gas']=}.")
             break
 
     tx["from"] = original_from

operate/ledger/profiles.py

@@ -46,7 +46,6 @@ for _chain in CHAINS:
                 "service_registry_token_utility": profile[
                     "service_registry_token_utility"
                 ],
-                "service_manager": profile["service_manager_token"],
                 "gnosis_safe_proxy_factory": profile["gnosis_safe_proxy_factory"],
                 "gnosis_safe_same_address_multisig": profile[
                     "gnosis_safe_same_address_multisig"

operate/operate_http/__init__.py

@@ -32,8 +32,6 @@ from starlette.types import Receive, Scope, Send
 from operate.operate_http.exceptions import NotAllowed, ResourceException
 
 
-# pylint: disable=no-self-use
-
 GenericResource = t.TypeVar("GenericResource")
 PostPayload = t.TypeVar("PostPayload")
 PostResponse = t.TypeVar("PostResponse")

operate/operate_types.py

@@ -30,7 +30,7 @@ from pathlib import Path
 import argon2
 from aea_ledger_ethereum import cast
 from autonomy.chain.config import ChainType
-from autonomy.chain.constants import CHAIN_NAME_TO_CHAIN_ID
+from autonomy.chain.config import LedgerType as LedgerTypeOA
 from cryptography.fernet import Fernet
 from typing_extensions import TypedDict
 
@@ -38,98 +38,8 @@ from operate.constants import FERNET_KEY_LENGTH, NO_STAKING_PROGRAM_ID
 from operate.resource import LocalResource
 
 
-CHAIN_NAME_TO_CHAIN_ID["solana"] = 900
-
-_CHAIN_ID_TO_CHAIN_NAME = {
-    chain_id: chain_name for chain_name, chain_id in CHAIN_NAME_TO_CHAIN_ID.items()
-}
-
-
-class LedgerType(str, enum.Enum):
-    """Ledger type enum."""
-
-    ETHEREUM = "ethereum"
-    SOLANA = "solana"
-
-    @property
-    def config_file(self) -> str:
-        """Config filename."""
-        return f"{self.name.lower()}.json"
-
-    @property
-    def key_file(self) -> str:
-        """Key filename."""
-        return f"{self.name.lower()}.txt"
-
-    @property
-    def mnemonic_file(self) -> str:
-        """Mnemonic filename."""
-        return f"{self.name.lower()}.mnemonic.json"
-
-    @classmethod
-    def from_id(cls, chain_id: int) -> "LedgerType":
-        """Load from chain ID."""
-        return Chain(_CHAIN_ID_TO_CHAIN_NAME[chain_id]).ledger_type
-
-
-# Dynamically create the Chain enum from the ChainType
-# TODO: Migrate this to open-autonomy and remove this modified version of Chain here and use the one from open-autonomy
-# This version of open-autonomy must support the LedgerType to support SOLANA in the future
-# If solana support is not fuly implemented, decide to keep this half-baked feature.
-#
-# TODO: Once the above issue is properly implemented in Open Autonomy, remove the following
-# lines from tox.ini:
-#
-#    exclude = ^(operate/operate_types\.py|scripts/setup_wallet\.py|operate/ledger/profiles\.py|operate/ledger/__init__\.py|operate/wallet/master\.py|operate/services/protocol\.py|operate/services/manage\.py|operate/cli\.py)$
-#
-#    [mypy-operate.*]
-#    follow_imports = skip  # noqa
-#
-# These lines were itroduced to resolve mypy issues with the temporary Chain/ChainType solution.
-Chain = enum.Enum(
-    "Chain",
-    [(member.name, member.value) for member in ChainType]
-    + [
-        ("SOLANA", "solana"),
-    ],
-)
-
-
-class ChainMixin:
-    """Mixin for some new functions in the ChainType class."""
-
-    @property
-    def id(self) -> t.Optional[int]:
-        """Chain ID"""
-        if self == Chain.CUSTOM:
-            chain_id = os.environ.get("CUSTOM_CHAIN_ID")
-            if chain_id is None:
-                return None
-            return int(chain_id)
-        return CHAIN_NAME_TO_CHAIN_ID[self.value]
-
-    @property
-    def ledger_type(self) -> LedgerType:
-        """Ledger type."""
-        if self in (Chain.SOLANA,):
-            return LedgerType.SOLANA
-        return LedgerType.ETHEREUM
-
-    @classmethod
-    def from_string(cls, chain: str) -> "Chain":
-        """Load from string."""
-        return Chain(chain.lower())
-
-    @classmethod
-    def from_id(cls, chain_id: int) -> "Chain":
-        """Load from chain ID."""
-        return Chain(_CHAIN_ID_TO_CHAIN_NAME[chain_id])
-
-
-# Add the ChainMixin methods to the Chain enum
-for name in dir(ChainMixin):
-    if not name.startswith("__"):
-        setattr(Chain, name, getattr(ChainMixin, name))
+LedgerType = LedgerTypeOA
+Chain = ChainType
 
 
 class DeploymentStatus(enum.IntEnum):

operate/quickstart/run_service.py

@@ -34,7 +34,12 @@ from halo import Halo  # type: ignore[import]
 from web3.exceptions import Web3Exception
 
 from operate.account.user import UserAccount
-from operate.constants import IPFS_ADDRESS, NO_STAKING_PROGRAM_ID, USER_JSON
+from operate.constants import (
+    DEFAULT_TIMEOUT,
+    IPFS_ADDRESS,
+    NO_STAKING_PROGRAM_ID,
+    USER_JSON,
+)
 from operate.data import DATA_DIR
 from operate.data.contracts.staking_token.contract import StakingTokenContract
 from operate.ledger import DEFAULT_RPCS
@@ -49,6 +54,7 @@ from operate.quickstart.utils import (
     CHAIN_TO_METADATA,
     QuickstartConfig,
     ask_or_get_from_env,
+    ask_yes_or_no,
     check_rpc,
     print_box,
     print_section,
@@ -124,6 +130,42 @@ QS_STAKING_PROGRAMS: t.Dict[Chain, t.Dict[str, str]] = {
     },
 }
 
+DEPRECATED_QS_STAKING_PROGRAMS = {
+    "quickstart_beta_hobbyist",
+    "quickstart_beta_hobbyist_2",
+    "quickstart_beta_expert",
+    "quickstart_beta_expert_2",
+    "quickstart_beta_expert_3",
+    "quickstart_beta_expert_4",
+    "quickstart_beta_expert_5",
+    "quickstart_beta_expert_6",
+    "quickstart_beta_expert_7",
+    "quickstart_beta_expert_8",
+    "quickstart_beta_expert_9",
+    "quickstart_beta_expert_10",
+    "quickstart_beta_expert_11",
+    "quickstart_beta_expert_12",
+    "quickstart_beta_expert_15_mech_marketplace",
+    "quickstart_beta_expert_16_mech_marketplace",
+    "quickstart_beta_expert_17_mech_marketplace",
+    "quickstart_beta_expert_18_mech_marketplace",
+}
+
+
+def _deprecated_program_warning(program_id: str) -> bool:
+    """Confirm deprecated program warning."""
+    if program_id not in DEPRECATED_QS_STAKING_PROGRAMS:
+        return True
+
+    print_box(
+        """
+        WARNING
+        The selected staking program is deprecated.
+        Using it may prevent your agent from earning staking rewards.
+    """
+    )
+    return ask_yes_or_no("Do you want to proceed anyway?")
+
 
 def ask_confirm_password() -> str:
     """Ask for password confirmation."""
@@ -221,6 +263,7 @@ def configure_local_config(
         LedgerType.ETHEREUM.lower(),
         address=config.rpc[config.principal_chain],  # type: ignore[index]
         chain_id=home_chain.id,
+        poa_chain=chain in (Chain.OPTIMISM.value, Chain.POLYGON.value),
     )
 
     if config.staking_program_id is None:
@@ -253,7 +296,7 @@ def configure_local_config(
                 try:
                     metadata_hash = instance.functions.metadataHash().call().hex()
                     ipfs_address = IPFS_ADDRESS.format(hash=metadata_hash)
-                    response = requests.get(ipfs_address)
+                    response = requests.get(ipfs_address, timeout=DEFAULT_TIMEOUT)
                     if response.status_code != HTTPStatus.OK:
                         raise requests.RequestException(
                             f"Failed to fetch data from {ipfs_address}: {response.status_code}"
@@ -276,7 +319,10 @@ def configure_local_config(
                 except Web3Exception:
                     metadata["available_staking_slots"] = "?"
 
-            name = metadata["name"]
+            deprecated_str = (
+                "[DEPRECATED] " if program_id in DEPRECATED_QS_STAKING_PROGRAMS else ""
+            )
+            name = deprecated_str + metadata["name"]
             description = metadata["description"]
             if "available_staking_slots" in metadata:
                 available_slots_str = (
@@ -313,12 +359,23 @@ def configure_local_config(
                         for idx, prog in available_choices.items():
                             print(f"{idx}) {prog['name']} : {prog['slots']}")
                         continue
+
+                    if not _deprecated_program_warning(
+                        available_choices[choice]["program_id"]
+                    ):
+                        continue
+
                     selected_program = available_choices[choice]
                     config.staking_program_id = selected_program["program_id"]
                     print(f"Selected staking program: {selected_program['name']}")
                     break
                 except ValueError:
                     if input_value in ids:
+                        if not _deprecated_program_warning(
+                            available_choices[choice]["program_id"]
+                        ):
+                            continue
+
                         config.staking_program_id = input_value
                         break
                     else:
@@ -431,9 +488,9 @@ def configure_local_config(
 
                 print()
 
-            template["env_variables"][env_var_name][
-                "value"
-            ] = config.user_provided_args[env_var_name]
+            template["env_variables"][env_var_name]["value"] = (
+                config.user_provided_args[env_var_name]
+            )
 
         # TODO: Handle it in a more generic way
         if (

operate/quickstart/utils.py

@@ -27,9 +27,10 @@ from pathlib import Path
 from typing import Dict, Optional, Union, get_args, get_origin
 
 import requests
-from halo import Halo  # type: ignore[import]  # pylint: disable=import-error
+from halo import Halo
+from web3.exceptions import Web3RPCError
 
-from operate.constants import ZERO_ADDRESS
+from operate.constants import DEFAULT_TIMEOUT, ZERO_ADDRESS
 from operate.ledger.profiles import OLAS, USDC
 from operate.operate_types import Chain
 from operate.resource import LocalResource, deserialize
@@ -225,11 +226,14 @@ def check_rpc(chain: str, rpc_url: Optional[str] = None) -> bool:
 
     try:
         response = requests.post(
-            rpc_url, json=rpc_data, headers={"Content-Type": "application/json"}
+            rpc_url,
+            json=rpc_data,
+            headers={"Content-Type": "application/json"},
+            timeout=DEFAULT_TIMEOUT,
         )
         response.raise_for_status()
         rpc_response = response.json()
-    except (requests.exceptions.RequestException, ValueError, TypeError) as e:
+    except (requests.exceptions.RequestException, Web3RPCError, TypeError) as e:
         spinner.fail(f"Error: Failed to send {chain} RPC request: {e}")
         return False
 

operate/resource.py

@@ -40,7 +40,7 @@ N_BACKUPS = 5
 
 def serialize(obj: t.Any) -> t.Any:
     """Serialize object."""
-    if is_dataclass(obj):
+    if is_dataclass(obj) and not isinstance(obj, type):
         return serialize(asdict(obj))
     if isinstance(obj, Path):
         return str(obj)
@@ -88,7 +88,7 @@ def deserialize(obj: t.Any, otype: t.Any) -> t.Any:
         return otype(obj)
     if otype is Path:
         return Path(obj)
-    if is_dataclass(otype):
+    if is_dataclass(otype) and hasattr(otype, "from_json"):
         return otype.from_json(obj)
     if otype is bytes:
         return bytes.fromhex(obj)

operate/services/agent_runner.py

@@ -33,7 +33,7 @@ import requests
 from aea.configurations.data_types import PublicId
 from aea.helpers.logging import setup_logger
 
-from operate.constants import AGENT_RUNNER_PREFIX, CONFIG_JSON
+from operate.constants import AGENT_RUNNER_PREFIX, CONFIG_JSON, DEFAULT_TIMEOUT
 
 
 @dataclass
@@ -52,7 +52,7 @@ class AgentRelease:
 
     def get_url_and_hash(self, asset_name: str) -> tuple[str, str]:
         """Get download url and asset sha256 hash."""
-        release_data = requests.get(self.release_url).json()
+        release_data = requests.get(self.release_url, timeout=DEFAULT_TIMEOUT).json()
 
         assets_filtered = [i for i in release_data["assets"] if i["name"] == asset_name]
         if not assets_filtered:
@@ -106,7 +106,7 @@ class AgentRunnerManager:
         """Download file of agent runner."""
         try:
             # Send a GET request to the URL
-            response = requests.get(url, stream=True)
+            response = requests.get(url, stream=True, timeout=DEFAULT_TIMEOUT)
             response.raise_for_status()  # Raise an error for bad status codes (4xx or 5xx)
 
             # Open the file in binary write mode and save the content

operate/services/manage.py

@@ -1551,7 +1551,7 @@ class ServiceManager:
                 f"Cannot enable recovery module. Safe {service_safe_address} has inconsistent owners."
             )
 
-    def _get_current_staking_program(  # pylint: disable=no-self-use
+    def _get_current_staking_program(
         self, service: Service, chain: str
     ) -> t.Optional[str]:
         staking_manager = StakingManager(Chain(chain))
@@ -1940,7 +1940,7 @@ class ServiceManager:
 
         # transfer claimed amount from agents safe to master safe
         # TODO: remove after staking contract directly starts sending the rewards to master safe
-        amount_claimed = int(receipt["logs"][0]["data"].hex(), 16)
+        amount_claimed = int(receipt["logs"][0]["data"].to_0x_hex(), 16)
         self.logger.info(f"Claimed amount: {amount_claimed}")
         ethereum_crypto = self.keys_manager.get_crypto_instance(
             service.agent_addresses[0]
@@ -2352,9 +2352,9 @@ class ServiceManager:
                 allow_start_agent = False
 
             # Protocol asset requirements
-            protocol_asset_requirements[
-                chain
-            ] = self._compute_protocol_asset_requirements(service_config_id, chain)
+            protocol_asset_requirements[chain] = (
+                self._compute_protocol_asset_requirements(service_config_id, chain)
+            )
             service_asset_requirements = chain_data.user_params.fund_requirements
 
             # Bonded assets
@@ -2461,15 +2461,12 @@ class ServiceManager:
                     asset_address
                 ] = recommended_refill
 
-                total_requirements[chain].setdefault(master_safe, {})[
-                    asset_address
-                ] = sum(
-                    agent_asset_funding_values[address]["topup"]
-                    for address in agent_asset_funding_values
-                ) + protocol_asset_requirements[
-                    chain
-                ].get(
-                    asset_address, 0
+                total_requirements[chain].setdefault(master_safe, {})[asset_address] = (
+                    sum(
+                        agent_asset_funding_values[address]["topup"]
+                        for address in agent_asset_funding_values
+                    )
+                    + protocol_asset_requirements[chain].get(asset_address, 0)
                 )
 
                 if asset_address == ZERO_ADDRESS and any(
@@ -2498,9 +2495,9 @@ class ServiceManager:
                 ZERO_ADDRESS
             ] = eoa_recommended_refill
 
-            total_requirements[chain].setdefault(master_eoa, {})[
-                ZERO_ADDRESS
-            ] = eoa_funding_values["topup"]
+            total_requirements[chain].setdefault(master_eoa, {})[ZERO_ADDRESS] = (
+                eoa_funding_values["topup"]
+            )
 
         is_refill_required = any(
             amount > 0