pmxtjs 2.48.6 → 2.49.1

package/generated/src/models/ExchangeOptions.ts

@@ -0,0 +1,115 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * PMXT Sidecar API
+ * A unified local sidecar API for prediction markets (Polymarket, Kalshi, Limitless). This API acts as a JSON-RPC-style gateway. Each endpoint corresponds to a specific method on the generic exchange implementation.
+ *
+ * The version of the OpenAPI document: 0.4.4
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Constructor-level options for venue clients (Polymarket, Kalshi, Opinion, etc.).
+ * Hosted mode is the default when pmxtApiKey is set; otherwise the SDK runs against
+ * a local sidecar with venue credentials.
+ * @export
+ * @interface ExchangeOptions
+ */
+export interface ExchangeOptions {
+    /**
+     * PMXT customer API key. When set, the SDK routes to api.pmxt.dev (catalog) and trade.pmxt.dev (trading). Get one at pmxt.dev/dashboard.
+     * @type {string}
+     * @memberof ExchangeOptions
+     */
+    pmxtApiKey?: string;
+    /**
+     * EVM wallet address for hosted reads/writes. Required for endpoints that operate on a wallet (balances, positions, trades, open orders).
+     * @type {string}
+     * @memberof ExchangeOptions
+     */
+    walletAddress?: string | null;
+    /**
+     * Optional pre-built signer for hosted writes. If absent and privateKey is set, the SDK auto-wraps privateKey into a signer.
+     * @type {object}
+     * @memberof ExchangeOptions
+     */
+    signer?: object | null;
+    /**
+     * Private key. In hosted mode, used to derive an EIP-712 signer for writes (wraps into EthAccountSigner/EthersSigner). In self-hosted mode, used as the venue credential directly.
+     * @type {string}
+     * @memberof ExchangeOptions
+     */
+    privateKey?: string | null;
+    /**
+     * Explicit base URL override. When unset, the SDK uses api.pmxt.dev when pmxtApiKey is set, or the local sidecar otherwise.
+     * @type {string}
+     * @memberof ExchangeOptions
+     */
+    baseUrl?: string | null;
+    /**
+     * Venue-side API key (e.g. Polymarket CLOB key). Only relevant for self-hosted mode.
+     * @type {string}
+     * @memberof ExchangeOptions
+     */
+    apiKey?: string | null;
+    /**
+     * Auto-start the local sidecar when running self-hosted. Defaults to true when no pmxtApiKey is set, false when hosted.
+     * @type {boolean}
+     * @memberof ExchangeOptions
+     */
+    autoStartServer?: boolean | null;
+}
+
+/**
+ * Check if a given object implements the ExchangeOptions interface.
+ */
+export function instanceOfExchangeOptions(value: object): value is ExchangeOptions {
+    return true;
+}
+
+export function ExchangeOptionsFromJSON(json: any): ExchangeOptions {
+    return ExchangeOptionsFromJSONTyped(json, false);
+}
+
+export function ExchangeOptionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExchangeOptions {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'pmxtApiKey': json['pmxtApiKey'] == null ? undefined : json['pmxtApiKey'],
+        'walletAddress': json['walletAddress'] == null ? undefined : json['walletAddress'],
+        'signer': json['signer'] == null ? undefined : json['signer'],
+        'privateKey': json['privateKey'] == null ? undefined : json['privateKey'],
+        'baseUrl': json['baseUrl'] == null ? undefined : json['baseUrl'],
+        'apiKey': json['apiKey'] == null ? undefined : json['apiKey'],
+        'autoStartServer': json['autoStartServer'] == null ? undefined : json['autoStartServer'],
+    };
+}
+
+export function ExchangeOptionsToJSON(json: any): ExchangeOptions {
+    return ExchangeOptionsToJSONTyped(json, false);
+}
+
+export function ExchangeOptionsToJSONTyped(value?: ExchangeOptions | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'pmxtApiKey': value['pmxtApiKey'],
+        'walletAddress': value['walletAddress'],
+        'signer': value['signer'],
+        'privateKey': value['privateKey'],
+        'baseUrl': value['baseUrl'],
+        'apiKey': value['apiKey'],
+        'autoStartServer': value['autoStartServer'],
+    };
+}
+

package/generated/src/models/MatchedMarketPair.ts

@@ -82,7 +82,7 @@ export interface MatchedMarketPair {
      */
     confidence?: number;
     /**
-     * 
+     * Why the two markets were matched.
      * @type {string}
      * @memberof MatchedMarketPair
      */

package/generated/src/models/Order.ts

@@ -103,6 +103,24 @@ export interface Order {
      * @memberof Order
      */
     feeRateBps?: number;
+    /**
+     * Populated in hosted mode after on-chain settlement; null for local-mode and for non-on-chain venues.
+     * @type {string}
+     * @memberof Order
+     */
+    txHash?: string | null;
+    /**
+     * Populated in hosted mode after on-chain settlement; null for local-mode and for non-on-chain venues.
+     * @type {string}
+     * @memberof Order
+     */
+    chain?: string | null;
+    /**
+     * Populated in hosted mode after on-chain settlement; null for local-mode and for non-on-chain venues.
+     * @type {number}
+     * @memberof Order
+     */
+    blockNumber?: number | null;
 }
 
 
@@ -178,6 +196,9 @@ export function OrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): Ord
         'timestamp': json['timestamp'],
         'fee': json['fee'] == null ? undefined : json['fee'],
         'feeRateBps': json['feeRateBps'] == null ? undefined : json['feeRateBps'],
+        'txHash': json['txHash'] == null ? undefined : json['txHash'],
+        'chain': json['chain'] == null ? undefined : json['chain'],
+        'blockNumber': json['blockNumber'] == null ? undefined : json['blockNumber'],
     };
 }
 
@@ -206,6 +227,9 @@ export function OrderToJSONTyped(value?: Order | null, ignoreDiscriminator: bool
         'timestamp': value['timestamp'],
         'fee': value['fee'],
         'feeRateBps': value['feeRateBps'],
+        'txHash': value['txHash'],
+        'chain': value['chain'],
+        'blockNumber': value['blockNumber'],
     };
 }
 

package/generated/src/models/OrderLevel.ts

@@ -31,6 +31,12 @@ export interface OrderLevel {
      * @memberof OrderLevel
      */
     size: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof OrderLevel
+     */
+    orderCount?: number;
 }
 
 /**
@@ -54,6 +60,7 @@ export function OrderLevelFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         
         'price': json['price'],
         'size': json['size'],
+        'orderCount': json['orderCount'] == null ? undefined : json['orderCount'],
     };
 }
 
@@ -70,6 +77,7 @@ export function OrderLevelToJSONTyped(value?: OrderLevel | null, ignoreDiscrimin
         
         'price': value['price'],
         'size': value['size'],
+        'orderCount': value['orderCount'],
     };
 }
 

package/generated/src/models/Position.ts

@@ -14,7 +14,7 @@
 
 import { mapValues } from '../runtime';
 /**
- * 
+ * A current position in a market. In hosted mode, `outcomeLabel`, `entryPrice`, `currentPrice` and `unrealizedPnL` may be null when the server cannot derive them (e.g. `with_mtm=false` or no fill history). Venue-direct callers continue to populate every field.
  * @export
  * @interface Position
  */
@@ -32,11 +32,11 @@ export interface Position {
      */
     outcomeId: string;
     /**
-     * Human-readable label for the outcome held.
+     * Human-readable label for the outcome held. Optional in hosted mode.
      * @type {string}
      * @memberof Position
      */
-    outcomeLabel: string;
+    outcomeLabel?: string | null;
     /**
      * Positive for long, negative for short
      * @type {number}
@@ -44,29 +44,53 @@ export interface Position {
      */
     size: number;
     /**
-     * Average entry price for the position (probability between 0.0 and 1.0).
+     * Average entry price for the position (probability between 0.0 and 1.0). Optional in hosted mode when no fill history is available.
+     * @type {number}
+     * @memberof Position
+     */
+    entryPrice?: number | null;
+    /**
+     * Current mark price for the position (probability between 0.0 and 1.0). Optional in hosted mode when mark-to-market data is unavailable.
      * @type {number}
      * @memberof Position
      */
-    entryPrice: number;
+    currentPrice?: number | null;
     /**
-     * Current mark price for the position (probability between 0.0 and 1.0).
+     * Current market value of the position (size * currentPrice). Null when currentPrice is unavailable.
      * @type {number}
      * @memberof Position
      */
-    currentPrice: number;
+    currentValue?: number | null;
     /**
-     * Unrealized profit or loss at the current price (USD).
+     * Unrealized profit or loss at the current price (USD). Optional in hosted mode when mark-to-market data is unavailable.
      * @type {number}
      * @memberof Position
      */
-    unrealizedPnL: number;
+    unrealizedPnL?: number | null;
     /**
      * Realized profit or loss booked so far (USD).
      * @type {number}
      * @memberof Position
      */
     realizedPnL?: number;
+    /**
+     * Populated in hosted mode after on-chain settlement (from the last fill); null for local-mode and for non-on-chain venues.
+     * @type {string}
+     * @memberof Position
+     */
+    txHash?: string | null;
+    /**
+     * Populated in hosted mode after on-chain settlement (from the last fill); null for local-mode and for non-on-chain venues.
+     * @type {string}
+     * @memberof Position
+     */
+    chain?: string | null;
+    /**
+     * Populated in hosted mode after on-chain settlement (from the last fill); null for local-mode and for non-on-chain venues.
+     * @type {number}
+     * @memberof Position
+     */
+    blockNumber?: number | null;
 }
 
 /**
@@ -75,11 +99,7 @@ export interface Position {
 export function instanceOfPosition(value: object): value is Position {
     if (!('marketId' in value) || value['marketId'] === undefined) return false;
     if (!('outcomeId' in value) || value['outcomeId'] === undefined) return false;
-    if (!('outcomeLabel' in value) || value['outcomeLabel'] === undefined) return false;
     if (!('size' in value) || value['size'] === undefined) return false;
-    if (!('entryPrice' in value) || value['entryPrice'] === undefined) return false;
-    if (!('currentPrice' in value) || value['currentPrice'] === undefined) return false;
-    if (!('unrealizedPnL' in value) || value['unrealizedPnL'] === undefined) return false;
     return true;
 }
 
@@ -95,12 +115,16 @@ export function PositionFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         
         'marketId': json['marketId'],
         'outcomeId': json['outcomeId'],
-        'outcomeLabel': json['outcomeLabel'],
+        'outcomeLabel': json['outcomeLabel'] == null ? undefined : json['outcomeLabel'],
         'size': json['size'],
-        'entryPrice': json['entryPrice'],
-        'currentPrice': json['currentPrice'],
-        'unrealizedPnL': json['unrealizedPnL'],
+        'entryPrice': json['entryPrice'] == null ? undefined : json['entryPrice'],
+        'currentPrice': json['currentPrice'] == null ? undefined : json['currentPrice'],
+        'currentValue': json['currentValue'] == null ? undefined : json['currentValue'],
+        'unrealizedPnL': json['unrealizedPnL'] == null ? undefined : json['unrealizedPnL'],
         'realizedPnL': json['realizedPnL'] == null ? undefined : json['realizedPnL'],
+        'txHash': json['txHash'] == null ? undefined : json['txHash'],
+        'chain': json['chain'] == null ? undefined : json['chain'],
+        'blockNumber': json['blockNumber'] == null ? undefined : json['blockNumber'],
     };
 }
 
@@ -121,8 +145,12 @@ export function PositionToJSONTyped(value?: Position | null, ignoreDiscriminator
         'size': value['size'],
         'entryPrice': value['entryPrice'],
         'currentPrice': value['currentPrice'],
+        'currentValue': value['currentValue'],
         'unrealizedPnL': value['unrealizedPnL'],
         'realizedPnL': value['realizedPnL'],
+        'txHash': value['txHash'],
+        'chain': value['chain'],
+        'blockNumber': value['blockNumber'],
     };
 }
 

package/generated/src/models/UnifiedSeries.ts

@@ -52,13 +52,13 @@ export interface UnifiedSeries {
      */
     title: string;
     /**
-     * 
+     * Long-form series description.
      * @type {string}
      * @memberof UnifiedSeries
      */
     description?: string | null;
     /**
-     * 
+     * Recurrence cadence the venue reports ('daily', 'weekly', 'annual', ...).
      * @type {string}
      * @memberof UnifiedSeries
      */
@@ -70,13 +70,13 @@ export interface UnifiedSeries {
      */
     events?: Array<UnifiedEvent>;
     /**
-     * 
+     * Canonical venue URL for the series.
      * @type {string}
      * @memberof UnifiedSeries
      */
     url?: string | null;
     /**
-     * 
+     * Venue-hosted image.
      * @type {string}
      * @memberof UnifiedSeries
      */

package/generated/src/models/UserTrade.ts

@@ -61,6 +61,24 @@ export interface UserTrade {
      * @memberof UserTrade
      */
     orderId?: string;
+    /**
+     * Populated in hosted mode after on-chain settlement; null for local-mode and for non-on-chain venues.
+     * @type {string}
+     * @memberof UserTrade
+     */
+    txHash?: string | null;
+    /**
+     * Populated in hosted mode after on-chain settlement; null for local-mode and for non-on-chain venues.
+     * @type {string}
+     * @memberof UserTrade
+     */
+    chain?: string | null;
+    /**
+     * Populated in hosted mode after on-chain settlement; null for local-mode and for non-on-chain venues.
+     * @type {number}
+     * @memberof UserTrade
+     */
+    blockNumber?: number | null;
 }
 
 
@@ -104,6 +122,9 @@ export function UserTradeFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'side': json['side'],
         'outcomeId': json['outcomeId'] == null ? undefined : json['outcomeId'],
         'orderId': json['orderId'] == null ? undefined : json['orderId'],
+        'txHash': json['txHash'] == null ? undefined : json['txHash'],
+        'chain': json['chain'] == null ? undefined : json['chain'],
+        'blockNumber': json['blockNumber'] == null ? undefined : json['blockNumber'],
     };
 }
 
@@ -125,6 +146,9 @@ export function UserTradeToJSONTyped(value?: UserTrade | null, ignoreDiscriminat
         'side': value['side'],
         'outcomeId': value['outcomeId'],
         'orderId': value['orderId'],
+        'txHash': value['txHash'],
+        'chain': value['chain'],
+        'blockNumber': value['blockNumber'],
     };
 }
 

package/generated/src/models/index.ts

@@ -23,6 +23,7 @@ export * from './EventFilterCriteriaTotalVolume';
 export * from './EventMatchResult';
 export * from './ExchangeCredentials';
 export * from './ExchangeCredentialsSignatureType';
+export * from './ExchangeOptions';
 export * from './ExecutionPriceResult';
 export * from './FeedFetchHistoricalPrices200Response';
 export * from './FeedFetchOHLCV200Response';

package/index.ts

@@ -36,6 +36,7 @@ export { MarketList } from "./pmxt/models.js";
 export type { UnifiedSeries } from "./pmxt/models.js";
 export type * from "./pmxt/models.js";
 export * from "./pmxt/errors.js";
+export * from "./pmxt/hosted-errors.js";
 
 
 const defaultManager = new ServerManager();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmxtjs",
-  "version": "2.48.6",
+  "version": "2.49.1",
   "description": "Unified prediction market data API - The ccxt for prediction markets",
   "author": "PMXT Contributors",
   "repository": {
@@ -43,12 +43,21 @@
     "unified"
   ],
   "dependencies": {
-    "pmxt-core": "2.48.6",
+    "pmxt-core": "2.49.1",
     "ws": "^8.18.0"
   },
+  "peerDependencies": {
+    "ethers": ">=6.0.0 <7.0.0"
+  },
+  "peerDependenciesMeta": {
+    "ethers": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@types/jest": "^30.0.0",
     "@types/node": "^20.0.0",
+    "ethers": "^6.16.0",
     "jest": "^30.4.2",
     "ts-jest": "^29.4.11",
     "typescript": "^5.0.0"