@varla/polymarket 1.1.3 → 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,127 @@
+# @varla/polymarket
+
+## 2.0.0
+
+### Major Changes
+
+- abd5339: Updated closed positions API types and endpoint handling while adding new PnL helper utilities.
+
+  - Updated `DataClosedPosition` to match the live `/closed-positions` response with new fields and numeric types.,- Changed `getClosedPositions` to use the `/closed-positions` endpoint and added filtering/sorting options for positions queries.,- Added PnL helper functions (`computeClosedPnl`, `computeOpenPnl`, `computePnlSummary`) and exported them from the package.
+
+- 16ccb4b: Data API parsing now uses updated field names and numeric values across position responses.
+
+  - Updated position parsing to return numbers and new property names such as cashPnl, totalBought, and eventSlug
+  - Closed positions parsing now exposes avgPrice, curPrice, timestamp, and outcomeIndex fields
+  - Adjusted data API requests to use the market query parameter and /closed-positions endpoint
+
+### Patch Changes
+
+- 2a59485: No functional changes were made to the polymarket package.
+
+  - Reformat the package files list without altering published contents
+
+- a17d263: Adjusted concurrency limiter error message and made live trading tests skip when no private key is set.
+
+  - Simplified the ConcurrencyLimiter invalid maxInFlight error message.
+  - Live CLOB trading tests now skip unless both live tests are enabled and a private key is provided.
+
+## 1.1.7
+
+### Patch Changes
+
+- 587916d: Adjust package.json formatting without functional changes.
+
+  - Reformat the published files list in package metadata
+
+## 1.1.6
+
+### Patch Changes
+
+- Reformatted the package manifest file list with no functional changes.
+
+  - No functional changes; package.json formatting updated.
+
+## 1.1.5
+
+### Patch Changes
+
+- 5efcc9d: Update package metadata formatting without functional changes.
+
+  - Format the files list in package.json with a single-line array
+
+## 1.1.4
+
+### Patch Changes
+
+- cea1cf2: Added TypeScript declaration output and exports metadata for the Polymarket package.
+
+  - Publish generated type declarations and include them in the package exports
+  - Include CHANGELOG in published files and build types during prepack
+
+## 1.1.3
+
+### Patch Changes
+
+- 883517a: This release updates package metadata formatting with no functional changes.
+
+  - Reformatted the package.json files list without changing shipped contents.
+
+## 1.1.2
+
+### Patch Changes
+
+- 9bb27c7: No functional changes; updated package metadata formatting.
+
+  - Adjusted package.json files field formatting without affecting build output.
+
+## 1.1.1
+
+### Patch Changes
+
+- 5fdc094: Updated README to correct ClobWsClient feature description wording.
+
+  - Adjusted documentation to list "Auto-connect" for the ClobWsClient diagram.
+
+- 0d59e12: Updated package metadata formatting without functional changes.
+
+  - No functional changes; package file list formatting was adjusted.
+
+## 1.1.0
+
+### Minor Changes
+
+- 04689a5: Added new SDK types and expanded EIP-712 signer compatibility while tightening internal checks.
+
+  - Introduced OrderMarketCancelParams in SDK types for market cancel requests
+  - Expanded ClobEip712Signer to accept raw address strings for EIP-712 signing
+  - Improved internal cursor comparisons and builder auth checks
+
+### Patch Changes
+
+- 1cedbad: Align Polymarket API types with live responses and expand validation coverage while fixing a fetch usage bug.
+
+  - Updated DataApiClient to use the injected fetch function for book summaries.,- Expanded Gamma, CLOB, and Data API TypeScript types with additional optional fields and wider value shapes.,- Added comprehensive fixtures and schema-based tests to validate parsing against realistic and live API payloads.
+
+## 1.0.4
+
+### Patch Changes
+
+- 6857157: Package metadata formatting was updated with no functional changes.
+
+  - Reformatted the files list in package.json
+
+## 1.0.3
+
+### Patch Changes
+
+- 036a615: Release metadata updated with a new changelog and version bump.
+
+  - Added a changelog entry and bumped the package version to 1.0.2.
+
+## 1.0.2
+
+### Patch Changes
+
+- 803b77f: Updated README performance claims to a rounded value.
+
+  - Adjusted documented speed comparison from 139% to ~140% faster.

package/README.md

@@ -7,39 +7,6 @@
 
 A modern, lightweight TypeScript client for Polymarket's CLOB and Gamma APIs with full trading support.
 
-## Why @varla/polymarket?
-
-| Metric | @varla/polymarket | @polymarket/clob-client |
-|--------|-------------------|-------------------------|
-| **Average Speed** | **~140% faster** | baseline |
-| **Bundle Size** | ~50KB | ~500KB (ethers.js) |
-| **Runtime** | Bun/Node/Edge | Node.js only |
-| **Signing** | viem (native) | ethers.js |
-| **HTTP** | fetch | axios |
-
-### Benchmark Highlights
-
-| Function | Speedup |
-|----------|---------|
-| `getLastTradePrice` | 261% faster |
-| `getMidpoints` | 176% faster |
-| `deleteApiKey` | 144% faster |
-| `cancelOrder` | 73% faster |
-| `getOpenOrders` | 56% faster |
-
-<details>
-<summary>Full benchmark results (88 functions)</summary>
-
-- **81 functions faster** (92%)
-- **7 functions slower** (8%)
-- Best case: 1233% faster (RFQ operations)
-
-Run benchmarks yourself:
-```bash
-POLYMARKET_BENCH=true bun test packages/polymarket/test/sdk
-```
-</details>
-
 ## Installation
 
 ```bash
@@ -50,7 +17,7 @@ npm install @varla/polymarket
 pnpm add @varla/polymarket
 ```
 
-**Peer dependencies:**
+### Peer dependencies:
 - `viem` ^2.0.0
 
 ## Quick Start

package/dist/abi/ctf-exchange.d.ts

@@ -0,0 +1,329 @@
+/**
+ * CTF Exchange ABI for Polymarket.
+ *
+ * This is the Conditional Token Framework Exchange contract ABI,
+ * used for order matching and settlement.
+ *
+ * Only includes functions needed for trading operations.
+ * Full ABI available in the official SDK examples.
+ *
+ * @see https://github.com/Polymarket/clob-client/blob/main/examples/abi/ctfAbi.ts
+ */
+export declare const ctfExchangeAbi: readonly [{
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "id";
+        readonly type: "uint256";
+    }];
+    readonly name: "balanceOf";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "owners";
+        readonly type: "address[]";
+    }, {
+        readonly name: "ids";
+        readonly type: "uint256[]";
+    }];
+    readonly name: "balanceOfBatch";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256[]";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "operator";
+        readonly type: "address";
+    }];
+    readonly name: "isApprovedForAll";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "operator";
+        readonly type: "address";
+    }, {
+        readonly name: "approved";
+        readonly type: "bool";
+    }];
+    readonly name: "setApprovalForAll";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "from";
+        readonly type: "address";
+    }, {
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "id";
+        readonly type: "uint256";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+    }, {
+        readonly name: "data";
+        readonly type: "bytes";
+    }];
+    readonly name: "safeTransferFrom";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "from";
+        readonly type: "address";
+    }, {
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "ids";
+        readonly type: "uint256[]";
+    }, {
+        readonly name: "values";
+        readonly type: "uint256[]";
+    }, {
+        readonly name: "data";
+        readonly type: "bytes";
+    }];
+    readonly name: "safeBatchTransferFrom";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "collateralToken";
+        readonly type: "address";
+    }, {
+        readonly name: "parentCollectionId";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "conditionId";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "partition";
+        readonly type: "uint256[]";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly name: "splitPosition";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "collateralToken";
+        readonly type: "address";
+    }, {
+        readonly name: "parentCollectionId";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "conditionId";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "partition";
+        readonly type: "uint256[]";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly name: "mergePositions";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "collateralToken";
+        readonly type: "address";
+    }, {
+        readonly name: "parentCollectionId";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "conditionId";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "indexSets";
+        readonly type: "uint256[]";
+    }];
+    readonly name: "redeemPositions";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "conditionId";
+        readonly type: "bytes32";
+    }];
+    readonly name: "payoutDenominator";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "conditionId";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "outcomeIndex";
+        readonly type: "uint256";
+    }];
+    readonly name: "payoutNumerators";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "conditionId";
+        readonly type: "bytes32";
+    }];
+    readonly name: "getOutcomeSlotCount";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "oracle";
+        readonly type: "address";
+    }, {
+        readonly name: "questionId";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "outcomeSlotCount";
+        readonly type: "uint256";
+    }];
+    readonly name: "getConditionId";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bytes32";
+    }];
+    readonly stateMutability: "pure";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "parentCollectionId";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "conditionId";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "indexSet";
+        readonly type: "uint256";
+    }];
+    readonly name: "getCollectionId";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bytes32";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "collateralToken";
+        readonly type: "address";
+    }, {
+        readonly name: "collectionId";
+        readonly type: "bytes32";
+    }];
+    readonly name: "getPositionId";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "pure";
+    readonly type: "function";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly name: "operator";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly name: "from";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly name: "id";
+        readonly type: "uint256";
+    }, {
+        readonly indexed: false;
+        readonly name: "value";
+        readonly type: "uint256";
+    }];
+    readonly name: "TransferSingle";
+    readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly name: "operator";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly name: "from";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly name: "ids";
+        readonly type: "uint256[]";
+    }, {
+        readonly indexed: false;
+        readonly name: "values";
+        readonly type: "uint256[]";
+    }];
+    readonly name: "TransferBatch";
+    readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly name: "operator";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly name: "approved";
+        readonly type: "bool";
+    }];
+    readonly name: "ApprovalForAll";
+    readonly type: "event";
+}];
+//# sourceMappingURL=ctf-exchange.d.ts.map

package/dist/abi/ctf-exchange.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ctf-exchange.d.ts","sourceRoot":"","sources":["../../src/abi/ctf-exchange.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4MjB,CAAC"}

package/dist/abi/erc20.d.ts

@@ -0,0 +1,152 @@
+/**
+ * Standard ERC20 ABI for USDC interactions.
+ *
+ * Used for checking balances, allowances, and approvals.
+ */
+export declare const erc20Abi: readonly [{
+    readonly inputs: readonly [];
+    readonly name: "name";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "symbol";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "decimals";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "totalSupply";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+    }];
+    readonly name: "balanceOf";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+    }];
+    readonly name: "allowance";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "spender";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly name: "approve";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly name: "transfer";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "from";
+        readonly type: "address";
+    }, {
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly name: "transferFrom";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly name: "from";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly name: "value";
+        readonly type: "uint256";
+    }];
+    readonly name: "Transfer";
+    readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly name: "spender";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly name: "value";
+        readonly type: "uint256";
+    }];
+    readonly name: "Approval";
+    readonly type: "event";
+}];
+//# sourceMappingURL=erc20.d.ts.map

package/dist/abi/erc20.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"erc20.d.ts","sourceRoot":"","sources":["../../src/abi/erc20.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsGX,CAAC"}

package/dist/abi/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Polymarket contract ABIs.
+ *
+ * @module @varla/polymarket/abi
+ */
+export { ctfExchangeAbi } from "./ctf-exchange.js";
+export { erc20Abi } from "./erc20.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/abi/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/abi/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC"}