poly-web3 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

examples/example_redeem.py

@@ -24,7 +24,7 @@ if __name__ == "__main__":
         host,
         key=os.getenv("POLY_API_KEY"),
         chain_id=chain_id,
-        signature_type=1,
+        signature_type=1,  # signature_type=2 for Safe
         funder=os.getenv("POLYMARKET_PROXY_ADDRESS"),
     )
     creds = client.create_or_derive_api_creds()
@@ -41,27 +41,27 @@ if __name__ == "__main__":
             )
         ),
     )
-    condition_id = "0x31fb435a9506d14f00b9de5e5e4491cf2223b6d40a2525d9afa8b620b61b50e2"
     service = PolyWeb3Service(
         clob_client=client,
         relayer_client=relayer_client,
         rpc_url="https://polygon-bor.publicnode.com",
     )
+
+    # Redeem all positions that are currently redeemable (returns list or None)
+    redeem_all = service.redeem_all(batch_size=10)
+    print(redeem_all)
+
     # Redeem in batch
     condition_ids = [
-        condition_id,
         "0x31fb435a9506d14f00b9de5e5e4491cf2223b6d40a2525d9afa8b620b61b50e2",
     ]
     redeem_batch = service.redeem(condition_ids, batch_size=10)
     print(redeem_batch)
 
-    # Redeem all positions that are currently redeemable (returns list or None)
-    redeem_all = service.redeem_all(batch_size=10)
-    print(redeem_all)
 
     # Optional - Query operations (可选操作，用于查询)
     # can_redeem = service.is_condition_resolved(condition_id)
     # redeem_balance = service.get_redeemable_index_and_balance(
-    #     condition_id, owner=client.builder.funder
+    #     condition_id
     # )
     # print(can_redeem, redeem_balance)

poly_web3/const.py

@@ -4,7 +4,7 @@
 # @Site:
 # @File: const.py
 # @Software: PyCharm
-from web3 import Web3
+from eth_utils import to_checksum_address
 
 GET_NONCE = "/nonce"
 GET_RELAY_PAYLOAD = "/relay-payload"
@@ -23,13 +23,13 @@ STATE_CONFIRMED = "STATE_CONFIRMED"
 STATE_FAILED = "STATE_FAILED"
 
 # address
-CTF_ADDRESS = Web3.to_checksum_address("0x4d97dcd97ec945f40cf65f87097ace5ea0476045")
-USDC_POLYGON = Web3.to_checksum_address("0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174")
-NEG_RISK_ADAPTER_ADDRESS = Web3.to_checksum_address(
+CTF_ADDRESS = to_checksum_address("0x4d97dcd97ec945f40cf65f87097ace5ea0476045")
+USDC_POLYGON = to_checksum_address("0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174")
+NEG_RISK_ADAPTER_ADDRESS = to_checksum_address(
     "0xd91E80cF2E7be2e162c6513ceD06f1dD0dA35296"
 )
 ZERO_BYTES32 = "0x" + "00" * 32
-proxy_factory_address = Web3.to_checksum_address(
+proxy_factory_address = to_checksum_address(
     "0xaB45c5A4B0c941a2F231C04C3f49182e1A254052"
 )
 SAFE_INIT_CODE_HASH = (

poly_web3/web3_service/base.py

@@ -8,6 +8,7 @@ from typing import Any
 
 from py_builder_relayer_client.client import RelayClient
 from py_clob_client.client import ClobClient
+from eth_utils import to_checksum_address
 from web3 import Web3
 import requests
 
@@ -132,7 +133,7 @@ class BaseWeb3Service:
         if not winners:
             return []
         ctf = self.w3.eth.contract(address=CTF_ADDRESS, abi=CTF_ABI_PAYOUT)
-        owner_checksum = Web3.to_checksum_address(owner)
+        owner_checksum = to_checksum_address(owner)
         redeemable: list[tuple] = []
         for index in winners:
             index_set = 1 << index
@@ -149,7 +150,6 @@ class BaseWeb3Service:
 
     def build_ctf_redeem_tx_data(self, condition_id: str) -> str:
         ctf = self.w3.eth.contract(address=CTF_ADDRESS, abi=CTF_ABI_REDEEM)
-        # 只需要 calldata：encodeABI 即可
         return ctf.functions.redeemPositions(
             USDC_POLYGON,
             ZERO_BYTES32,
@@ -264,7 +264,7 @@ class BaseWeb3Service:
                     )
             except Exception as e:
                 error_list.extend(batch)
-                logger.info(f"redeem batch error, {batch=}, error={e}")
+                logger.error(f"redeem batch error, {batch=}, error={e}")
         if error_list:
             logger.warning(f"error redeem condition list, {error_list}")
         return redeem_list

poly_web3/web3_service/proxy_service.py

@@ -6,8 +6,7 @@
 # @Software: PyCharm
 import requests
 
-from web3 import Web3
-from eth_utils import to_bytes
+from eth_utils import to_bytes, to_checksum_address
 
 from poly_web3.const import (
     proxy_wallet_factory_abi,
@@ -22,6 +21,8 @@ from poly_web3.web3_service.base import BaseWeb3Service
 from poly_web3.signature.build import derive_proxy_wallet, create_struct_hash
 from poly_web3.signature.hash_message import hash_message
 from poly_web3.signature import secp256k1
+
+
 class ProxyWeb3Service(BaseWeb3Service):
     def _build_redeem_tx(self, to: str, data: str) -> dict:
         return {
@@ -92,15 +93,13 @@ class ProxyWeb3Service(BaseWeb3Service):
         # Create the contract object
         contract = self.w3.eth.contract(abi=proxy_wallet_factory_abi)
 
-        # Encode function data
-        function_data = contract.encodeABI(fn_name="proxy", args=[calls_data])
-
-        return function_data
+        # Encode function data (compatible with web3 6/7)
+        return contract.functions.proxy(calls_data)._encode_transaction_data()
 
     def _submit_redeem(self, txs: list[dict]) -> dict:
         if self.clob_client is None:
             raise Exception("signer not found")
-        _from = Web3.to_checksum_address(self.clob_client.get_address())
+        _from = to_checksum_address(self.clob_client.get_address())
         rp = self._get_relay_payload(_from, self.wallet_type)
         args = {
             "from": _from,

{poly_web3-1.0.0.dist-info → poly_web3-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: poly-web3
-Version: 1.0.0
+Version: 1.0.1
 Summary: Polymarket Proxy wallet redeem SDK - Execute redeem operations on Polymarket using proxy wallets
 Home-page: https://github.com/tosmart01/poly-web3
 Author: PinBar
@@ -19,7 +19,7 @@ Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 Requires-Dist: py-clob-client>=0.25.0
 Requires-Dist: py-builder-relayer-client>=0.0.1
-Requires-Dist: web3==6.8
+Requires-Dist: web3<8,>=7.0.0
 Requires-Dist: eth-utils==5.3.1
 Requires-Dist: setuptools>=80.9.0
 Dynamic: home-page
@@ -27,13 +27,42 @@ Dynamic: requires-python
 
 # poly-web3
 
-Python SDK for Polymarket Proxy wallet redeem operations. Supports executing Conditional Token Fund (CTF) redeem operations on Polymarket through proxy wallets, Free gas.
+Python SDK for redeeming Polymarket positions via Proxy/Safe wallets (gas-free).
 
 [English](README.md) | [中文](README.zh.md)
 
+```bash
+pip install poly-web3
+```
+
+```python
+from poly_web3 import PolyWeb3Service
+
+service = PolyWeb3Service(
+    clob_client=client,
+    relayer_client=relayer_client,
+)
+
+# Redeem all redeemable positions for the current account.
+service.redeem_all(batch_size=20)
+```
+
+[See the full example](#quick-start)
+
+## Redeem Behavior Notes
+
+- Redeemable positions are fetched via the official Positions API, which typically has ~1 minute latency.
+- `redeem_all` returns an empty list if there are no redeemable positions. If the returned list contains `None`, the redeem failed and should be retried.
+
+## Troubleshooting
+
+1. **UI shows redeemable, but `redeem_all` returns `[]`**: The official Positions API can be delayed by 1–3 minutes. Wait a bit and retry.
+2. **RPC error during redeem**: Switch RPC endpoints by setting `rpc_url` when instantiating `PolyWeb3Service`.
+3. **Redeem stuck in `execute`**: The official relayer may be congested. Stop redeeming for 1 hour to avoid nonce looping from repeated submissions.
+
 ## About the Project
 
-This project is a Python rewrite of Polymarket's official TypeScript implementation of `builder-relayer-client`, designed to provide Python developers with a convenient tool for executing proxy wallet redeem operations on Polymarket.
+This project is a Python rewrite of Polymarket's official TypeScript implementation of `builder-relayer-client`, designed to provide Python developers with a convenient tool for executing Proxy and Safe wallet redeem operations on Polymarket.
 
 **Important Notes:**
 - This project **only implements the official redeem functionality**, focusing on Conditional Token Fund (CTF) redeem operations
@@ -46,18 +75,10 @@ Reference：
 
 **Current Status:**
 - ✅ **Proxy Wallet** - Fully supported for redeem functionality
-- 🚧 **Safe Wallet** - Under development
+- ✅ **Safe Wallet** - Fully supported for redeem functionality
 - 🚧 **EOA Wallet** - Under development
 
-We welcome community contributions! If you'd like to help implement Safe or EOA wallet redeem functionality, or have other improvement suggestions, please feel free to submit a Pull Request.
-
-## Features
-
-- ✅ Support for Polymarket Proxy wallet redeem operations (currently only Proxy wallet is supported)
-- ✅ Check if conditions are resolved
-- ✅ Get redeemable indexes and balances
-- ✅ Support for standard CTF redeem and negative risk (neg_risk) redeem
-- ✅ Automatic transaction execution through Relayer service
+We welcome community contributions! If you'd like to help implement EOA wallet redeem functionality, or have other improvement suggestions, please feel free to submit a Pull Request.
 
 ## Installation
 
@@ -79,7 +100,7 @@ uv add poly-web3
 
 - `py-clob-client >= 0.25.0` - Polymarket CLOB client
 - `py-builder-relayer-client >= 0.0.1` - Builder Relayer client
-- `web3 == 6.8` - Web3.py library
+- `web3 >= 7.0.0` - Web3.py library
 - `eth-utils == 5.3.1` - Ethereum utilities library
 
 ## Quick Start
@@ -104,7 +125,7 @@ client = ClobClient(
     host,
     key=os.getenv("POLY_API_KEY"),
     chain_id=chain_id,
-    signature_type=1,  # Proxy wallet type
+    signature_type=1,  # Proxy wallet type (signature_type=2 for Safe)
     funder=os.getenv("POLYMARKET_PROXY_ADDRESS"),
 )
 
@@ -143,33 +164,51 @@ print(f"Redeem batch result: {redeem_batch_result}")
 # Redeem all positions that are currently redeemable
 redeem_all_result = service.redeem_all(batch_size=20)
 print(f"Redeem all result: {redeem_all_result}")
+if redeem_all_result and any(item is None for item in redeem_all_result):
+    print("Redeem failed for some items; please retry.")
 ```
 
-### Optional - Query Operations
+## API Documentation
 
-Before executing redeem, you can optionally check the condition status and query redeemable balances:
+### PolyWeb3Service
 
-```python
-# Check if condition is resolved
-condition_id = "0xc3df016175463c44f9c9f98bddaa3bf3daaabb14b069fb7869621cffe73ddd1c"
-can_redeem = service.is_condition_resolved(condition_id)
+The main service class that automatically selects the appropriate service implementation based on wallet type.
 
-# Get redeemable indexes and balances
-redeem_balance = service.get_redeemable_index_and_balance(
-    condition_id, owner=client.builder.funder
-)
+#### Methods
 
-print(f"Can redeem: {can_redeem}")
-print(f"Redeemable balance: {redeem_balance}")
+##### `redeem(condition_ids: list[str], batch_size: int = 20)`
+
+Execute redeem operation.
+
+**Parameters:**
+- `condition_ids` (list[str]): List of condition IDs
+- `batch_size` (int): Batch size for redeem requests
+
+**Returns:**
+- `dict | list[dict]`: Transaction result(s) containing transaction status and related information
+
+**Examples:**
+
+```python
+# Batch redeem
+result = service.redeem(["0x...", "0x..."], batch_size=20)
 ```
 
-## API Documentation
+##### `redeem_all(batch_size: int = 20) -> list[dict]`
 
-### PolyWeb3Service
+Redeem all positions that are currently redeemable for the authenticated account.
 
-The main service class that automatically selects the appropriate service implementation based on wallet type.
+**Returns:**
+- `list[dict]`: List of redeem results; empty list if no redeemable positions. If the list contains `None`, the redeem failed and should be retried.
 
-#### Methods
+**Examples:**
+
+```python
+# Redeem all positions that can be redeemed
+service.redeem_all(batch_size=20)
+```
+
+#### Optional APIs
 
 ##### `is_condition_resolved(condition_id: str) -> bool`
 
@@ -202,36 +241,22 @@ Get redeemable indexes and balances for the specified address.
 **Returns:**
 - `list[tuple]`: List of tuples containing (index, balance), balance is in USDC units
 
-##### `redeem(condition_ids: list[str], batch_size: int = 20)`
-
-Execute redeem operation.
-
-**Parameters:**
-- `condition_ids` (list[str]): List of condition IDs
-- `batch_size` (int): Batch size for redeem requests
+## Optional: Query Operations
 
-**Returns:**
-- `dict | list[dict]`: Transaction result(s) containing transaction status and related information
-
-**Examples:**
+Before executing redeem, you can optionally check the condition status and query redeemable balances:
 
 ```python
-# Batch redeem
-result = service.redeem(["0x...", "0x..."], batch_size=20)
-```
-
-##### `redeem_all(batch_size: int = 20) -> list[dict] | None`
-
-Redeem all positions that are currently redeemable for the authenticated account.
-
-**Returns:**
-- `list[dict] | None`: List of redeem results, or `None` if no redeemable positions
+# Check if condition is resolved
+condition_id = "0xc3df016175463c44f9c9f98bddaa3bf3daaabb14b069fb7869621cffe73ddd1c"
+can_redeem = service.is_condition_resolved(condition_id)
 
-**Examples:**
+# Get redeemable indexes and balances
+redeem_balance = service.get_redeemable_index_and_balance(
+    condition_id, owner=client.builder.funder
+)
 
-```python
-# Redeem all positions that can be redeemed
-service.redeem_all(batch_size=20)
+print(f"Can redeem: {can_redeem}")
+print(f"Redeemable balance: {redeem_balance}")
 ```
 
 ## Project Structure
@@ -249,14 +274,14 @@ poly_web3/
     ├── base.py             # Base service class
     ├── proxy_service.py    # Proxy wallet service (✅ Implemented)
     ├── eoa_service.py      # EOA wallet service (🚧 Under development)
-    └── safe_service.py     # Safe wallet service (🚧 Under development)
+    └── safe_service.py     # Safe wallet service (✅ Implemented)
 ```
 
 ## Notes
 
 1. **Environment Variable Security**: Make sure `.env` file is added to `.gitignore`, do not commit sensitive information to the code repository
 2. **Network Support**: Currently mainly supports Polygon mainnet (chain_id: 137), Amoy testnet may have limited functionality
-3. **Wallet Type**: **Currently only Proxy wallet is supported** (signature_type: 1), Safe and EOA wallet redeem functionality is under development
+3. **Wallet Type**: Proxy (signature_type: 1) and Safe (signature_type: 2) are supported; EOA wallet redeem functionality is under development
 4. **Gas Fees**: Transactions are executed through Relayer, gas fees are handled by the Relayer
 
 ## Development
@@ -277,7 +302,7 @@ python examples/example_redeem.py
 
 We welcome all forms of contributions! If you'd like to:
 
-- Implement Safe or EOA wallet support
+- Implement EOA wallet support
 - Fix bugs or improve existing functionality
 - Add new features or improve documentation
 - Make suggestions or report issues

{poly_web3-1.0.0.dist-info → poly_web3-1.0.1.dist-info}/RECORD

@@ -1,6 +1,6 @@
-examples/example_redeem.py,sha256=grSaAsmjgQDKd1zpd17-cYkAv7fkqFUqDEvCr3gXJtA,2149
+examples/example_redeem.py,sha256=r4tNcrhOIMBebZ1eVudswQKoMjhNZ-BkujNqx0w0sAI,2041
 poly_web3/__init__.py,sha256=O4xBBGCQoO453RdGZ9eWpjpOEOz_kFoU_TTnigbBaPs,1078
-poly_web3/const.py,sha256=UYBs1b9P2YJw1isbUzlGOxMWIqWyRiyGt9D2WmZCYfU,4959
+poly_web3/const.py,sha256=2np6u918fInlwigQHb4VryxUkKQgHebAIh2rhQHgN88,4959
 poly_web3/log.py,sha256=NPY6X7Ysw-5ds3JkA26vhfge2Dc39ptezmCWYbwT-FM,986
 poly_web3/schema.py,sha256=GTzpEy8-mqw2fCqoQKQFn6ieyhXdSnW6I9YQMKGnnhM,435
 poly_web3/signature/__init__.py,sha256=p4EwohjUtwEsFqrc7eeqY5sQa14GWc8BdR6km8c7SH8,123
@@ -8,11 +8,11 @@ poly_web3/signature/build.py,sha256=PEyMFbE2PM2Xvz3wvmA6T6FVnU3mB7uanoEutbneFQ8,
 poly_web3/signature/hash_message.py,sha256=hREtjuOdLcm_IlBz1YuzyrObVdxs7Yn-ULfh09PeNmk,1319
 poly_web3/signature/secp256k1.py,sha256=IBgp0vNJyskU7ZUcWCdDttrzmJgEWH6lakB74whur_w,1500
 poly_web3/web3_service/__init__.py,sha256=HNRh06yZNYXDmGS69ISXG7_PPG9foGXLyHOdnbgYXk0,315
-poly_web3/web3_service/base.py,sha256=SwiJ3nTPHUTYH5gDwjDPRoxjZNICfYKsy6w4pWiG73U,12195
+poly_web3/web3_service/base.py,sha256=xEGPKr8s_oMQQmsHj36MTGXu57cAKPhHRwYfboIZs-Y,12185
 poly_web3/web3_service/eoa_service.py,sha256=mTJ0OHJvpzkrYvom1wDlA7EyV_tJFwxekpgPSXMXz0Y,515
-poly_web3/web3_service/proxy_service.py,sha256=-Odgpq24dKnBmtuwQ3RRINS88zzTFEQCbtaTZ4WNLs8,4181
+poly_web3/web3_service/proxy_service.py,sha256=ZOP1g4w1-LvN4tcaTSNx56IFNNvtzh49Z_9Kf3MMY2Q,4174
 poly_web3/web3_service/safe_service.py,sha256=D9rHcxbU9rjvDd5k__qu8MCZ8srdQITS8g4JNkoE7Uo,776
-poly_web3-1.0.0.dist-info/METADATA,sha256=7r6FXHqXFPdPz8IpQHSEoI-Qm0-ZdrgVL1k_UiZf0fc,9765
-poly_web3-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-poly_web3-1.0.0.dist-info/top_level.txt,sha256=wW40wsocHfhFgqSWWvYWrhwKGQU5IWkhyaz5J90vmHo,19
-poly_web3-1.0.0.dist-info/RECORD,,
+poly_web3-1.0.1.dist-info/METADATA,sha256=hsc6uPXf6AHW5XojikhM9EqpWugIPUfh3LaLjA_qHhc,10605
+poly_web3-1.0.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+poly_web3-1.0.1.dist-info/top_level.txt,sha256=wW40wsocHfhFgqSWWvYWrhwKGQU5IWkhyaz5J90vmHo,19
+poly_web3-1.0.1.dist-info/RECORD,,

{poly_web3-1.0.0.dist-info → poly_web3-1.0.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any