prediction-market-agent-tooling 0.45.1__tar.gz → 0.47.0__tar.gz

{prediction_market_agent_tooling-0.45.1 → prediction_market_agent_tooling-0.47.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: prediction-market-agent-tooling
-Version: 0.45.1
+Version: 0.47.0
 Summary: Tools to benchmark, deploy and monitor prediction market agents.
 Author: Gnosis
 Requires-Python: >=3.10,<3.12

{prediction_market_agent_tooling-0.45.1 → prediction_market_agent_tooling-0.47.0}/prediction_market_agent_tooling/deploy/agent.py

@@ -22,7 +22,7 @@ from prediction_market_agent_tooling.deploy.gcp.utils import (
     gcp_function_is_active,
     gcp_resolve_api_keys_secrets,
 )
-from prediction_market_agent_tooling.gtypes import Probability, xdai_type
+from prediction_market_agent_tooling.gtypes import Probability, xDai, xdai_type
 from prediction_market_agent_tooling.loggers import logger
 from prediction_market_agent_tooling.markets.agent_market import (
     AgentMarket,
@@ -35,6 +35,7 @@ from prediction_market_agent_tooling.markets.markets import (
     have_bet_on_market_since,
 )
 from prediction_market_agent_tooling.markets.omen.omen import (
+    is_minimum_required_balance,
     redeem_from_all_user_positions,
     withdraw_wxdai_to_xdai_to_keep_balance,
 )
@@ -73,6 +74,10 @@ def to_boolean_outcome(value: str | bool) -> bool:
 Decision = Annotated[bool, BeforeValidator(to_boolean_outcome)]
 
 
+class OutOfFundsError(ValueError):
+    pass
+
+
 class Answer(BaseModel):
     decision: Decision  # Warning: p_yes > 0.5 doesn't necessarily mean decision is True! For example, if our p_yes is 55%, but market's p_yes is 80%, then it might be profitable to bet on False.
     p_yes: Probability
@@ -201,6 +206,8 @@ def {entrypoint_function_name}(request) -> str:
 
 class DeployableTraderAgent(DeployableAgent):
     bet_on_n_markets_per_run: int = 1
+    min_required_balance_to_operate: xDai | None = xdai_type(1)
+    min_balance_to_keep_in_native_currency: xDai | None = xdai_type(0.1)
 
     def __init__(self, place_bet: bool = True) -> None:
         super().__init__()
@@ -273,10 +280,22 @@ class DeployableTraderAgent(DeployableAgent):
         if market_type == MarketType.OMEN:
             # Omen is specific, because the user (agent) needs to manually withdraw winnings from the market.
             redeem_from_all_user_positions(api_keys)
+            # Check if we have enough of balance to operate.
+            if self.min_required_balance_to_operate is not None:
+                if not is_minimum_required_balance(
+                    api_keys.public_key,
+                    min_required_balance=self.min_required_balance_to_operate,
+                ):
+                    raise OutOfFundsError(
+                        f"Minimum required balance {self.min_required_balance_to_operate} is not met."
+                    )
             # Exchange wxdai back to xdai if the balance is getting low, so we can keep paying for fees.
-            withdraw_wxdai_to_xdai_to_keep_balance(
-                api_keys, min_required_balance=xdai_type(1), withdraw_multiplier=2
-            )
+            if self.min_balance_to_keep_in_native_currency is not None:
+                withdraw_wxdai_to_xdai_to_keep_balance(
+                    api_keys,
+                    min_required_balance=self.min_balance_to_keep_in_native_currency,
+                    withdraw_multiplier=2,
+                )
 
     def process_bets(self, market_type: MarketType) -> None:
         """

{prediction_market_agent_tooling-0.45.1 → prediction_market_agent_tooling-0.47.0}/prediction_market_agent_tooling/markets/omen/data_models.py

@@ -31,6 +31,7 @@ from prediction_market_agent_tooling.tools.web3_utils import wei_to_xdai
 OMEN_TRUE_OUTCOME = "Yes"
 OMEN_FALSE_OUTCOME = "No"
 INVALID_ANSWER = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
+INVALID_ANSWER_HEX_BYTES = HexBytes(INVALID_ANSWER)
 OMEN_BASE_URL = "https://aiomen.eth.limo"
 PRESAGIO_BASE_URL = "https://presagio.pages.dev"
 

{prediction_market_agent_tooling-0.45.1 → prediction_market_agent_tooling-0.47.0}/prediction_market_agent_tooling/markets/omen/omen.py

@@ -1043,6 +1043,20 @@ def get_binary_market_p_yes_history(market: OmenAgentMarket) -> list[Probability
     return history
 
 
+def is_minimum_required_balance(
+    address: ChecksumAddress,
+    min_required_balance: xDai,
+    web3: Web3 | None = None,
+) -> bool:
+    """
+    Checks if the total balance of xDai and wxDai in the wallet is above the minimum required balance.
+    """
+    current_balances = get_balances(address, web3)
+    # xDai and wxDai have equal value and can be exchanged for almost no cost, so we can sum them up.
+    total_balance = current_balances.xdai + current_balances.wxdai
+    return total_balance >= min_required_balance
+
+
 def withdraw_wxdai_to_xdai_to_keep_balance(
     api_keys: APIKeys,
     min_required_balance: xDai,

{prediction_market_agent_tooling-0.45.1 → prediction_market_agent_tooling-0.47.0}/prediction_market_agent_tooling/markets/omen/omen_contracts.py

@@ -22,6 +22,9 @@ from prediction_market_agent_tooling.gtypes import (
     wei_type,
     xdai_type,
 )
+from prediction_market_agent_tooling.markets.omen.data_models import (
+    INVALID_ANSWER_HEX_BYTES,
+)
 from prediction_market_agent_tooling.tools.contract import (
     ContractDepositableWrapperERC20OnGnosisChain,
     ContractERC20OnGnosisChain,
@@ -562,8 +565,7 @@ class OmenRealitioContract(ContractOnGnosisChain):
         self,
         api_keys: APIKeys,
         question_id: HexBytes,
-        answer: str,
-        outcomes: list[str],
+        answer: HexBytes,
         bond: Wei,
         max_previous: Wei | None = None,
         web3: Web3 | None = None,
@@ -573,24 +575,60 @@ class OmenRealitioContract(ContractOnGnosisChain):
             # same as on Omen website: https://github.com/protofire/omen-exchange/blob/763d9c9d05ebf9edacbc1dbaa561aa5d08813c0f/app/src/services/realitio.ts#L363.
             max_previous = Wei(0)
 
-        # Normalise the answer to lowercase, to match Enum values as [YES, NO] against outcomes as ["Yes", "No"].
-        answer = answer.lower()
-        outcomes = [o.lower() for o in outcomes]
-
         return self.send_with_value(
             api_keys=api_keys,
             function_name="submitAnswer",
             function_params=dict(
                 question_id=question_id,
-                answer=int_to_hexbytes(
-                    outcomes.index(answer)
-                ),  # Contract's method expects answer index in bytes.
+                answer=answer,
                 max_previous=max_previous,
             ),
             amount_wei=bond,
             web3=web3,
         )
 
+    def submit_answer(
+        self,
+        api_keys: APIKeys,
+        question_id: HexBytes,
+        answer: str,
+        outcomes: list[str],
+        bond: Wei,
+        max_previous: Wei | None = None,
+        web3: Web3 | None = None,
+    ) -> TxReceipt:
+        # Normalise the answer to lowercase, to match Enum values as [YES, NO] against outcomes as ["Yes", "No"].
+        answer = answer.lower()
+        outcomes = [o.lower() for o in outcomes]
+
+        return self.submitAnswer(
+            api_keys=api_keys,
+            question_id=question_id,
+            answer=int_to_hexbytes(
+                outcomes.index(answer)
+            ),  # Contract's method expects answer index in bytes.
+            bond=bond,
+            max_previous=max_previous,
+            web3=web3,
+        )
+
+    def submit_answer_invalid(
+        self,
+        api_keys: APIKeys,
+        question_id: HexBytes,
+        bond: Wei,
+        max_previous: Wei | None = None,
+        web3: Web3 | None = None,
+    ) -> TxReceipt:
+        return self.submitAnswer(
+            api_keys=api_keys,
+            question_id=question_id,
+            answer=INVALID_ANSWER_HEX_BYTES,
+            bond=bond,
+            max_previous=max_previous,
+            web3=web3,
+        )
+
     def claimWinnings(
         self,
         api_keys: APIKeys,

{prediction_market_agent_tooling-0.45.1 → prediction_market_agent_tooling-0.47.0}/prediction_market_agent_tooling/markets/omen/omen_resolving.py

@@ -1,3 +1,5 @@
+from datetime import datetime
+
 from web3 import Web3
 
 from prediction_market_agent_tooling.config import APIKeys
@@ -140,6 +142,7 @@ def claim_bonds_on_realitio_question(
 def finalize_markets(
     api_keys: APIKeys,
     markets_with_resolutions: list[tuple[OmenMarket, Resolution | None]],
+    wait_n_days_before_invalid: int = 30,
     web3: Web3 | None = None,
 ) -> list[HexAddress]:
     finalized_markets: list[HexAddress] = []
@@ -148,9 +151,24 @@ def finalize_markets(
         logger.info(
             f"[{idx+1} / {len(markets_with_resolutions)}] Looking into {market.url=} {market.question_title=}"
         )
+        closed_before_days = (datetime.now() - market.close_time).days
 
         if resolution is None:
-            logger.warning(f"No resolution provided for {market.url=}")
+            if closed_before_days > wait_n_days_before_invalid:
+                logger.warning(
+                    f"Finalizing as invalid, market closed before {closed_before_days} days: {market.url=}"
+                )
+                omen_submit_invalid_answer_market_tx(
+                    api_keys,
+                    market,
+                    OMEN_DEFAULT_REALITIO_BOND_VALUE,
+                    web3=web3,
+                )
+
+            else:
+                logger.warning(
+                    f"Skipping, no resolution provided, market closed before {closed_before_days} days: {market.url=}"
+                )
 
         elif resolution in (Resolution.YES, Resolution.NO):
             logger.info(f"Found resolution {resolution.value=} for {market.url=}")
@@ -165,7 +183,15 @@ def finalize_markets(
             logger.info(f"Finalized {market.url=}")
 
         else:
-            logger.error(f"Invalid resolution found, {resolution=}, for {market.url=}")
+            logger.warning(
+                f"Invalid resolution found, {resolution=}, for {market.url=}, finalizing as invalid."
+            )
+            omen_submit_invalid_answer_market_tx(
+                api_keys,
+                market,
+                OMEN_DEFAULT_REALITIO_BOND_VALUE,
+                web3=web3,
+            )
 
     return finalized_markets
 
@@ -199,7 +225,7 @@ def omen_submit_answer_market_tx(
     And after the period is over, you need to resolve the market using `omen_resolve_market_tx`.
     """
     realitio_contract = OmenRealitioContract()
-    realitio_contract.submitAnswer(
+    realitio_contract.submit_answer(
         api_keys=api_keys,
         question_id=market.question.id,
         answer=resolution.value,
@@ -209,6 +235,25 @@ def omen_submit_answer_market_tx(
     )
 
 
+def omen_submit_invalid_answer_market_tx(
+    api_keys: APIKeys,
+    market: OmenMarket,
+    bond: xDai,
+    web3: Web3 | None = None,
+) -> None:
+    """
+    After the answer is submitted, there is 24h waiting period where the answer can be challenged by others.
+    And after the period is over, you need to resolve the market using `omen_resolve_market_tx`.
+    """
+    realitio_contract = OmenRealitioContract()
+    realitio_contract.submit_answer_invalid(
+        api_keys=api_keys,
+        question_id=market.question.id,
+        bond=xdai_to_wei(bond),
+        web3=web3,
+    )
+
+
 def omen_resolve_market_tx(
     api_keys: APIKeys,
     market: OmenMarket,

{prediction_market_agent_tooling-0.45.1 → prediction_market_agent_tooling-0.47.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "prediction-market-agent-tooling"
-version = "0.45.1"
+version = "0.47.0"
 description = "Tools to benchmark, deploy and monitor prediction market agents."
 authors = ["Gnosis"]
 readme = "README.md"