olas-operate-middleware 0.1.0rc59__py3-none-any.whl → 0.13.2__py3-none-any.whl

operate/quickstart/claim_staking_rewards.py

@@ -0,0 +1,104 @@
+# -*- 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.
+#
+# ------------------------------------------------------------------------------
+"""Claim staking rewards."""
+
+import json
+import logging
+import os
+import warnings
+from typing import TYPE_CHECKING, cast
+
+from operate.constants import SAFE_WEBAPP_URL
+from operate.quickstart.run_service import (
+    ask_password_if_needed,
+    configure_local_config,
+    get_service,
+    load_local_config,
+)
+from operate.quickstart.utils import ask_yes_or_no, print_section
+
+
+if TYPE_CHECKING:
+    from operate.cli import OperateApp
+
+warnings.filterwarnings("ignore", category=UserWarning)
+
+
+def claim_staking_rewards(operate: "OperateApp", config_path: str) -> None:
+    """Claim staking rewards."""
+    with open(config_path, "r") as config_file:
+        template = json.load(config_file)
+
+    print_section(f"Claim staking rewards for {template['name']}")
+
+    # check if agent was started before
+    config = load_local_config(
+        operate=operate, service_name=cast(str, template["name"])
+    )
+    if not config.path.exists():
+        print("No previous agent setup found. Exiting.")
+        return
+
+    print(
+        "This script will claim the OLAS staking rewards "
+        "accrued in the current staking contract and transfer them to your service safe."
+    )
+
+    if not ask_yes_or_no("Do you want to continue?"):
+        print("Cancelled.")
+        return
+
+    print("")
+
+    ask_password_if_needed(operate)
+    config = configure_local_config(template, operate)
+    manager = operate.service_manager()
+    service = get_service(manager, template)
+
+    # reload manger and config after setting operate.password
+    manager = operate.service_manager()
+    chain_config = service.chain_configs[config.principal_chain]
+    wallet = operate.wallet_manager.load(
+        ledger_type=chain_config.ledger_config.chain.ledger_type
+    )
+    config = load_local_config(operate=operate, service_name=cast(str, service.name))
+    assert (  # nosec
+        config.principal_chain is not None
+    ), "Principal chain not set in quickstart config"
+    assert config.rpc is not None, "RPC not set in quickstart config"  # nosec
+    os.environ["CUSTOM_CHAIN_RPC"] = config.rpc[config.principal_chain]
+
+    try:
+        manager.claim_on_chain_from_safe(
+            service_config_id=service.service_config_id,
+            chain=config.principal_chain,
+        )
+    except RuntimeError as e:
+        print(
+            "The transaction was reverted. "
+            "This may be caused because your service does not have rewards to claim.\n"
+        )
+        logging.error(e)
+        return
+
+    master_safe = wallet.safes[chain_config.ledger_config.chain]
+    print(
+        f"Claimed staking rewards are transferred to your Master Safe {master_safe}.\n"
+    )
+    print(f"You may connect to the Master Safe at {SAFE_WEBAPP_URL}{master_safe}")

operate/quickstart/reset_configs.py

@@ -0,0 +1,106 @@
+# -*- coding: utf-8 -*-
+# ------------------------------------------------------------------------------
+#
+#   Copyright 2023-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.
+#
+# ------------------------------------------------------------------------------
+"""Reset configurations."""
+
+import json
+from typing import Callable, Optional, TYPE_CHECKING, cast
+
+from operate.quickstart.run_service import load_local_config
+from operate.quickstart.utils import (
+    ask_or_get_from_env,
+    ask_yes_or_no,
+    check_rpc,
+    print_section,
+    print_title,
+)
+
+
+if TYPE_CHECKING:
+    from operate.cli import OperateApp
+
+
+def _ask_to_change(
+    name: str,
+    env_var: str,
+    old_value: str,
+    hidden: bool = False,
+    validator: Callable[[Optional[str]], bool] = lambda x: False if x is None else True,
+) -> str:
+    """Ask user if they want to change a configuration value."""
+    old_value_str = old_value
+    if hidden:
+        if len(old_value_str) < 4:
+            old_value_str = "*" * len(old_value_str)
+        else:
+            old_value_str = "*" * len(old_value_str[:-4]) + old_value_str[-4:]
+
+    print(f"\nCurrent '{name}' is set to: {old_value_str}")
+    if ask_yes_or_no(f"Do you want to change the '{name}'?"):
+        new_value = None
+        while not validator(new_value):
+            new_value = ask_or_get_from_env(
+                prompt=f"Enter new value for '{name}' {'[hidden]' if hidden else ''}: ",
+                env_var_name=env_var,
+                is_pass=hidden,
+            )
+
+        return str(new_value)
+
+    return old_value
+
+
+def reset_configs(operate: "OperateApp", config_path: str) -> None:
+    """Reset configurations."""
+    with open(config_path, "r") as config_file:
+        template = json.load(config_file)
+
+    print_title(f"Reset your {template['name']} configurations")
+
+    # check if agent was started before
+    config = load_local_config(
+        operate=operate, service_name=cast(str, template["name"])
+    )
+    if not config.path.exists():
+        print("No previous agent setup found. Exiting.")
+        return
+
+    if config.rpc is None:
+        config.rpc = {}
+
+    for chain_name in config.rpc:
+        config.rpc[chain_name] = _ask_to_change(
+            name=f"{chain_name.capitalize()} RPC URL",
+            env_var=f"{chain_name.upper()}_LEDGER_RPC",
+            old_value=config.rpc[chain_name],
+            hidden=True,
+            validator=lambda x: check_rpc(chain_name, x),  # noqa: B023
+        )
+
+    if config.user_provided_args is None:
+        config.user_provided_args = {}
+
+    for env_var in config.user_provided_args:
+        config.user_provided_args[env_var] = _ask_to_change(
+            name=env_var,
+            env_var=env_var,
+            old_value=config.user_provided_args[env_var],
+        )
+
+    config.store()
+    print_section("Configurations updated")

operate/quickstart/reset_password.py

@@ -0,0 +1,70 @@
+# -*- coding: utf-8 -*-
+# ------------------------------------------------------------------------------
+#
+#   Copyright 2023-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.
+#
+# ------------------------------------------------------------------------------
+"""Reset password."""
+
+from typing import TYPE_CHECKING
+
+from operate.account.user import UserAccount
+from operate.constants import USER_JSON
+from operate.quickstart.run_service import ask_confirm_password
+from operate.quickstart.utils import ask_or_get_from_env, print_section, print_title
+
+
+if TYPE_CHECKING:
+    from operate.cli import OperateApp
+
+
+def reset_password(operate: "OperateApp") -> None:
+    """Reset password."""
+    print_title("Reset your password")
+
+    # check if agent was started before
+    if not (operate._path / USER_JSON).exists():
+        print("No previous agent setup found. Exiting.")
+        return
+
+    old_password = None
+    while old_password is None:
+        old_password = ask_or_get_from_env(
+            "\nEnter local user account password [hidden input]: ",
+            True,
+            "OLD_OPERATE_PASSWORD",
+        )
+        if operate.user_account.is_valid(password=old_password):
+            break
+        old_password = None
+        print("Invalid password!")
+
+    print_section("Update local user account")
+    new_password = ask_confirm_password()
+    print("Resetting password of user account...")
+    UserAccount.new(
+        password=old_password,
+        path=operate._path / USER_JSON,
+    ).update(
+        old_password=old_password,
+        new_password=new_password,
+    )
+
+    print('Resetting password of "ethereum" wallet...')
+    operate.password = old_password
+    operate.wallet_manager.update_password(new_password=new_password)
+    operate.keys_manager.update_password(new_password=new_password)
+
+    print_section("Password reset done!")

operate/quickstart/reset_staking.py

@@ -0,0 +1,145 @@
+# -*- coding: utf-8 -*-
+# ------------------------------------------------------------------------------
+#
+#   Copyright 2023-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.
+#
+# ------------------------------------------------------------------------------
+"""Reset staking."""
+
+import json
+import os
+from typing import TYPE_CHECKING, cast
+
+from operate.constants import NO_STAKING_PROGRAM_ID
+from operate.ledger.profiles import get_staking_contract
+from operate.quickstart.run_service import (
+    CUSTOM_PROGRAM_ID,
+    ask_password_if_needed,
+    configure_local_config,
+    ensure_enough_funds,
+    get_service,
+    load_local_config,
+)
+from operate.quickstart.utils import ask_yes_or_no, print_section, print_title
+from operate.services.protocol import StakingState
+
+
+if TYPE_CHECKING:
+    from operate.cli import OperateApp
+
+
+def reset_staking(operate: "OperateApp", config_path: str) -> None:
+    """Reset staking."""
+    with open(config_path, "r") as config_file:
+        template = json.load(config_file)
+
+    print_title("Reset your staking program preference")
+
+    # check if agent was started before
+    config = load_local_config(
+        operate=operate, service_name=cast(str, template["name"])
+    )
+    if not config.path.exists():
+        print("No previous agent setup found. Exiting.")
+        return
+
+    ask_password_if_needed(operate)
+    config = configure_local_config(template, operate)
+    assert (  # nosec
+        config.principal_chain is not None
+    ), "Principal chain not set in quickstart config"
+
+    if not config.staking_program_id:
+        print("No staking program preference found. Exiting.")
+        return
+
+    print(
+        f"Your current staking program preference is set to '{config.staking_program_id}'.\n"
+    )
+    print(
+        "You can reset your preference. "
+        "However, your agent might not be able to switch between staking contracts "
+        "until it has been staked for a minimum staking period in the current program.\n"
+    )
+
+    if not ask_yes_or_no(
+        "Please, ensure that your service is stopped (./stop_service.sh) before proceeding. "
+        "Do you want to continue?"
+    ):
+        print("Cancelled.")
+        return
+
+    manager = operate.service_manager()
+    service = get_service(manager, template)
+
+    # Check if service can be unstaked from current program
+    os.environ["CUSTOM_CHAIN_RPC"] = service.chain_configs[
+        config.principal_chain
+    ].ledger_config.rpc
+    sftxb = manager.get_eth_safe_tx_builder(
+        ledger_config=service.chain_configs[config.principal_chain].ledger_config
+    )
+    service_id = service.chain_configs[config.principal_chain].chain_data.token
+    staking_contract = get_staking_contract(
+        chain=config.principal_chain,
+        staking_program_id=config.staking_program_id,
+    )
+
+    if (
+        config.staking_program_id is not None
+        and config.staking_program_id not in (NO_STAKING_PROGRAM_ID, CUSTOM_PROGRAM_ID)
+        and sftxb.staking_status(
+            service_id=service_id, staking_contract=staking_contract
+        )
+        in (StakingState.STAKED, StakingState.EVICTED)
+    ):
+        if not sftxb.can_unstake(
+            service_id=service_id,
+            staking_contract=staking_contract,
+        ):
+            print_section("Cannot Reset Staking Preference")
+            print(
+                "Your service cannot be unstaked at this time. This could be due to:\n"
+                "- Minimum staking period not elapsed\n"
+                "- Available rewards pending\n\n"
+                "Please try again once the staking conditions allow unstaking."
+            )
+            return
+
+        if not ask_yes_or_no(
+            "Service can be unstaked. Would you like to proceed with unstaking and reset?"
+        ):
+            print("Cancelled.")
+            return
+
+        # Unstake the service
+        ensure_enough_funds(operate, service)
+        manager.unstake_service_on_chain_from_safe(
+            service_config_id=service.service_config_id,
+            chain=config.principal_chain,
+            staking_program_id=config.staking_program_id,
+        )
+        print_section("Service has been unstaked successfully")
+
+    # Update local config and service template
+    config.staking_program_id = None
+    config.store()
+    config = configure_local_config(template, operate)
+    service = get_service(manager, template)
+    manager.update(
+        service_config_id=service.service_config_id,
+        service_template=template,
+    )
+    print("\nStaking preference has been reset successfully.")