Skip to content

core/docs/SETUP_POLYMARKET.md has no TypeScript initialization sample, unlike SETUP_KALSHI.md and SETUP_LIMITLESS.md #2198

Description

@realfishsam

Gap

core/docs/SETUP_POLYMARKET.md documents credential setup and constructor usage for the Polymarket venue but only ever shows a Python initialization sample. Its sibling venue setup guides in the same directory are bilingual (Python + TypeScript). This leaves Polymarket — the flagship/most-documented venue elsewhere in the docs tree — as the one core setup guide without a TypeScript quickstart snippet.

Core

core/docs/SETUP_POLYMARKET.md — the doc's only initialization section is:

## 4. Initialization (Python)

```python
import os
import pmxt

exchange = pmxt.Polymarket(
    private_key=os.getenv('POLYMARKET_PRIVATE_KEY'),
    proxy_address=os.getenv('POLYMARKET_PROXY_ADDRESS'),
    signature_type='deposit_wallet'
)
There is no `## 5. Initialization (TypeScript)` section (or equivalent) anywhere in the file — confirmed by grepping the file for `typescript`/`Initialization`, which returns exactly one match (the Python heading) and one ` ```python ` fence, with nothing else.

## TypeScript SDK
N/A — this is a documentation gap, not a missing SDK method. The TypeScript SDK's `Polymarket` class (`sdks/typescript/pmxt/client.ts`) fully supports the same `privateKey`/`proxyAddress`/`signatureType` constructor options shown in the Python sample, so the doc gap is purely an omission, not a capability limitation.

## Python SDK
N/A — Python is the language that *is* documented here; no gap on the Python side.

## Evidence
Contrast with the other two files in the same directory:
- `core/docs/SETUP_KALSHI.md` — has `## 4. Initialization (Python)` (line 52, ` ```python ` at line 54) **and** `## 5. Initialization (TypeScript)` (line 91, ` ```typescript ` at line 93).
- `core/docs/SETUP_LIMITLESS.md` — has `## 3. Initialization (Python)` (line 30, ` ```python ` at line 32) **and** `## 4. Initialization (TypeScript)` (line 55, ` ```typescript ` at line 57).
- `core/docs/SETUP_POLYMARKET.md` — has only `## 4. Initialization (Python)` (line 52, ` ```python ` at line 54). No TypeScript section exists in the file at all.

This mirrors an already-established gap pattern in this repo (e.g. #1920, which flags Python-only code samples in `docs/guides/self-hosted.mdx`), but is a distinct file/finding not covered by any currently open `core-sdk-gap` issue — verified via issue search for `SETUP_KALSHI SETUP_LIMITLESS SETUP_POLYMARKET core/docs venue setup guide bilingual` (0 results) and for `SETUP_POLYMARKET.md missing TypeScript sample Python only setup guide` (no matching issue).

## Impact
A TypeScript developer following `core/docs/SETUP_POLYMARKET.md` — the canonical self-hosted credential setup guide for the most prominent venue — has no in-doc example of how to construct `new pmxt.Polymarket({...})` with the `privateKey`/`proxyAddress`/`signatureType` options this same file just told them to put in their `.env`. They must reverse-engineer the constructor shape from the Kalshi/Limitless guides or from `docs/api-reference/configuration.mdx`, creating unnecessary friction for what should be the most well-documented onboarding path in the project.

---
*Found by automated Core-to-SDK surface coverage audit*

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions