Merge pull request #341 from valory-xyz/develop

Release v0.19.2

Author: jmoreira-valory

README.md

@@ -48,7 +48,7 @@ Do you want to use staking in this service? (yes/no): n
 > Using this code could potentially lead to loss of funds, compromised data, or asset risk.
 > Exercise caution and use this code at your own risk. Please refer to the [LICENSE](./LICENSE) file for details about the terms and conditions.
 
-Before you proceed, ensure you have at least 20 OLAS on Gnosis Chain. For more information on staking, checkout the following [blogpost](https://www.valory.xyz/post/alpine).
+Each staking program has different OLAS requirements. The script will check that your owner address meets the minimum required OLAS on the Gnosis Chain.
 
 Clone this repository locally and execute:
 
@@ -57,23 +57,46 @@ chmod +x run_service.sh
 ./run_service.sh
 ```
 
-Answer 'Yes' when prompted:
+Select your preferred staking program when prompted:
 
 ```text
-Do you want to use staking in this service? (yes/no): y
+Please, select your staking program preference
+----------------------------------------------
+1) No staking
+   Your Olas Predict agent will still actively participate in prediction
+   markets, but it will not be staked within any staking program.
+
+2) Quickstart Beta - Hobbyist
+   The Quickstart Beta - Hobbyist staking contract offers 100 slots for
+   operators running Olas Predict agents with the quickstart. It is designed as
+   a step up from Coastal Staker Expeditions, requiring 100 OLAS for staking.
+   The rewards are also more attractive than with Coastal Staker Expeditions.
+
+3) Quickstart Beta - Expert
+   The Quickstart Beta - Expert staking contract offers 20 slots for operators
+   running Olas Predict agents with the quickstart. It is designed for
+   professional agent operators, requiring 1000 OLAS for staking. The rewards
+   are proportional to the Quickstart Beta - Hobbyist.
 ```
 
-Find below a diagram of the possible status a service can be in the **Alpine staking** program:
+Find below a diagram of the possible status a service can be in the staking program:
 
-![Alpine staking FSM](images/alpine_staking_fsm.svg)
+![Staking FSM](images/staking_fsm.svg)
 
-Services can become staked by invoking the `stake()` contract method, where service parameters and deposit amounts are verified. Staked services can call the `checkpoint()` method at regular intervals, ensuring liveness checks and calculating staking incentives. In case a service remains inactive beyond the specified `maxAllowedInactivity` time, it faces eviction from the staking program, ceasing to accrue additional rewards. Staked or evicted services can unstaked by calling the `unstake()` contract method. They can do so after `minStakingDuration` has passed or if no more staking rewards are available.
+Services can become staked by invoking the `stake()` contract method, where service parameters and deposit amounts are verified. Staked services can call the `checkpoint()` method at regular intervals, ensuring liveness checks and calculating staking rewards. In case a service remains inactive beyond the specified `maxAllowedInactivity` time, it faces eviction from the staking program, ceasing to accrue additional rewards. Staked or evicted services can be unstaked by calling the `unstake()` contract method. They can do so after `minStakingDuration` has passed or if no more staking rewards are available.
 
  __Notes__:
 
 - Staking is currently in a testing phase, so the number of trader agents that can be staked might be limited.
-- In the [Alpine staking program](https://www.valory.xyz/post/alpine) services are evicted after accumulating 2 consecutive checkpoints without meeting the activity threshold.  
+- Services are evicted after accumulating 2 consecutive checkpoints without meeting the activity threshold.  
 - Currently, the minimum staking time is approximately 3 days. In particular, a service cannot be unstaked during the minimum staking period.
+- Once a staking program is selected, you can reset your preference by stopping your agent by running ./stop_service.sh and then running the command
+
+  ``` bash
+  cd trader; poetry run python ../scripts/choose_staking.py --reset; cd ..
+  ```
+
+  Keep in mind that your service must stay for `minStakingDuration` in a staking program (typically 3 days) before you can change to a new program.
 
 ### Service is Running
 

images/alpine_staking_fsm.svg renamed to images/staking_fsm.svg

@@ -897,7 +897,7 @@ if [ "$local_service_hash" != "$remote_service_hash" ] || [ "$on_chain_agent_id"
 
     response="y"
     if [ "${USE_STAKING}" = true ]; then
-      echo "Your service is in a staking program. Updating your on-chain service requires that it is first unstaked."
+      echo "If your service is in a staking program, updating your on-chain service requires that it is first unstaked."
       echo "Unstaking your service will retrieve the accrued staking rewards."
       echo ""
       echo "Do you want to continue updating your service? (yes/no)"
@@ -909,9 +909,7 @@ if [ "$local_service_hash" != "$remote_service_hash" ] || [ "$on_chain_agent_id"
         echo "Skipping on-chain service update."
     else
       # unstake the service
-      if [ "${USE_STAKING}" = true ]; then
-          perform_staking_ops true
-      fi
+      perform_staking_ops true
 
       # Check balances
       suggested_amount=$suggested_top_up_default
@@ -1133,7 +1131,7 @@ export STOP_TRADING_IF_STAKING_KPI_MET=true
 export RESET_PAUSE_DURATION=45
 export MECH_WRAPPED_NATIVE_TOKEN_ADDRESS=$WXDAI_ADDRESS
 export MECH_CHAIN_ID=ethereum
-export TOOLS_ACCURACY_HASH=QmexjVcbhh7sMAKmRtxLbgZiiGKdGpHHMYAWecVq7riAD1
+export TOOLS_ACCURACY_HASH=QmZnwodYVedKYChEUtGVVCCw2FCYP9xPQFYK3yL7VHXkid
 
 if [ -n "$SUBGRAPH_API_KEY" ]; then
     export CONDITIONAL_TOKENS_SUBGRAPH_URL="https://gateway-arbitrum.network.thegraph.com/api/$SUBGRAPH_API_KEY/subgraphs/id/7s9rGBffUTL8kDZuxvvpuc46v44iuDarbrADBFw5uVp2"

run_service.sh

@@ -229,14 +229,14 @@ def _get_nevermined_env_variables() -> Dict[str, str]:
         use_nevermined = True
 
     if use_nevermined:
-        print("A Nevermined subscription will be used to pay for the mech requests.")
+        print("  - A Nevermined subscription will be used to pay for the mech requests.")
         return {
             "MECH_CONTRACT_ADDRESS": NEVERMINED_MECH_CONTRACT_ADDRESS,
             "AGENT_REGISTRY_ADDRESS": NEVERMINED_AGENT_REGISTRY_ADDRESS,
             "MECH_REQUEST_PRICE": NEVERMINED_MECH_REQUEST_PRICE
         }
     else:
-        print("No Nevermined subscription set.")
+        print("  - No Nevermined subscription set.")
         return {
             "AGENT_REGISTRY_ADDRESS": "",
             "MECH_REQUEST_PRICE": ""
@@ -249,24 +249,35 @@ def main() -> None:
     args = parser.parse_args()
 
     if args.reset:
+        env_file_vars = dotenv_values(DOTENV_PATH)
+        staking_program = env_file_vars.get("STAKING_PROGRAM")
+        print("=====================================")
+        print("Reset your staking program preference")
+        print("=====================================")
+        print("")
+        print(f"Your current staking program is set to '{staking_program}'")
+        response = input("Do you want to reset your staking program preference? (yes/no): ").strip().lower()
+        if response not in ['yes', 'y']:
+            return
+
+        print("")
         unset_key(dotenv_path=DOTENV_PATH, key_to_unset="USE_STAKING")
         unset_key(dotenv_path=DOTENV_PATH, key_to_unset="STAKING_PROGRAM")
         print(f"Environment variables USE_STAKING and STAKING_PROGRAM have been reset in '{DOTENV_PATH}'.")
-        print("You can now execute './run_service.sh' and select a different staking program.")
         print("")
-        return
 
     program_id = _prompt_select_staking_program()
 
-    print("Populating staking program variables in the .env file")
-    print("")
+    print(" - Populating staking program variables in the .env file")
     staking_env_variables = _get_staking_env_variables(program_id)
     _set_dotenv_file_variables(staking_env_variables)
 
-    print("Populating Nevermined variables in the .env file")
+    print(" - Populating Nevermined variables in the .env file")
     print("")
     nevermined_env_variables = _get_nevermined_env_variables()
     _set_dotenv_file_variables(nevermined_env_variables)
+    print("")
+    print("Finished populating the .env file.")
 
 
 if __name__ == "__main__":