polymarket-helper 1.0.3

package/README.md

@@ -0,0 +1,125 @@
+# Prediction SDK
+
+SDK for prediction market trading including Polymarket, Kalshi, Limitless, and more.
+
+## 安装
+
+```bash
+npm install prediction-sdk
+```
+
+## 使用教程
+
+### Polymarket
+
+#### 1. 初始化客户端
+
+```typescript
+import Polymarket from 'prediction-sdk'
+
+const polymarket = new Polymarket({
+  rpcUrl: 'https://polygon-rpc.com',  // Polygon RPC 端点
+  privateKey: '0x...',                 // 你的私钥
+})
+```
+
+#### 2. 创建客户端连接
+
+```typescript
+await polymarket.createClient()
+```
+
+#### 3. 授权交易（首次使用需要）
+
+在交易前，需要授权 Polymarket 交易所管理你的代币：
+
+```typescript
+// 检查是否已授权
+const isApproved = await polymarket.isApproved()
+
+if (!isApproved) {
+  // 授权交易所管理所有代币
+  await polymarket.approvalAll()
+}
+```
+
+#### 4. 提交订单
+
+```typescript
+import { UserMarketOrder } from '@polymarket/clob-client'
+
+const order: UserMarketOrder = {
+  market: '0x...',           // 市场合约地址
+  side: 'YES',               // 'YES' 或 'NO'
+  size: '1000000000',        // 订单数量（原始单位）
+  price: '0.5',              // 价格（0-1之间）
+}
+
+await polymarket.postOrder(order)
+```
+
+#### 完整示例
+
+```typescript
+import Polymarket from 'prediction-sdk'
+
+async function trade() {
+  // 1. 初始化
+  const polymarket = new Polymarket({
+    rpcUrl: 'https://polygon-rpc.com',
+    privateKey: process.env.PRIVATE_KEY!,
+  })
+
+  // 2. 创建客户端
+  await polymarket.createClient()
+
+  // 3. 检查并授权
+  if (!(await polymarket.isApproved())) {
+    await polymarket.approvalAll()
+  }
+
+  // 4. 提交订单
+  await polymarket.postOrder({
+    market: '0x...',
+    side: 'YES',
+    size: '1000000000',
+    price: '0.5',
+  })
+}
+```
+
+### 工具函数
+
+#### 格式化金额
+
+```typescript
+import { formatClobAmount } from 'prediction-sdk'
+
+// 将原始金额转换为可读格式
+const amount = formatClobAmount('1000000', 6)  // "1.0" (USDC)
+```
+
+#### 检查是否为 Gnosis Safe
+
+```typescript
+import { isGnosisSafe } from 'prediction-sdk'
+
+const isSafe = await isGnosisSafe('0x...', 'https://polygon-rpc.com')
+```
+
+## 开发
+
+```bash
+# 安装依赖
+bun install
+
+# 构建
+bun run build
+
+# 开发模式（监听文件变化）
+bun run dev
+```
+
+## License
+
+ISC

package/dist/index.d.mts

@@ -0,0 +1,146 @@
+import { ClobClient, UserMarketOrder, CreateOrderOptions } from '@polymarket/clob-client';
+
+/**
+ * Type definitions for prediction market platforms
+ *
+ * This module contains TypeScript interfaces and types used across
+ * the prediction SDK for various market platforms.
+ */
+/**
+ * Configuration options for Polymarket client initialization
+ *
+ * @interface PolymarketOptions
+ * @property {string} rpcUrl - Polygon RPC endpoint URL for blockchain interactions
+ * @property {string} privateKey - Private key of the wallet to use for signing transactions
+ * @property {string} [cLobHttpUrl] - Optional CLOB API endpoint URL (defaults to https://clob.polymarket.com)
+ */
+interface PolymarketOptions {
+    /** Polygon RPC endpoint URL for blockchain interactions */
+    rpcUrl: string;
+    /** Private key of the wallet to use for signing transactions */
+    privateKey: string;
+    /** Optional CLOB API endpoint URL (defaults to https://clob.polymarket.com) */
+    cLobHttpUrl?: string;
+}
+
+/**
+ * Polymarket integration module
+ *
+ * This module provides a client for interacting with Polymarket,
+ * a decentralized prediction market platform built on Polygon.
+ *
+ * Features:
+ * - Create and post market orders
+ * - Manage token approvals for trading
+ * - Support for both EOA and Gnosis Safe wallets
+ */
+
+/**
+ * Conditional Token Framework contract address for Polygon
+ * This contract is used to manage conditional tokens (market shares)
+ */
+declare const CTFContract: string;
+/**
+ * Polymarket client class
+ *
+ * Provides methods to interact with Polymarket prediction markets,
+ * including creating orders, managing approvals, and handling transactions.
+ *
+ * @example
+ * ```typescript
+ * const polymarket = new Polymarket({
+ *   rpcUrl: "https://polygon-rpc.com",
+ *   privateKey: "0x...",
+ * });
+ *
+ * await polymarket.createClient();
+ * await polymarket.approvalAll();
+ * await polymarket.postOrder(order);
+ * ```
+ */
+declare class Polymarket {
+    /** Configuration options for the Polymarket client */
+    private options;
+    /** Ethers.js provider for blockchain interactions */
+    private provider;
+    /** Wallet signer for transaction signing */
+    private signer;
+    /** CLOB signer for Polymarket SDK (ethers v5) */
+    private clobSigner;
+    /** Conditional Token Framework contract instance */
+    private ctfContract;
+    /** Polymarket CLOB client instance */
+    private client;
+    /** ClobClient signer type (ethers v5 compatibility) */
+    private getClobSigner;
+    /**
+     * Creates a new Polymarket client instance
+     *
+     * @param options - Configuration options including RPC URL and private key
+     * @throws {Error} If the private key or RPC URL is invalid
+     */
+    constructor(options: PolymarketOptions);
+    /**
+     * Creates and initializes the CLOB client
+     *
+     * Automatically detects if the wallet is a Gnosis Safe proxy or EOA,
+     * and configures the appropriate signature type.
+     *
+     * @returns {Promise<ClobClient>} The initialized CLOB client
+     * @throws {Error} If client creation fails
+     */
+    createClient(): Promise<ClobClient>;
+    /**
+     * Posts a market order to Polymarket
+     *
+     * Creates a signed market order and submits it to the order book
+     * using Fill-or-Kill (FOK) order type.
+     *
+     * @param {UserMarketOrder} userMarketOrder - The market order to post
+     * @param {Partial<CreateOrderOptions>} [options] - Optional order creation options
+     * @returns {Promise<void>} Promise that resolves when the order is posted
+     * @throws {Error} If order creation or posting fails
+     *
+     * @example
+     * ```typescript
+     * await polymarket.postOrder({
+     *   market: "0x...",
+     *   side: "YES",
+     *   size: "1000000000",
+     *   price: "0.5"
+     * });
+     * ```
+     */
+    postOrder(userMarketOrder: UserMarketOrder, options?: Partial<CreateOrderOptions>): Promise<void>;
+    /**
+     * Checks if the exchange contract is approved to manage tokens
+     *
+     * This checks if setApprovalForAll has been called for the Polymarket
+     * exchange contract, which is required before trading.
+     *
+     * @returns {Promise<boolean>} True if approved, false otherwise
+     */
+    isApproved(): Promise<boolean>;
+    /**
+     * Approves the Polymarket exchange to manage all tokens
+     *
+     * This is a one-time operation that allows the exchange contract
+     * to transfer conditional tokens on your behalf. Required before trading.
+     *
+     * Uses a 50% gas price buffer to ensure transaction confirmation.
+     *
+     * @returns {Promise<boolean>} True if approval succeeds
+     * @throws {Error} If the approval transaction fails or is not confirmed
+     *
+     * @example
+     * ```typescript
+     * const isApproved = await polymarket.isApproved();
+     * if (!isApproved) {
+     *   await polymarket.approvalAll();
+     * }
+     * ```
+     */
+    approvalAll(): Promise<boolean>;
+}
+
+export { CTFContract, Polymarket as default };

package/dist/index.d.ts

@@ -0,0 +1,146 @@
+import { ClobClient, UserMarketOrder, CreateOrderOptions } from '@polymarket/clob-client';
+
+/**
+ * Type definitions for prediction market platforms
+ *
+ * This module contains TypeScript interfaces and types used across
+ * the prediction SDK for various market platforms.
+ */
+/**
+ * Configuration options for Polymarket client initialization
+ *
+ * @interface PolymarketOptions
+ * @property {string} rpcUrl - Polygon RPC endpoint URL for blockchain interactions
+ * @property {string} privateKey - Private key of the wallet to use for signing transactions
+ * @property {string} [cLobHttpUrl] - Optional CLOB API endpoint URL (defaults to https://clob.polymarket.com)
+ */
+interface PolymarketOptions {
+    /** Polygon RPC endpoint URL for blockchain interactions */
+    rpcUrl: string;
+    /** Private key of the wallet to use for signing transactions */
+    privateKey: string;
+    /** Optional CLOB API endpoint URL (defaults to https://clob.polymarket.com) */
+    cLobHttpUrl?: string;
+}
+
+/**
+ * Polymarket integration module
+ *
+ * This module provides a client for interacting with Polymarket,
+ * a decentralized prediction market platform built on Polygon.
+ *
+ * Features:
+ * - Create and post market orders
+ * - Manage token approvals for trading
+ * - Support for both EOA and Gnosis Safe wallets
+ */
+
+/**
+ * Conditional Token Framework contract address for Polygon
+ * This contract is used to manage conditional tokens (market shares)
+ */
+declare const CTFContract: string;
+/**
+ * Polymarket client class
+ *
+ * Provides methods to interact with Polymarket prediction markets,
+ * including creating orders, managing approvals, and handling transactions.
+ *
+ * @example
+ * ```typescript
+ * const polymarket = new Polymarket({
+ *   rpcUrl: "https://polygon-rpc.com",
+ *   privateKey: "0x...",
+ * });
+ *
+ * await polymarket.createClient();
+ * await polymarket.approvalAll();
+ * await polymarket.postOrder(order);
+ * ```
+ */
+declare class Polymarket {
+    /** Configuration options for the Polymarket client */
+    private options;
+    /** Ethers.js provider for blockchain interactions */
+    private provider;
+    /** Wallet signer for transaction signing */
+    private signer;
+    /** CLOB signer for Polymarket SDK (ethers v5) */
+    private clobSigner;
+    /** Conditional Token Framework contract instance */
+    private ctfContract;
+    /** Polymarket CLOB client instance */
+    private client;
+    /** ClobClient signer type (ethers v5 compatibility) */
+    private getClobSigner;
+    /**
+     * Creates a new Polymarket client instance
+     *
+     * @param options - Configuration options including RPC URL and private key
+     * @throws {Error} If the private key or RPC URL is invalid
+     */
+    constructor(options: PolymarketOptions);
+    /**
+     * Creates and initializes the CLOB client
+     *
+     * Automatically detects if the wallet is a Gnosis Safe proxy or EOA,
+     * and configures the appropriate signature type.
+     *
+     * @returns {Promise<ClobClient>} The initialized CLOB client
+     * @throws {Error} If client creation fails
+     */
+    createClient(): Promise<ClobClient>;
+    /**
+     * Posts a market order to Polymarket
+     *
+     * Creates a signed market order and submits it to the order book
+     * using Fill-or-Kill (FOK) order type.
+     *
+     * @param {UserMarketOrder} userMarketOrder - The market order to post
+     * @param {Partial<CreateOrderOptions>} [options] - Optional order creation options
+     * @returns {Promise<void>} Promise that resolves when the order is posted
+     * @throws {Error} If order creation or posting fails
+     *
+     * @example
+     * ```typescript
+     * await polymarket.postOrder({
+     *   market: "0x...",
+     *   side: "YES",
+     *   size: "1000000000",
+     *   price: "0.5"
+     * });
+     * ```
+     */
+    postOrder(userMarketOrder: UserMarketOrder, options?: Partial<CreateOrderOptions>): Promise<void>;
+    /**
+     * Checks if the exchange contract is approved to manage tokens
+     *
+     * This checks if setApprovalForAll has been called for the Polymarket
+     * exchange contract, which is required before trading.
+     *
+     * @returns {Promise<boolean>} True if approved, false otherwise
+     */
+    isApproved(): Promise<boolean>;
+    /**
+     * Approves the Polymarket exchange to manage all tokens
+     *
+     * This is a one-time operation that allows the exchange contract
+     * to transfer conditional tokens on your behalf. Required before trading.
+     *
+     * Uses a 50% gas price buffer to ensure transaction confirmation.
+     *
+     * @returns {Promise<boolean>} True if approval succeeds
+     * @throws {Error} If the approval transaction fails or is not confirmed
+     *
+     * @example
+     * ```typescript
+     * const isApproved = await polymarket.isApproved();
+     * if (!isApproved) {
+     *   await polymarket.approvalAll();
+     * }
+     * ```
+     */
+    approvalAll(): Promise<boolean>;
+}
+
+export { CTFContract, Polymarket as default };