prediction-market-agent-tooling 0.61.2.dev479__py3-none-any.whl → 0.62.0__py3-none-any.whl

prediction_market_agent_tooling/markets/market_fees.py

@@ -1,5 +1,7 @@
 from pydantic import BaseModel, Field
 
+from prediction_market_agent_tooling.gtypes import CollateralToken
+
 
 class MarketFees(BaseModel):
     bet_proportion: float = Field(
@@ -32,5 +34,7 @@ class MarketFees(BaseModel):
         total_fee = self.total_fee_absolute_value(bet_amount)
         return total_fee / bet_amount
 
-    def get_bet_size_after_fees(self, bet_amount: float) -> float:
-        return bet_amount - self.total_fee_absolute_value(bet_amount)
+    def get_after_fees(self, bet_amount: CollateralToken) -> CollateralToken:
+        return bet_amount - CollateralToken(
+            self.total_fee_absolute_value(bet_amount.value)
+        )

prediction_market_agent_tooling/markets/omen/data_models.py

@@ -6,20 +6,19 @@ from web3 import Web3
 from prediction_market_agent_tooling.gtypes import (
     USD,
     ChecksumAddress,
+    CollateralToken,
     HexAddress,
     HexBytes,
     HexStr,
-    OmenOutcomeToken,
+    OutcomeStr,
+    OutcomeWei,
     Probability,
     Wei,
-    wei_type,
     xDai,
+    xDaiWei,
 )
 from prediction_market_agent_tooling.markets.data_models import (
     Bet,
-    BetAmount,
-    Currency,
-    ProfitAmount,
     Resolution,
     ResolvedBet,
 )
@@ -28,6 +27,7 @@ from prediction_market_agent_tooling.tools.contract import (
     init_collateral_token_contract,
     to_gnosis_chain_contract,
 )
+from prediction_market_agent_tooling.tools.tokens.usd import get_token_in_usd
 from prediction_market_agent_tooling.tools.utils import (
     BPS_CONSTANT,
     DatetimeUTC,
@@ -35,11 +35,13 @@ from prediction_market_agent_tooling.tools.utils import (
     should_not_happen,
     utcnow,
 )
-from prediction_market_agent_tooling.tools.web3_utils import wei_to_xdai
 
-OMEN_TRUE_OUTCOME = "Yes"
-OMEN_FALSE_OUTCOME = "No"
-OMEN_BINARY_MARKET_OUTCOMES = [OMEN_TRUE_OUTCOME, OMEN_FALSE_OUTCOME]
+OMEN_TRUE_OUTCOME = OutcomeStr("Yes")
+OMEN_FALSE_OUTCOME = OutcomeStr("No")
+OMEN_BINARY_MARKET_OUTCOMES: t.Sequence[OutcomeStr] = [
+    OMEN_TRUE_OUTCOME,
+    OMEN_FALSE_OUTCOME,
+]
 INVALID_ANSWER = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
 INVALID_ANSWER_HEX_BYTES = HexBytes(INVALID_ANSWER)
 INVALID_ANSWER_STR = HexStr(INVALID_ANSWER_HEX_BYTES.hex())
@@ -78,7 +80,7 @@ class Question(BaseModel):
     title: str
     data: str
     templateId: int
-    outcomes: list[str]
+    outcomes: t.Sequence[OutcomeStr]
     isPendingArbitration: bool
     openingTimestamp: int
     answerFinalizedTimestamp: t.Optional[DatetimeUTC] = None
@@ -187,9 +189,9 @@ class OmenPosition(BaseModel):
 class OmenUserPosition(BaseModel):
     id: HexBytes
     position: OmenPosition
-    balance: Wei
-    wrappedBalance: Wei
-    totalBalance: Wei
+    balance: OutcomeWei
+    wrappedBalance: OutcomeWei
+    totalBalance: OutcomeWei
 
     @property
     def redeemable(self) -> bool:
@@ -209,8 +211,6 @@ class OmenMarket(BaseModel):
     5. redeeming - a user withdraws collateral tokens from the market
     """
 
-    BET_AMOUNT_CURRENCY: t.ClassVar[Currency] = Currency.xDai
-
     id: HexAddress
     title: str
     creator: HexAddress
@@ -224,9 +224,9 @@ class OmenMarket(BaseModel):
     liquidityParameter: Wei
     usdVolume: USD
     collateralToken: HexAddress
-    outcomes: list[str]
-    outcomeTokenAmounts: list[OmenOutcomeToken]
-    outcomeTokenMarginalPrices: t.Optional[list[xDai]]
+    outcomes: t.Sequence[OutcomeStr]
+    outcomeTokenAmounts: list[OutcomeWei]
+    outcomeTokenMarginalPrices: t.Optional[list[CollateralToken]]
     fee: t.Optional[Wei]
     resolutionTimestamp: t.Optional[int] = None
     answerFinalizedTimestamp: t.Optional[int] = None
@@ -367,7 +367,11 @@ class OmenMarket(BaseModel):
             )
 
         return Probability(
-            1 - self.outcomeTokenAmounts[self.yes_index] / sum(self.outcomeTokenAmounts)
+            1
+            - (
+                self.outcomeTokenAmounts[self.yes_index]
+                / sum(self.outcomeTokenAmounts, start=OutcomeWei(0))
+            )
         )
 
     def __repr__(self) -> str:
@@ -466,22 +470,22 @@ class OmenMarket(BaseModel):
 
 
 def calculate_liquidity_parameter(
-    outcome_token_amounts: list[OmenOutcomeToken],
+    outcome_token_amounts: list[OutcomeWei],
 ) -> Wei:
     """
     Converted to Python from https://github.com/protofire/omen-subgraph/blob/f92bbfb6fa31ed9cd5985c416a26a2f640837d8b/src/utils/fpmm.ts#L171.
     """
-    amounts_product = 1.0
+    amounts_product = Wei(1)
     for amount in outcome_token_amounts:
-        amounts_product *= amount
+        amounts_product *= amount.as_wei
     n = len(outcome_token_amounts)
-    liquidity_parameter = amounts_product ** (1.0 / n)
-    return wei_type(liquidity_parameter)
+    liquidity_parameter = amounts_product.value ** (1.0 / n)
+    return Wei(liquidity_parameter)
 
 
 def calculate_marginal_prices(
-    outcome_token_amounts: list[OmenOutcomeToken],
-) -> list[xDai] | None:
+    outcome_token_amounts: list[OutcomeWei],
+) -> list[CollateralToken] | None:
     """
     Converted to Python from https://github.com/protofire/omen-subgraph/blob/f92bbfb6fa31ed9cd5985c416a26a2f640837d8b/src/utils/fpmm.ts#L197.
     """
@@ -490,19 +494,19 @@ def calculate_marginal_prices(
         return None
 
     n_outcomes = len(outcome_token_amounts)
-    weights = []
+    weights: list[Wei] = []
 
     for i in range(n_outcomes):
-        weight = 1.0
+        weight = Wei(1)
         for j in range(n_outcomes):
             if i != j:
-                weight *= outcome_token_amounts[j]
+                weight *= outcome_token_amounts[j].as_wei.value
         weights.append(weight)
 
-    sum_weights = sum(weights)
+    sum_weights = sum(weights, start=Wei(0))
 
-    marginal_prices = [weights[i] / sum_weights for i in range(n_outcomes)]
-    return [xDai(mp) for mp in marginal_prices]
+    marginal_prices = [weights[i].value / sum_weights.value for i in range(n_outcomes)]
+    return [CollateralToken(mp) for mp in marginal_prices]
 
 
 class OmenBetCreator(BaseModel):
@@ -513,22 +517,25 @@ class OmenBet(BaseModel):
     id: HexAddress  # A concatenation of: FPMM contract ID, trader ID and nonce. See https://github.com/protofire/omen-subgraph/blob/f92bbfb6fa31ed9cd5985c416a26a2f640837d8b/src/FixedProductMarketMakerMapping.ts#L109
     title: str
     collateralToken: HexAddress
-    outcomeTokenMarginalPrice: xDai
-    oldOutcomeTokenMarginalPrice: xDai
+    outcomeTokenMarginalPrice: CollateralToken
+    oldOutcomeTokenMarginalPrice: CollateralToken
     type: str
     creator: OmenBetCreator
     creationTimestamp: int
     collateralAmount: Wei
     feeAmount: Wei
     outcomeIndex: int
-    outcomeTokensTraded: Wei
+    outcomeTokensTraded: OutcomeWei
     transactionHash: HexBytes
     fpmm: OmenMarket
 
     @property
-    def collateral_amount_usd(self) -> USD:
-        # Convert manually instad of using the field `collateralAmountUSD` available on the graph, because it's bugged, it's 0 for non-xDai markets.
-        return USD(wei_to_xdai(self.collateralAmount))
+    def collateral_amount_token(self) -> CollateralToken:
+        return self.collateralAmount.as_token
+
+    @property
+    def collateral_token_checksummed(self) -> ChecksumAddress:
+        return Web3.to_checksum_address(self.collateralToken)
 
     @property
     def creation_datetime(self) -> DatetimeUTC:
@@ -548,23 +555,25 @@ class OmenBet(BaseModel):
         # Marginal price is the probability of the outcome after placing this bet.
         return Probability(float(self.outcomeTokenMarginalPrice))
 
-    def get_profit(self) -> ProfitAmount:
-        bet_amount_xdai = wei_to_xdai(self.collateralAmount)
+    def get_collateral_amount_usd(self) -> USD:
+        return get_token_in_usd(
+            self.collateral_amount_token, self.collateral_token_checksummed
+        )
+
+    def get_profit(self) -> CollateralToken:
+        bet_amount = self.collateral_amount_token
         profit = (
-            wei_to_xdai(self.outcomeTokensTraded) - bet_amount_xdai
+            self.outcomeTokensTraded.as_outcome_token.as_token - bet_amount
             if self.boolean_outcome == self.fpmm.boolean_outcome
-            else -bet_amount_xdai
-        )
-        return ProfitAmount(
-            amount=profit,
-            currency=Currency.xDai,
+            else -bet_amount
         )
+        return profit
 
     def to_bet(self) -> Bet:
         return Bet(
             id=str(self.transactionHash),
             # Use the transaction hash instead of the bet id - both are valid, but we return the transaction hash from the trade functions, so be consistent here.
-            amount=BetAmount(amount=self.collateral_amount_usd, currency=Currency.xDai),
+            amount=self.collateral_amount_token,
             outcome=self.boolean_outcome,
             created_time=self.creation_datetime,
             market_question=self.title,
@@ -580,7 +589,7 @@ class OmenBet(BaseModel):
         return ResolvedBet(
             id=self.transactionHash.hex(),
             # Use the transaction hash instead of the bet id - both are valid, but we return the transaction hash from the trade functions, so be consistent here.
-            amount=BetAmount(amount=self.collateral_amount_usd, currency=Currency.xDai),
+            amount=self.collateral_amount_token,
             outcome=self.boolean_outcome,
             created_time=self.creation_datetime,
             market_question=self.title,
@@ -658,7 +667,7 @@ class RealityResponse(BaseModel):
     answer: HexBytes
     isUnrevealed: bool
     isCommitment: bool
-    bond: Wei
+    bond: xDaiWei
     user: HexAddress
     historyHash: HexBytes
     question: RealityQuestion
@@ -667,7 +676,7 @@ class RealityResponse(BaseModel):
 
     @property
     def bond_xdai(self) -> xDai:
-        return wei_to_xdai(self.bond)
+        return self.bond.as_xdai
 
     @property
     def user_checksummed(self) -> ChecksumAddress:
@@ -684,7 +693,7 @@ class RealityAnswersResponse(BaseModel):
 
 def format_realitio_question(
     question: str,
-    outcomes: list[str],
+    outcomes: t.Sequence[str],
     category: str,
     language: str,
     template_id: int,
@@ -711,7 +720,7 @@ def parse_realitio_question(question_raw: str, template_id: int) -> "ParsedQuest
     """If you add a new template id here, also add to the encoding function above."""
     if template_id == 2:
         question, outcomes_raw, category, language = question_raw.split("␟")
-        outcomes = [o.strip('"') for o in outcomes_raw.split(",")]
+        outcomes = [OutcomeStr(o.strip('"')) for o in outcomes_raw.split(",")]
         return ParsedQuestion(
             question=question, outcomes=outcomes, category=category, language=language
         )
@@ -721,7 +730,7 @@ def parse_realitio_question(question_raw: str, template_id: int) -> "ParsedQuest
 
 class ParsedQuestion(BaseModel):
     question: str
-    outcomes: list[str]
+    outcomes: t.Sequence[OutcomeStr]
     language: str
     category: str
 
@@ -783,13 +792,13 @@ class ConditionPreparationEvent(BaseModel):
 
 class FPMMFundingAddedEvent(BaseModel):
     funder: HexAddress
-    amountsAdded: list[OmenOutcomeToken]
+    amountsAdded: list[Wei]
     sharesMinted: Wei
 
     @property
-    def outcome_token_amounts(self) -> list[OmenOutcomeToken]:
+    def outcome_token_amounts(self) -> list[OutcomeWei]:
         # Just renaming so we remember what it is.
-        return self.amountsAdded
+        return [OutcomeWei(x.value) for x in self.amountsAdded]
 
 
 class CreatedMarket(BaseModel):
@@ -801,7 +810,7 @@ class CreatedMarket(BaseModel):
     condition_event: ConditionPreparationEvent | None
     initial_funds: Wei
     fee: Wei
-    distribution_hint: list[OmenOutcomeToken] | None
+    distribution_hint: list[OutcomeWei] | None
 
     @property
     def url(self) -> str: