pmwallets 0.3.0__tar.gz → 0.5.0__tar.gz

{pmwallets-0.3.0 → pmwallets-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pmwallets
-Version: 0.3.0
+Version: 0.5.0
 Summary: Official PMWallets SDK: Polymarket smart-money leaderboard, real-time wallet fills over WebSocket with gap replay, webhooks and exports.
 Project-URL: Homepage, https://pmwallets.com/docs
 Project-URL: Repository, https://github.com/polymarketwallets/pmwallets-python
@@ -65,7 +65,7 @@ asyncio.run(main())
 
 | | |
 |---|---|
-| `Client` / `AsyncClient` | leaderboard, entities, address unlocks, subscriptions, fills replay (`fills`, `fills_since`), trade-history exports |
+| `Client` / `AsyncClient` | leaderboard, entities, address unlocks (balance or plan), your unlocked addresses (`my_addresses`), plan and balance, subscriptions, webhook status and deliveries, fills replay (`fills`, `fills_since`), trade-history exports |
 | `FillStream` | asyncio WebSocket with reconnect and keep-alive; detects missed frames by `session`/`seq` and replays them from the last fill delivered; de-duplicates by `eventId`; anchors behind the chain head on first start; persisted cursor |
 | `verify_webhook(raw_body, signature, secret)` | checks `x-pmw-signature` (HMAC-SHA256 of the raw body) |
 

{pmwallets-0.3.0 → pmwallets-0.5.0}/README.md

@@ -47,7 +47,7 @@ asyncio.run(main())
 
 | | |
 |---|---|
-| `Client` / `AsyncClient` | leaderboard, entities, address unlocks, subscriptions, fills replay (`fills`, `fills_since`), trade-history exports |
+| `Client` / `AsyncClient` | leaderboard, entities, address unlocks (balance or plan), your unlocked addresses (`my_addresses`), plan and balance, subscriptions, webhook status and deliveries, fills replay (`fills`, `fills_since`), trade-history exports |
 | `FillStream` | asyncio WebSocket with reconnect and keep-alive; detects missed frames by `session`/`seq` and replays them from the last fill delivered; de-duplicates by `eventId`; anchors behind the chain head on first start; persisted cursor |
 | `verify_webhook(raw_body, signature, secret)` | checks `x-pmw-signature` (HMAC-SHA256 of the raw body) |
 

{pmwallets-0.3.0 → pmwallets-0.5.0}/README.zh.md

@@ -20,7 +20,7 @@ pip install pmwallets     # Python ≥ 3.10
 
 | | |
 |---|---|
-| `Client` / `AsyncClient` | 排行榜、实体、地址解锁、订阅、成交补发（`fills`、`fills_since`）、交易历史导出 |
+| `Client` / `AsyncClient` | 排行榜、实体、地址解锁(余额或套餐额度)、我的地址(`my_addresses`)、套餐与余额、订阅、webhook 状态与投递记录、成交补发（`fills`、`fills_since`）、交易历史导出 |
 | `FillStream` | asyncio WebSocket，自动重连与保活；按 `session`/`seq` 发现漏帧并从最后送达的成交补发；按 `eventId` 去重；首次启动锚定在链头之后；游标持久化 |
 | `verify_webhook(raw_body, signature, secret)` | 校验 `x-pmw-signature`（原始 body 的 HMAC-SHA256） |
 

{pmwallets-0.3.0 → pmwallets-0.5.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pmwallets"
-version = "0.3.0"
+version = "0.5.0"
 description = "Official PMWallets SDK: Polymarket smart-money leaderboard, real-time wallet fills over WebSocket with gap replay, webhooks and exports."
 readme = "README.md"
 requires-python = ">=3.10"

{pmwallets-0.3.0 → pmwallets-0.5.0}/src/pmwallets/client.py

@@ -102,6 +102,13 @@ class Client(_Base):
     def leaderboard(self, **query: Any) -> Leaderboard:
         return self.request("GET", "/v1/leaderboard", query)
 
+    def my_addresses(self, **query: Any) -> Leaderboard:
+        """Every address you have unlocked (bought, free, or with your plan) as board rows. Each row has
+        `unlockedBy` ('paid' / 'free' / 'plan', or None when a free or plan unlock lapsed and is masked again)
+        and `pausedReason` when your push subscription to it is paused; `outside` (first page only) lists
+        unlocked addresses with no fill in the window. Spends no board rows."""
+        return self.request("GET", "/v1/leaderboard", {**query, "mine": 1})
+
     def entity(self, entity_id: str, period: Optional[str] = None) -> dict[str, Any]:
         """One entity by handle or address. The full address comes back only for entities you own."""
         return self.request("GET", f"/v1/entities/{_q(entity_id)}", {"period": period})
@@ -109,11 +116,53 @@ class Client(_Base):
     def latency(self) -> dict[str, Any]:
         return self.request("GET", "/v1/latency")
 
+    def periods(self) -> list[dict[str, Any]]:
+        """The published statistics windows (e.g. 30d, 7d) and when each was computed."""
+        return self.request("GET", "/v1/periods")
+
+    # ── account
+    def plan(self) -> dict[str, Any]:
+        """Your monthly plan (Base / Pro / Max), its period dates and what is used of its allowances."""
+        return self.request("GET", "/v1/account/plan")
+
+    def plans(self) -> dict[str, Any]:
+        """The plans on sale: price and allowances of Base / Pro / Max."""
+        return self.request("GET", "/v1/plans")
+
+    def billing(self) -> dict[str, Any]:
+        """Balance and top-up options."""
+        return self.request("GET", "/v1/account/billing")
+
+    def ledger(self, limit: Optional[int] = None, cursor: Optional[str] = None) -> dict[str, Any]:
+        """One page of the balance statement, newest first; pass the previous page's `next` as `cursor`."""
+        return self.request("GET", "/v1/account/ledger", {"limit": limit, "cursor": cursor})
+
+    # ── webhooks
+    def webhooks(self) -> list[dict[str, Any]]:
+        """Your webhook endpoint. With an API key the URL comes back as its origin only; adding or removing one needs the website."""
+        return self.request("GET", "/v1/account/webhooks")
+
+    def reactivate_webhook(self, webhook_id: str) -> dict[str, Any]:
+        """Re-enable an endpoint that was disabled after a day of failures, and resume the subscriptions it paused."""
+        return self.request("POST", f"/v1/account/webhooks/{_q(webhook_id)}/reactivate")
+
+    def deliveries(self, limit: Optional[int] = None, cursor: Optional[str] = None) -> dict[str, Any]:
+        """One page of delivery attempts (webhook and WebSocket), newest first."""
+        return self.request("GET", "/v1/account/deliveries", {"limit": limit, "cursor": cursor})
+
+    def delivery_stats(self, hours: Optional[int] = None) -> dict[str, Any]:
+        """Delivery success and latency over the last `hours`."""
+        return self.request("GET", "/v1/account/delivery-stats", {"hours": hours})
+
     # ── addresses
     def buy_reveal(self, entity_id: str, max_price_cents: int) -> dict[str, Any]:
         """Buy the address behind a handle. `max_price_cents` is a ceiling: the charge never exceeds it."""
         return self.request("POST", "/v1/account/reveals", body={"entityId": entity_id, "maxPriceCents": max_price_cents})
 
+    def unlock_with_plan(self, entity_id: str) -> dict[str, Any]:
+        """Unlock with your plan's allowance instead of the balance: never charges (409 when the allowance is used up)."""
+        return self.request("POST", "/v1/account/reveals", body={"entityId": entity_id, "maxPriceCents": 0, "viaPlan": True})
+
     def reveals(self) -> list[dict[str, Any]]:
         return self.request("GET", "/v1/account/reveals")
 
@@ -157,6 +206,18 @@ class Client(_Base):
         """Charges the balance; the price is recomputed server-side."""
         return self.request("POST", "/v1/account/exports", body={"entityIds": entity_ids, "from": from_, "to": to})
 
+    def create_plan_export(self, entity_ids: list[str]) -> dict[str, Any]:
+        """From a Max plan's monthly allowance: the whole sellable window, nothing charged."""
+        return self.request("POST", "/v1/account/exports", body={"entityIds": entity_ids, "viaPlan": True})
+
+    def export_window(self) -> dict[str, Any]:
+        """The days that can be bought right now (a contiguous range ending at the latest published day)."""
+        return self.request("GET", "/v1/account/exports/window")
+
+    def export_rate_card(self) -> dict[str, Any]:
+        """The per-day prices exports are charged at."""
+        return self.request("GET", "/v1/exports/rate-card")
+
     def exports(self) -> list[dict[str, Any]]:
         return self.request("GET", "/v1/account/exports")
 
@@ -205,15 +266,61 @@ class AsyncClient(_Base):
     async def leaderboard(self, **query: Any) -> Leaderboard:
         return await self.request("GET", "/v1/leaderboard", query)
 
+    async def my_addresses(self, **query: Any) -> Leaderboard:
+        """See Client.my_addresses."""
+        return await self.request("GET", "/v1/leaderboard", {**query, "mine": 1})
+
     async def entity(self, entity_id: str, period: Optional[str] = None) -> dict[str, Any]:
         return await self.request("GET", f"/v1/entities/{_q(entity_id)}", {"period": period})
 
     async def latency(self) -> dict[str, Any]:
         return await self.request("GET", "/v1/latency")
 
+    async def periods(self) -> list[dict[str, Any]]:
+        """The published statistics windows (e.g. 30d, 7d) and when each was computed."""
+        return await self.request("GET", "/v1/periods")
+
+    # ── account
+    async def plan(self) -> dict[str, Any]:
+        """Your monthly plan (Base / Pro / Max), its period dates and what is used of its allowances."""
+        return await self.request("GET", "/v1/account/plan")
+
+    async def plans(self) -> dict[str, Any]:
+        """The plans on sale: price and allowances of Base / Pro / Max."""
+        return await self.request("GET", "/v1/plans")
+
+    async def billing(self) -> dict[str, Any]:
+        """Balance and top-up options."""
+        return await self.request("GET", "/v1/account/billing")
+
+    async def ledger(self, limit: Optional[int] = None, cursor: Optional[str] = None) -> dict[str, Any]:
+        """One page of the balance statement, newest first; pass the previous page's `next` as `cursor`."""
+        return await self.request("GET", "/v1/account/ledger", {"limit": limit, "cursor": cursor})
+
+    # ── webhooks
+    async def webhooks(self) -> list[dict[str, Any]]:
+        """Your webhook endpoint. With an API key the URL comes back as its origin only; adding or removing one needs the website."""
+        return await self.request("GET", "/v1/account/webhooks")
+
+    async def reactivate_webhook(self, webhook_id: str) -> dict[str, Any]:
+        """Re-enable an endpoint that was disabled after a day of failures, and resume the subscriptions it paused."""
+        return await self.request("POST", f"/v1/account/webhooks/{_q(webhook_id)}/reactivate")
+
+    async def deliveries(self, limit: Optional[int] = None, cursor: Optional[str] = None) -> dict[str, Any]:
+        """One page of delivery attempts (webhook and WebSocket), newest first."""
+        return await self.request("GET", "/v1/account/deliveries", {"limit": limit, "cursor": cursor})
+
+    async def delivery_stats(self, hours: Optional[int] = None) -> dict[str, Any]:
+        """Delivery success and latency over the last `hours`."""
+        return await self.request("GET", "/v1/account/delivery-stats", {"hours": hours})
+
     async def buy_reveal(self, entity_id: str, max_price_cents: int) -> dict[str, Any]:
         return await self.request("POST", "/v1/account/reveals", body={"entityId": entity_id, "maxPriceCents": max_price_cents})
 
+    async def unlock_with_plan(self, entity_id: str) -> dict[str, Any]:
+        """Unlock with your plan's allowance instead of the balance: never charges (409 when the allowance is used up)."""
+        return await self.request("POST", "/v1/account/reveals", body={"entityId": entity_id, "maxPriceCents": 0, "viaPlan": True})
+
     async def reveals(self) -> list[dict[str, Any]]:
         return await self.request("GET", "/v1/account/reveals")
 
@@ -249,6 +356,18 @@ class AsyncClient(_Base):
     async def create_export(self, entity_ids: list[str], from_: str, to: str) -> dict[str, Any]:
         return await self.request("POST", "/v1/account/exports", body={"entityIds": entity_ids, "from": from_, "to": to})
 
+    async def create_plan_export(self, entity_ids: list[str]) -> dict[str, Any]:
+        """From a Max plan's monthly allowance: the whole sellable window, nothing charged."""
+        return await self.request("POST", "/v1/account/exports", body={"entityIds": entity_ids, "viaPlan": True})
+
+    async def export_window(self) -> dict[str, Any]:
+        """The days that can be bought right now (a contiguous range ending at the latest published day)."""
+        return await self.request("GET", "/v1/account/exports/window")
+
+    async def export_rate_card(self) -> dict[str, Any]:
+        """The per-day prices exports are charged at."""
+        return await self.request("GET", "/v1/exports/rate-card")
+
     async def exports(self) -> list[dict[str, Any]]:
         return await self.request("GET", "/v1/account/exports")
 

{pmwallets-0.3.0 → pmwallets-0.5.0}/tests/test_client.py

@@ -38,6 +38,53 @@ async def test_walks_every_page():
     assert "sinceBlock=2&sinceLogIndex=0&limit=2" in str(calls[1].url)
 
 
+def test_my_addresses_asks_the_board_for_mine():
+    calls = []
+    c = Client("k", "https://api.example.com", http=httpx.Client(transport=transport([{"periodId": "30d", "tracked": 2, "rows": []}], calls=calls)))
+    assert c.my_addresses(sort="realizedPnl", offset=15)["tracked"] == 2
+    assert str(calls[0].url) == "https://api.example.com/v1/leaderboard?sort=realizedPnl&offset=15&mine=1"
+
+
+async def test_async_my_addresses():
+    calls = []
+    c = AsyncClient("k", "https://api.example.com", http=httpx.AsyncClient(transport=transport([{"tracked": 0, "rows": []}], calls=calls)))
+    await c.my_addresses()
+    assert str(calls[0].url) == "https://api.example.com/v1/leaderboard?mine=1"
+
+
+CASES = [
+    (lambda c: c.periods(), "GET", "/v1/periods", None),
+    (lambda c: c.plan(), "GET", "/v1/account/plan", None),
+    (lambda c: c.plans(), "GET", "/v1/plans", None),
+    (lambda c: c.billing(), "GET", "/v1/account/billing", None),
+    (lambda c: c.ledger(limit=10, cursor="x|1"), "GET", "/v1/account/ledger?limit=10&cursor=x%7C1", None),
+    (lambda c: c.unlock_with_plan("H1"), "POST", "/v1/account/reveals", {"entityId": "H1", "maxPriceCents": 0, "viaPlan": True}),
+    (lambda c: c.create_plan_export(["H1"]), "POST", "/v1/account/exports", {"entityIds": ["H1"], "viaPlan": True}),
+    (lambda c: c.export_window(), "GET", "/v1/account/exports/window", None),
+    (lambda c: c.export_rate_card(), "GET", "/v1/exports/rate-card", None),
+    (lambda c: c.webhooks(), "GET", "/v1/account/webhooks", None),
+    (lambda c: c.reactivate_webhook("w 1"), "POST", "/v1/account/webhooks/w%201/reactivate", None),
+    (lambda c: c.deliveries(limit=5), "GET", "/v1/account/deliveries?limit=5", None),
+    (lambda c: c.delivery_stats(hours=24), "GET", "/v1/account/delivery-stats?hours=24", None),
+]
+
+
+@pytest.mark.parametrize("call,method,path,body", CASES)
+def test_account_calls_map_to_endpoints(call, method, path, body):
+    calls = []
+    call(Client("k", "https://api.example.com", http=httpx.Client(transport=transport([{}], calls=calls))))
+    assert f"{calls[0].method} {calls[0].url}" == f"{method} https://api.example.com{path}"
+    if body is not None:
+        assert json.loads(calls[0].content) == body
+
+
+@pytest.mark.parametrize("call,method,path,body", CASES)
+async def test_async_account_calls_map_to_endpoints(call, method, path, body):
+    calls = []
+    await call(AsyncClient("k", "https://api.example.com", http=httpx.AsyncClient(transport=transport([{}], calls=calls))))
+    assert f"{calls[0].method} {calls[0].url}" == f"{method} https://api.example.com{path}"
+
+
 def test_non_2xx_is_pmw_error():
     calls = []
     c = Client("k", http=httpx.Client(transport=transport([{"statusCode": 402, "message": "insufficient balance"}], 402, calls)))

{pmwallets-0.3.0 → pmwallets-0.5.0}/uv.lock

@@ -134,7 +134,7 @@ wheels = [
 
 [[package]]
 name = "pmwallets"
-version = "0.2.0"
+version = "0.5.0"
 source = { editable = "." }
 dependencies = [
     { name = "httpx" },