olas-operate-middleware 0.12.1__py3-none-any.whl → 0.13.0__py3-none-any.whl

operate/services/agent_runner.py

@@ -19,6 +19,7 @@
 # -------------------------------------------------------------
 """Source dode to download and run agent from the repos."""
 import hashlib
+import json
 import os
 import platform
 import shutil
@@ -32,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
+from operate.constants import AGENT_RUNNER_PREFIX, CONFIG_JSON
 
 
 @dataclass
@@ -42,6 +43,7 @@ class AgentRelease:
     owner: str
     repo: str
     release: str
+    is_aea: bool
 
     @property
     def release_url(self) -> str:
@@ -64,25 +66,10 @@ class AgentRelease:
         return file_url, file_hash
 
 
-# list of agents releases supported
-AGENTS_SUPPORTED = {
-    "valory/trader": AgentRelease(
-        owner="valory-xyz", repo="trader", release="v0.27.2-1-rc.2"
-    ),
-    "valory/optimus": AgentRelease(
-        owner="valory-xyz", repo="optimus", release="v0.6.0-rc.1"
-    ),
-    "dvilela/memeooorr": AgentRelease(
-        owner="valory-xyz", repo="meme-ooorr", release="v0.0.101"
-    ),
-}
-
-
 class AgentRunnerManager:
     """Agent Runner Manager."""
 
     logger = setup_logger(name="operate.agent_runner_manager")
-    AGENTS = AGENTS_SUPPORTED
 
     @staticmethod
     def get_agent_runner_executable_name() -> str:
@@ -133,14 +120,19 @@ class AgentRunnerManager:
             raise
 
     @classmethod
-    def get_agent_release_by_public_id(cls, agent_public_id_str: str) -> AgentRelease:
+    def get_agent_release_from_service_dir(cls, service_dir: Path) -> AgentRelease:
         """Get agent release object according to public id."""
-        agent_author, agent_name = cls.parse_agent(public_id_str=agent_public_id_str)
-
-        agent_name = f"{agent_author}/{agent_name}"
-        agent_release = cls.AGENTS.get(agent_name, None)
-        if agent_release is None:
-            raise ValueError(f"{agent_name} is not supported!")
+        service_config_file = service_dir / CONFIG_JSON
+        service_config = json.loads(service_config_file.read_text())
+        if "agent_release" not in service_config:
+            raise ValueError(f"Agent release details are not found in {service_config}")
+        agent_release_data = service_config["agent_release"]
+        agent_release = AgentRelease(
+            is_aea=agent_release_data["is_aea"],
+            owner=agent_release_data["repository"]["owner"],
+            repo=agent_release_data["repository"]["name"],
+            release=agent_release_data["repository"]["version"],
+        )
         return agent_release
 
     @staticmethod
@@ -189,13 +181,11 @@ class AgentRunnerManager:
             raise
 
     @classmethod
-    def get_agent_runner_path(cls, service_dir: Path, agent_public_id_str: str) -> str:
+    def get_agent_runner_path(cls, service_dir: Path) -> str:
         """Get path to the agent runner bin palced."""
         agent_runner_name = cls.get_agent_runner_executable_name()
         agent_runner_path: Path = service_dir / agent_runner_name
-        agent_release = cls.get_agent_release_by_public_id(
-            agent_public_id_str=agent_public_id_str
-        )
+        agent_release = cls.get_agent_release_from_service_dir(service_dir=service_dir)
 
         cls.update_agent_runner(
             target_path=agent_runner_path,
@@ -205,8 +195,8 @@ class AgentRunnerManager:
         return str(agent_runner_path)
 
 
-def get_agent_runner_path(service_dir: Path, agent_public_id_str: str) -> str:
+def get_agent_runner_path(service_dir: Path) -> str:
     """Get path to the agent runner bin placed."""
     return AgentRunnerManager.get_agent_runner_path(
-        service_dir=service_dir, agent_public_id_str=agent_public_id_str
+        service_dir=service_dir,
     )

operate/services/deployment_runner.py

@@ -105,6 +105,11 @@ class BaseDeploymentRunner(AbstractDeploymentRunner, metaclass=ABCMeta):
     START_TRIES = constants.DEPLOYMENT_START_TRIES_NUM
     logger = setup_logger(name="operate.base_deployment_runner")
 
+    def __init__(self, work_directory: Path, is_aea: bool) -> None:
+        """Initialize the deployment runner."""
+        super().__init__(work_directory)
+        self._is_aea = is_aea
+
     def _open_agent_runner_log_file(self) -> TextIOWrapper:
         """Open agent_runner.log file."""
         return (
@@ -186,6 +191,21 @@ class BaseDeploymentRunner(AbstractDeploymentRunner, metaclass=ABCMeta):
         """Setup agent."""
         working_dir = self._work_directory
         env = self._prepare_agent_env()
+        agent_alias_name = "agent"
+        agent_dir_full_path = Path(working_dir) / agent_alias_name
+        if not self._is_aea:
+            if agent_dir_full_path.exists():
+                # remove if exists before fetching! can have issues with retry mechanism of multiple start attempts
+                with suppress(Exception):
+                    shutil.rmtree(agent_dir_full_path, ignore_errors=True)
+
+            # Add keys
+            agent_dir_full_path.mkdir(exist_ok=True, parents=True)
+            shutil.copy(
+                working_dir / "ethereum_private_key.txt",
+                working_dir / "agent" / "ethereum_private_key.txt",
+            )
+            return
 
         self._run_aea_command(
             "init",
@@ -199,10 +219,6 @@ class BaseDeploymentRunner(AbstractDeploymentRunner, metaclass=ABCMeta):
             cwd=working_dir,
         )
 
-        agent_alias_name = "agent"
-
-        agent_dir_full_path = Path(working_dir) / agent_alias_name
-
         if agent_dir_full_path.exists():
             # remove if exists before fetching! can have issues with retry mechanism of multiple start attempts
             with suppress(Exception):
@@ -264,13 +280,16 @@ class BaseDeploymentRunner(AbstractDeploymentRunner, metaclass=ABCMeta):
     def _start(self, password: str) -> None:
         """Start the deployment."""
         self._setup_agent(password=password)
-        self._start_tendermint()
+        if self._is_aea:
+            self._start_tendermint()
+
         self._start_agent(password=password)
 
     def stop(self) -> None:
         """Stop the deployment."""
         self._stop_agent()
-        self._stop_tendermint()
+        if self._is_aea:
+            self._stop_tendermint()
 
     def _stop_agent(self) -> None:
         """Start process."""
@@ -313,6 +332,24 @@ class BaseDeploymentRunner(AbstractDeploymentRunner, metaclass=ABCMeta):
         """Return aea_bin path."""
         raise NotImplementedError
 
+    def get_agent_start_args(self, password: str) -> List[str]:
+        """Return agent start arguments."""
+        return (
+            [self._agent_runner_bin]
+            + (
+                [
+                    "-s",
+                    "run",
+                ]
+                if self._is_aea
+                else []
+            )
+            + [
+                "--password",
+                password,
+            ]
+        )
+
 
 class PyInstallerHostDeploymentRunner(BaseDeploymentRunner):
     """Deployment runner within pyinstaller env."""
@@ -320,16 +357,8 @@ class PyInstallerHostDeploymentRunner(BaseDeploymentRunner):
     @property
     def _agent_runner_bin(self) -> str:
         """Return aea_bin path."""
-        env = json.loads(
-            (self._work_directory / "agent.json").read_text(encoding="utf-8")
-        )
-
-        agent_publicid_str = env["AEA_AGENT"]
         service_dir = self._work_directory.parent
-
-        agent_runner_bin = get_agent_runner_path(
-            service_dir=service_dir, agent_public_id_str=agent_publicid_str
-        )
+        agent_runner_bin = get_agent_runner_path(service_dir=service_dir)
         return str(agent_runner_bin)
 
     @property
@@ -393,13 +422,7 @@ class PyInstallerHostDeploymentRunnerMac(PyInstallerHostDeploymentRunner):
         """Start agent process."""
         agent_runner_log_file = self._open_agent_runner_log_file()
         process = subprocess.Popen(  # pylint: disable=consider-using-with,subprocess-popen-preexec-fn # nosec
-            args=[
-                self._agent_runner_bin,
-                "-s",
-                "run",
-                "--password",
-                password,
-            ],
+            args=self.get_agent_start_args(password=password),
             cwd=working_dir / "agent",
             stdout=agent_runner_log_file,
             stderr=agent_runner_log_file,
@@ -431,9 +454,9 @@ class PyInstallerHostDeploymentRunnerMac(PyInstallerHostDeploymentRunner):
 class PyInstallerHostDeploymentRunnerWindows(PyInstallerHostDeploymentRunner):
     """Windows deployment runner."""
 
-    def __init__(self, work_directory: Path) -> None:
+    def __init__(self, work_directory: Path, is_aea: bool) -> None:
         """Init the runner."""
-        super().__init__(work_directory)
+        super().__init__(work_directory, is_aea=is_aea)
         self._job = self.set_windows_object_job()
 
     @staticmethod
@@ -519,13 +542,7 @@ class PyInstallerHostDeploymentRunnerWindows(PyInstallerHostDeploymentRunner):
         """Start agent process."""
         agent_runner_log_file = self._open_agent_runner_log_file()
         process = subprocess.Popen(  # pylint: disable=consider-using-with # nosec
-            args=[
-                self._agent_runner_bin,
-                "-s",
-                "run",
-                "--password",
-                password,
-            ],  # TODO: Patch for Windows failing hash
+            args=self.get_agent_start_args(password=password),
             cwd=working_dir / "agent",
             stdout=agent_runner_log_file,
             stderr=agent_runner_log_file,
@@ -562,7 +579,12 @@ class HostPythonHostDeploymentRunner(BaseDeploymentRunner):
     @property
     def _agent_runner_bin(self) -> str:
         """Return aea_bin path."""
-        return str(self._venv_dir / "bin" / "aea")
+        if self._is_aea:
+            return str(self._venv_dir / "bin" / "aea")
+
+        service_dir = self._work_directory.parent
+        agent_runner_bin = get_agent_runner_path(service_dir=service_dir)
+        return str(agent_runner_bin)
 
     def _start_agent(self, password: str) -> None:
         """Start agent process."""
@@ -573,13 +595,7 @@ class HostPythonHostDeploymentRunner(BaseDeploymentRunner):
         agent_runner_log_file = self._open_agent_runner_log_file()
 
         process = subprocess.Popen(  # pylint: disable=consider-using-with # nosec
-            args=[
-                self._agent_runner_bin,
-                "-s",
-                "run",
-                "--password",
-                password,
-            ],  # TODO: Patch for Windows failing hash
+            args=self.get_agent_start_args(password=password),
             cwd=str(working_dir / "agent"),
             env={**os.environ, **env},
             stdout=agent_runner_log_file,
@@ -629,6 +645,9 @@ class HostPythonHostDeploymentRunner(BaseDeploymentRunner):
 
     def _setup_venv(self) -> None:
         """Perform venv setup, install deps."""
+        if not self._is_aea:
+            return
+
         self._venv_dir.mkdir(exist_ok=True)
         venv_cli(args=[str(self._venv_dir)])
         pbin = str(self._venv_dir / "bin" / "python")
@@ -655,6 +674,9 @@ class HostPythonHostDeploymentRunner(BaseDeploymentRunner):
         multiprocessing.set_start_method("spawn")
         self._setup_venv()
         super()._setup_agent(password=password)
+        if not self._is_aea:
+            return
+
         # Install agent dependencies
         self._run_cmd(
             args=[
@@ -690,9 +712,11 @@ class DeploymentManager:
         self.logger = setup_logger(name="operate.deployment_manager")
         self._states: Dict[Path, States] = {}
 
-    def _get_deployment_runner(self, build_dir: Path) -> BaseDeploymentRunner:
+    def _get_deployment_runner(
+        self, build_dir: Path, is_aea: bool
+    ) -> BaseDeploymentRunner:
         """Get deploymnent runner instance."""
-        return self._deployment_runner_class(build_dir)
+        return self._deployment_runner_class(build_dir, is_aea=is_aea)
 
     @staticmethod
     def _get_host_deployment_runner_class() -> Type[BaseDeploymentRunner]:
@@ -741,7 +765,9 @@ class DeploymentManager:
             "Failed to perform test connection to ipfs to check network connection!"
         )
 
-    def run_deployment(self, build_dir: Path, password: str) -> None:
+    def run_deployment(
+        self, build_dir: Path, password: str, is_aea: bool = True
+    ) -> None:
         """Run deployment."""
         if self._is_stopping:
             raise RuntimeError("deployment manager stopped")
@@ -754,7 +780,9 @@ class DeploymentManager:
         self.logger.info(f"Starting deployment {build_dir}...")
         self._states[build_dir] = States.STARTING
         try:
-            deployment_runner = self._get_deployment_runner(build_dir=build_dir)
+            deployment_runner = self._get_deployment_runner(
+                build_dir=build_dir, is_aea=is_aea
+            )
             deployment_runner.start(password=password)
             self.logger.info(f"Started deployment {build_dir}")
             self._states[build_dir] = States.STARTED
@@ -771,7 +799,9 @@ class DeploymentManager:
             )
             self.stop_deployment(build_dir=build_dir, force=True)
 
-    def stop_deployment(self, build_dir: Path, force: bool = False) -> None:
+    def stop_deployment(
+        self, build_dir: Path, force: bool = False, is_aea: bool = True
+    ) -> None:
         """Stop the deployment."""
         if (
             self.get_state(build_dir=build_dir) in [States.STARTING, States.STOPPING]
@@ -780,7 +810,9 @@ class DeploymentManager:
             raise ValueError("Service already in transition")
         self.logger.info(f"Stopping deployment {build_dir}...")
         self._states[build_dir] = States.STOPPING
-        deployment_runner = self._get_deployment_runner(build_dir=build_dir)
+        deployment_runner = self._get_deployment_runner(
+            build_dir=build_dir, is_aea=is_aea
+        )
         try:
             deployment_runner.stop()
             self.logger.info(f"Stopped deployment {build_dir}...")
@@ -794,14 +826,16 @@ class DeploymentManager:
 deployment_manager = DeploymentManager()
 
 
-def run_host_deployment(build_dir: Path, password: str) -> None:
+def run_host_deployment(build_dir: Path, password: str, is_aea: bool = True) -> None:
     """Run host deployment."""
-    deployment_manager.run_deployment(build_dir=build_dir, password=password)
+    deployment_manager.run_deployment(
+        build_dir=build_dir, password=password, is_aea=is_aea
+    )
 
 
-def stop_host_deployment(build_dir: Path) -> None:
+def stop_host_deployment(build_dir: Path, is_aea: bool = True) -> None:
     """Stop host deployment."""
-    deployment_manager.stop_deployment(build_dir=build_dir)
+    deployment_manager.stop_deployment(build_dir=build_dir, is_aea=is_aea)
 
 
 def stop_deployment_manager() -> None:

operate/services/funding_manager.py

@@ -79,11 +79,13 @@ class FundingManager:
 
     def __init__(
         self,
+        keys_manager: KeysManager,
         wallet_manager: MasterWalletManager,
         logger: Logger,
         funding_requests_cooldown_seconds: int = DEFAULT_FUNDING_REQUESTS_COOLDOWN_SECONDS,
     ) -> None:
         """Initialize funding manager."""
+        self.keys_manager = keys_manager
         self.wallet_manager = wallet_manager
         self.logger = logger
         self.funding_requests_cooldown_seconds = funding_requests_cooldown_seconds
@@ -102,7 +104,7 @@ class FundingManager:
             f"Draining service agents {service.name} ({service_config_id=})"
         )
         for agent_address in service.agent_addresses:
-            ethereum_crypto = KeysManager().get_crypto_instance(agent_address)
+            ethereum_crypto = self.keys_manager.get_crypto_instance(agent_address)
             balance = ledger_api.get_balance(agent_address)
             self.logger.info(
                 f"Draining {balance} (approx) {get_currency_denom(chain)} from {agent_address} (agent) to {withdrawal_address}"
@@ -167,7 +169,7 @@ class FundingManager:
 
             # Safe not swapped
             if set(owners) == set(service.agent_addresses):
-                ethereum_crypto = KeysManager().get_crypto_instance(
+                ethereum_crypto = self.keys_manager.get_crypto_instance(
                     service.agent_addresses[0]
                 )
                 transfer_erc20_from_safe(
@@ -207,7 +209,7 @@ class FundingManager:
             )
 
             if set(owners) == set(service.agent_addresses):
-                ethereum_crypto = KeysManager().get_crypto_instance(
+                ethereum_crypto = self.keys_manager.get_crypto_instance(
                     service.agent_addresses[0]
                 )
                 transfer_from_safe(

operate/services/manage.py

@@ -109,9 +109,10 @@ NUM_LOCAL_AGENT_INSTANCES = 1
 class ServiceManager:
     """Service manager."""
 
-    def __init__(
+    def __init__(  # pylint: disable=too-many-arguments
         self,
         path: Path,
+        keys_manager: KeysManager,
         wallet_manager: MasterWalletManager,
         funding_manager: FundingManager,
         logger: logging.Logger,
@@ -126,7 +127,7 @@ class ServiceManager:
         :param logger: logging.Logger object.
         """
         self.path = path
-        self.keys_manager = KeysManager()
+        self.keys_manager = keys_manager
         self.wallet_manager = wallet_manager
         self.funding_manager = funding_manager
         self.logger = logger
@@ -812,6 +813,9 @@ class ServiceManager:
         on_chain_metadata = self._get_on_chain_metadata(chain_config=chain_config)
         on_chain_hash = on_chain_metadata.get("code_uri", "")[len(IPFS_URI_PREFIX) :]
         on_chain_description = on_chain_metadata.get("description")
+        needs_update_agent_addresses = set(chain_data.instances) != set(
+            service.agent_addresses
+        )
 
         current_agent_bond = sftxb.get_agent_bond(
             service_id=chain_data.token, agent_id=target_staking_params["agent_ids"][0]
@@ -840,6 +844,7 @@ class ServiceManager:
                 or current_staking_params["staking_token"]
                 != target_staking_params["staking_token"]
                 or on_chain_description != service.description
+                or needs_update_agent_addresses
             )
         )
 
@@ -1923,7 +1928,9 @@ class ServiceManager:
         # TODO: remove after staking contract directly starts sending the rewards to master safe
         amount_claimed = int(receipt["logs"][0]["data"].hex(), 16)
         self.logger.info(f"Claimed amount: {amount_claimed}")
-        ethereum_crypto = KeysManager().get_crypto_instance(service.agent_addresses[0])
+        ethereum_crypto = self.keys_manager.get_crypto_instance(
+            service.agent_addresses[0]
+        )
         transfer_erc20_from_safe(
             ledger_api=ledger_api,
             crypto=ethereum_crypto,
@@ -2206,7 +2213,7 @@ class ServiceManager:
             chain=chain,
         )
 
-    def deploy_service_locally(
+    def deploy_service_locally(  # pylint: disable=too-many-arguments
         self,
         service_config_id: str,
         chain: t.Optional[str] = None,
@@ -2232,11 +2239,15 @@ class ServiceManager:
             use_kubernetes=use_kubernetes,
             force=True,
             chain=chain or service.home_chain,
-            password=self.wallet_manager.password,
+            keys_manager=self.keys_manager,
         )
         if build_only:
             return deployment
-        deployment.start(password=self.wallet_manager.password, use_docker=use_docker)
+        deployment.start(
+            password=self.wallet_manager.password,
+            use_docker=use_docker,
+            is_aea=service.agent_release["is_aea"],
+        )
         return deployment
 
     def stop_service_locally(
@@ -2256,7 +2267,11 @@ class ServiceManager:
         service = self.load(service_config_id=service_config_id)
         service.remove_latest_healthcheck()
         deployment = service.deployment
-        deployment.stop(use_docker=use_docker, force=force)
+        deployment.stop(
+            use_docker=use_docker,
+            force=force,
+            is_aea=service.agent_release["is_aea"],
+        )
         if delete:
             deployment.delete()
         return deployment