@catalyst-team/poly-sdk 0.1.0

package/src/mcp/types.ts

@@ -0,0 +1,472 @@
+/**
+ * MCP Tool Types for Polymarket
+ */
+
+// Tool Input Types
+export interface GetTraderPositionsInput {
+  address: string;
+}
+
+export interface GetTraderTradesInput {
+  address: string;
+  limit?: number;
+  side?: 'BUY' | 'SELL';
+}
+
+export interface GetTraderProfileInput {
+  address: string;
+}
+
+export interface GetLeaderboardInput {
+  limit?: number;
+  offset?: number;
+}
+
+export interface GetMarketInput {
+  identifier: string;
+}
+
+export interface SearchMarketsInput {
+  query: string;
+  active?: boolean;
+  limit?: number;
+}
+
+export interface GetTrendingMarketsInput {
+  limit?: number;
+  sortBy?: 'volume' | 'liquidity' | 'newest';
+}
+
+export interface GetMarketTradesInput {
+  conditionId: string;
+  limit?: number;
+}
+
+export interface GetOrderbookInput {
+  conditionId: string;
+  outcome: 'Yes' | 'No';
+  depth?: number;
+}
+
+export interface GetBestPricesInput {
+  conditionId: string;
+}
+
+export interface EstimateExecutionInput {
+  conditionId: string;
+  outcome: 'Yes' | 'No';
+  side: 'BUY' | 'SELL';
+  amount: number;
+}
+
+export interface PlaceLimitOrderInput {
+  conditionId: string;
+  outcome: 'Yes' | 'No';
+  side: 'BUY' | 'SELL';
+  price: number;
+  size: number;
+  orderType?: 'GTC' | 'GTD';
+}
+
+export interface PlaceMarketOrderInput {
+  conditionId: string;
+  outcome: 'Yes' | 'No';
+  side: 'BUY' | 'SELL';
+  amount: number;
+  maxSlippage?: number;
+}
+
+export interface CancelOrderInput {
+  orderId: string;
+}
+
+export interface GetMyOrdersInput {
+  status?: 'LIVE' | 'FILLED' | 'CANCELLED';
+}
+
+// Tool Output Types
+export interface TraderInfo {
+  address: string;
+  displayName: string | null;
+}
+
+export interface MarketInfo {
+  conditionId: string;
+  title: string;
+  slug?: string;
+}
+
+export interface PositionHolding {
+  outcome: string;
+  size: number;
+  avgPrice: number;
+  curPrice?: number;
+}
+
+export interface PositionPnL {
+  unrealized?: number;
+  unrealizedPercent?: number;
+  realized?: number;
+}
+
+export interface PositionStatus {
+  redeemable?: boolean;
+  endDate?: string;
+}
+
+export interface PositionOutput {
+  market: MarketInfo;
+  holding: PositionHolding;
+  pnl: PositionPnL;
+  status: PositionStatus;
+}
+
+export interface GetTraderPositionsOutput {
+  trader: TraderInfo;
+  positions: PositionOutput[];
+  summary: {
+    totalPositions: number;
+    totalUnrealizedPnl: number;
+    totalRealizedPnl: number;
+    winningPositions: number;
+    losingPositions: number;
+  };
+}
+
+export interface TradeExecution {
+  size: number;
+  price: number;
+  usdcValue: number;
+}
+
+export interface TradeOutput {
+  type: string;
+  side: 'BUY' | 'SELL';
+  market: MarketInfo;
+  outcome: string;
+  execution: TradeExecution;
+  timestamp: string;
+  txHash: string;
+}
+
+export interface GetTraderTradesOutput {
+  trader: TraderInfo;
+  trades: TradeOutput[];
+  summary: {
+    totalTrades: number;
+    buyCount: number;
+    sellCount: number;
+    buyVolume: number;
+    sellVolume: number;
+  };
+}
+
+export interface GetTraderProfileOutput {
+  trader: {
+    address: string;
+    displayName: string | null;
+    xUsername: string | null;
+    verified: boolean;
+    profileImage: string | null;
+  };
+  ranking: {
+    rank: number | null;
+    totalTraders: number;
+  };
+  performance: {
+    officialPnl: number | null;
+    totalVolume: number;
+    unrealizedPnl: number;
+    realizedPnl: number;
+  };
+  stats: {
+    positionCount: number;
+    winRate: number;
+    avgPercentPnl: number;
+    smartScore: number;
+  };
+  activity: {
+    lastTradeAt: string | null;
+    isActive: boolean;
+  };
+  /** Explanation when PnL values differ between sources */
+  notes?: string;
+}
+
+export interface LeaderboardTrader {
+  rank: number;
+  address: string;
+  displayName: string | null;
+  pnl: number;
+  volume: number;
+  verified: boolean;
+}
+
+export interface GetLeaderboardOutput {
+  traders: LeaderboardTrader[];
+  pagination: {
+    total: number;
+    offset: number;
+    limit: number;
+  };
+}
+
+export interface TokenInfo {
+  tokenId: string;
+  price: number;
+}
+
+export interface GetMarketOutput {
+  market: {
+    conditionId: string;
+    question: string;
+    slug: string;
+    description?: string;
+  };
+  prices: {
+    yes: number;
+    no: number;
+    spread?: number;
+  };
+  tokens: {
+    yes: TokenInfo;
+    no: TokenInfo;
+  };
+  stats: {
+    volume: number;
+    liquidity: number;
+  };
+  status: {
+    active: boolean;
+    closed: boolean;
+    acceptingOrders: boolean;
+    endDate?: string;
+  };
+  trading: {
+    minTickSize?: number;
+    minOrderSize?: number;
+  };
+}
+
+export interface SearchMarketResult {
+  conditionId: string;
+  question: string;
+  slug: string;
+  prices: { yes: number; no: number };
+  volume: number;
+  volume24h?: number;
+  endDate?: string;
+}
+
+export interface SearchMarketsOutput {
+  markets: SearchMarketResult[];
+  total: number;
+}
+
+export interface TrendingMarket {
+  conditionId: string;
+  question: string;
+  slug: string;
+  volume24h?: number;
+  priceChange24h?: number;
+  prices: { yes: number; no: number };
+  status?: {
+    active: boolean;
+    closed: boolean;
+    endDate?: string;
+  };
+}
+
+export interface GetTrendingMarketsOutput {
+  markets: TrendingMarket[];
+}
+
+export interface MarketTradeOutput {
+  trader: string;
+  traderName?: string;
+  side: 'BUY' | 'SELL';
+  outcome: string;
+  size: number;
+  price: number;
+  timestamp: string;
+}
+
+export interface GetMarketTradesOutput {
+  market: MarketInfo;
+  trades: MarketTradeOutput[];
+  summary: {
+    buyVolume24h: number;
+    sellVolume24h: number;
+    netFlow: number;
+  };
+}
+
+export interface OrderbookLevel {
+  price: number;
+  size: number;
+  total: number;
+}
+
+export interface GetOrderbookOutput {
+  market: MarketInfo;
+  outcome: string;
+  tokenId: string;
+  orderbook: {
+    bids: OrderbookLevel[];
+    asks: OrderbookLevel[];
+  };
+  summary: {
+    bestBid: number;
+    bestAsk: number;
+    spread: number;
+    spreadPercent: number;
+    bidDepth: number;
+    askDepth: number;
+  };
+}
+
+export interface PriceInfo {
+  bestBid: number;
+  bestAsk: number;
+  midPrice: number;
+  spread: number;
+}
+
+export interface GetBestPricesOutput {
+  market: string;
+  yes: PriceInfo;
+  no: PriceInfo;
+}
+
+export interface EstimateExecutionOutput {
+  market: string;
+  order: {
+    side: 'BUY' | 'SELL';
+    outcome: string;
+    usdcAmount: number;
+  };
+  estimate: {
+    avgPrice: number;
+    sharesReceived: number;
+    priceImpact: number;
+    worstPrice: number;
+  };
+  warning: string | null;
+}
+
+// ===== Wallet Tool Types =====
+
+// Deposit Input/Output
+export interface GetSupportedAssetsInput {
+  chainId?: number;
+}
+
+export interface SupportedAsset {
+  chainId: number;
+  chainName: string;
+  tokenSymbol: string;
+  tokenName: string;
+  tokenAddress: string;
+  decimals: number;
+  minDeposit: string;
+  minDepositUsd: number;
+}
+
+export interface GetSupportedAssetsOutput {
+  assets: SupportedAsset[];
+  summary: {
+    totalChains: number;
+    totalAssets: number;
+    chains: string[];
+  };
+}
+
+export interface GetDepositAddressesInput {
+  // Uses wallet from SDK
+}
+
+export interface GetDepositAddressesOutput {
+  wallet: string;
+  addresses: {
+    evm: string;
+    solana: string;
+    bitcoin: string;
+  };
+  evmChains: string[];
+  instructions: string;
+}
+
+// Allowance Input/Output
+export interface CheckAllowancesInput {
+  // Uses wallet from SDK
+}
+
+export interface AllowanceStatus {
+  contract: string;
+  address: string;
+  approved: boolean;
+  allowance?: string;
+}
+
+export interface CheckAllowancesOutput {
+  wallet: string;
+  erc20: {
+    usdc: {
+      balance: string;
+      allowances: AllowanceStatus[];
+    };
+  };
+  erc1155: {
+    conditionalTokens: {
+      approvals: AllowanceStatus[];
+    };
+  };
+  tradingReady: boolean;
+  issues: string[];
+}
+
+export interface ApproveTradingInput {
+  // Uses wallet from SDK
+}
+
+export interface ApprovalResult {
+  contract: string;
+  txHash?: string;
+  success: boolean;
+  error?: string;
+}
+
+export interface ApproveTradingOutput {
+  wallet: string;
+  erc20Approvals: ApprovalResult[];
+  erc1155Approvals: ApprovalResult[];
+  allApproved: boolean;
+  summary: string;
+}
+
+// Error Types
+export interface McpErrorResponse {
+  error: {
+    code: string;
+    message: string;
+    details?: Record<string, unknown>;
+  };
+}
+
+export type McpToolResult<T> = T | McpErrorResponse;
+
+// Tool Definition Type
+export interface ToolDefinition {
+  name: string;
+  description: string;
+  inputSchema: {
+    type: 'object';
+    properties: Record<string, {
+      type: string;
+      description?: string;
+      enum?: string[];
+      default?: unknown;
+    }>;
+    required?: string[];
+  };
+}