prediction-market-agent-tooling 0.63.7__tar.gz → 0.63.9__tar.gz

{prediction_market_agent_tooling-0.63.7 → prediction_market_agent_tooling-0.63.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: prediction-market-agent-tooling
-Version: 0.63.7
+Version: 0.63.9
 Summary: Tools to benchmark, deploy and monitor prediction market agents.
 Author: Gnosis
 Requires-Python: >=3.10,<3.13

prediction_market_agent_tooling-0.63.9/prediction_market_agent_tooling/abis/seer_gnosis_router.abi.json

@@ -0,0 +1,348 @@
+[
+  {
+    "inputs": [
+      {
+        "internalType": "contract IConditionalTokens",
+        "name": "_conditionalTokens",
+        "type": "address"
+      },
+      {
+        "internalType": "contract IWrapped1155Factory",
+        "name": "_wrapped1155Factory",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "constructor"
+  },
+  {
+    "inputs": [],
+    "name": "conditionalTokens",
+    "outputs": [
+      {
+        "internalType": "contract IConditionalTokens",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "contract IERC20",
+        "name": "collateralToken",
+        "type": "address"
+      },
+      {
+        "internalType": "bytes32",
+        "name": "parentCollectionId",
+        "type": "bytes32"
+      },
+      {
+        "internalType": "bytes32",
+        "name": "conditionId",
+        "type": "bytes32"
+      },
+      {
+        "internalType": "uint256",
+        "name": "indexSet",
+        "type": "uint256"
+      }
+    ],
+    "name": "getTokenId",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "bytes32",
+        "name": "conditionId",
+        "type": "bytes32"
+      }
+    ],
+    "name": "getWinningOutcomes",
+    "outputs": [
+      {
+        "internalType": "bool[]",
+        "name": "",
+        "type": "bool[]"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "contract IERC20",
+        "name": "collateralToken",
+        "type": "address"
+      },
+      {
+        "internalType": "contract Market",
+        "name": "market",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      }
+    ],
+    "name": "mergePositions",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "contract Market",
+        "name": "market",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      }
+    ],
+    "name": "mergeToBase",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256[]",
+        "name": "",
+        "type": "uint256[]"
+      },
+      {
+        "internalType": "uint256[]",
+        "name": "",
+        "type": "uint256[]"
+      },
+      {
+        "internalType": "bytes",
+        "name": "",
+        "type": "bytes"
+      }
+    ],
+    "name": "onERC1155BatchReceived",
+    "outputs": [
+      {
+        "internalType": "bytes4",
+        "name": "",
+        "type": "bytes4"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      },
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      },
+      {
+        "internalType": "bytes",
+        "name": "",
+        "type": "bytes"
+      }
+    ],
+    "name": "onERC1155Received",
+    "outputs": [
+      {
+        "internalType": "bytes4",
+        "name": "",
+        "type": "bytes4"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "contract IERC20",
+        "name": "collateralToken",
+        "type": "address"
+      },
+      {
+        "internalType": "contract Market",
+        "name": "market",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256[]",
+        "name": "outcomeIndexes",
+        "type": "uint256[]"
+      },
+      {
+        "internalType": "uint256[]",
+        "name": "amounts",
+        "type": "uint256[]"
+      }
+    ],
+    "name": "redeemPositions",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "contract Market",
+        "name": "market",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256[]",
+        "name": "outcomeIndexes",
+        "type": "uint256[]"
+      },
+      {
+        "internalType": "uint256[]",
+        "name": "amounts",
+        "type": "uint256[]"
+      }
+    ],
+    "name": "redeemToBase",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "sDAI",
+    "outputs": [
+      {
+        "internalType": "contract IERC20",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "savingsXDaiAdapter",
+    "outputs": [
+      {
+        "internalType": "contract ISavingsXDaiAdapter",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "contract Market",
+        "name": "market",
+        "type": "address"
+      }
+    ],
+    "name": "splitFromBase",
+    "outputs": [],
+    "stateMutability": "payable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "contract IERC20",
+        "name": "collateralToken",
+        "type": "address"
+      },
+      {
+        "internalType": "contract Market",
+        "name": "market",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      }
+    ],
+    "name": "splitPosition",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "bytes4",
+        "name": "interfaceId",
+        "type": "bytes4"
+      }
+    ],
+    "name": "supportsInterface",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "wrapped1155Factory",
+    "outputs": [
+      {
+        "internalType": "contract IWrapped1155Factory",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  }
+]

{prediction_market_agent_tooling-0.63.7 → prediction_market_agent_tooling-0.63.9}/prediction_market_agent_tooling/markets/seer/data_models.py

@@ -13,12 +13,14 @@ from prediction_market_agent_tooling.gtypes import (
     HexAddress,
     HexBytes,
     OutcomeStr,
+    OutcomeWei,
     Web3Wei,
 )
 from prediction_market_agent_tooling.markets.data_models import Resolution
 from prediction_market_agent_tooling.markets.seer.subgraph_data_models import (
     SeerParentMarket,
 )
+from prediction_market_agent_tooling.tools.contract import ContractERC20OnGnosisChain
 from prediction_market_agent_tooling.tools.datetime_utc import DatetimeUTC
 
 
@@ -149,6 +151,27 @@ class SeerMarket(BaseModel):
             return Resolution.YES
         return Resolution.NO
 
+    def is_redeemable(self, owner: ChecksumAddress, web3: Web3 | None = None) -> bool:
+        token_balances = self.get_outcome_token_balances(owner, web3)
+        if not self.payout_reported:
+            return False
+        return any(
+            payout and balance > 0
+            for payout, balance in zip(self.payout_numerators, token_balances)
+        )
+
+    def get_outcome_token_balances(
+        self, owner: ChecksumAddress, web3: Web3 | None = None
+    ) -> list[OutcomeWei]:
+        return [
+            OutcomeWei.from_wei(
+                ContractERC20OnGnosisChain(
+                    address=Web3.to_checksum_address(token)
+                ).balanceOf(owner, web3=web3)
+            )
+            for token in self.wrapped_tokens
+        ]
+
     @property
     def is_binary(self) -> bool:
         # 3 because Seer has also third, `Invalid` outcome.
@@ -186,3 +209,10 @@ class SeerMarket(BaseModel):
     def url(self) -> str:
         chain_id = RPCConfig().chain_id
         return urljoin(SEER_BASE_URL, f"markets/{chain_id}/{self.id.hex()}")
+
+
+class RedeemParams(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    market: ChecksumAddress
+    outcome_indices: list[int] = Field(alias="outcomeIndexes")
+    amounts: list[OutcomeWei]

{prediction_market_agent_tooling-0.63.7 → prediction_market_agent_tooling-0.63.9}/prediction_market_agent_tooling/markets/seer/seer.py

@@ -28,11 +28,13 @@ from prediction_market_agent_tooling.markets.data_models import ExistingPosition
 from prediction_market_agent_tooling.markets.market_fees import MarketFees
 from prediction_market_agent_tooling.markets.omen.omen import OmenAgentMarket
 from prediction_market_agent_tooling.markets.seer.data_models import (
+    RedeemParams,
     SeerMarket,
     SeerOutcomeEnum,
 )
 from prediction_market_agent_tooling.markets.seer.price_manager import PriceManager
 from prediction_market_agent_tooling.markets.seer.seer_contracts import (
+    GnosisRouter,
     SeerMarketFactory,
 )
 from prediction_market_agent_tooling.markets.seer.seer_subgraph_handler import (
@@ -48,6 +50,7 @@ from prediction_market_agent_tooling.tools.contract import (
 )
 from prediction_market_agent_tooling.tools.cow.cow_order import (
     get_buy_token_amount_else_raise,
+    get_trades_by_owner,
     swap_tokens_waiting,
 )
 from prediction_market_agent_tooling.tools.datetime_utc import DatetimeUTC
@@ -202,10 +205,70 @@ class SeerAgentMarket(AgentMarket):
     def get_user_id(api_keys: APIKeys) -> str:
         return OmenAgentMarket.get_user_id(api_keys)
 
+    @staticmethod
+    def _filter_markets_contained_in_trades(
+        api_keys: APIKeys,
+        markets: list[SeerMarket],
+    ) -> list[SeerMarket]:
+        """
+        We filter the markets using previous trades by the user so that we don't have to process all Seer markets.
+        """
+        trades_by_user = get_trades_by_owner(api_keys.bet_from_address)
+
+        traded_tokens = {t.buyToken for t in trades_by_user}.union(
+            [t.sellToken for t in trades_by_user]
+        )
+        filtered_markets = []
+        for market in markets:
+            if any(
+                [
+                    Web3.to_checksum_address(wrapped_token) in traded_tokens
+                    for wrapped_token in market.wrapped_tokens
+                ]
+            ):
+                filtered_markets.append(market)
+
+        return filtered_markets
+
     @staticmethod
     def redeem_winnings(api_keys: APIKeys) -> None:
-        # ToDo - implement me (https://github.com/gnosis/prediction-market-agent-tooling/issues/499)
-        pass
+        web3 = RPCConfig().get_web3()
+        subgraph = SeerSubgraphHandler()
+
+        closed_markets = subgraph.get_binary_markets(
+            filter_by=FilterBy.RESOLVED, sort_by=SortBy.NEWEST
+        )
+        filtered_markets = SeerAgentMarket._filter_markets_contained_in_trades(
+            api_keys, closed_markets
+        )
+
+        market_balances = {
+            market.id: market.get_outcome_token_balances(
+                api_keys.bet_from_address, web3
+            )
+            for market in filtered_markets
+        }
+
+        markets_to_redeem = [
+            market
+            for market in filtered_markets
+            if market.is_redeemable(owner=api_keys.bet_from_address, web3=web3)
+        ]
+
+        gnosis_router = GnosisRouter()
+        for market in markets_to_redeem:
+            try:
+                params = RedeemParams(
+                    market=Web3.to_checksum_address(market.id),
+                    outcome_indices=list(range(len(market.payout_numerators))),
+                    amounts=market_balances[market.id],
+                )
+                gnosis_router.redeem_to_base(api_keys, params=params, web3=web3)
+                logger.info(f"Redeemed market {market.id.hex()}")
+            except Exception as e:
+                logger.error(f"Failed to redeem market {market.id.hex()}, {e}")
+
+        # GnosisRouter withdraws sDai into wxDAI/xDai on its own, so no auto-withdraw needed by us.
 
     @staticmethod
     def verify_operational_balance(api_keys: APIKeys) -> bool:

{prediction_market_agent_tooling-0.63.7 → prediction_market_agent_tooling-0.63.9}/prediction_market_agent_tooling/markets/seer/seer_contracts.py

@@ -11,6 +11,7 @@ from prediction_market_agent_tooling.gtypes import (
     TxReceipt,
     xDai,
 )
+from prediction_market_agent_tooling.markets.seer.data_models import RedeemParams
 from prediction_market_agent_tooling.markets.seer.subgraph_data_models import (
     CreateCategoricalMarketsParams,
 )
@@ -79,3 +80,33 @@ class SeerMarketFactory(ContractOnGnosisChain):
             web3=web3,
         )
         return receipt_tx
+
+
+class GnosisRouter(ContractOnGnosisChain):
+    # https://gnosisscan.io/address/0x83183da839ce8228e31ae41222ead9edbb5cdcf1#code.
+    abi: ABI = abi_field_validator(
+        os.path.join(
+            os.path.dirname(os.path.realpath(__file__)),
+            "../../abis/seer_gnosis_router.abi.json",
+        )
+    )
+    address: ChecksumAddress = Web3.to_checksum_address(
+        "0xeC9048b59b3467415b1a38F63416407eA0c70fB8"
+    )
+
+    def redeem_to_base(
+        self,
+        api_keys: APIKeys,
+        params: RedeemParams,
+        web3: Web3 | None = None,
+    ) -> TxReceipt:
+        params_dict = params.model_dump(by_alias=True)
+        # We explicity set amounts since OutcomeWei gets serialized as dict
+        params_dict["amounts"] = [amount.value for amount in params.amounts]
+        receipt_tx = self.send(
+            api_keys=api_keys,
+            function_name="redeemToBase",
+            function_params=params_dict,
+            web3=web3,
+        )
+        return receipt_tx

{prediction_market_agent_tooling-0.63.7 → prediction_market_agent_tooling-0.63.9}/prediction_market_agent_tooling/tools/cow/cow_order.py

@@ -23,6 +23,7 @@ from cowdao_cowpy.order_book.generated.model import (
     OrderStatus,
     TokenAmount,
 )
+from cowdao_cowpy.subgraph.client import BaseModel
 from eth_account.signers.local import LocalAccount
 from tenacity import retry_if_not_exception_type, stop_after_attempt, wait_fixed
 from web3 import Web3
@@ -34,6 +35,11 @@ from prediction_market_agent_tooling.tools.contract import ContractERC20OnGnosis
 from prediction_market_agent_tooling.tools.utils import utcnow
 
 
+class MinimalisticToken(BaseModel):
+    sellToken: ChecksumAddress
+    buyToken: ChecksumAddress
+
+
 class OrderStatusError(Exception):
     pass
 
@@ -221,3 +227,20 @@ async def swap_tokens_waiting_async(
         )
 
         await asyncio.sleep(3.14)
+
+
+@tenacity.retry(
+    stop=stop_after_attempt(3),
+    wait=wait_fixed(1),
+    after=lambda x: logger.debug(f"get_trades_by_owner failed, {x.attempt_number=}."),
+)
+def get_trades_by_owner(
+    owner: ChecksumAddress,
+) -> list[MinimalisticToken]:
+    # Using this until cowpy gets fixed (https://github.com/cowdao-grants/cow-py/issues/35)
+    response = httpx.get(
+        f"https://api.cow.fi/xdai/api/v1/trades",
+        params={"owner": owner},
+    )
+    response.raise_for_status()
+    return [MinimalisticToken.model_validate(i) for i in response.json()]

{prediction_market_agent_tooling-0.63.7 → prediction_market_agent_tooling-0.63.9}/prediction_market_agent_tooling/tools/utils.py

@@ -194,15 +194,19 @@ def calculate_sell_amount_in_collateral(
     fees: MarketFees,
 ) -> CollateralToken:
     """
-    Computes the amount of collateral that needs to be sold to get `shares`
-    amount of shares. Returns None if the amount can't be computed.
+    Computes the amount of collateral that needs to be sold to get `shares` amount of shares.
 
     Taken from https://github.com/protofire/omen-exchange/blob/29d0ab16bdafa5cc0d37933c1c7608a055400c73/app/src/util/tools/fpmm/trading/index.ts#L99
     Simplified for binary markets.
     """
+    if shares_to_sell == 0:
+        return CollateralToken(0)
+
     for v in [shares_to_sell, holdings, other_holdings]:
         if v <= 0:
-            raise ValueError("All share args must be greater than 0")
+            raise ValueError(
+                f"All share args must be greater than 0, got {[shares_to_sell, holdings, other_holdings]=}"
+            )
 
     def f(r: float) -> float:
         R = OutcomeToken((r + fees.absolute) / (1 - fees.bet_proportion))

{prediction_market_agent_tooling-0.63.7 → prediction_market_agent_tooling-0.63.9}/pyproject.toml

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