prediction-market-agent-tooling 0.48.18__py3-none-any.whl → 0.49.1__py3-none-any.whl

prediction_market_agent_tooling/markets/omen/omen.py

@@ -1,16 +1,16 @@
 import sys
 import typing as t
-from datetime import datetime
+from datetime import datetime, timedelta
 
 import tenacity
 from web3 import Web3
-from web3.constants import HASH_ZERO
 
 from prediction_market_agent_tooling.config import APIKeys
 from prediction_market_agent_tooling.gtypes import (
     ChecksumAddress,
     HexAddress,
     HexStr,
+    OmenOutcomeToken,
     OutcomeStr,
     Probability,
     Wei,
@@ -37,6 +37,8 @@ from prediction_market_agent_tooling.markets.omen.data_models import (
     OMEN_TRUE_OUTCOME,
     PRESAGIO_BASE_URL,
     Condition,
+    ConditionPreparationEvent,
+    CreatedMarket,
     OmenBet,
     OmenMarket,
     OmenUserPosition,
@@ -44,7 +46,7 @@ from prediction_market_agent_tooling.markets.omen.data_models import (
     get_boolean_outcome,
 )
 from prediction_market_agent_tooling.markets.omen.omen_contracts import (
-    OMEN_DEFAULT_MARKET_FEE,
+    OMEN_DEFAULT_MARKET_FEE_PERC,
     Arbitrator,
     OmenConditionalTokenContract,
     OmenFixedProductMarketMakerContract,
@@ -52,6 +54,7 @@ from prediction_market_agent_tooling.markets.omen.omen_contracts import (
     OmenOracleContract,
     OmenRealitioContract,
     WrappedxDaiContract,
+    build_parent_collection_id,
 )
 from prediction_market_agent_tooling.markets.omen.omen_subgraph_handler import (
     OmenSubgraphHandler,
@@ -71,6 +74,7 @@ from prediction_market_agent_tooling.tools.utils import (
 )
 from prediction_market_agent_tooling.tools.web3_utils import (
     add_fraction,
+    get_receipt_block_timestamp,
     remove_fraction,
     wei_to_xdai,
     xdai_to_wei,
@@ -189,7 +193,7 @@ class OmenAgentMarket(AgentMarket):
         omen_auto_deposit: bool = True,
         web3: Web3 | None = None,
         api_keys: APIKeys | None = None,
-    ) -> None:
+    ) -> str:
         if not self.can_be_traded():
             raise ValueError(
                 f"Market {self.id} is not open for trading. Cannot place bet."
@@ -197,7 +201,7 @@ class OmenAgentMarket(AgentMarket):
         if amount.currency != self.currency:
             raise ValueError(f"Omen bets are made in xDai. Got {amount.currency}.")
         amount_xdai = xDai(amount.amount)
-        binary_omen_buy_outcome_tx(
+        return binary_omen_buy_outcome_tx(
             api_keys=api_keys if api_keys is not None else APIKeys(),
             amount=amount_xdai,
             market=self,
@@ -212,7 +216,7 @@ class OmenAgentMarket(AgentMarket):
         amount: TokenAmount,
         web3: Web3 | None = None,
         api_keys: APIKeys | None = None,
-    ) -> None:
+    ) -> str:
         return self.place_bet(
             outcome=outcome,
             amount=amount,
@@ -245,7 +249,7 @@ class OmenAgentMarket(AgentMarket):
         auto_withdraw: bool = False,
         api_keys: APIKeys | None = None,
         web3: Web3 | None = None,
-    ) -> None:
+    ) -> str:
         if not self.can_be_traded():
             raise ValueError(
                 f"Market {self.id} is not open for trading. Cannot sell tokens."
@@ -258,7 +262,7 @@ class OmenAgentMarket(AgentMarket):
             outcome=outcome,
             web3=web3,
         )
-        binary_omen_sell_outcome_tx(
+        return binary_omen_sell_outcome_tx(
             amount=collateral,
             api_keys=api_keys if api_keys is not None else APIKeys(),
             market=self,
@@ -325,6 +329,10 @@ class OmenAgentMarket(AgentMarket):
 
         omen_redeem_full_position_tx(api_keys=api_keys, market=self)
 
+    @staticmethod
+    def from_created_market(model: "CreatedMarket") -> "OmenAgentMarket":
+        return OmenAgentMarket.from_data_model(OmenMarket.from_created_market(model))
+
     @staticmethod
     def from_data_model(model: OmenMarket) -> "OmenAgentMarket":
         return OmenAgentMarket(
@@ -633,6 +641,14 @@ class OmenAgentMarket(AgentMarket):
         )
         return Probability(new_p_yes)
 
+    @staticmethod
+    def get_user_balance(user_id: str) -> float:
+        return float(get_balances(Web3.to_checksum_address(user_id)).total)
+
+    @staticmethod
+    def get_user_id(api_keys: APIKeys) -> str:
+        return api_keys.bet_from_address
+
 
 def get_omen_user_url(address: ChecksumAddress) -> str:
     return f"https://gnosisscan.io/address/{address}"
@@ -659,14 +675,14 @@ def omen_buy_outcome_tx(
     outcome: str,
     auto_deposit: bool,
     web3: Web3 | None = None,
-) -> None:
+) -> str:
     """
     Bets the given amount of xDai for the given outcome in the given market.
     """
     amount_wei = xdai_to_wei(amount)
 
     market_contract: OmenFixedProductMarketMakerContract = market.get_contract()
-    collateral_token_contract = market_contract.get_collateral_token_contract()
+    collateral_token_contract = market_contract.get_collateral_token_contract(web3)
 
     # In case of ERC4626, obtained (for example) sDai out of xDai could be lower than the `amount_wei`, so we need to handle it.
     amount_wei_to_buy = collateral_token_contract.get_in_shares(amount_wei, web3)
@@ -695,7 +711,7 @@ def omen_buy_outcome_tx(
         )
 
     # Buy shares using the deposited xDai in the collateral token.
-    market_contract.buy(
+    tx_receipt = market_contract.buy(
         api_keys=api_keys,
         amount_wei=amount_wei_to_buy,
         outcome_index=outcome_index,
@@ -703,6 +719,8 @@ def omen_buy_outcome_tx(
         web3=web3,
     )
 
+    return tx_receipt["transactionHash"].hex()
+
 
 def binary_omen_buy_outcome_tx(
     api_keys: APIKeys,
@@ -711,8 +729,8 @@ def binary_omen_buy_outcome_tx(
     binary_outcome: bool,
     auto_deposit: bool,
     web3: Web3 | None = None,
-) -> None:
-    omen_buy_outcome_tx(
+) -> str:
+    return omen_buy_outcome_tx(
         api_keys=api_keys,
         amount=amount,
         market=market,
@@ -729,7 +747,7 @@ def omen_sell_outcome_tx(
     outcome: str,
     auto_withdraw: bool,
     web3: Web3 | None = None,
-) -> None:
+) -> str:
     """
     Sells the given xDai value of shares corresponding to the given outcome in
     the given market.
@@ -741,7 +759,7 @@ def omen_sell_outcome_tx(
 
     market_contract: OmenFixedProductMarketMakerContract = market.get_contract()
     conditional_token_contract = OmenConditionalTokenContract()
-    collateral_token_contract = market_contract.get_collateral_token_contract()
+    collateral_token_contract = market_contract.get_collateral_token_contract(web3)
 
     # Verify, that markets uses conditional tokens that we expect.
     if (
@@ -770,7 +788,7 @@ def omen_sell_outcome_tx(
         web3=web3,
     )
     # Sell the shares.
-    market_contract.sell(
+    tx_receipt = market_contract.sell(
         api_keys,
         amount_wei,
         outcome_index,
@@ -792,6 +810,8 @@ def omen_sell_outcome_tx(
             web3,
         )
 
+    return tx_receipt["transactionHash"].hex()
+
 
 def binary_omen_sell_outcome_tx(
     api_keys: APIKeys,
@@ -800,8 +820,8 @@ def binary_omen_sell_outcome_tx(
     binary_outcome: bool,
     auto_withdraw: bool,
     web3: Web3 | None = None,
-) -> None:
-    omen_sell_outcome_tx(
+) -> str:
+    return omen_sell_outcome_tx(
         api_keys=api_keys,
         amount=amount,
         market=market,
@@ -820,10 +840,13 @@ def omen_create_market_tx(
     language: str,
     outcomes: list[str],
     auto_deposit: bool,
-    fee: float = OMEN_DEFAULT_MARKET_FEE,
+    finalization_timeout: timedelta = timedelta(days=1),
+    fee_perc: float = OMEN_DEFAULT_MARKET_FEE_PERC,
+    distribution_hint: list[OmenOutcomeToken] | None = None,
     collateral_token_address: ChecksumAddress = WrappedxDaiContract().address,
+    arbitrator: Arbitrator = Arbitrator.KLEROS_31_JURORS_WITH_APPEAL,
     web3: Web3 | None = None,
-) -> ChecksumAddress:
+) -> CreatedMarket:
     """
     Based on omen-exchange TypeScript code: https://github.com/protofire/omen-exchange/blob/b0b9a3e71b415d6becf21fe428e1c4fc0dad2e80/app/src/services/cpk/cpk.ts#L308
     """
@@ -861,28 +884,30 @@ def omen_create_market_tx(
         )
 
     # Create the question on Realitio.
-    question_id = realitio_contract.askQuestion(
+    question_event = realitio_contract.askQuestion(
         api_keys=api_keys,
         question=question,
         category=category,
         outcomes=outcomes,
         language=language,
-        arbitrator=Arbitrator.KLEROS,
+        arbitrator=arbitrator,
         opening=closing_time,  # The question is opened at the closing time of the market.
+        timeout=finalization_timeout,
         web3=web3,
     )
 
     # Construct the condition id.
+    cond_event: ConditionPreparationEvent | None = None
     condition_id = conditional_token_contract.getConditionId(
-        question_id=question_id,
+        question_id=question_event.question_id,
         oracle_address=oracle_contract.address,
         outcomes_slot_count=len(outcomes),
         web3=web3,
     )
     if not conditional_token_contract.does_condition_exists(condition_id, web3=web3):
-        conditional_token_contract.prepareCondition(
+        cond_event = conditional_token_contract.prepareCondition(
             api_keys=api_keys,
-            question_id=question_id,
+            question_id=question_event.question_id,
             oracle_address=oracle_contract.address,
             outcomes_slot_count=len(outcomes),
             web3=web3,
@@ -902,10 +927,16 @@ def omen_create_market_tx(
     )
 
     # Create the market.
-    create_market_receipt_tx = factory_contract.create2FixedProductMarketMaker(
+    fee = xdai_to_wei(xdai_type(fee_perc))
+    (
+        market_event,
+        funding_event,
+        receipt_tx,
+    ) = factory_contract.create2FixedProductMarketMaker(
         api_keys=api_keys,
         condition_id=condition_id,
         fee=fee,
+        distribution_hint=distribution_hint,
         initial_funds_wei=initial_funds_in_shares,
         collateral_token_address=collateral_token_contract.address,
         web3=web3,
@@ -916,10 +947,17 @@ def omen_create_market_tx(
     # but address of stakingRewardsFactoryAddress on xDai/Gnosis is 0x0000000000000000000000000000000000000000,
     # so skipping it here.
 
-    market_address = create_market_receipt_tx["logs"][-1][
-        "address"
-    ]  # The market address is available in the last emitted log, in the address field.
-    return market_address
+    return CreatedMarket(
+        market_creation_timestamp=get_receipt_block_timestamp(receipt_tx, web3),
+        market_event=market_event,
+        funding_event=funding_event,
+        condition_id=condition_id,
+        question_event=question_event,
+        condition_event=cond_event,
+        initial_funds=initial_funds_wei,
+        fee=fee,
+        distribution_hint=distribution_hint,
+    )
 
 
 def omen_fund_market_tx(
@@ -930,7 +968,7 @@ def omen_fund_market_tx(
     web3: Web3 | None = None,
 ) -> None:
     market_contract = market.get_contract()
-    collateral_token_contract = market_contract.get_collateral_token_contract()
+    collateral_token_contract = market_contract.get_collateral_token_contract(web3=web3)
 
     amount_to_fund = collateral_token_contract.get_in_shares(funds, web3)
 
@@ -948,10 +986,6 @@ def omen_fund_market_tx(
     market_contract.addFunding(api_keys, amount_to_fund, web3=web3)
 
 
-def build_parent_collection_id() -> HexStr:
-    return HASH_ZERO  # Taken from Olas
-
-
 def omen_redeem_full_position_tx(
     api_keys: APIKeys,
     market: OmenAgentMarket,
@@ -973,8 +1007,6 @@ def omen_redeem_full_position_tx(
             f"Market {market.id} uses conditional token that we didn't expect, {market_contract.conditionalTokens()} != {conditional_token_contract.address=}"
         )
 
-    parent_collection_id = build_parent_collection_id()
-
     if not market.is_resolved():
         logger.debug("Cannot redeem winnings if market is not yet resolved. Exiting.")
         return
@@ -995,7 +1027,6 @@ def omen_redeem_full_position_tx(
         api_keys=api_keys,
         collateral_token_address=market.collateral_token_contract_address_checksummed,
         condition_id=market.condition.id,
-        parent_collection_id=parent_collection_id,
         index_sets=market.condition.index_sets,
         web3=web3,
     )
@@ -1048,8 +1079,12 @@ def omen_remove_fund_market_tx(
     """
     from_address = api_keys.bet_from_address
     market_contract = market.get_contract()
-    market_collateral_token_contract = market_contract.get_collateral_token_contract()
-    original_balance = market_collateral_token_contract.balanceOf(from_address)
+    market_collateral_token_contract = market_contract.get_collateral_token_contract(
+        web3=web3
+    )
+    original_balance = market_collateral_token_contract.balanceOf(
+        from_address, web3=web3
+    )
 
     total_shares = market_contract.balanceOf(from_address, web3=web3)
     if total_shares == 0:
@@ -1084,11 +1119,11 @@ def omen_remove_fund_market_tx(
         web3=web3,
     )
 
-    new_balance = market_collateral_token_contract.balanceOf(from_address)
+    new_balance = market_collateral_token_contract.balanceOf(from_address, web3=web3)
 
     logger.debug(f"Result from merge positions {result}")
     logger.info(
-        f"Withdrawn {new_balance - original_balance} {market_collateral_token_contract.symbol_cached()} from liquidity at {market.url=}."
+        f"Withdrawn {new_balance - original_balance} {market_collateral_token_contract.symbol_cached(web3=web3)} from liquidity at {market.url=}."
     )
 
 
@@ -1126,7 +1161,6 @@ def redeem_from_all_user_positions(
             api_keys=api_keys,
             collateral_token_address=user_position.position.collateral_token_contract_address_checksummed,
             condition_id=condition_id,
-            parent_collection_id=build_parent_collection_id(),
             index_sets=user_position.position.indexSets,
             web3=web3,
         )