prediction-market-agent-tooling 0.48.6__tar.gz → 0.48.8__tar.gz

{prediction_market_agent_tooling-0.48.6 → prediction_market_agent_tooling-0.48.8}/PKG-INFO

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

{prediction_market_agent_tooling-0.48.6 → prediction_market_agent_tooling-0.48.8}/prediction_market_agent_tooling/markets/data_models.py

@@ -19,6 +19,10 @@ class Resolution(str, Enum):
     CANCEL = "CANCEL"
     MKT = "MKT"
 
+    @staticmethod
+    def from_bool(value: bool) -> "Resolution":
+        return Resolution.YES if value else Resolution.NO
+
 
 class TokenAmount(BaseModel):
     amount: float

{prediction_market_agent_tooling-0.48.6 → prediction_market_agent_tooling-0.48.8}/prediction_market_agent_tooling/markets/omen/data_models.py

@@ -470,6 +470,8 @@ class RealityQuestion(BaseModel):
     updatedTimestamp: datetime
     contentHash: HexBytes
     questionId: HexBytes
+    answerFinalizedTimestamp: datetime
+    currentScheduledFinalizationTimestamp: datetime
 
     @property
     def url(self) -> str:
@@ -486,6 +488,32 @@ class RealityAnswer(BaseModel):
     createdBlock: int
 
 
+class RealityResponse(BaseModel):
+    """
+    This is similar to `RealityAnswer`, but contains additional fields, most importantly `historyHash`.
+    """
+
+    id: str
+    timestamp: datetime
+    answer: HexBytes
+    isUnrevealed: bool
+    isCommitment: bool
+    bond: Wei
+    user: HexAddress
+    historyHash: HexBytes
+    question: RealityQuestion
+    createdBlock: int
+    revealedBlock: int | None
+
+    @property
+    def bond_xdai(self) -> xDai:
+        return wei_to_xdai(self.bond)
+
+    @property
+    def user_checksummed(self) -> ChecksumAddress:
+        return Web3.to_checksum_address(self.user)
+
+
 class RealityAnswers(BaseModel):
     answers: list[RealityAnswer]
 

{prediction_market_agent_tooling-0.48.6 → prediction_market_agent_tooling-0.48.8}/prediction_market_agent_tooling/markets/omen/omen_contracts.py

@@ -1,7 +1,7 @@
 import os
 import random
 import typing as t
-from datetime import datetime
+from datetime import datetime, timedelta
 from enum import Enum
 
 from web3 import Web3
@@ -521,6 +521,7 @@ class OmenRealitioContract(ContractOnGnosisChain):
         language: str,
         arbitrator: Arbitrator,
         opening: datetime,
+        timeout: timedelta = timedelta(days=1),
         nonce: int | None = None,
         tx_params: t.Optional[TxParams] = None,
         web3: Web3 | None = None,
@@ -547,7 +548,7 @@ class OmenRealitioContract(ContractOnGnosisChain):
                 template_id=template_id,
                 question=realitio_question,
                 arbitrator=arbitrator_contract_address,
-                timeout=86400,  # See https://github.com/protofire/omen-exchange/blob/2cfdf6bfe37afa8b169731d51fea69d42321d66c/app/src/util/networks.ts#L278.
+                timeout=int(timeout.total_seconds()),
                 opening_ts=int(opening.timestamp()),
                 nonce=(
                     nonce if nonce is not None else random.randint(0, 1000000)

{prediction_market_agent_tooling-0.48.6 → prediction_market_agent_tooling-0.48.8}/prediction_market_agent_tooling/markets/omen/omen_resolving.py

@@ -33,7 +33,6 @@ from prediction_market_agent_tooling.markets.omen.omen_subgraph_handler import (
 from prediction_market_agent_tooling.markets.polymarket.utils import (
     find_resolution_on_polymarket,
 )
-from prediction_market_agent_tooling.tools.utils import check_not_none
 from prediction_market_agent_tooling.tools.web3_utils import ZERO_BYTES, xdai_to_wei
 
 
@@ -42,7 +41,6 @@ def claim_bonds_on_realitio_questions(
     questions: list[RealityQuestion],
     auto_withdraw: bool,
     web3: Web3 | None = None,
-    silent_errors: bool = False,
 ) -> list[HexBytes]:
     claimed_questions: list[HexBytes] = []
 
@@ -50,19 +48,10 @@ def claim_bonds_on_realitio_questions(
         logger.info(
             f"[{idx+1} / {len(questions)}] Claiming bond for {question.questionId=} {question.url=}"
         )
-        try:
-            claim_bonds_on_realitio_question(
-                api_keys, question, auto_withdraw=auto_withdraw, web3=web3
-            )
-            claimed_questions.append(question.questionId)
-        except Exception as e:
-            # TODO: This shouldn't be required once `claim_bonds_on_realitio_question` below is fixed.
-            if silent_errors:
-                logger.warning(
-                    f"Error while claiming bond for {question.questionId=} {question.url=}: {e}"
-                )
-            else:
-                raise
+        claim_bonds_on_realitio_question(
+            api_keys, question, auto_withdraw=auto_withdraw, web3=web3
+        )
+        claimed_questions.append(question.questionId)
 
     return claimed_questions
 
@@ -77,50 +66,39 @@ def claim_bonds_on_realitio_question(
     realitio_contract = OmenRealitioContract()
 
     # Get all answers for the question.
-    answers_objects = OmenSubgraphHandler().get_answers(question_id=question.questionId)
+    responses = OmenSubgraphHandler().get_responses(question_id=question.questionId)
 
-    if not answers_objects:
-        raise ValueError(f"No answers found for {question.questionId=}")
+    # They need to be processed in order.
+    responses = sorted(responses, key=lambda x: x.timestamp)
 
-    if answers_objects[-1].question.historyHash == ZERO_BYTES:
-        raise ValueError(f"Already claimed {question.questionId=}.")
+    if not responses:
+        raise ValueError(f"No answers found for {question.questionId.hex()=}")
 
-    if len(answers_objects) > 1:
-        # As you can see below, we need `history_hash` for every answer.
-        # The trouble is, that historyHash is updated after each new answer and the contract holds only the latest one.
-        # So if we have more than 1 answer, we missing the historyHash n-1 of them and this would fail.
-        # You can find how to calculate history hash at https://realitio.github.io/docs/html/contract_explanation.html#answer-history-entries.
-        # At the moment, we support only 1 answer, as for that one answer we will have the hash.
-        raise NotImplementedError()
+    if responses[-1].question.historyHash == ZERO_BYTES:
+        raise ValueError(f"Already claimed {question.questionId.hex()=}.")
 
-    # Logic taken from packages/valory/skills/decision_maker_abci/models.py in `def claim_params`.
     history_hashes: list[HexBytes] = []
     addresses: list[ChecksumAddress] = []
     bonds: list[Wei] = []
     answers: list[HexBytes] = []
 
-    for i, answer in enumerate(reversed(answers_objects)):
-        # history_hashes second-last-to-first, the hash of each history entry, calculated as described here:
-        # https://realitio.github.io/docs/html/contract_explanation.html#answer-history-entries.
-        if i == len(answers_objects) - 1:
+    # Caller must provide the answer history, in reverse order.
+    # See https://gnosisscan.io/address/0x79e32aE03fb27B07C89c0c568F80287C01ca2E57#code#L625 for the `claimWinnings` logic.
+    reversed_responses = list(reversed(responses))
+
+    for i, response in enumerate(reversed_responses):
+        # second-last-to-first, the hash of each history entry. (Final one should be empty).
+        if i == len(reversed_responses) - 1:
             history_hashes.append(ZERO_BYTES)
         else:
-            # TODO: See `if len(answers_objects) > 1` above.
-            # This is from the original Olas implementation (https://github.com/kongzii/trader/blob/700af475a4538cc3d5d22caf9dec9e9d22d72af1/packages/valory/skills/market_manager_abci/graph_tooling/requests.py#L297),
-            # but it's most probably wrong (see comment above).
-            history_hashes.append(
-                check_not_none(
-                    answers_objects[i + 1].question.historyHash,
-                    "Shouldn't be None here.",
-                )
-            )
+            history_hashes.append(reversed_responses[i + 1].historyHash)
 
         # last-to-first, the address of each answerer or commitment sender
-        addresses.append(Web3.to_checksum_address(answer.question.user))
+        addresses.append(Web3.to_checksum_address(response.user))
         # last-to-first, the bond supplied with each answer or commitment
-        bonds.append(answer.lastBond)
+        bonds.append(response.bond)
         # last-to-first, each answer supplied, or commitment ID if the answer was supplied with commit->reveal
-        answers.append(answer.answer)
+        answers.append(response.answer)
 
     realitio_contract.claimWinnings(
         api_keys=api_keys,

{prediction_market_agent_tooling-0.48.6 → prediction_market_agent_tooling-0.48.8}/prediction_market_agent_tooling/markets/omen/omen_subgraph_handler.py

@@ -22,6 +22,7 @@ from prediction_market_agent_tooling.markets.omen.data_models import (
     OmenUserPosition,
     RealityAnswer,
     RealityQuestion,
+    RealityResponse,
 )
 from prediction_market_agent_tooling.markets.omen.omen_contracts import (
     OmenThumbnailMapping,
@@ -118,6 +119,8 @@ class OmenSubgraphHandler(metaclass=SingletonMeta):
             questions_field.questionId,
             questions_field.contentHash,
             questions_field.historyHash,
+            questions_field.answerFinalizedTimestamp,
+            questions_field.currentScheduledFinalizationTimestamp,
         ]
 
     def _get_fields_for_answers(self, answers_field: FieldPath) -> list[FieldPath]:
@@ -130,6 +133,20 @@ class OmenSubgraphHandler(metaclass=SingletonMeta):
             answers_field.createdBlock,
         ] + self._get_fields_for_reality_questions(answers_field.question)
 
+    def _get_fields_for_responses(self, responses_field: FieldPath) -> list[FieldPath]:
+        return [
+            responses_field.id,
+            responses_field.timestamp,
+            responses_field.answer,
+            responses_field.isUnrevealed,
+            responses_field.isCommitment,
+            responses_field.bond,
+            responses_field.user,
+            responses_field.historyHash,
+            responses_field.createdBlock,
+            responses_field.revealedBlock,
+        ] + self._get_fields_for_reality_questions(responses_field.question)
+
     def _get_fields_for_market_questions(
         self, questions_field: FieldPath
     ) -> list[FieldPath]:
@@ -175,11 +192,13 @@ class OmenSubgraphHandler(metaclass=SingletonMeta):
     def _build_where_statements(
         self,
         creator: t.Optional[HexAddress] = None,
+        creator_in: t.Optional[t.Sequence[HexAddress]] = None,
         outcomes: list[str] = [OMEN_TRUE_OUTCOME, OMEN_FALSE_OUTCOME],
         created_after: t.Optional[datetime] = None,
         opened_before: t.Optional[datetime] = None,
         opened_after: t.Optional[datetime] = None,
         finalized_before: t.Optional[datetime] = None,
+        finalized_after: t.Optional[datetime] = None,
         finalized: bool | None = None,
         resolved: bool | None = None,
         liquidity_bigger_than: Wei | None = None,
@@ -202,7 +221,10 @@ class OmenSubgraphHandler(metaclass=SingletonMeta):
             ]
 
         if creator:
-            where_stms["creator"] = creator
+            where_stms["creator"] = creator.lower()
+
+        if creator_in:
+            where_stms["creator_in"] = [x.lower() for x in creator_in]
 
         if created_after:
             where_stms["creationTimestamp_gt"] = to_int_timestamp(created_after)
@@ -244,6 +266,11 @@ class OmenSubgraphHandler(metaclass=SingletonMeta):
                 finalized_before
             )
 
+        if finalized_after:
+            where_stms["answerFinalizedTimestamp_gt"] = to_int_timestamp(
+                finalized_after
+            )
+
         # `excluded_question_titles` can not be an empty list, otherwise the API bugs out and returns nothing.
         excluded_question_titles = [""]
         if excluded_questions:
@@ -331,9 +358,11 @@ class OmenSubgraphHandler(metaclass=SingletonMeta):
         opened_before: t.Optional[datetime] = None,
         opened_after: t.Optional[datetime] = None,
         finalized_before: t.Optional[datetime] = None,
+        finalized_after: t.Optional[datetime] = None,
         finalized: bool | None = None,
         resolved: bool | None = None,
         creator: t.Optional[HexAddress] = None,
+        creator_in: t.Optional[t.Sequence[HexAddress]] = None,
         liquidity_bigger_than: Wei | None = None,
         condition_id_in: list[HexBytes] | None = None,
         id_in: list[str] | None = None,
@@ -353,11 +382,13 @@ class OmenSubgraphHandler(metaclass=SingletonMeta):
         """
         where_stms = self._build_where_statements(
             creator=creator,
+            creator_in=creator_in,
             outcomes=outcomes,
             created_after=created_after,
             opened_before=opened_before,
             opened_after=opened_after,
             finalized_before=finalized_before,
+            finalized_after=finalized_after,
             finalized=finalized,
             resolved=resolved,
             condition_id_in=condition_id_in,
@@ -582,6 +613,10 @@ class OmenSubgraphHandler(metaclass=SingletonMeta):
         user: HexAddress | None = None,
         claimed: bool | None = None,
         current_answer_before: datetime | None = None,
+        finalized_before: datetime | None = None,
+        finalized_after: datetime | None = None,
+        id_in: list[str] | None = None,
+        question_id_in: list[HexBytes] | None = None,
     ) -> list[RealityQuestion]:
         where_stms: dict[str, t.Any] = {}
 
@@ -599,6 +634,22 @@ class OmenSubgraphHandler(metaclass=SingletonMeta):
                 current_answer_before
             )
 
+        if finalized_before is not None:
+            where_stms["answerFinalizedTimestamp_lt"] = to_int_timestamp(
+                finalized_before
+            )
+
+        if finalized_after is not None:
+            where_stms["answerFinalizedTimestamp_gt"] = to_int_timestamp(
+                finalized_after
+            )
+
+        if id_in is not None:
+            where_stms["id_in"] = id_in
+
+        if question_id_in is not None:
+            where_stms["questionId_in"] = [x.hex() for x in question_id_in]
+
         questions = self.realityeth_subgraph.Query.questions(where=where_stms)
         fields = self._get_fields_for_reality_questions(questions)
         result = self.sg.query_json(fields)
@@ -618,6 +669,17 @@ class OmenSubgraphHandler(metaclass=SingletonMeta):
         items = self._parse_items_from_json(result)
         return [RealityAnswer.model_validate(i) for i in items]
 
+    def get_responses(self, question_id: HexBytes) -> list[RealityResponse]:
+        response = self.realityeth_subgraph.Response
+        where_stms = [
+            response.question.questionId == question_id.hex(),
+        ]
+        responses = self.realityeth_subgraph.Query.responses(where=where_stms)
+        fields = self._get_fields_for_responses(responses)
+        result = self.sg.query_json(fields)
+        items = self._parse_items_from_json(result)
+        return [RealityResponse.model_validate(i) for i in items]
+
     def get_markets_from_all_user_positions(
         self, user_positions: list[OmenUserPosition]
     ) -> list[OmenMarket]:

{prediction_market_agent_tooling-0.48.6 → prediction_market_agent_tooling-0.48.8}/prediction_market_agent_tooling/markets/polymarket/data_models_web.py

@@ -38,7 +38,7 @@ class Event(BaseModel):
 
 
 class Event1(BaseModel):
-    startDate: datetime
+    startDate: datetime | None = None
     slug: str
 
 
@@ -78,13 +78,13 @@ class Market(BaseModel):
     conditionId: str
     slug: str
     twitterCardImage: t.Any | None = None
-    resolutionSource: str
+    resolutionSource: str | None = None
     endDate: datetime
     category: t.Any | None = None
     ammType: t.Any | None = None
     description: str
     liquidity: str | None = None
-    startDate: datetime
+    startDate: datetime | None = None
     createdAt: datetime
     xAxisValue: t.Any | None = None
     yAxisValue: t.Any | None = None
@@ -93,8 +93,8 @@ class Market(BaseModel):
     lowerBound: t.Any | None = None
     upperBound: t.Any | None = None
     outcomes: list[str]
-    image: str
-    icon: str
+    image: str | None = None
+    icon: str | None = None
     imageOptimized: t.Any | None = None
     iconOptimized: t.Any | None = None
     outcomePrices: list[USDC]
@@ -108,23 +108,23 @@ class Market(BaseModel):
     marketMakerAddress: HexAddress
     closedTime: datetime | None = None
     wideFormat: bool | None = None
-    new: bool
+    new: bool | None = None
     sentDiscord: t.Any | None = None
     mailchimpTag: t.Any | None = None
-    featured: bool
-    submitted_by: str
+    featured: bool | None = None
+    submitted_by: str | None = None
     subcategory: t.Any | None = None
     categoryMailchimpTag: t.Any | None = None
-    archived: bool
-    resolvedBy: str
-    restricted: bool
-    groupItemTitle: str
-    groupItemThreshold: str
-    questionID: str
+    archived: bool | None = None
+    resolvedBy: str | None = None
+    restricted: bool | None = None
+    groupItemTitle: str | None = None
+    groupItemThreshold: str | None = None
+    questionID: str | None = None
     umaEndDate: t.Any | None = None
-    enableOrderBook: bool
-    orderPriceMinTickSize: float
-    orderMinSize: int
+    enableOrderBook: bool | None = None
+    orderPriceMinTickSize: float | None = None
+    orderMinSize: int | None = None
     umaResolutionStatus: t.Any | None = None
     curationOrder: t.Any | None = None
     volumeNum: USDC | None = None
@@ -134,9 +134,9 @@ class Market(BaseModel):
     umaEndDateIso: datetime | None = None
     commentsEnabled: bool | None = None
     disqusThread: t.Any | None = None
-    gameStartTime: datetime | None = None
+    gameStartTime: t.Any | None = None
     secondsDelay: int | None = None
-    clobTokenIds: list[str]
+    clobTokenIds: list[str] | None = None
     liquidityAmm: float | None = None
     liquidityClob: float | None = None
     makerBaseFee: int | None = None
@@ -144,27 +144,27 @@ class Market(BaseModel):
     negRisk: t.Any | None = None
     negRiskRequestID: t.Any | None = None
     negRiskMarketID: t.Any | None = None
-    events: list[Event]
-    markets: list[Market1]
+    events: list[Event] | None = None
+    markets: list[Market1] | None = None
     lower_bound_date: t.Any | None = None
     upper_bound_date: t.Any | None = None
     market_type: str | None = None
-    resolution_source: str
-    end_date: str
+    resolution_source: str | None = None
+    end_date: str | None = None
     amm_type: t.Any | None = None
     x_axis_value: t.Any | None = None
     y_axis_value: t.Any | None = None
     denomination_token: t.Any | None = None
-    resolved_by: str
+    resolved_by: str | None = None
     upper_bound: t.Any | None = None
     lower_bound: t.Any | None = None
-    created_at: str
+    created_at: str | None = None
     updated_at: t.Any | None = None
     closed_time: t.Any | None = None
     wide_format: bool | None = None
     volume_num: USDC | None = None
     liquidity_num: USDC | None = None
-    image_raw: str
+    image_raw: str | None = None
     resolutionData: ResolutionData
 
     @field_validator("closedTime", mode="before")
@@ -234,19 +234,19 @@ class PolymarketFullMarket(BaseModel):
     title: str
     subtitle: t.Any | None = None
     description: str
-    commentCount: int
-    resolutionSource: str
-    startDate: datetime
+    commentCount: int | None = None
+    resolutionSource: str | None = None
+    startDate: datetime | None = None
     endDate: datetime
-    image: str
-    icon: str
+    image: str | None = None
+    icon: str | None = None
     featuredImage: str | None = None
     active: bool
     closed: bool
-    archived: bool
-    new: bool
-    featured: bool
-    restricted: bool
+    archived: bool | None = None
+    new: bool | None = None
+    featured: bool | None = None
+    restricted: bool | None = None
     liquidity: USDC | None = None
     volume: USDC | None = None
     volume24hr: USDC | None = None
@@ -257,7 +257,7 @@ class PolymarketFullMarket(BaseModel):
     commentsEnabled: bool | None = None
     disqusThread: t.Any | None = None
     updatedAt: datetime
-    enableOrderBook: bool
+    enableOrderBook: bool | None = None
     liquidityAmm: float | None = None
     liquidityClob: float | None = None
     imageOptimized: ImageOptimized | None = None
@@ -269,7 +269,7 @@ class PolymarketFullMarket(BaseModel):
     markets: list[Market]
     categories: list[Category] | None = None
     series: t.Any | None = None
-    image_raw: str
+    image_raw: str | None = None
 
     @property
     def url(self) -> str:
@@ -298,6 +298,8 @@ class PolymarketFullMarket(BaseModel):
 
         Warning: This is a very slow operation, as it requires fetching the website. Use it only when necessary.
         """
+        logger.info(f"Fetching full market from {url}")
+
         # Fetch the website as a normal browser would.
         headers = {
             "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3"
@@ -352,7 +354,8 @@ class State(BaseModel):
         | dict[str, MarketBidsAndAsks]
         | dict[str, PriceSide]
         | None
-    )  # It's none if you go to the website and it says "Oops...we didn't forecast this".
+        # It's none if you go to the website and it says "Oops...we didn't forecast this".
+    )
     dataUpdateCount: int
     dataUpdatedAt: int
     error: t.Any | None = None

{prediction_market_agent_tooling-0.48.6 → prediction_market_agent_tooling-0.48.8}/pyproject.toml

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