feat: add stop_service.sh

stop_service.py

@@ -0,0 +1,351 @@
+# -*- coding: utf-8 -*-
+# ------------------------------------------------------------------------------
+#
+#   Copyright 2024 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.
+#
+# ------------------------------------------------------------------------------
+"""Optimus Quickstart script."""
+
+import getpass
+import json
+import os
+import sys
+import time
+import typing as t
+from dataclasses import dataclass
+from pathlib import Path
+
+import requests
+from aea.crypto.base import LedgerApi
+from aea_ledger_ethereum import EthereumApi
+from dotenv import load_dotenv
+from halo import Halo
+from termcolor import colored
+
+from operate.account.user import UserAccount
+from operate.cli import OperateApp
+from operate.ledger import Ethereum
+from operate.resource import LocalResource
+from operate.types import (
+    LedgerType,
+    ServiceTemplate,
+    ConfigurationTemplate,
+    FundRequirementsTemplate,
+)
+
+load_dotenv()
+
+SUGGESTED_TOP_UP_DEFAULT = 1_000_000_000_000_000
+SUGGESTED_SAFE_TOP_UP_DEFAULT = 5_000_000_000_000_000
+MASTER_WALLET_MIMIMUM_BALANCE = 7_000_000_000_000_000
+COST_OF_BOND = 1
+USDC_REQUIRED = 10_000_000
+USDC_ADDRESS = "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
+WARNING_ICON = colored('\u26A0', 'yellow')
+OPERATE_HOME = Path.cwd() / ".optimus"
+
+CHAIN_ID_TO_METADATA = {
+    1: {
+        "name": "Ethereum Mainnet",
+        "token": "ETH",
+        "native_token_balance": MASTER_WALLET_MIMIMUM_BALANCE,
+        "usdcRequired": True,
+    },
+    10: {
+        "name": "Optimism",
+        "token": "ETH",
+        "usdcRequired": False,
+    },
+    8453: {
+        "name": "Base",
+        "token": "ETH",
+        "usdcRequired": False,
+    },
+}
+
+
+
+@dataclass
+class OptimusConfig(LocalResource):
+    """Local configuration."""
+
+    path: Path
+    optimism_rpc: t.Optional[str] = None
+    ethereum_rpc: t.Optional[str] = None
+    base_rpc: t.Optional[str] = None
+    tenderly_access_key: t.Optional[str] = None
+    tenderly_account_slug: t.Optional[str] = None
+    tenderly_project_slug: t.Optional[str] = None
+
+
+def print_box(text: str, margin: int = 1, character: str = '=') -> None:
+    """Print text centered within a box."""
+
+    lines = text.split('\n')
+    text_length = max(len(line) for line in lines)
+    length = text_length + 2 * margin
+
+    border = character * length
+    margin_str = ' ' * margin
+
+    print(border)
+    print(f"{margin_str}{text}{margin_str}")
+    print(border)
+    print()
+
+
+def print_title(text: str) -> None:
+    """Print title."""
+    print()
+    print_box(text, 4, '=')
+
+
+def print_section(text: str) -> None:
+    """Print section."""
+    print_box(text, 1, '-')
+
+
+def wei_to_unit(wei: int) -> float:
+    """Convert Wei to unit."""
+    return wei / 1e18
+
+
+def wei_to_token(wei: int, token: str = "xDAI") -> str:
+    """Convert Wei to token."""
+    return f"{wei_to_unit(wei):.2f} {token}"
+
+
+def ask_confirm_password() -> str:
+    password = getpass.getpass("Please enter a password: ")
+    confirm_password = getpass.getpass("Please confirm your password: ")
+
+    if password == confirm_password:
+        return password
+    else:
+        print("Passwords do not match. Terminating.")
+        sys.exit(1)
+
+
+def check_rpc(rpc_url: str) -> None:
+    spinner = Halo(text=f"Checking RPC...", spinner="dots")
+    spinner.start()
+
+    rpc_data = {
+        "jsonrpc": "2.0",
+        "method": "eth_newFilter",
+        "params": ["invalid"],
+        "id": 1
+    }
+
+    try:
+        response = requests.post(
+            rpc_url,
+            json=rpc_data,
+            headers={"Content-Type": "application/json"}
+        )
+        response.raise_for_status()
+        rpc_response = response.json()
+    except Exception as e:
+        print("Error: Failed to send RPC request:", e)
+        sys.exit(1)
+
+    rcp_error_message = rpc_response.get("error", {}).get("message", "Exception processing RCP response")
+
+    if rcp_error_message == "Exception processing RCP response":
+        print("Error: The received RCP response is malformed. Please verify the RPC address and/or RCP behavior.")
+        print("  Received response:")
+        print("  ", rpc_response)
+        print("")
+        print("Terminating script.")
+        sys.exit(1)
+    elif rcp_error_message == "Out of requests":
+        print("Error: The provided RCP is out of requests.")
+        print("Terminating script.")
+        sys.exit(1)
+    elif rcp_error_message == "The method eth_newFilter does not exist/is not available":
+        print("Error: The provided RPC does not support 'eth_newFilter'.")
+        print("Terminating script.")
+        sys.exit(1)
+    elif rcp_error_message == "invalid params":
+        spinner.succeed("RPC checks passed.")
+    else:
+        print("Error: Unknown RCP error.")
+        print("  Received response:")
+        print("  ", rpc_response)
+        print("")
+        print("Terminating script.")
+        sys.exit(1)
+
+
+def get_local_config() -> OptimusConfig:
+    """Get local optimus configuration."""
+    path = OPERATE_HOME / "local_config.json"
+    if path.exists():
+        optimus_config = OptimusConfig.load(path)
+    else:
+        optimus_config = OptimusConfig(path)
+
+    print_section("API Key Configuration")
+
+    if optimus_config.ethereum_rpc is None:
+        optimus_config.ethereum_rpc = input("Please enter an Ethereum RPC URL: ")
+
+    if optimus_config.optimism_rpc is None:
+        optimus_config.optimism_rpc = input("Please enter an Optimism RPC URL: ")
+
+    if optimus_config.base_rpc is None:
+        optimus_config.base_rpc = input("Please enter a Base RPC URL: ")
+
+    if optimus_config.tenderly_access_key is None:
+        optimus_config.tenderly_access_key = input(
+            "Please enter your Tenderly API Key. Get one at https://dashboard.tenderly.co/: "
+        )
+
+    if optimus_config.tenderly_account_slug is None:
+        optimus_config.tenderly_account_slug = input(
+            "Please enter your Tenderly Account Slug: "
+        )
+
+    if optimus_config.tenderly_project_slug is None:
+        optimus_config.tenderly_project_slug = input(
+            "Please enter your Tenderly Project Slug: "
+        )
+
+    optimus_config.store()
+    return optimus_config
+
+
+def apply_env_vars(env_vars: t.Dict[str, str]) -> None:
+    """Apply environment variables."""
+    for key, value in env_vars.items():
+        if value is not None:
+            os.environ[key] = value
+
+
+def get_service_template(config: OptimusConfig) -> ServiceTemplate:
+    """Get the service template"""
+    return ServiceTemplate({
+        "name": "Optimus",
+        "hash": "bafybeig2yqrfkqylnpus7fjsm6eydrlarc7rsonuh7bb6gskeiite7744a",
+        "description": "Optimus",
+        "image": "https://operate.olas.network/_next/image?url=%2Fimages%2Fprediction-agent.png&w=3840&q=75",
+        "service_version": 'v0.18.1',
+        "home_chain_id": "10",
+        "configurations": {
+            "1": ConfigurationTemplate(
+                {
+                    "staking_program_id": "pearl_alpha",
+                    "rpc": config.ethereum_rpc,
+                    "nft": "bafybeig64atqaladigoc3ds4arltdu63wkdrk3gesjfvnfdmz35amv7faq",
+                    "cost_of_bond": COST_OF_BOND,
+                    "threshold": 1,
+                    "use_staking": False,
+                    "fund_requirements": FundRequirementsTemplate(
+                        {
+                            "agent": SUGGESTED_TOP_UP_DEFAULT,
+                            "safe": SUGGESTED_SAFE_TOP_UP_DEFAULT,
+                        }
+                    ),
+                }
+            ),
+            "10": ConfigurationTemplate(
+                {
+                    "staking_program_id": "pearl_alpha",
+                    "rpc": config.optimism_rpc,
+                    "nft": "bafybeig64atqaladigoc3ds4arltdu63wkdrk3gesjfvnfdmz35amv7faq",
+                    "cost_of_bond": COST_OF_BOND,
+                    "threshold": 1,
+                    "use_staking": False,
+                    "fund_requirements": FundRequirementsTemplate(
+                        {
+                            "agent": SUGGESTED_TOP_UP_DEFAULT,
+                            "safe": SUGGESTED_SAFE_TOP_UP_DEFAULT,
+                        }
+                    ),
+                }
+            ),
+            "8453": ConfigurationTemplate(
+                {
+                    "staking_program_id": "pearl_alpha",
+                    "rpc": config.base_rpc,
+                    "nft": "bafybeig64atqaladigoc3ds4arltdu63wkdrk3gesjfvnfdmz35amv7faq",
+                    "cost_of_bond": COST_OF_BOND,
+                    "threshold": 1,
+                    "use_staking": False,
+                    "fund_requirements": FundRequirementsTemplate(
+                        {
+                            "agent": SUGGESTED_TOP_UP_DEFAULT,
+                            "safe": SUGGESTED_SAFE_TOP_UP_DEFAULT,
+                        }
+                    ),
+                }
+            ),
+        },
+})
+
+
+def get_erc20_balance(ledger_api: LedgerApi, token: str, account: str) -> int:
+    """Get ERC-20 token balance of an account."""
+    web3 = t.cast(EthereumApi, ledger_api).api
+
+    # ERC20 Token Standard Partial ABI
+    erc20_abi = [
+        {
+            "constant": True,
+            "inputs": [{"name": "_owner", "type": "address"}],
+            "name": "balanceOf",
+            "outputs": [{"name": "balance", "type": "uint256"}],
+            "type": "function",
+        }
+    ]
+
+    # Create contract instance
+    contract = web3.eth.contract(address=web3.to_checksum_address(token), abi=erc20_abi)
+
+    # Get the balance of the account
+    balance = contract.functions.balanceOf(web3.to_checksum_address(account)).call()
+
+    return balance
+
+
+
+def main() -> None:
+    """Run service."""
+
+    print_title("Optimus Quickstart")
+    print("This script will assist you in setting up and running the Optimus service.")
+    print()
+
+    print_section("Set up local user account")
+    operate = OperateApp(
+        home=OPERATE_HOME,
+    )
+    operate.setup()
+
+    optimus_config = get_local_config()
+    template = get_service_template(optimus_config)
+    manager = operate.service_manager()
+    service = manager.load_or_create(
+        hash=template["hash"],
+        service_template=template,
+    )
+    manager.stop_service_locally(hash=service.hash, delete=True)
+
+    print()
+    print_section("Service stopped")
+
+
+if __name__ == "__main__":
+    main()

stop_service.sh

@@ -0,0 +1,30 @@
+#!/bin/bash
+
+# ------------------------------------------------------------------------------
+#
+#   Copyright 2024 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.
+#
+# ------------------------------------------------------------------------------
+
+if [ "$(git rev-parse --is-inside-work-tree)" = true ]
+then
+    poetry install
+    poetry run python stop_service.py
+    docker rm -f $(docker ps -a -q --filter name=optimus)
+    sudo rm -rf .optimus/services/*/deployment
+else
+    echo "$directory is not a git repo!"
+    exit 1
+fi