prediction-market-agent-tooling 0.46.0__tar.gz → 0.47.1__tar.gz

{prediction_market_agent_tooling-0.46.0 → prediction_market_agent_tooling-0.47.1}/PKG-INFO

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

{prediction_market_agent_tooling-0.46.0 → prediction_market_agent_tooling-0.47.1}/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__()
@@ -209,6 +216,19 @@ class DeployableTraderAgent(DeployableAgent):
     def have_bet_on_market_since(self, market: AgentMarket, since: timedelta) -> bool:
         return have_bet_on_market_since(keys=APIKeys(), market=market, since=since)
 
+    def check_min_required_balance_to_operate(self, market_type: MarketType) -> None:
+        api_keys = APIKeys()
+        if self.min_required_balance_to_operate is None:
+            return
+        if market_type == MarketType.OMEN and 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} "
+                f"for agent with address {api_keys.public_key} is not met."
+            )
+
     def pick_markets(
         self, market_type: MarketType, markets: t.Sequence[AgentMarket]
     ) -> t.Sequence[AgentMarket]:
@@ -273,10 +293,14 @@ 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)
+            self.check_min_required_balance_to_operate(market_type)
             # 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:
         """
@@ -285,6 +309,8 @@ class DeployableTraderAgent(DeployableAgent):
         available_markets = self.get_markets(market_type)
         markets = self.pick_markets(market_type, available_markets)
         for market in markets:
+            # We need to check it again before each market bet, as the balance might have changed.
+            self.check_min_required_balance_to_operate(market_type)
             result = self.answer_binary_market(market)
             if result is None:
                 logger.info(f"Skipping market {market} as no answer was provided")

{prediction_market_agent_tooling-0.46.0 → prediction_market_agent_tooling-0.47.1}/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.46.0 → prediction_market_agent_tooling-0.47.1}/pyproject.toml

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