polymarket-apis 0.3.0__py3-none-any.whl → 0.3.9__py3-none-any.whl

polymarket_apis/types/web3_types.py

@@ -0,0 +1,45 @@
+from typing import Literal, Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from ..types.common import EthAddress, HexString, Keccak256OrPadded
+
+
+class TransactionLog(BaseModel):
+    """Log entry in a transaction receipt."""
+
+    address: EthAddress
+    topics: list[Keccak256OrPadded]
+    data: HexString
+    block_number: int = Field(alias="blockNumber")
+    transaction_hash: HexString = Field(alias="transactionHash")
+    transaction_index: int = Field(alias="transactionIndex")
+    block_hash: HexString = Field(alias="blockHash")
+    block_timestamp: Optional[HexString] = Field(None, alias="blockTimestamp")
+    log_index: int = Field(alias="logIndex")
+    removed: bool
+
+
+class TransactionReceipt(BaseModel):
+    """Transaction receipt from the blockchain."""
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    tx_hash: HexString = Field(alias="transactionHash")
+    tx_index: int = Field(alias="transactionIndex")
+    block_hash: HexString = Field(alias="blockHash")
+    block_number: int = Field(alias="blockNumber")
+
+    status: Literal[0, 1]
+    type: int
+
+    gas_used: int = Field(alias="gasUsed")
+    cumulative_gas_used: int = Field(alias="cumulativeGasUsed")
+    effective_gas_price: int = Field(alias="effectiveGasPrice")
+
+    from_address: EthAddress = Field(alias="from")
+    to_address: EthAddress = Field(alias="to")
+    contract_address: Optional[EthAddress] = Field(None, alias="contractAddress")
+
+    logs: list[TransactionLog]
+    logs_bloom: HexString = Field(alias="logsBloom")

polymarket_apis/types/websockets_types.py

@@ -5,9 +5,11 @@ from pydantic import AliasChoices, BaseModel, Field, field_validator
 
 from ..types.clob_types import MakerOrder, OrderBookSummary, TickSize
 from ..types.common import EthAddress, Keccak256, TimeseriesPoint
+from ..types.gamma_types import Comment, Reaction
 
 # wss://ws-subscriptions-clob.polymarket.com/ws/market types
 
+
 class PriceChange(BaseModel):
     best_ask: float = Field(validation_alias=AliasChoices("ba", "best_ask"))
     best_bid: float = Field(validation_alias=AliasChoices("bb", "best_bid"))
@@ -17,17 +19,22 @@ class PriceChange(BaseModel):
     token_id: str = Field(validation_alias=AliasChoices("a", "asset_id"))
     hash: str = Field(validation_alias=AliasChoices("h", "hash"))
 
+
 class PriceChanges(BaseModel):
     condition_id: Keccak256 = Field(validation_alias=AliasChoices("m", "market"))
-    price_changes: list[PriceChange] = Field(validation_alias=AliasChoices("pc", "price_changes"))
+    price_changes: list[PriceChange] = Field(
+        validation_alias=AliasChoices("pc", "price_changes")
+    )
     timestamp: datetime = Field(validation_alias=AliasChoices("t", "timestamp"))
 
+
 class TickSizeChange(BaseModel):
     token_id: str = Field(alias="asset_id")
     condition_id: Keccak256 = Field(alias="market")
     old_tick_size: TickSize
     new_tick_size: TickSize
 
+
 class LastTradePrice(BaseModel):
     price: float
     size: float
@@ -36,31 +43,37 @@ class LastTradePrice(BaseModel):
     condition_id: Keccak256 = Field(alias="market")
     fee_rate_bps: float
 
+
 class OrderBookSummaryEvent(OrderBookSummary):
     event_type: Literal["book"]
 
+
 class PriceChangeEvent(PriceChanges):
     event_type: Literal["price_change"]
 
+
 class TickSizeChangeEvent(TickSizeChange):
     side: Literal["BUY", "SELL"]
     timestamp: datetime
     event_type: Literal["tick_size_change"]
 
+
 class LastTradePriceEvent(LastTradePrice):
     timestamp: datetime
     event_type: Literal["last_trade_price"]
 
+
 # wss://ws-subscriptions-clob.polymarket.com/ws/user types
 
+
 class OrderEvent(BaseModel):
     token_id: str = Field(alias="asset_id")
     condition_id: Keccak256 = Field(alias="market")
     order_id: Keccak256 = Field(alias="id")
-    associated_trades: Optional[list[str]] = None # list of trade ids which
+    associated_trades: Optional[list[str]] = None  # list of trade ids which
     maker_address: EthAddress
-    order_owner: str = Field(alias="owner") # api key of order owner
-    event_owner: Optional[str] = Field(None, alias="owner") # api key of event owner
+    order_owner: str = Field(alias="owner")  # api key of order owner
+    event_owner: Optional[str] = Field(None, alias="owner")  # api key of event owner
 
     price: float
     side: Literal["BUY", "SELL"]
@@ -71,7 +84,7 @@ class OrderEvent(BaseModel):
 
     created_at: datetime
     expiration: Optional[datetime] = None
-    timestamp: Optional[datetime] = None # time of event
+    timestamp: Optional[datetime] = None  # time of event
 
     event_type: Optional[Literal["order"]] = None
     type: Literal["PLACEMENT", "UPDATE", "CANCELLATION"]
@@ -84,35 +97,42 @@ class OrderEvent(BaseModel):
             return None
         return v
 
+
 class TradeEvent(BaseModel):
     token_id: str = Field(alias="asset_id")
     condition_id: Keccak256 = Field(alias="market")
     taker_order_id: Keccak256
     maker_orders: list[MakerOrder]
     trade_id: str = Field(alias="id")
-    trade_owner: Optional[str] = Field(None, alias="owner") # api key of trade owner
-    event_owner: str = Field(alias="owner") # api key of event owner
+    trade_owner: Optional[str] = Field(None, alias="owner")  # api key of trade owner
+    event_owner: str = Field(alias="owner")  # api key of event owner
 
     price: float
     size: float
     side: Literal["BUY", "SELL"]
     outcome: str
 
-    last_update: datetime # time of last update to trade
-    matchtime: Optional[datetime] = None # time trade was matched
-    timestamp: Optional[datetime] = None # time of event
+    last_update: datetime  # time of last update to trade
+    matchtime: Optional[datetime] = None  # time trade was matched
+    timestamp: Optional[datetime] = None  # time of event
 
     event_type: Optional[Literal["trade"]] = None
     type: Optional[Literal["TRADE"]] = None
 
     status: Literal["MATCHED", "MINED", "CONFIRMED", "RETRYING", "FAILED"]
 
+
 # wss://ws-live-data.polymarket.com types
 
+
 # Payload models
 class ActivityTrade(BaseModel):
-    token_id: str = Field(alias="asset") # ERC1155 token ID of conditional token being traded
-    condition_id: str = Field(alias="conditionId")  # Id of market which is also the CTF condition ID
+    token_id: str = Field(
+        alias="asset"
+    )  # ERC1155 token ID of conditional token being traded
+    condition_id: str = Field(
+        alias="conditionId"
+    )  # Id of market which is also the CTF condition ID
     event_slug: str = Field(alias="eventSlug")  # Slug of the event
     outcome: str  # Human readable outcome of the market
     outcome_index: int = Field(alias="outcomeIndex")  # Index of the outcome
@@ -131,66 +151,81 @@ class ActivityTrade(BaseModel):
     profile_image: str = Field(alias="profileImage")  # URL to the user profile image
     profile_image_optimized: Optional[str] = Field(None, alias="profileImageOptimized")
 
-class Comment(BaseModel):
-    id: str  # Unique identifier of comment
-    body: str  # Content of the comment
-    parent_entity_type: str = Field(alias="parentEntityType")  # Type of the parent entity (Event or Series)
-    parent_entity_id: int = Field(alias="parentEntityID")  # ID of the parent entity
-    parent_comment_id: Optional[str] = Field(None, alias="parentCommentID")  # ID of the parent comment
-    user_address: str = Field(alias="userAddress")  # Address of the user
-    reply_address: Optional[str] = Field(None, alias="replyAddress")  # Address of the reply user
-    created_at: datetime = Field(alias="createdAt")  # Creation timestamp
-    updated_at: Optional[datetime] = Field(None, alias="updatedAt")  # Last update timestamp
-
-class Reaction(BaseModel):
-    id: str  # Unique identifier of reaction
-    comment_id: int = Field(alias="commentID")  # ID of the comment
-    reaction_type: str = Field(alias="reactionType")  # Type of the reaction
-    icon: Optional[str] = None  # Icon representing the reaction
-    user_address: str = Field(alias="userAddress")  # Address of the user
-    created_at: datetime = Field(alias="createdAt")  # Creation timestamp
 
 class Request(BaseModel):
     request_id: str = Field(alias="requestId")  # Unique identifier for the request
     proxy_address: str = Field(alias="proxyAddress")  # Proxy address
     user_address: str = Field(alias="userAddress")  # User address
-    condition_id: Keccak256 = Field(alias="market")  # Id of market which is also the CTF condition ID
-    token_id: str = Field(alias="token")  # ERC1155 token ID of conditional token being traded
-    complement_token_id: str = Field(alias="complement")  # Complement ERC1155 token ID of conditional token being traded
-    state: Literal["STATE_REQUEST_EXPIRED", "STATE_USER_CANCELED", "STATE_REQUEST_CANCELED", "STATE_MAKER_CANCELED", "STATE_ACCEPTING_QUOTES", "STATE_REQUEST_QUOTED", "STATE_QUOTE_IMPROVED"]  # Current state of the request
+    condition_id: Keccak256 = Field(
+        alias="market"
+    )  # Id of market which is also the CTF condition ID
+    token_id: str = Field(
+        alias="token"
+    )  # ERC1155 token ID of conditional token being traded
+    complement_token_id: str = Field(
+        alias="complement"
+    )  # Complement ERC1155 token ID of conditional token being traded
+    state: Literal[
+        "STATE_REQUEST_EXPIRED",
+        "STATE_USER_CANCELED",
+        "STATE_REQUEST_CANCELED",
+        "STATE_MAKER_CANCELED",
+        "STATE_ACCEPTING_QUOTES",
+        "STATE_REQUEST_QUOTED",
+        "STATE_QUOTE_IMPROVED",
+    ]  # Current state of the request
     side: Literal["BUY", "SELL"]  # Indicates buy or sell side
     price: float  # Price from in/out sizes
     size_in: float = Field(alias="sizeIn")  # Input size of the request
     size_out: float = Field(alias="sizeOut")  # Output size of the request
     expiry: Optional[datetime] = None
 
+
 class Quote(BaseModel):
     quote_id: str = Field(alias="quoteId")  # Unique identifier for the quote
     request_id: str = Field(alias="requestId")  # Associated request identifier
     proxy_address: str = Field(alias="proxyAddress")  # Proxy address
     user_address: str = Field(alias="userAddress")  # User address
-    condition_id: Keccak256 = Field(alias="condition")  # Id of market which is also the CTF condition ID
-    token_id: str = Field(alias="token")  # ERC1155 token ID of conditional token being traded
-    complement_token_id: str = Field(alias="complement")  # Complement ERC1155 token ID of conditional token being traded
-    state: Literal["STATE_REQUEST_EXPIRED", "STATE_USER_CANCELED", "STATE_REQUEST_CANCELED", "STATE_MAKER_CANCELED", "STATE_ACCEPTING_QUOTES", "STATE_REQUEST_QUOTED", "STATE_QUOTE_IMPROVED"]  # Current state of the quote
+    condition_id: Keccak256 = Field(
+        alias="condition"
+    )  # Id of market which is also the CTF condition ID
+    token_id: str = Field(
+        alias="token"
+    )  # ERC1155 token ID of conditional token being traded
+    complement_token_id: str = Field(
+        alias="complement"
+    )  # Complement ERC1155 token ID of conditional token being traded
+    state: Literal[
+        "STATE_REQUEST_EXPIRED",
+        "STATE_USER_CANCELED",
+        "STATE_REQUEST_CANCELED",
+        "STATE_MAKER_CANCELED",
+        "STATE_ACCEPTING_QUOTES",
+        "STATE_REQUEST_QUOTED",
+        "STATE_QUOTE_IMPROVED",
+    ]  # Current state of the quote
     side: Literal["BUY", "SELL"]  # Indicates buy or sell side
     size_in: float = Field(alias="sizeIn")  # Input size of the quote
     size_out: float = Field(alias="sizeOut")  # Output size of the quote
     expiry: Optional[datetime] = None
 
+
 class CryptoPriceSubscribe(BaseModel):
     data: list[TimeseriesPoint]
     symbol: str
 
+
 class CryptoPriceUpdate(TimeseriesPoint):
     symbol: str
     full_accuracy_value: str
 
+
 class AggOrderBookSummary(OrderBookSummary):
     min_order_size: float
     tick_size: TickSize
     neg_risk: bool
 
+
 class LiveDataClobMarket(BaseModel):
     token_ids: list[str] = Field(alias="asset_ids")
     condition_id: Keccak256 = Field(alias="market")
@@ -198,6 +233,7 @@ class LiveDataClobMarket(BaseModel):
     tick_size: TickSize
     neg_risk: bool
 
+
 # Event models
 class ActivityTradeEvent(BaseModel):
     payload: ActivityTrade
@@ -205,36 +241,44 @@ class ActivityTradeEvent(BaseModel):
     type: Literal["trades"]
     topic: Literal["activity"]
 
+
 class ActivityOrderMatchEvent(BaseModel):
     payload: ActivityTrade
     timestamp: datetime
     type: Literal["orders_matched"]
     topic: Literal["activity"]
 
+
 class CommentEvent(BaseModel):
     payload: Comment
     timestamp: datetime
     type: Literal["comment_created", "comment_removed"]
     topic: Literal["comments"]
 
+
 class ReactionEvent(BaseModel):
     payload: Reaction
     timestamp: datetime
     type: Literal["reaction_created", "reaction_removed"]
     topic: Literal["comments"]
 
+
 class RequestEvent(BaseModel):
     payload: Request
     timestamp: datetime
-    type: Literal["request_created", "request_edited", "request_canceled", "request_expired"]
+    type: Literal[
+        "request_created", "request_edited", "request_canceled", "request_expired"
+    ]
     topic: Literal["rfq"]
 
+
 class QuoteEvent(BaseModel):
     payload: Quote
     timestamp: datetime
     type: Literal["quote_created", "quote_edited", "quote_canceled", "quote_expired"]
     topic: Literal["rfq"]
 
+
 class CryptoPriceUpdateEvent(BaseModel):
     payload: CryptoPriceUpdate
     timestamp: datetime
@@ -242,12 +286,14 @@ class CryptoPriceUpdateEvent(BaseModel):
     type: Literal["update"]
     topic: Literal["crypto_prices", "crypto_prices_chainlink"]
 
+
 class CryptoPriceSubscribeEvent(BaseModel):
     payload: CryptoPriceSubscribe
     timestamp: datetime
     type: Literal["subscribe"]
     topic: Literal["crypto_prices", "crypto_prices_chainlink"]
 
+
 class LiveDataOrderBookSummaryEvent(BaseModel):
     payload: list[AggOrderBookSummary] | AggOrderBookSummary
     timestamp: datetime
@@ -255,6 +301,7 @@ class LiveDataOrderBookSummaryEvent(BaseModel):
     type: Literal["agg_orderbook"]
     topic: Literal["clob_market"]
 
+
 class LiveDataPriceChangeEvent(BaseModel):
     payload: PriceChanges
     timestamp: datetime
@@ -262,6 +309,7 @@ class LiveDataPriceChangeEvent(BaseModel):
     type: Literal["price_change"]
     topic: Literal["clob_market"]
 
+
 class LiveDataLastTradePriceEvent(BaseModel):
     payload: LastTradePrice
     timestamp: datetime
@@ -269,6 +317,7 @@ class LiveDataLastTradePriceEvent(BaseModel):
     type: Literal["last_trade_price"]
     topic: Literal["clob_market"]
 
+
 class LiveDataTickSizeChangeEvent(BaseModel):
     payload: TickSizeChange
     timestamp: datetime
@@ -276,6 +325,7 @@ class LiveDataTickSizeChangeEvent(BaseModel):
     type: Literal["tick_size_change"]
     topic: Literal["clob_market"]
 
+
 class MarketStatusChangeEvent(BaseModel):
     payload: LiveDataClobMarket
     timestamp: datetime
@@ -283,6 +333,7 @@ class MarketStatusChangeEvent(BaseModel):
     type: Literal["market_created", "market_resolved"]
     topic: Literal["clob_market"]
 
+
 class LiveDataOrderEvent(BaseModel):
     payload: OrderEvent
     timestamp: datetime
@@ -290,6 +341,7 @@ class LiveDataOrderEvent(BaseModel):
     type: Literal["order"]
     topic: Literal["clob_user"]
 
+
 class LiveDataTradeEvent(BaseModel):
     payload: TradeEvent
     timestamp: datetime
@@ -297,9 +349,8 @@ class LiveDataTradeEvent(BaseModel):
     type: Literal["trade"]
     topic: Literal["clob_user"]
 
+
 class ErrorEvent(BaseModel):
     message: str
     connection_id: str = Field(alias="connectionId")
     request_id: str = Field(alias="requestId")
-
-

polymarket_apis/utilities/config.py

@@ -26,6 +26,7 @@ NEG_RISK_CONFIG = {
     ),
 }
 
+
 def get_contract_config(chain_id: int, neg_risk: bool = False) -> ContractConfig:
     """Get the contract configuration for the chain."""
     config = NEG_RISK_CONFIG.get(chain_id) if neg_risk else CONFIG.get(chain_id)

polymarket_apis/utilities/constants.py

@@ -1,3 +1,5 @@
+from typing import Literal
+
 # Access levels
 L0 = 0
 L1 = 1
@@ -14,12 +16,11 @@ L1_AUTH_UNAVAILABLE = "A private key is needed to interact with this endpoint!"
 
 L2_AUTH_UNAVAILABLE = "API Credentials are needed to interact with this endpoint!"
 
-ZERO_ADDRESS = "0x0000000000000000000000000000000000000000"
+ADDRESS_ZERO = "0x0000000000000000000000000000000000000000"
 HASH_ZERO = "0x0000000000000000000000000000000000000000000000000000000000000000"
 
-AMOY = 80002
-POLYGON = 137
-
+AMOY: Literal[80002] = 80002
+POLYGON: Literal[137] = 137
 END_CURSOR = "LTE="
 
 BUY = "BUY"

polymarket_apis/utilities/exceptions.py

@@ -1,17 +1,26 @@
 class InvalidPriceError(Exception):
     pass
 
+
 class InvalidTickSizeError(Exception):
     pass
 
+
 class InvalidFeeRateError(Exception):
     pass
 
+
 class LiquidityError(Exception):
     pass
 
+
 class MissingOrderbookError(Exception):
     pass
 
+
 class AuthenticationRequiredError(ValueError):
     """Raised when authentication credentials are required but not provided."""
+
+
+class SafeAlreadyDeployedError(Exception):
+    """Raised when attempting to deploy a Safe that has already been deployed."""

polymarket_apis/utilities/order_builder/builder.py

@@ -54,7 +54,11 @@ class OrderBuilder:
         self.funder = funder if funder is not None else self.signer.address()
 
     def get_order_amounts(
-            self, side: str, size: float, price: float, round_config: RoundConfig,
+        self,
+        side: str,
+        size: float,
+        price: float,
+        round_config: RoundConfig,
     ):
         raw_price = round_normal(price, round_config.price)
 
@@ -88,7 +92,11 @@ class OrderBuilder:
         raise ValueError(msg)
 
     def get_market_order_amounts(
-            self, side: str, amount: float, price: float, round_config: RoundConfig,
+        self,
+        side: str,
+        amount: float,
+        price: float,
+        round_config: RoundConfig,
     ):
         raw_price = round_normal(price, round_config.price)
 
@@ -122,7 +130,9 @@ class OrderBuilder:
         raise ValueError(msg)
 
     def create_order(
-            self, order_args: OrderArgs, options: CreateOrderOptions,
+        self,
+        order_args: OrderArgs,
+        options: CreateOrderOptions,
     ) -> SignedOrder:
         """Creates and signs an order."""
         side, maker_amount, taker_amount = self.get_order_amounts(
@@ -147,7 +157,8 @@ class OrderBuilder:
         )
 
         contract_config = get_contract_config(
-            self.signer.get_chain_id(), options.neg_risk,
+            self.signer.get_chain_id(),
+            options.neg_risk,
         )
 
         order_builder = UtilsOrderBuilder(
@@ -159,7 +170,9 @@ class OrderBuilder:
         return order_builder.build_signed_order(data)
 
     def create_market_order(
-            self, order_args: MarketOrderArgs, options: CreateOrderOptions,
+        self,
+        order_args: MarketOrderArgs,
+        options: CreateOrderOptions,
     ) -> SignedOrder:
         """Creates and signs a market order."""
         side, maker_amount, taker_amount = self.get_market_order_amounts(
@@ -184,7 +197,8 @@ class OrderBuilder:
         )
 
         contract_config = get_contract_config(
-            self.signer.get_chain_id(), options.neg_risk,
+            self.signer.get_chain_id(),
+            options.neg_risk,
         )
 
         order_builder = UtilsOrderBuilder(
@@ -196,19 +210,21 @@ class OrderBuilder:
         return order_builder.build_signed_order(data)
 
     def calculate_buy_market_price(
-            self,
-            asks: list[OrderSummary], # expected to be sorted from worst to best price (high to low)
-            amount_to_match: float, # in usdc
-            order_type: OrderType,
+        self,
+        asks: list[
+            OrderSummary
+        ],  # expected to be sorted from worst to best price (high to low)
+        amount_to_match: float,  # in usdc
+        order_type: OrderType,
     ) -> float:
         if not asks:
             msg = "No ask orders available"
             raise LiquidityError(msg)
 
-        sum = 0
+        amount = 0.0
         for p in reversed(asks):
-            sum += float(p.size) * float(p.price)
-            if sum >= amount_to_match:
+            amount += float(p.size) * float(p.price)
+            if amount >= amount_to_match:
                 return float(p.price)
 
         if order_type == OrderType.FOK:
@@ -218,23 +234,23 @@ class OrderBuilder:
         return float(asks[0].price)
 
     def calculate_sell_market_price(
-            self,
-            bids: list[OrderSummary], # expected to be sorted from worst to best price (low to high)
-            amount_to_match: float, # in shares
-            order_type: OrderType,
+        self,
+        bids: list[
+            OrderSummary
+        ],  # expected to be sorted from worst to best price (low to high)
+        amount_to_match: float,  # in shares
+        order_type: OrderType,
     ) -> float:
         if not bids:
             msg = "No bid orders available"
             raise LiquidityError(msg)
 
-        sum = 0
+        amount = 0.0
         for p in reversed(bids):
-            sum += float(p.size)
-            if sum >= amount_to_match:
-                print(f"market order price {p.price}")
+            amount += float(p.size)
+            if amount >= amount_to_match:
                 return float(p.price)
 
-
         if order_type == OrderType.FOK:
             msg = "no match"
             raise ValueError(msg)

polymarket_apis/utilities/order_builder/helpers.py

@@ -39,7 +39,6 @@ def decimal_places(x: float) -> int:
     return max(0, -exponent)
 
 
-
 def generate_orderbook_summary_hash(orderbook: OrderBookSummary) -> str:
     """Compute hash while forcing empty string for hash field."""
     server_hash = orderbook.hash

polymarket_apis/utilities/signing/hmac.py

@@ -4,7 +4,11 @@ import hmac
 
 
 def build_hmac_signature(
-    secret: str, timestamp: str, method: str, request_path: str, body=None,
+    secret: str,
+    timestamp: str,
+    method: str,
+    request_path: str,
+    body=None,
 ):
     """Creates an HMAC signature by signing a payload with the secret."""
     base64_secret = base64.urlsafe_b64decode(secret)

polymarket_apis/utilities/signing/signer.py

@@ -11,7 +11,7 @@ class Signer:
             raise ValueError(msg)
 
         self.private_key = private_key
-        self.account = Account.from_key(private_key)
+        self.account = Account.from_key(private_key)  # type: ignore[misc]
         self.chain_id = chain_id
 
     def address(self):
@@ -22,4 +22,4 @@ class Signer:
 
     def sign(self, message_hash):
         """Signs a message hash."""
-        return Account.unsafe_sign_hash(message_hash, self.private_key).signature.hex()
+        return Account.unsafe_sign_hash(message_hash, self.private_key).signature.hex()  # type: ignore[misc]