pmxtjs 0.1.0 → 0.1.1

package/examples/get_event_prices.ts

@@ -1,37 +0,0 @@
-import { PolymarketExchange } from '../src/exchanges/Polymarket';
-import { KalshiExchange } from '../src/exchanges/Kalshi';
-
-const main = async () => {
-    const polySlug = process.argv[2] || 'who-will-trump-nominate-as-fed-chair';
-    const kalshiTicker = process.argv[3] || 'KXFEDCHAIRNOM-29';
-
-    console.log(`Fetching prices for: ${polySlug} / ${kalshiTicker}\n`);
-
-    // Polymarket
-    const polymarket = new PolymarketExchange();
-    const polyMarkets = await polymarket.getMarketsBySlug(polySlug);
-
-    console.log('--- Polymarket ---');
-    polyMarkets
-        .sort((a, b) => b.outcomes[0].price - a.outcomes[0].price)
-        .slice(0, 10)
-        .forEach(m => {
-            console.log(`${m.outcomes[0].label}: ${(m.outcomes[0].price * 100).toFixed(1)}% ` +
-                `(Vol24h: $${m.volume24h.toLocaleString()})`);
-        });
-
-    // Kalshi
-    const kalshi = new KalshiExchange();
-    const kalshiMarkets = await kalshi.getMarketsBySlug(kalshiTicker);
-
-    console.log('\n--- Kalshi ---');
-    kalshiMarkets
-        .sort((a, b) => b.outcomes[0].price - a.outcomes[0].price)
-        .slice(0, 10)
-        .forEach(m => {
-            console.log(`${m.outcomes[0].label}: ${(m.outcomes[0].price * 100).toFixed(1)}% ` +
-                `(Vol24h: $${m.volume24h.toLocaleString()})`);
-        });
-};
-
-main();

package/examples/historical_prices.ts

@@ -1,117 +0,0 @@
-
-import { PolymarketExchange } from '../src/exchanges/Polymarket';
-import { KalshiExchange } from '../src/exchanges/Kalshi';
-import { CandleInterval } from '../src/types';
-
-/**
- * START HERE
- * 
- * This example fetches historical price data for a specific EVENT.
- * 
- * NOTE: 
- * An "Event" (e.g. "Who will be Fed Chair?") contains multiple "Markets" or "Outcomes" 
- * (e.g. "Kevin Warsh", "Marc Rowan", "Scott Bessent").
- * 
- * Price history is tracked at the MARKET/OUTCOME level.
- */
-
-const main = async () => {
-    // 1. Define the Event Slugs (Hardcoded for simplicity)
-    const polySlug = 'who-will-trump-nominate-as-fed-chair';
-    const kalshiTicker = 'KXFEDCHAIRNOM-29';
-
-    console.log(`=== Historical Price Fetcher ===\n`);
-    console.log(`Target Event: Fed Chair Nomination (Kevin Warsh - YES)`);
-
-    // ---------------------------------------------------------
-    // Polymarket
-    // ---------------------------------------------------------
-    const polymarket = new PolymarketExchange();
-    console.log('\n--- Polymarket ---');
-    try {
-        const polyMarkets = await polymarket.getMarketsBySlug(polySlug);
-
-        if (polyMarkets.length > 0) {
-            const eventMarket = polyMarkets[0];
-
-            // Find "Kevin Warsh" outcome
-            const warshOutcome = eventMarket.outcomes.find(o =>
-                o.label.toLowerCase().includes('warsh') &&
-                !o.label.toLowerCase().includes('not') // Ensure it's YES
-            );
-
-            if (!warshOutcome) {
-                console.log("Could not find 'Kevin Warsh' outcome in Polymarket event.");
-            } else {
-                console.log(`Target Outcome: ${warshOutcome.label}`);
-                console.log(`Current Price: ${(warshOutcome.price * 100).toFixed(1)}%`);
-
-                const clobTokenId = warshOutcome.metadata?.clobTokenId;
-
-                if (clobTokenId) {
-                    console.log(`Fetching 1-hour history for "${warshOutcome.label}"...`);
-                    console.log(`Token ID: ${clobTokenId}`);
-
-                    const history = await polymarket.getMarketHistory(clobTokenId, {
-                        resolution: '1h',
-                        limit: 20,
-                        start: new Date(Date.now() - 7 * 24 * 60 * 60 * 1000) // 7 days ago
-                    });
-
-                    console.log(`Received ${history.length} data points.`);
-                    history.forEach(point => {
-                        const date = new Date(point.timestamp).toLocaleString();
-                        console.log(`   ${date} | Price: $${point.close.toFixed(3)}`);
-                    });
-                } else {
-                    console.log('No Token ID found, cannot fetch history.');
-                }
-            }
-        }
-    } catch (e) {
-        console.error("Polymarket Error:", e);
-    }
-
-    // ---------------------------------------------------------
-    // Kalshi
-    // ---------------------------------------------------------
-    const kalshi = new KalshiExchange();
-    console.log('\n--- Kalshi ---');
-    try {
-        // First get the event to find the markets
-        const kalshiMarkets = await kalshi.getMarketsBySlug(kalshiTicker);
-
-        if (kalshiMarkets.length > 0) {
-            // Find the market where the subtitle/title includes Warsh
-            // Kalshi often has subtitles like "Kevin Warsh"
-            const warshMarket = kalshiMarkets.find(m =>
-                m.description.toLowerCase().includes('warsh') ||
-                m.outcomes[0].label.toLowerCase().includes('warsh')
-            );
-
-            if (!warshMarket) {
-                console.log("Could not find 'Kevin Warsh' market in Kalshi event.");
-            } else {
-                console.log(`Target Market: ${warshMarket.title} (${warshMarket.description})`);
-                console.log(`Ticker: ${warshMarket.id}`);
-                console.log(`Current Price: ${(warshMarket.outcomes[0].price * 100).toFixed(1)}%`);
-
-                console.log(`Fetching 1-hour history...`);
-
-                const history = await kalshi.getMarketHistory(warshMarket.id, {
-                    resolution: '1h',
-                    limit: 10
-                });
-
-                history.forEach(candle => {
-                    const date = new Date(candle.timestamp).toLocaleString();
-                    console.log(`   ${date} | Price: $${candle.close.toFixed(2)}`);
-                });
-            }
-        }
-    } catch (e) {
-        console.error("Kalshi Error:", e);
-    }
-};
-
-main();

package/examples/orderbook.ts

@@ -1,102 +0,0 @@
-
-import { PolymarketExchange } from '../src/exchanges/Polymarket';
-import { KalshiExchange } from '../src/exchanges/Kalshi';
-import { OrderBook } from '../src/types';
-
-/**
- * Example: Get Order Book (Multi-Exchange)
- * 
- * This example fetches and compares order books from both Polymarket and Kalshi
- * for the "Kevin Warsh" Fed Chair nomination prediction.
- */
-
-// Helper to display an order book
-const displayOrderBook = (exchangeName: string, book: OrderBook) => {
-    console.log(`\n-----------------------------------------`);
-    console.log(`ORDER BOOK: ${exchangeName}`);
-    console.log(`-----------------------------------------`);
-
-    if (book.bids.length === 0 && book.asks.length === 0) {
-        console.log("No orders found or market is closed.");
-        return;
-    }
-
-    // Show Asks (Sellers) - Reverse to show highest price (lowest/best ask) at bottom
-    console.log(`\n   --- ASKS (Sellers) ---`);
-    const asks = book.asks.slice(0, 5).sort((a, b) => b.price - a.price); // Sort descending for display (high to low)
-    asks.forEach(level => {
-        console.log(`   Price: $${level.price.toFixed(2)} | Size: ${level.size.toLocaleString().padStart(8)}`);
-    });
-
-    // Show Bids (Buyers) - Descending (Highest/best buy first)
-    console.log(`   --- BIDS (Buyers)  ---`);
-    const bids = book.bids.slice(0, 5).sort((a, b) => b.price - a.price);
-    bids.forEach(level => {
-        console.log(`   Price: $${level.price.toFixed(2)} | Size: ${level.size.toLocaleString().padStart(8)}`);
-    });
-};
-
-const main = async () => {
-    console.log(`=== Multi-Exchange Order Book Fetcher ===`);
-    console.log(`Target: "Kevin Warsh" -> Fed Chair Nomination\n`);
-
-    // 1. Polymarket
-    try {
-        const polymarket = new PolymarketExchange();
-        const polySlug = 'who-will-trump-nominate-as-fed-chair';
-
-        console.log(`Fetching Polymarket data...`);
-        const markets = await polymarket.getMarketsBySlug(polySlug);
-
-        if (markets.length > 0) {
-            const warshOutcome = markets[0].outcomes.find(o =>
-                o.label.toLowerCase().includes('warsh') &&
-                !o.label.toLowerCase().includes('not')
-            );
-
-            if (warshOutcome && warshOutcome.metadata?.clobTokenId) {
-                const book = await polymarket.getOrderBook(warshOutcome.metadata.clobTokenId);
-                displayOrderBook('Polymarket', book);
-            } else {
-                console.log("Polymarket: Outcome or Token ID not found.");
-            }
-        }
-    } catch (e) {
-        console.error("Polymarket Error:", e);
-    }
-
-    // 2. Kalshi
-    try {
-        const kalshi = new KalshiExchange();
-        // Specifically for "Kevin Warsh" in the Fed Chair market.
-        // Ticker derived from previous searches.
-        const kalshiTicker = 'KXFEDCHAIRNOM-29';
-
-        console.log(`\nFetching Kalshi data...`);
-        // Verify event exists and find the specific market
-        const markets = await kalshi.getMarketsBySlug(kalshiTicker);
-
-        if (markets.length > 0) {
-            // Find "Kevin Warsh" market within the event group
-            const warshMarket = markets.find(m =>
-                m.description.toLowerCase().includes('warsh') ||
-                m.outcomes[0].label.toLowerCase().includes('warsh')
-            );
-
-            if (warshMarket) {
-                console.log(`Found Market Ticker: ${warshMarket.id}`);
-                const book = await kalshi.getOrderBook(warshMarket.id);
-                displayOrderBook('Kalshi', book);
-            } else {
-                console.log("Kalshi: 'Kevin Warsh' market not found in event.");
-            }
-        } else {
-            console.log("Kalshi: Event not found.");
-        }
-
-    } catch (e) {
-        console.error("Kalshi Error:", e);
-    }
-};
-
-main();

package/examples/recent_trades.ts

@@ -1,29 +0,0 @@
-import { KalshiExchange } from '../src/exchanges/Kalshi';
-import { PolymarketExchange } from '../src/exchanges/Polymarket';
-
-async function run() {
-    const kalshi = new KalshiExchange();
-    const poly = new PolymarketExchange();
-
-    const kMarkets = await kalshi.getMarketsBySlug('KXFEDCHAIRNOM-29');
-    // Filter for Kevin Warsh specifically
-    const warshMarket = kMarkets.find(m => m.outcomes[0].label.includes('Kevin Warsh'));
-
-    if (warshMarket) {
-        console.log(`--- Kalshi Tape: ${warshMarket.outcomes[0].label} ---`);
-        const trades = await kalshi.getTradeHistory(warshMarket.id, { limit: 10, resolution: '1m' });
-        trades.forEach(t => console.log(`${new Date(t.timestamp).toLocaleTimeString()} | ${t.side.toUpperCase()} | ${(t.price * 100).toFixed(1)}c | ${t.amount}`));
-    }
-
-    const pMarkets = await poly.getMarketsBySlug('who-will-trump-nominate-as-fed-chair');
-    const pWarsh = pMarkets.find(m => m.outcomes[0].label.includes('Kevin Warsh'));
-
-    if (pWarsh) {
-        console.log(`\n--- Polymarket Tape: Kevin Warsh ---`);
-        const tokenId = pWarsh.outcomes[0].metadata?.clobTokenId;
-        const trades = await poly.getTradeHistory(tokenId, { limit: 5, resolution: '1m' });
-        trades.forEach(t => console.log(`${new Date(t.timestamp).toLocaleTimeString()} | ${t.side.toUpperCase()} | ${(t.price * 100).toFixed(1)}c | ${t.amount}`));
-    }
-}
-
-run();

package/examples/search_events.ts

@@ -1,68 +0,0 @@
-import { PolymarketExchange } from '../src/exchanges/Polymarket';
-import { KalshiExchange } from '../src/exchanges/Kalshi';
-import { UnifiedMarket } from '../src/types';
-
-interface UnifiedEvent {
-    title: string;
-    url: string;
-    volume24h: number; // Aggregated
-    markets: UnifiedMarket[];
-}
-
-const groupMarketsByEvent = (markets: UnifiedMarket[]): UnifiedEvent[] => {
-    const eventsMap = new Map<string, UnifiedEvent>();
-
-    for (const m of markets) {
-        if (!eventsMap.has(m.url)) {
-            eventsMap.set(m.url, {
-                title: m.title,
-                url: m.url,
-                volume24h: 0,
-                markets: []
-            });
-        }
-        const event = eventsMap.get(m.url)!;
-        event.volume24h += m.volume24h;
-        event.markets.push(m);
-    }
-
-    return Array.from(eventsMap.values());
-};
-
-const main = async () => {
-    const query = process.argv[2] || 'Fed';
-    console.log(`Searching for Events matching "${query}"...\n`);
-
-    // 1. Polymarket
-    const polymarket = new PolymarketExchange();
-    // Polymarket returns many sub-markets per event
-    const polyMarkets = await polymarket.searchMarkets(query, { sort: 'volume' });
-    const polyEvents = groupMarketsByEvent(polyMarkets);
-
-    console.log(`--- Polymarket Events (${polyEvents.length}) ---`);
-    polyEvents
-        .sort((a, b) => b.volume24h - a.volume24h)
-        .slice(0, 5)
-        .forEach(e => {
-            console.log(`${e.title} (Vol24h: $${e.volume24h.toLocaleString()})`);
-            console.log(`   -> ${e.markets.length} sub-markets`);
-        });
-
-    console.log('');
-
-    // 2. Kalshi
-    const kalshi = new KalshiExchange();
-    const kalshiMarkets = await kalshi.searchMarkets(query);
-    const kalshiEvents = groupMarketsByEvent(kalshiMarkets);
-
-    console.log(`--- Kalshi Events (${kalshiEvents.length}) ---`);
-    kalshiEvents
-        .sort((a, b) => b.volume24h - a.volume24h)
-        .slice(0, 5)
-        .forEach(e => {
-            console.log(`${e.title} (Vol24h: $${e.volume24h.toLocaleString()})`);
-            console.log(`   -> ${e.markets.length} sub-markets`);
-        });
-};
-
-main();

package/examples/search_market.ts

@@ -1,29 +0,0 @@
-import { PolymarketExchange } from '../src/exchanges/Polymarket';
-import { KalshiExchange } from '../src/exchanges/Kalshi';
-
-const main = async () => {
-    const query = process.argv[2] || 'Fed';
-    console.log(`Searching for "${query}"...\n`);
-
-    // Polymarket
-    const polymarket = new PolymarketExchange();
-    const polyResults = await polymarket.searchMarkets(query, { sort: 'volume' });
-
-    console.log(`--- Polymarket Found ${polyResults.length} ---`);
-    polyResults.slice(0, 10).forEach(m => {
-        const label = m.outcomes[0]?.label || 'Unknown';
-        console.log(`[${m.id}] ${m.title} - ${label} (Vol24h: $${m.volume24h.toLocaleString()})`);
-    });
-
-    // Kalshi
-    const kalshi = new KalshiExchange();
-    const kalshiResults = await kalshi.searchMarkets(query);
-
-    console.log(`\n--- Kalshi Found ${kalshiResults.length} ---`);
-    kalshiResults.slice(0, 10).forEach(m => {
-        const label = m.outcomes[0]?.label || 'Unknown';
-        console.log(`[${m.id}] ${m.title} - ${label} (Vol24h: $${m.volume24h.toLocaleString()})`);
-    });
-};
-
-main();

package/jest.config.js

@@ -1,11 +0,0 @@
-const { createDefaultPreset } = require("ts-jest");
-
-const tsJestTransformCfg = createDefaultPreset().transform;
-
-/** @type {import("jest").Config} **/
-module.exports = {
-  testEnvironment: "node",
-  transform: {
-    ...tsJestTransformCfg,
-  },
-};

package/src/BaseExchange.ts

@@ -1,57 +0,0 @@
-import { UnifiedMarket, PriceCandle, CandleInterval, OrderBook, Trade } from './types';
-
-export interface MarketFilterParams {
-    limit?: number;
-    offset?: number;
-    sort?: 'volume' | 'liquidity' | 'newest';
-}
-
-export interface HistoryFilterParams {
-    resolution: CandleInterval;
-    start?: Date;
-    end?: Date;
-    limit?: number;
-}
-
-// ----------------------------------------------------------------------------
-// Base Exchange Class
-// ----------------------------------------------------------------------------
-
-export abstract class PredictionMarketExchange {
-    abstract get name(): string;
-
-    /**
-     * Fetch all relevant markets from the source.
-     */
-    abstract fetchMarkets(params?: MarketFilterParams): Promise<UnifiedMarket[]>;
-
-    /**
-     * Search for markets matching a keyword query.
-     * Searches across title and description fields.
-     */
-    abstract searchMarkets(query: string, params?: MarketFilterParams): Promise<UnifiedMarket[]>;
-
-    /**
-     * Fetch historical price data for a specific market or outcome.
-     * @param id - The market ID or specific outcome ID/Token ID depending on the exchange
-     */
-    async getMarketHistory(id: string, params: HistoryFilterParams): Promise<PriceCandle[]> {
-        throw new Error("Method getMarketHistory not implemented.");
-    }
-
-    /**
-     * Fetch the current order book (bids/asks) for a specific outcome.
-     * Essential for calculating localized spread and depth.
-     */
-    async getOrderBook(id: string): Promise<OrderBook> {
-        throw new Error("Method getOrderBook not implemented.");
-    }
-
-    /**
-     * Fetch raw trade history.
-     * Useful for generating synthetic OHLCV candles if the exchange doesn't provide them natively.
-     */
-    async getTradeHistory(id: string, params: HistoryFilterParams): Promise<Trade[]> {
-        throw new Error("Method getTradeHistory not implemented.");
-    }
-}

package/src/index.ts

@@ -1,5 +0,0 @@
-export * from './BaseExchange';
-export * from './types';
-export * from './exchanges/Polymarket';
-export * from './exchanges/Kalshi';
-

package/src/types.ts

@@ -1,61 +0,0 @@
-
-// ----------------------------------------------------------------------------
-// Core Data Models
-// ----------------------------------------------------------------------------
-
-export interface MarketOutcome {
-    id: string;
-    label: string;
-    price: number;
-    priceChange24h?: number;
-    metadata?: Record<string, any>;
-}
-
-export interface UnifiedMarket {
-    id: string;
-    title: string;
-    description: string;
-    outcomes: MarketOutcome[];
-
-    resolutionDate: Date;
-    volume24h: number;
-    volume?: number; // Total / Lifetime volume
-    liquidity: number;
-    openInterest?: number;
-
-    url: string;
-    image?: string;
-
-    category?: string;
-    tags?: string[];
-}
-
-export type CandleInterval = '1m' | '5m' | '15m' | '1h' | '6h' | '1d';
-
-export interface PriceCandle {
-    timestamp: number;
-    open: number;
-    high: number;
-    low: number;
-    close: number;
-    volume?: number;
-}
-
-export interface OrderLevel {
-    price: number; // 0.0 to 1.0 (probability)
-    size: number;  // contracts/shares
-}
-
-export interface OrderBook {
-    bids: OrderLevel[];
-    asks: OrderLevel[];
-    timestamp?: number;
-}
-
-export interface Trade {
-    id: string;
-    timestamp: number;
-    price: number;
-    amount: number;
-    side: 'buy' | 'sell' | 'unknown';
-}

package/test/exchanges/kalshi/ApiErrors.test.ts

@@ -1,132 +0,0 @@
-import axios from 'axios';
-import { KalshiExchange } from '../../../src/exchanges/Kalshi';
-
-/**
- * Kalshi API Error Handling Test
- * 
- * What: Tests how the exchange handles various API error responses (4xx, 5xx).
- * Why: External APIs can fail with rate limits, authentication errors, or server issues.
- *      The library must handle these gracefully without crashing.
- * How: Mocks different HTTP error responses and verifies proper error handling.
- */
-
-jest.mock('axios');
-const mockedAxios = axios as jest.Mocked<typeof axios>;
-
-describe('KalshiExchange - API Error Handling', () => {
-    let exchange: KalshiExchange;
-
-    beforeEach(() => {
-        exchange = new KalshiExchange();
-        jest.clearAllMocks();
-    });
-
-    it('should handle 404 errors in getMarketsBySlug', async () => {
-        const error = {
-            response: {
-                status: 404,
-                data: { error: 'Event not found' }
-            },
-            isAxiosError: true
-        };
-        mockedAxios.get.mockRejectedValue(error);
-        // @ts-expect-error - Mock type mismatch is expected in tests
-        mockedAxios.isAxiosError = jest.fn().mockReturnValue(true);
-
-        await expect(exchange.getMarketsBySlug('INVALID-EVENT'))
-            .rejects
-            .toThrow(/not found/i);
-    });
-
-    it('should handle 500 errors in getMarketsBySlug', async () => {
-        const error = {
-            response: {
-                status: 500,
-                data: { error: 'Internal Server Error' }
-            },
-            isAxiosError: true
-        };
-        mockedAxios.get.mockRejectedValue(error);
-        // @ts-expect-error - Mock type mismatch is expected in tests
-        mockedAxios.isAxiosError = jest.fn().mockReturnValue(true);
-
-        await expect(exchange.getMarketsBySlug('SOME-EVENT'))
-            .rejects
-            .toThrow(/API Error/i);
-    });
-
-    it('should handle network errors in fetchMarkets', async () => {
-        mockedAxios.get.mockRejectedValue(new Error('Network timeout'));
-        const consoleSpy = jest.spyOn(console, 'error').mockImplementation(() => { });
-
-        const markets = await exchange.fetchMarkets();
-
-        expect(markets).toEqual([]);
-        expect(consoleSpy).toHaveBeenCalled();
-        consoleSpy.mockRestore();
-    });
-
-    it('should handle malformed response data', async () => {
-        mockedAxios.get.mockResolvedValue({
-            data: {
-                events: [
-                    {
-                        // Missing required fields
-                        event_ticker: 'TEST',
-                        markets: [{ ticker: 'TEST-MARKET' }]
-                    }
-                ]
-            }
-        });
-
-        const markets = await exchange.fetchMarkets();
-
-        // Should not crash, may return empty or partial data
-        expect(Array.isArray(markets)).toBe(true);
-    });
-
-    it('should handle invalid ticker format in getMarketHistory', async () => {
-        await expect(exchange.getMarketHistory('INVALID', { resolution: '1h' }))
-            .rejects
-            .toThrow(/Invalid Kalshi Ticker format/i);
-    });
-
-    it('should handle API errors in getMarketHistory', async () => {
-        const error = {
-            response: {
-                status: 400,
-                data: { error: 'Invalid parameters' }
-            },
-            isAxiosError: true
-        };
-        mockedAxios.get.mockRejectedValue(error);
-        // @ts-expect-error - Mock type mismatch is expected in tests
-        mockedAxios.isAxiosError = jest.fn().mockReturnValue(true);
-
-        await expect(exchange.getMarketHistory('FED-25JAN-B4.75', { resolution: '1h' }))
-            .rejects
-            .toThrow(/History API Error/i);
-    });
-
-    it('should return empty orderbook on error', async () => {
-        mockedAxios.get.mockRejectedValue(new Error('API Error'));
-        const consoleSpy = jest.spyOn(console, 'error').mockImplementation(() => { });
-
-        const orderbook = await exchange.getOrderBook('TEST-TICKER');
-
-        expect(orderbook).toEqual({ bids: [], asks: [] });
-        expect(consoleSpy).toHaveBeenCalled();
-        consoleSpy.mockRestore();
-    });
-
-    it('should return empty trades on error', async () => {
-        mockedAxios.get.mockRejectedValue(new Error('API Error'));
-        const consoleSpy = jest.spyOn(console, 'error').mockImplementation(() => { });
-
-        const trades = await exchange.getTradeHistory('TEST-TICKER', { resolution: '1h' });
-
-        expect(trades).toEqual([]);
-        expect(consoleSpy).toHaveBeenCalled();
-        consoleSpy.mockRestore();
-    });
-});