@vesper85/strategy-sdk 0.1.20 → 0.1.21

package/README.md

@@ -22,6 +22,8 @@ pnpm add @vesper85/strategy-sdk
 yarn add @vesper85/strategy-sdk
 ```
 
+**Note:** This package supports both ESM and CommonJS. You can use it in either type of project without needing to add `"type": "module"` to your `package.json`.
+
 ## Quick Start
 
 ### 1. Create a Tick-Based Strategy

package/dist/clients/__tests__/polymarket-client.integration.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=polymarket-client.integration.test.d.ts.map

package/dist/clients/__tests__/polymarket-client.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=polymarket-client.test.d.ts.map

package/dist/clients/polymarket-client.d.ts

@@ -1,4 +1,4 @@
-import { GammaMarket, type Event as GammaEvent, type Tag, type Team, type Sport, type Series, type Comment as GammaComment, type SearchResults, type PaginatedResponse, type MarketFilters, type EventPaginationFilters, type PaginationParams, type SearchParams } from 'polymarket-gamma';
+import { GammaMarket, type Event as GammaEvent, type Tag, type Team, type Sport, type Series, type Comment as GammaComment, type SearchResults, type PaginatedResponse, type MarketFilters, type EventPaginationFilters, type PaginationParams, type SearchParams } from '../gamma';
 import { ethers } from 'ethers';
 import type { PolymarketAPI, PolymarketClientOptions, PolymarketLimitOrderParams, PolymarketMarketOrderParams, PolymarketOrderResponse, PolymarketOpenOrder, PolymarketCancelResponse, PolymarketOrderBook, PolymarketApprovalResult, PolymarketMergeParams, PolymarketMergeResponse, PolymarketRedeemParams, PolymarketRedeemResponse, SignerAPI, ExtendedEventFilters } from '../types/osiris';
 import type { Logger } from '../utils/logger';
@@ -179,10 +179,12 @@ export declare class PolymarketClient implements PolymarketAPI {
     /**
      * Create limit order via Safe wallet using relay client
      * Orders are still submitted to CLOB, but approvals and execution use Safe
+     * Automatically ensures required approvals are in place before placing the order
      */
     private createLimitOrderViaSafe;
     /**
      * Create market order via Safe wallet using relay client
+     * Automatically ensures required approvals are in place before placing the order
      */
     private createMarketOrderViaSafe;
     /**

package/dist/gamma/client.d.ts

@@ -0,0 +1,180 @@
+/**
+ * Polymarket Gamma API Client
+ * TypeScript client for accessing Polymarket's prediction markets and events
+ */
+import type { Comment, Event, EventFilters, EventPaginationFilters, GammaMarket, MarketFilters, PaginatedResponse, PaginationParams, SearchParams, SearchResults, Series, Sport, Tag, Team } from './types';
+/**
+ * Configuration options for the Gamma client
+ */
+export interface GammaClientConfig {
+    baseUrl?: string;
+    timeout?: number;
+    fetch?: typeof fetch;
+    headers?: Record<string, string>;
+    enableCache?: boolean;
+}
+/**
+ * Polymarket Gamma API Client
+ * Provides methods to access prediction markets, events, tags, and related data
+ */
+export declare class PolymarketGammaClient {
+    private readonly baseUrl;
+    private readonly timeout;
+    private readonly fetchFn;
+    private readonly customHeaders;
+    private readonly enableCache;
+    private readonly requestCache;
+    /**
+     * Creates a new Polymarket Gamma API client
+     * @param config - Optional configuration
+     */
+    constructor(config?: GammaClientConfig);
+    /**
+     * Parse JSON string fields that the API returns as strings instead of arrays/objects
+     */
+    private parseJsonFields;
+    /**
+     * Validate API response to ensure it's a valid object
+     */
+    private validateResponse;
+    /**
+     * Internal method to make HTTP requests with deduplication
+     */
+    private request;
+    /**
+     * Perform the actual HTTP request
+     */
+    private doRequest;
+    /**
+     * Internal method to make POST requests
+     */
+    private post;
+    /**
+     * Search across events, tags, and profiles
+     * @param params - Search parameters
+     * @returns Search results
+     */
+    search(params: SearchParams): Promise<SearchResults>;
+    /**
+     * Get a market by ID or slug
+     * @param idOrSlug - Market ID or slug
+     * @returns Market details
+     */
+    getMarket(idOrSlug: string): Promise<GammaMarket>;
+    /**
+     * Get markets with optional filtering and pagination
+     * @param filters - Filter and pagination parameters
+     * @returns Array of markets
+     */
+    getMarkets(filters?: MarketFilters): Promise<GammaMarket[]>;
+    /**
+     * Get tags for a specific market
+     * @param marketId - Market ID
+     * @returns Array of tags
+     */
+    getMarketTags(marketId: string): Promise<Tag[]>;
+    /**
+     * Get an event by ID or slug
+     * @param idOrSlug - Event ID or slug
+     * @returns Event details
+     */
+    getEvent(idOrSlug: string): Promise<Event>;
+    /**
+     * Get events with optional filtering and pagination
+     * @param filters - Filter and pagination parameters
+     * @returns Array of events
+     */
+    getEvents(filters?: EventFilters): Promise<Event[]>;
+    /**
+     * Get tags for a specific event
+     * @param eventId - Event ID
+     * @returns Array of tags
+     */
+    getEventTags(eventId: string): Promise<Tag[]>;
+    /**
+     * Get events with pagination metadata
+     * @param filters - Filter and pagination parameters
+     * @returns Paginated response with events and metadata
+     */
+    getEventsPaginated(filters?: EventPaginationFilters): Promise<PaginatedResponse<Event>>;
+    /**
+     * Get all tags
+     * @param params - Optional pagination parameters
+     * @returns Array of tags
+     */
+    getTags(params?: PaginationParams): Promise<Tag[]>;
+    /**
+     * Get a specific tag by ID or slug
+     * @param idOrSlug - Tag ID or slug
+     * @returns Tag details
+     */
+    getTag(idOrSlug: string): Promise<Tag>;
+    /**
+     * Get related tags for a specific tag
+     * @param idOrSlug - Tag ID or slug
+     * @returns Array of related tags
+     */
+    getRelatedTags(idOrSlug: string): Promise<Tag[]>;
+    /**
+     * Get all tags related to a specific tag
+     * @param idOrSlug - Tag ID or slug
+     * @returns Array of tags
+     */
+    getRelatedTagsTags(idOrSlug: string): Promise<Tag[]>;
+    /**
+     * Get all teams
+     * @param params - Optional pagination parameters
+     * @returns Array of teams
+     */
+    getTeams(params?: PaginationParams): Promise<Team[]>;
+    /**
+     * Get all sports
+     * @param params - Optional pagination parameters
+     * @returns Array of sports
+     */
+    getSports(params?: PaginationParams): Promise<Sport[]>;
+    /**
+     * Get all series
+     * @param params - Optional pagination parameters
+     * @returns Array of series
+     */
+    getSeries(params?: PaginationParams): Promise<Series[]>;
+    /**
+     * Get a specific series by ID
+     * @param seriesId - Series ID
+     * @returns Series details
+     */
+    getSeriesById(seriesId: string): Promise<Series>;
+    /**
+     * Get comments with optional filtering
+     * @param params - Optional pagination and filter parameters
+     * @returns Array of comments
+     */
+    getComments(params?: PaginationParams): Promise<Comment[]>;
+    /**
+     * Get a specific comment by ID
+     * @param commentId - Comment ID
+     * @returns Comment details
+     */
+    getComment(commentId: string): Promise<Comment>;
+    /**
+     * Get comments by user address
+     * @param userAddress - User's Ethereum address
+     * @param params - Optional pagination parameters
+     * @returns Array of comments
+     */
+    getCommentsByUser(userAddress: string, params?: PaginationParams): Promise<Comment[]>;
+    /**
+     * Get Grok AI-powered event summary
+     * @param eventSlug - Event slug
+     * @returns Event summary text
+     */
+    grokEventSummary(eventSlug: string): Promise<string>;
+    /**
+     * Get Grok AI-powered election market explanation
+     * @param marketSlug - Market slug
+     * @returns Market explanation text
+     */
+    grokElectionMarketExplanation(marketSlug: string): Promise<string>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/gamma/index.d.ts

@@ -0,0 +1,3 @@
+export * from './client';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/gamma/types.d.ts

@@ -0,0 +1,339 @@
+/**
+ * TypeScript type definitions for Polymarket Gamma API
+ * Based on the Python Pydantic models from polymarket-apis
+ */
+/**
+ * Represents a prediction market on Polymarket
+ */
+export interface GammaMarket {
+    id?: string;
+    condition_id?: string;
+    question_id?: string;
+    slug?: string;
+    question?: string;
+    twitter_card_image?: string;
+    resolution_source?: string;
+    end_date?: string;
+    category?: string;
+    amm_type?: string;
+    liquidity?: number;
+    sponsor_name?: string;
+    sponsor_image?: string;
+    start_date?: string;
+    x_axis_value?: string;
+    y_axis_value?: string;
+    denomination_token?: string;
+    fee?: string;
+    image?: string;
+    icon?: string;
+    lower_bound?: string;
+    upper_bound?: string;
+    description?: string;
+    outcomes?: string[];
+    outcome_prices?: string[];
+    outcomePrices?: string[];
+    volume?: string;
+    active?: boolean;
+    market_type?: string;
+    format_type?: string;
+    lower_bound_date?: string;
+    upper_bound_date?: string;
+    closed?: boolean;
+    market_maker_address?: string;
+    created_by?: number;
+    updated_by?: number;
+    created_at?: string;
+    updated_at?: string;
+    closed_time?: string;
+    wide_format?: boolean;
+    new?: boolean;
+    mailchimp_tag?: string;
+    featured?: boolean;
+    archived?: boolean;
+    resolved_by?: string;
+    restricted?: boolean;
+    market_group?: number;
+    group_item_title?: string;
+    group_item_threshold?: string;
+    uma_end_date?: string;
+    seconds_delay?: number;
+    notification_policy?: number;
+    pager_duty_notification_enabled?: boolean;
+    reward_pool?: number;
+    reward_epoch?: number;
+    reward_multiplier?: number;
+    reward_min_size?: number;
+    reward_max_spread?: number;
+    ready?: boolean;
+    enable_order_book?: boolean;
+    notification_type?: string;
+    uma_reward?: string;
+    uma_resolution_statuses?: string[];
+    umaResolutionStatuses?: string[];
+    question_title?: string;
+    enable_ask?: boolean;
+    notifications?: number[];
+    events?: Event[];
+    markets?: GammaMarket[];
+    clob_token_ids?: string[];
+    clobTokenIds?: string[];
+    clobRewards?: ClobReward[];
+    tags?: Tag[];
+    cyom?: boolean;
+    competitive?: number;
+    neg_risk?: boolean;
+    neg_risk_market_id?: string;
+    neg_risk_request_id?: string;
+    accepting_orders?: boolean;
+    accepting_order_timestamp?: string;
+    minimum_order_size?: number;
+    minimum_tick_size?: number;
+    taker_fee_bps?: number;
+    maker_fee_bps?: number;
+    minimum_tick_size_usd?: number;
+    maker_base_fee?: number;
+    taker_base_fee?: number;
+    best_bid?: string;
+    best_ask?: string;
+    spread?: number;
+    spread_percent?: number;
+    volume_24hr?: string;
+    volume_num_trades_24hr?: number;
+    last_trade_price?: string;
+    last_trade_time?: string;
+    open_interest?: string;
+    rewards_daily_rate?: number;
+    rewards_min_size?: number;
+    rewards_max_spread?: number;
+    seconds_delay_requested?: number;
+    auto_update_schema?: boolean;
+    active_trading_prompt?: boolean;
+}
+/**
+ * Represents an event that contains one or more markets
+ */
+export interface Event {
+    id?: string;
+    slug?: string;
+    title?: string;
+    description?: string;
+    start_date?: string;
+    end_date?: string;
+    image?: string;
+    icon?: string;
+    created_at?: string;
+    updated_at?: string;
+    archived?: boolean;
+    active?: boolean;
+    closed?: boolean;
+    restricted?: boolean;
+    liquidity?: number;
+    volume?: string;
+    markets?: GammaMarket[];
+    tags?: Tag[];
+    categories?: Category[];
+    series?: Series[];
+    comment_count?: number;
+    enable_comment?: boolean;
+    ticker?: string;
+}
+/**
+ * Represents a series or tournament of related events
+ */
+export interface Series {
+    id?: string;
+    slug?: string;
+    title?: string;
+    description?: string;
+    image?: string;
+    created_at?: string;
+    updated_at?: string;
+    events?: Event[];
+    categories?: Category[];
+}
+/**
+ * Represents a category for organizing markets and events
+ */
+export interface Category {
+    id?: string;
+    label?: string;
+    slug?: string;
+}
+/**
+ * Represents a tag for organizing and filtering content
+ */
+export interface Tag {
+    id?: string;
+    label?: string;
+    slug?: string;
+    description?: string;
+    event_count?: number;
+    market_count?: number;
+    parent_id?: string;
+    children?: Tag[];
+}
+/**
+ * Represents a user profile
+ */
+export interface Profile {
+    id?: string;
+    name?: string;
+    username?: string;
+    avatar_url?: string;
+    bio?: string;
+}
+/**
+ * Represents a comment on a market or event
+ */
+export interface Comment {
+    id?: string;
+    market_id?: string;
+    event_id?: string;
+    user?: Profile;
+    content?: string;
+    created_at?: string;
+    updated_at?: string;
+    parent_id?: string;
+    reactions?: Reaction[];
+    reply_count?: number;
+}
+/**
+ * Represents a reaction to a comment
+ */
+export interface Reaction {
+    id?: string;
+    comment_id?: string;
+    user?: Profile;
+    type?: string;
+    created_at?: string;
+}
+/**
+ * Represents a sports team
+ */
+export interface Team {
+    id?: string;
+    name?: string;
+    short_name?: string;
+    abbreviation?: string;
+    logo?: string;
+    sport_id?: string;
+    sport?: Sport;
+}
+/**
+ * Represents a sport
+ */
+export interface Sport {
+    id?: string;
+    name?: string;
+    slug?: string;
+}
+/**
+ * Represents a CLOB (Central Limit Order Book) reward
+ */
+export interface ClobReward {
+    id?: string;
+    market_id?: string;
+    event_id?: string;
+    reward_epoch?: number;
+    asset_address?: string;
+    reward_amount?: string;
+    start_date?: string;
+    end_date?: string;
+}
+/**
+ * Represents a collection of markets
+ */
+export interface Collection {
+    id?: string;
+    title?: string;
+    slug?: string;
+    description?: string;
+    markets?: GammaMarket[];
+}
+/**
+ * Represents a market creator
+ */
+export interface Creator {
+    id?: string;
+    name?: string;
+    avatar_url?: string;
+}
+/**
+ * Search results wrapper
+ */
+export interface SearchResults {
+    events?: Event[];
+    tags?: Tag[];
+    profiles?: Profile[];
+}
+/**
+ * Pagination parameters for list queries
+ */
+export interface PaginationParams {
+    limit?: number;
+    offset?: number;
+    [key: string]: unknown;
+}
+/**
+ * Filter parameters for markets
+ */
+export interface MarketFilters extends PaginationParams {
+    active?: boolean;
+    closed?: boolean;
+    archived?: boolean;
+    featured?: boolean;
+    restricted?: boolean;
+    tags?: string[];
+    category?: string;
+    event_id?: string;
+    order_by?: string;
+    ascending?: boolean;
+}
+/**
+ * Filter parameters for events
+ */
+export interface EventFilters extends PaginationParams {
+    active?: boolean;
+    closed?: boolean;
+    archived?: boolean;
+    restricted?: boolean;
+    tags?: string[];
+    category?: string;
+    series_id?: string;
+    order_by?: string;
+    ascending?: boolean;
+}
+/**
+ * Search parameters
+ */
+export interface SearchParams {
+    query: string;
+    limit?: number;
+    offset?: number;
+    [key: string]: unknown;
+}
+/**
+ * Pagination metadata
+ */
+export interface PaginationMetadata {
+    hasMore: boolean;
+    totalResults: number;
+}
+/**
+ * Paginated response wrapper
+ */
+export interface PaginatedResponse<T> {
+    data: T[];
+    pagination: PaginationMetadata;
+}
+/**
+ * Pagination filter parameters for events
+ */
+export interface EventPaginationFilters extends PaginationParams {
+    active?: boolean;
+    closed?: boolean;
+    archived?: boolean;
+    order?: string;
+    ascending?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map