polymarket-apis 0.3.7__py3-none-any.whl → 0.3.8__py3-none-any.whl

polymarket_apis/__init__.py

@@ -10,7 +10,7 @@ This package provides a comprehensive interface to Polymarket's APIs including:
 - GraphQL API for flexible data queries
 """
 
-__version__ = "0.3.7"
+__version__ = "0.3.8"
 __author__ = "Razvan Gheorghe"
 __email__ = "razvan@gheorghe.me"
 

polymarket_apis/clients/web3_client.py

@@ -14,10 +14,13 @@ from web3.types import ChecksumAddress, TxParams, Wei
 from ..types.common import EthAddress, Keccak256
 from ..utilities.config import get_contract_config
 from ..utilities.constants import ADDRESS_ZERO, HASH_ZERO, POLYGON
+from ..utilities.exceptions import SafeAlreadyDeployedError
 from ..utilities.web3.abis.custom_contract_errors import CUSTOM_ERROR_DICT
 from ..utilities.web3.helpers import (
+    create_safe_create_signature,
     get_index_set,
     sign_safe_transaction,
+    split_signature,
 )
 
 
@@ -123,6 +126,20 @@ class PolymarketWeb3Client:
             args=[address, True],
         )
 
+    def _encode_transfer_usdc(self, address: ChecksumAddress, amount: int) -> str:
+        return self.usdc.encode_abi(
+            abi_element_identifier="transfer",
+            args=[address, amount],
+        )
+
+    def _encode_transfer_token(
+        self, token_id: str, address: ChecksumAddress, amount: int
+    ) -> str:
+        return self.conditional_tokens.encode_abi(
+            abi_element_identifier="safeTransferFrom",
+            args=[self.address, address, int(token_id), amount, HASH_ZERO],
+        )
+
     def _encode_split(self, condition_id: Keccak256, amount: int) -> str:
         return self.conditional_tokens.encode_abi(
             abi_element_identifier="splitPosition",
@@ -364,6 +381,48 @@ class PolymarketWeb3Client:
             + self.neg_risk_adapter.functions.getConditionId(question_id).call().hex()
         )
 
+    def deploy_safe(self) -> str:
+        """Deploy a Safe wallet using the SafeProxyFactory contract."""
+        safe_address = self.get_safe_proxy_address()
+        if self.w3.eth.get_code(self.w3.to_checksum_address(safe_address)) != b"":
+            msg = f"Safe already deployed at {safe_address}"
+            raise SafeAlreadyDeployedError(msg)
+
+        # Create the EIP-712 signature for Safe creation
+        sig = create_safe_create_signature(account=self.account, chain_id=POLYGON)
+
+        # Split the signature into r, s, v components
+        split_sig = split_signature(sig)
+
+        # Build the transaction
+        transaction = self._build_transaction()
+
+        # Execute the createProxy function
+        txn_data = self.safe_proxy_factory.functions.createProxy(
+            ADDRESS_ZERO,  # paymentToken
+            0,  # payment
+            ADDRESS_ZERO,  # paymentReceiver
+            (
+                split_sig["v"],
+                split_sig["r"],
+                split_sig["s"],
+            ),  # createSig tuple (uint8, bytes32, bytes32)
+        ).build_transaction(transaction=transaction)
+
+        # Sign and send transaction
+        signed_txn = self.account.sign_transaction(txn_data)
+        tx_hash = self.w3.eth.send_raw_transaction(signed_txn.raw_transaction)
+        tx_hash_hex = tx_hash.hex()
+
+        print(f"txn hash: 0x{tx_hash_hex}")
+
+        # Wait for transaction to be mined
+        self.w3.eth.wait_for_transaction_receipt(tx_hash)
+
+        print("Done!")
+
+        return f"0x{tx_hash_hex}"
+
     def set_all_approvals(self) -> None:
         """Sets both collateral and conditional tokens approvals."""
         print("Approving ConditionalTokens as spender on USDC")
@@ -396,6 +455,143 @@ class PolymarketWeb3Client:
         )
         print("All approvals set!")
 
+    def transfer_usdc(self, recipient: EthAddress, amount: float) -> str:
+        """Transfers usdc.e from the account to the proxy address."""
+        balance = self.get_usdc_balance(address=self.address)
+        if balance < amount:
+            msg = f"Insufficient USDC.e balance: {balance} < {amount}"
+            raise ValueError(msg)
+        amount = int(balance * 1e6)
+        transaction = self._build_transaction()
+        data = self._encode_transfer_usdc(
+            self.w3.to_checksum_address(recipient), amount
+        )
+        txn_data: TxParams | None = None
+        match self.signature_type:
+            case 0:
+                txn_data = self.usdc.functions.transfer(
+                    recipient,
+                    amount,
+                ).build_transaction(transaction=transaction)
+            case 1:
+                proxy_txn = {
+                    "typeCode": 1,
+                    "to": self.usdc_address,
+                    "value": 0,
+                    "data": data,
+                }
+                txn_data = self.proxy_factory.functions.proxy(
+                    [proxy_txn]
+                ).build_transaction(transaction=transaction)
+            case 2:
+                safe_nonce = self.safe.functions.nonce().call()
+                safe_txn = {
+                    "to": self.usdc_address,
+                    "data": data,
+                    "operation": 0,  # 1 for delegatecall, 0 for call
+                    "value": 0,
+                }
+                packed_sig = sign_safe_transaction(
+                    self.account, self.safe, safe_txn, safe_nonce
+                )
+                txn_data = self.safe.functions.execTransaction(
+                    safe_txn["to"],
+                    safe_txn["value"],
+                    safe_txn["data"],
+                    safe_txn.get("operation", 0),
+                    0,  # safeTxGas
+                    0,  # baseGas
+                    0,  # gasPrice
+                    ADDRESS_ZERO,  # gasToken
+                    ADDRESS_ZERO,  # refundReceiver
+                    packed_sig,
+                ).build_transaction(transaction=transaction)
+
+        # Sign and send transaction
+        signed_txn = self.account.sign_transaction(txn_data)
+        tx_hash = self.w3.eth.send_raw_transaction(signed_txn.raw_transaction)
+        tx_hash_hex = tx_hash.hex()
+
+        print(f"Txn hash: 0x{tx_hash_hex}")
+
+        # Wait for transaction to be mined
+        self.w3.eth.wait_for_transaction_receipt(tx_hash)
+
+        print("Done!")
+
+        return f"0x{tx_hash_hex}"
+
+    def transfer_token(
+        self, token_id: str, recipient: EthAddress, amount: float
+    ) -> str:
+        """Transfers conditional tokens from the account to the recipient address."""
+        balance = self.get_token_balance(token_id=token_id, address=self.address)
+        if balance < amount:
+            msg = f"Insufficient token balance: {balance} < {amount}"
+            raise ValueError(msg)
+        amount = int(balance * 1e6)
+        transaction = self._build_transaction()
+        data = self._encode_transfer_token(
+            token_id, self.w3.to_checksum_address(recipient), amount
+        )
+        txn_data: TxParams | None = None
+        match self.signature_type:
+            case 0:
+                txn_data = self.conditional_tokens.functions.safeTransferFrom(
+                    self.address,
+                    recipient,
+                    int(token_id),
+                    amount,
+                    b"",
+                ).build_transaction(transaction=transaction)
+            case 1:
+                proxy_txn = {
+                    "typeCode": 1,
+                    "to": self.conditional_tokens_address,
+                    "value": 0,
+                    "data": data,
+                }
+                txn_data = self.proxy_factory.functions.proxy(
+                    [proxy_txn]
+                ).build_transaction(transaction=transaction)
+            case 2:
+                safe_nonce = self.safe.functions.nonce().call()
+                safe_txn = {
+                    "to": self.conditional_tokens_address,
+                    "data": data,
+                    "operation": 0,  # 1 for delegatecall, 0 for call
+                    "value": 0,
+                }
+                packed_sig = sign_safe_transaction(
+                    self.account, self.safe, safe_txn, safe_nonce
+                )
+                txn_data = self.safe.functions.execTransaction(
+                    safe_txn["to"],
+                    safe_txn["value"],
+                    safe_txn["data"],
+                    safe_txn.get("operation", 0),
+                    0,  # safeTxGas
+                    0,  # baseGas
+                    0,  # gasPrice
+                    ADDRESS_ZERO,  # gasToken
+                    ADDRESS_ZERO,  # refundReceiver
+                    packed_sig,
+                ).build_transaction(transaction=transaction)
+
+        # Sign and send transaction
+        signed_txn = self.account.sign_transaction(txn_data)
+        tx_hash = self.w3.eth.send_raw_transaction(signed_txn.raw_transaction)
+        tx_hash_hex = tx_hash.hex()
+
+        print(f"Txn hash: 0x{tx_hash_hex}")
+
+        # Wait for transaction to be mined
+        self.w3.eth.wait_for_transaction_receipt(tx_hash)
+
+        print("Done!")
+
+        return f"0x{tx_hash_hex}"
+
     def split_position(
         self, condition_id: Keccak256, amount: float, neg_risk: bool = True
     ) -> str:

polymarket_apis/utilities/exceptions.py

@@ -20,3 +20,7 @@ class MissingOrderbookError(Exception):
 
 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/web3/helpers.py

@@ -1,6 +1,6 @@
 import re
 from collections.abc import Iterable
-from typing import Any
+from typing import Any, Literal
 
 from eth_account import Account
 from eth_account.messages import encode_defunct
@@ -114,6 +114,88 @@ def abi_encode_packed(*params: dict) -> bytes:
     return b"".join(parts)
 
 
+def split_signature(signature_hex: str) -> dict[str, Any]:
+    """
+    Split a signature into r, s, v components compatible with Safe factory.
+
+    Args:
+        signature_hex: Signature as hex string
+
+    Returns:
+        dict: Dictionary with r, s, v components properly formatted for the contract
+
+    """
+    # Remove 0x prefix if present
+    signature_hex = signature_hex.removeprefix("0x")
+
+    # Convert to bytes
+    signature_bytes = bytes.fromhex(signature_hex)
+
+    if len(signature_bytes) != 65:
+        msg = "Invalid signature length"
+        raise ValueError(msg)
+
+    # Extract r, s, v
+    r = signature_bytes[:32]
+    s = signature_bytes[32:64]
+    v = signature_bytes[64]
+
+    if v < 27:
+        if v in {0, 1}:
+            v += 27
+        else:
+            msg = "Invalid signature v value"
+            raise ValueError(msg)
+
+    # Return properly formatted components for the contract:
+    # - r and s as bytes32 (keep as bytes, web3.py will handle conversion)
+    # - v as uint8 (integer)
+    return {
+        "r": r,  # bytes32
+        "s": s,  # bytes32
+        "v": v,  # uint8
+    }
+
+
+def create_safe_create_signature(
+    account: Account, chain_id: Literal[137, 80002]
+) -> str:
+    """
+    Create EIP-712 signature for Safe creation.
+
+    Returns:
+        str: The signature as hex string
+
+    """
+    # EIP-712 domain
+    domain = {
+        "name": "Polymarket Contract Proxy Factory",
+        "chainId": chain_id,
+        "verifyingContract": "0xaacFeEa03eb1561C4e67d661e40682Bd20E3541b",
+    }
+
+    # EIP-712 types
+    types = {
+        "CreateProxy": [
+            {"name": "paymentToken", "type": "address"},
+            {"name": "payment", "type": "uint256"},
+            {"name": "paymentReceiver", "type": "address"},
+        ]
+    }
+
+    # Values to sign
+    values = {
+        "paymentToken": ADDRESS_ZERO,
+        "payment": 0,
+        "paymentReceiver": ADDRESS_ZERO,
+    }
+
+    # Create the signature using eth_account
+    signature = account.sign_typed_data(domain, types, values)
+
+    return signature.signature.hex()
+
+
 def sign_safe_transaction(
     account: Account, safe: Contract, safe_txn: dict, nonce: int
 ) -> bytes:

{polymarket_apis-0.3.7.dist-info → polymarket_apis-0.3.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: polymarket-apis
-Version: 0.3.7
+Version: 0.3.8
 Summary: Unified Polymarket APIs with Pydantic data validation - Clob, Gamma, Data, Web3, Websockets, GraphQL clients.
 Project-URL: repository, https://github.com/qualiaenjoyer/polymarket-apis
 Author-email: Razvan Gheorghe <razvan@gheorghe.me>
@@ -158,10 +158,13 @@ flowchart LR
   - #### Supporting EOA(signature_type=0), Email/Magic wallets (signature_type=1) and Safe/Gnosis wallets (signature_type=2)
   - #### Approvals
     - set approvals for all needed usdc and conditional token spenders (needed for full trading functionality)
-      - Safe/Gnosis wallets need to be deployed beforehand, either via "Enable Trading" pop-up on the web UI or by calling createProxy on the SafeWalletFactory contract (wip)
+      - Safe/Gnosis wallet holders need to run deploy_safe before setting approvals
   - #### Balance
     - get usdc balance by user address
     - get token balance by `token_id` and user address
+  - #### Transfers
+    - transfer usdc to another address - needs recipient address, amount
+    - transfer token to another address - needs `token_id`, recipient address, amount
   - #### Token/USDC conversions
     - split USDC into complementary tokens - needs `condition_id`, amount, neg_risk bool
     - merge complementary tokens into USDC - needs `condition_id`, amount, neg_risk bool

{polymarket_apis-0.3.7.dist-info → polymarket_apis-0.3.8.dist-info}/RECORD

@@ -1,10 +1,10 @@
-polymarket_apis/__init__.py,sha256=OzhWc-PqnHoGyrcRwclQG2mLGSu0cz7QLuhx-jenzgk,1126
+polymarket_apis/__init__.py,sha256=6-aPCzc4EkyKJoDVu-LrkhOPUBHyog8_pKBYKbrdklI,1126
 polymarket_apis/clients/__init__.py,sha256=ruMvFEA4HNkbWEYqbnrCuYXR4PUwkV1XWG0w63we-LA,759
 polymarket_apis/clients/clob_client.py,sha256=Eo5zXYtI_Ct0EByzjJnH6h7FLHOqheXDujBA57CtINw,32485
 polymarket_apis/clients/data_client.py,sha256=0--2W6_DZtC7cRud8OYS7bH2heWzn2NwvcUVK3PyEwU,13242
 polymarket_apis/clients/gamma_client.py,sha256=iDfuaClhRK2Y5v8ZA03Qbne3CnIM4JJolHo-qUrQV78,27633
 polymarket_apis/clients/graphql_client.py,sha256=KgjxbXNWEXp82ZEz464in5mCn1PydnZqWq-g11xu9YU,1839
-polymarket_apis/clients/web3_client.py,sha256=Xsk1APsnMDRu9daLKZnf6LW41LdocuRV9rqjKnZjYmw,26400
+polymarket_apis/clients/web3_client.py,sha256=xyanN9Imfv-O_dPAirtkyKaMHll6HhWlEIzqE19kOzA,33930
 polymarket_apis/clients/websockets_client.py,sha256=gaGcsjqp1ZRyxrL6EWvZ9XaTv7koTPDzlcShj0u0B2A,7737
 polymarket_apis/types/__init__.py,sha256=cyrAPNX0ty0wkMwZqB0lNA7n3JoOJCSeTpclmamMh9k,3258
 polymarket_apis/types/clob_types.py,sha256=WZs370ni2B2UsLW-yIPGA2C-z8dfbywX26vADuu2YFc,11725
@@ -16,7 +16,7 @@ polymarket_apis/utilities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJW
 polymarket_apis/utilities/config.py,sha256=kQymQRy9fVg5jt8CcQJxsSgIZFbfjPx2q_gNnZI5b24,2449
 polymarket_apis/utilities/constants.py,sha256=TzFVtN8zNgvEa4yjLWjpvPYsAi1LLV5oPEnHlbwxSDQ,637
 polymarket_apis/utilities/endpoints.py,sha256=bxZyrJBPbVauWc-eR0RMh6KDqU-SmO_3LfQwVMNJ6vE,1235
-polymarket_apis/utilities/exceptions.py,sha256=nLVkwGNkX8mBhOi3L3lLEJ5UCPd5OBjl2f7kcct3K3A,368
+polymarket_apis/utilities/exceptions.py,sha256=lpZPF2-rw64qrnhCQWIspAv-rgm7aKvP8UUoVHcrPUA,495
 polymarket_apis/utilities/headers.py,sha256=Cc5WEnIBLYAgfwvmCXRBwA2zUYME8fDy4PbwlwlB6Oo,1510
 polymarket_apis/utilities/order_builder/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 polymarket_apis/utilities/order_builder/builder.py,sha256=dyxKhMeNjGyHXEIFBBZhWwI8TaQQcE_ErQ4sF6BcMX0,8476
@@ -27,7 +27,7 @@ polymarket_apis/utilities/signing/hmac.py,sha256=1VPfO2yT8nyStk6U4AQeyTzQTt5-69P
 polymarket_apis/utilities/signing/model.py,sha256=kVduuJGth7WSCUDCVVydCgPd4yEVI85gEmMxohXsvp0,191
 polymarket_apis/utilities/signing/signer.py,sha256=cxjcYRn1a0ApVcir1AvamsFcLZ0rYNlEEX4sPUz_Nrw,776
 polymarket_apis/utilities/web3/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-polymarket_apis/utilities/web3/helpers.py,sha256=qzQA-n9rHbuFk57olvBa8P_T6IzrUsaQ2Vv0887EX4o,4694
+polymarket_apis/utilities/web3/helpers.py,sha256=aczuvPXqnFGcKKfT5GhpnJL2U6UBEcpjbzhQUfw0MDk,6765
 polymarket_apis/utilities/web3/abis/CTFExchange.json,sha256=zt8fZnUaOrD8Vh5njM0EEUpeITWhuu0SZrIZigWxgV8,38499
 polymarket_apis/utilities/web3/abis/ConditionalTokens.json,sha256=3TUcX7He74VMkoL1kxbDbtULZ70VY_EBe01pfByprsk,12584
 polymarket_apis/utilities/web3/abis/NegRiskAdapter.json,sha256=HABIoRF1s1NgctpRTdaaNDqzODzgdZLE-s2E6ef4nAY,18867
@@ -38,6 +38,6 @@ polymarket_apis/utilities/web3/abis/SafeProxyFactory.json,sha256=bdr2WdYCRClXLTT
 polymarket_apis/utilities/web3/abis/UChildERC20Proxy.json,sha256=ZyQC38U0uxInlmnW2VXDVD3TJfTIRmSNMkTxQsaG7oA,27396
 polymarket_apis/utilities/web3/abis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 polymarket_apis/utilities/web3/abis/custom_contract_errors.py,sha256=GjCVn2b6iRheT7s-kc8Po9uwH9LfaHA1yRpJyjXRcxs,1172
-polymarket_apis-0.3.7.dist-info/METADATA,sha256=Z3jOxzSY7thon83qiZQbeZ_8sCebx2BKCVRKR-acFjA,12802
-polymarket_apis-0.3.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-polymarket_apis-0.3.7.dist-info/RECORD,,
+polymarket_apis-0.3.8.dist-info/METADATA,sha256=jgUzQQ3iAHns_9zGXKZ-Xt2Pe90v5rExs8qiInrEikg,12889
+polymarket_apis-0.3.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+polymarket_apis-0.3.8.dist-info/RECORD,,