#697 - Automatically claim payouts for previous epochs

pdr_backend/ppss/predictoor_ss.py

@@ -69,6 +69,12 @@ def revenue(self) -> Eth:
         """
         return Eth(self.d["sim_only"]["revenue"])
 
+    @property
+    def s_start_payouts(self) -> int:
+        if "s_start_payouts" not in self.d["bot_only"]:
+            return 0
+        return self.d["bot_only"]["s_start_payouts"]
+
     @property
     def s_until_epoch_end(self) -> int:
         return self.d["bot_only"]["s_until_epoch_end"]

pdr_backend/ppss/web3_pp.py

@@ -336,6 +336,9 @@ def get_current_epoch(self) -> int:
     def set_token(self, web3_pp):
         pass
 
+    def s_start_payouts(self) -> int:
+        return 0  # disabled
+
     def get_current_epoch_ts(self) -> UnixTimeS:
         """Returns a timestamp"""
         return UnixTimeS(self._w3.eth.timestamp // self.s_per_epoch * self.s_per_epoch)

pdr_backend/predictoor/predictoor_agent.py

@@ -14,12 +14,13 @@
 from pdr_backend.util.logutil import logging_has_stdout
 from pdr_backend.util.time_types import UnixTimeS
 from pdr_backend.util.web3_config import Web3Config
+from pdr_backend.payout.payout import do_ocean_payout
 from pdr_backend.util.currency_types import Eth
 
-
 logger = logging.getLogger("predictoor_agent")
 
 
+# pylint: disable=too-many-public-methods
 class PredictoorAgent:
     """
     What it does
@@ -92,6 +93,7 @@ def __init__(self, ppss: PPSS):
         self.prev_block_timestamp: UnixTimeS = UnixTimeS(0)
         self.prev_block_number: UnixTimeS = UnixTimeS(0)
         self.prev_submit_epochs: List[int] = []
+        self.prev_submit_payouts: List[int] = []
 
     @enforce_types
     def run(self):
@@ -118,6 +120,26 @@ def take_step(self):
         self.prev_block_number = UnixTimeS(self.cur_block_number)
         self.prev_block_timestamp = UnixTimeS(self.cur_timestamp)
 
+        # within the time window to run payout?
+        if (
+            self.s_start_payouts != 0
+            and self.cur_epoch_s_left < self.s_start_payouts
+            and self.cur_epoch not in self.prev_submit_payouts
+        ):
+            # run payout
+            # pylint: disable=line-too-long
+            logger.info(
+                "Running payouts, set predictoor_ss.bot_only.s_start_payouts to 0 to disable auto payouts"
+            )
+            web3_config = self._updown_web3_config(True)
+            self.ppss.web3_pp.set_web3_config(web3_config)
+            do_ocean_payout(self.ppss, False)
+            web3_config = self._updown_web3_config(False)
+            self.ppss.web3_pp.set_web3_config(web3_config)
+            do_ocean_payout(self.ppss, False)
+            self.prev_submit_payouts.append(self.cur_epoch)
+            return
+
         # within the time window to predict?
         if self.cur_epoch_s_left > self.epoch_s_thr:
             return
@@ -165,6 +187,11 @@ def cur_block_number(self) -> int:
     def cur_timestamp(self) -> UnixTimeS:
         return UnixTimeS(self.cur_block["timestamp"])
 
+    @property
+    def s_start_payouts(self) -> int:
+        """Run payout when there's this seconds left"""
+        return self.ppss.predictoor_ss.s_start_payouts
+
     @property
     def epoch_s_thr(self):
         """Start predicting if there's > this time left"""

ppss.yaml

@@ -20,6 +20,7 @@ predictoor_ss:
 
   bot_only:
     s_until_epoch_end: 60 # in s. Start predicting if there's > this time left
+    s_start_payouts: 220 # in s. Run payout when there's this seconds left, set to 0 to disable
     s_cutoff: 20 # in s. Stop predicting if there's < this time left
 
   aimodel_ss:

system_tests/test_predictoor_system.py

@@ -1,4 +1,3 @@
-import os
 import sys
 from unittest.mock import Mock, patch, MagicMock
 
@@ -20,6 +19,7 @@ def setup_mock_web3_pp(mock_feeds, mock_predictoor_contract):
     mock_predictoor_ss = Mock()
     mock_predictoor_ss.get_feed_from_candidates.return_value = mock_feeds["0x1"]
     mock_predictoor_ss.s_until_epoch_end = 100
+    mock_predictoor_ss.s_start_payouts = 0
 
     mock_web3_config = Mock(spec=Web3Config)
     mock_web3_config.w3 = Mock()
@@ -30,13 +30,7 @@ def setup_mock_web3_pp(mock_feeds, mock_predictoor_contract):
     return mock_web3_pp, mock_predictoor_ss
 
 
-def _test_predictoor_system(
-    mock_feeds, mock_predictoor_contract, approach, caplog, monkeypatch
-):
-    PRIV_KEY = str(os.getenv("PRIVATE_KEY"))
-    PRIV_KEY2 = str(PRIV_KEY[:-4] + "0000")
-    monkeypatch.setenv("PRIVATE_KEY2", PRIV_KEY2)
-
+def _test_predictoor_system(mock_feeds, mock_predictoor_contract, approach, caplog):
     mock_web3_pp, mock_predictoor_ss = setup_mock_web3_pp(
         mock_feeds, mock_predictoor_contract
     )
@@ -75,12 +69,9 @@ def test_predictoor_approach_1_system(
     mock_feeds,
     mock_predictoor_contract,
     caplog,
-    monkeypatch,
 ):
     _ = mock_verify_feed_dependencies
-    _test_predictoor_system(
-        mock_feeds, mock_predictoor_contract, 1, caplog, monkeypatch
-    )
+    _test_predictoor_system(mock_feeds, mock_predictoor_contract, 1, caplog)
 
 
 @patch("pdr_backend.ppss.ppss.PPSS.verify_feed_dependencies")
@@ -89,9 +80,6 @@ def test_predictoor_approach_3_system(
     mock_feeds,
     mock_predictoor_contract,
     caplog,
-    monkeypatch,
 ):
     _ = mock_verify_feed_dependencies
-    _test_predictoor_system(
-        mock_feeds, mock_predictoor_contract, 3, caplog, monkeypatch
-    )
+    _test_predictoor_system(mock_feeds, mock_predictoor_contract, 3, caplog)