@catalyst-team/poly-sdk 0.2.1 → 0.3.0

package/dist/services/onchain-service.d.ts

@@ -0,0 +1,309 @@
+/**
+ * OnchainService - Unified interface for all on-chain operations
+ *
+ * Consolidates:
+ * - CTF operations (split, merge, redeem)
+ * - Authorization (ERC20/ERC1155 approvals)
+ * - Swaps (QuickSwap V3)
+ *
+ * This service provides a single entry point for all blockchain interactions
+ * required for Polymarket trading. It shares wallet/provider configuration
+ * across all underlying services.
+ *
+ * @example
+ * ```typescript
+ * const onchain = new OnchainService({
+ *   privateKey: '0x...',
+ *   rpcUrl: 'https://polygon-rpc.com', // optional
+ * });
+ *
+ * // Check if ready for trading
+ * const status = await onchain.checkReadyForCTF('100');
+ * if (!status.ready) {
+ *   // Set up approvals
+ *   await onchain.approveAll();
+ * }
+ *
+ * // Execute CTF operations
+ * await onchain.split(conditionId, '100');
+ * await onchain.merge(conditionId, '100');
+ *
+ * // Swap tokens
+ * await onchain.swap('MATIC', 'USDC_E', '10');
+ * ```
+ */
+import { ethers } from 'ethers';
+import { CTFClient, type SplitResult, type MergeResult, type RedeemResult, type PositionBalance, type MarketResolution, type GasEstimate, type TransactionStatus, type TokenIds } from '../clients/ctf-client.js';
+import { AuthorizationService, type AllowancesResult, type ApprovalsResult, type ApprovalTxResult } from './authorization-service.js';
+import { SwapService, type SwapQuote, type SwapResult, type TokenBalance, type TransferResult, type QuoteResult, type PoolInfo } from './swap-service.js';
+export interface OnchainServiceConfig {
+    /** Private key for signing transactions */
+    privateKey: string;
+    /** RPC URL (default: Polygon mainnet) */
+    rpcUrl?: string;
+    /** Chain ID (default: 137 for Polygon) */
+    chainId?: number;
+    /** Gas price multiplier for CTF operations (default: 1.2) */
+    gasPriceMultiplier?: number;
+    /** Transaction confirmation blocks (default: 1) */
+    confirmations?: number;
+    /** Transaction timeout in ms (default: 60000) */
+    txTimeout?: number;
+}
+export interface ReadyStatus {
+    ready: boolean;
+    usdcEBalance: string;
+    nativeUsdcBalance: string;
+    maticBalance: string;
+    tradingReady: boolean;
+    issues: string[];
+    suggestion?: string;
+}
+export interface TokenBalances {
+    matic: string;
+    usdc: string;
+    usdcE: string;
+    usdt: string;
+    dai: string;
+    weth: string;
+    wmatic: string;
+}
+export type { SplitResult, MergeResult, RedeemResult, PositionBalance, MarketResolution, GasEstimate, TransactionStatus, TokenIds, AllowancesResult, ApprovalsResult, ApprovalTxResult, SwapQuote, SwapResult, TokenBalance, TransferResult, QuoteResult, PoolInfo, };
+/**
+ * Unified service for all on-chain operations on Polymarket
+ *
+ * This service wraps:
+ * - CTFClient: Conditional Token Framework operations (split, merge, redeem)
+ * - AuthorizationService: ERC20 and ERC1155 approvals
+ * - SwapService: DEX swaps on Polygon via QuickSwap V3
+ *
+ * All services share the same wallet and provider configuration.
+ */
+export declare class OnchainService {
+    private wallet;
+    private provider;
+    private ctfClient;
+    private authService;
+    private swapService;
+    constructor(config: OnchainServiceConfig);
+    /**
+     * Get the wallet address
+     */
+    getAddress(): string;
+    /**
+     * Get native MATIC balance
+     */
+    getMaticBalance(): Promise<string>;
+    /**
+     * Get all token balances
+     */
+    getTokenBalances(): Promise<TokenBalances>;
+    /**
+     * Check all ERC20 and ERC1155 allowances required for trading
+     *
+     * @returns Status of all allowances and whether trading is ready
+     */
+    checkAllowances(): Promise<AllowancesResult>;
+    /**
+     * Set up all required approvals for trading
+     *
+     * @returns Results of all approval transactions
+     */
+    approveAll(): Promise<ApprovalsResult>;
+    /**
+     * Approve USDC spending for a specific contract
+     */
+    approveUsdc(spenderAddress: string, amount?: ethers.BigNumber): Promise<ApprovalTxResult>;
+    /**
+     * Set approval for an ERC1155 operator
+     */
+    setErc1155Approval(operatorAddress: string, approved?: boolean): Promise<ApprovalTxResult>;
+    /**
+     * Split USDC into YES + NO tokens
+     *
+     * @param conditionId - Market condition ID
+     * @param amount - USDC amount (e.g., "100" for 100 USDC)
+     * @returns SplitResult with transaction details
+     */
+    split(conditionId: string, amount: string): Promise<SplitResult>;
+    /**
+     * Merge YES + NO tokens back to USDC
+     *
+     * @param conditionId - Market condition ID
+     * @param amount - Number of token pairs to merge
+     * @returns MergeResult with transaction details
+     */
+    merge(conditionId: string, amount: string): Promise<MergeResult>;
+    /**
+     * Merge YES and NO tokens using explicit token IDs
+     *
+     * Use this for Polymarket CLOB markets where token IDs
+     * don't match the calculated position IDs.
+     */
+    mergeByTokenIds(conditionId: string, tokenIds: TokenIds, amount: string): Promise<MergeResult>;
+    /**
+     * Redeem winning tokens after market resolution (Standard CTF)
+     *
+     * WARNING: Use redeemByTokenIds for Polymarket CLOB markets.
+     */
+    redeem(conditionId: string, outcome?: 'YES' | 'NO'): Promise<RedeemResult>;
+    /**
+     * Redeem winning tokens using Polymarket token IDs (Polymarket CLOB)
+     *
+     * This is the correct method for Polymarket CLOB markets.
+     */
+    redeemByTokenIds(conditionId: string, tokenIds: TokenIds, outcome?: 'YES' | 'NO'): Promise<RedeemResult>;
+    /**
+     * Get USDC.e (bridged USDC) balance - the token used by Polymarket CTF
+     */
+    getUsdcBalance(): Promise<string>;
+    /**
+     * Get native USDC balance (not compatible with CTF)
+     */
+    getNativeUsdcBalance(): Promise<string>;
+    /**
+     * Get token balances for a market using calculated position IDs
+     *
+     * @deprecated Use getPositionBalanceByTokenIds for CLOB markets
+     */
+    getPositionBalance(conditionId: string): Promise<PositionBalance>;
+    /**
+     * Get token balances using CLOB API token IDs
+     *
+     * This is the recommended method for checking balances when working with
+     * Polymarket CLOB markets.
+     */
+    getPositionBalanceByTokenIds(conditionId: string, tokenIds: TokenIds): Promise<PositionBalance>;
+    /**
+     * Check if wallet is ready for CTF trading operations
+     *
+     * Combines CTF readiness check with authorization status.
+     */
+    checkReadyForCTF(amount: string): Promise<ReadyStatus>;
+    /**
+     * Check if wallet has sufficient tokens for merge
+     */
+    canMerge(conditionId: string, amount: string): Promise<{
+        canMerge: boolean;
+        reason?: string;
+    }>;
+    /**
+     * Check if wallet has sufficient tokens for merge using CLOB token IDs
+     */
+    canMergeWithTokenIds(conditionId: string, tokenIds: TokenIds, amount: string): Promise<{
+        canMerge: boolean;
+        reason?: string;
+    }>;
+    /**
+     * Check if wallet has sufficient USDC for split
+     */
+    canSplit(amount: string): Promise<{
+        canSplit: boolean;
+        reason?: string;
+    }>;
+    /**
+     * Check if a market is resolved and get payout info
+     */
+    getMarketResolution(conditionId: string): Promise<MarketResolution>;
+    /**
+     * Get detailed gas estimate for a split operation
+     */
+    estimateSplitGas(conditionId: string, amount: string): Promise<GasEstimate>;
+    /**
+     * Get detailed gas estimate for a merge operation
+     */
+    estimateMergeGas(conditionId: string, amount: string): Promise<GasEstimate>;
+    /**
+     * Get current gas price info
+     */
+    getGasPrice(): Promise<{
+        gwei: string;
+        wei: string;
+    }>;
+    /**
+     * Get transaction status with detailed info
+     */
+    getTransactionStatus(txHash: string): Promise<TransactionStatus>;
+    /**
+     * Wait for transaction confirmation with timeout
+     */
+    waitForTransaction(txHash: string, confirmations?: number): Promise<TransactionStatus>;
+    /**
+     * Get a quote for a swap (checks if route is possible)
+     */
+    getSwapQuote(tokenIn: string, tokenOut: string, amount: string): Promise<QuoteResult>;
+    /**
+     * Execute a token swap using QuickSwap V3
+     *
+     * @param tokenIn - Token to swap from (e.g., 'MATIC', 'USDC', 'USDT')
+     * @param tokenOut - Token to swap to (e.g., 'USDC_E', 'WETH')
+     * @param amount - Amount to swap in token units
+     * @param slippage - Slippage tolerance in percent (default: 0.5)
+     */
+    swap(tokenIn: string, tokenOut: string, amount: string, slippage?: number): Promise<SwapResult>;
+    /**
+     * Swap any supported token to USDC.e and deposit to Polymarket
+     *
+     * This is a convenience method for converting tokens to the USDC.e
+     * format required by Polymarket CTF operations.
+     */
+    swapAndDeposit(token: string, amount: string, slippage?: number): Promise<SwapResult>;
+    /**
+     * Get all available liquidity pools on QuickSwap V3
+     */
+    getAvailablePools(): Promise<PoolInfo[]>;
+    /**
+     * Check if a pool exists for a token pair
+     */
+    checkPool(tokenA: string, tokenB: string): Promise<PoolInfo>;
+    /**
+     * Transfer an ERC20 token to another address
+     */
+    transfer(token: string, to: string, amount: string): Promise<TransferResult>;
+    /**
+     * Transfer native MATIC to another address
+     */
+    transferMatic(to: string, amount: string): Promise<TransferResult>;
+    /**
+     * Transfer native USDC to another address
+     *
+     * WARNING: This transfers NATIVE USDC, not USDC.e.
+     * For Polymarket CTF operations, use transferUsdcE() instead.
+     */
+    transferUsdc(to: string, amount: string): Promise<TransferResult>;
+    /**
+     * Transfer USDC.e (bridged USDC) to another address
+     *
+     * This is the correct method for Polymarket CTF operations.
+     */
+    transferUsdcE(to: string, amount: string): Promise<TransferResult>;
+    /**
+     * Wrap native MATIC to WMATIC
+     */
+    wrapMatic(amount: string): Promise<SwapResult>;
+    /**
+     * Unwrap WMATIC to native MATIC
+     */
+    unwrapMatic(amount: string): Promise<SwapResult>;
+    /**
+     * Get the underlying CTFClient for advanced operations
+     */
+    getCTFClient(): CTFClient;
+    /**
+     * Get the underlying AuthorizationService for advanced operations
+     */
+    getAuthorizationService(): AuthorizationService;
+    /**
+     * Get the underlying SwapService for advanced operations
+     */
+    getSwapService(): SwapService;
+    /**
+     * Get the shared wallet instance
+     */
+    getWallet(): ethers.Wallet;
+    /**
+     * Get the shared provider instance
+     */
+    getProvider(): ethers.providers.JsonRpcProvider;
+}
+//# sourceMappingURL=onchain-service.d.ts.map

package/dist/services/onchain-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onchain-service.d.ts","sourceRoot":"","sources":["../../src/services/onchain-service.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGhC,OAAO,EACL,SAAS,EAET,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,WAAW,EAChB,KAAK,iBAAiB,EACtB,KAAK,QAAQ,EACd,MAAM,0BAA0B,CAAC;AAElC,OAAO,EACL,oBAAoB,EACpB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACtB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EACL,WAAW,EACX,KAAK,SAAS,EACd,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,QAAQ,EACd,MAAM,mBAAmB,CAAC;AAI3B,MAAM,WAAW,oBAAoB;IACnC,2CAA2C;IAC3C,UAAU,EAAE,MAAM,CAAC;IACnB,yCAAyC;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6DAA6D;IAC7D,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,mDAAmD;IACnD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iDAAiD;IACjD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,OAAO,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB;AAGD,YAAY,EACV,WAAW,EACX,WAAW,EACX,YAAY,EACZ,eAAe,EACf,gBAAgB,EAChB,WAAW,EACX,iBAAiB,EACjB,QAAQ,EACR,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,SAAS,EACT,UAAU,EACV,YAAY,EACZ,cAAc,EACd,WAAW,EACX,QAAQ,GACT,CAAC;AAIF;;;;;;;;;GASG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,QAAQ,CAAmC;IACnD,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,WAAW,CAAuB;IAC1C,OAAO,CAAC,WAAW,CAAc;gBAErB,MAAM,EAAE,oBAAoB;IA6BxC;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;OAEG;IACG,eAAe,IAAI,OAAO,CAAC,MAAM,CAAC;IAKxC;;OAEG;IACG,gBAAgB,IAAI,OAAO,CAAC,aAAa,CAAC;IAqBhD;;;;OAIG;IACG,eAAe,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAIlD;;;;OAIG;IACG,UAAU,IAAI,OAAO,CAAC,eAAe,CAAC;IAI5C;;OAEG;IACG,WAAW,CACf,cAAc,EAAE,MAAM,EACtB,MAAM,GAAE,MAAM,CAAC,SAAuC,GACrD,OAAO,CAAC,gBAAgB,CAAC;IAI5B;;OAEG;IACG,kBAAkB,CACtB,eAAe,EAAE,MAAM,EACvB,QAAQ,GAAE,OAAc,GACvB,OAAO,CAAC,gBAAgB,CAAC;IAM5B;;;;;;OAMG;IACG,KAAK,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAItE;;;;;;OAMG;IACG,KAAK,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAItE;;;;;OAKG;IACG,eAAe,CACnB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,WAAW,CAAC;IAIvB;;;;OAIG;IACG,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,GAAG,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IAIhF;;;;OAIG;IACG,gBAAgB,CACpB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,QAAQ,EAClB,OAAO,CAAC,EAAE,KAAK,GAAG,IAAI,GACrB,OAAO,CAAC,YAAY,CAAC;IAMxB;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;IAIvC;;OAEG;IACG,oBAAoB,IAAI,OAAO,CAAC,MAAM,CAAC;IAI7C;;;;OAIG;IACG,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAIvE;;;;;OAKG;IACG,4BAA4B,CAChC,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,QAAQ,GACjB,OAAO,CAAC,eAAe,CAAC;IAI3B;;;;OAIG;IACG,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAyB5D;;OAEG;IACG,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAIpG;;OAEG;IACG,oBAAoB,CACxB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC;QAAE,QAAQ,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAIlD;;OAEG;IACG,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAM/E;;OAEG;IACG,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAMzE;;OAEG;IACG,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAIjF;;OAEG;IACG,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAIjF;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAM3D;;OAEG;IACG,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAItE;;OAEG;IACG,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAM5F;;OAEG;IACG,YAAY,CAChB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,WAAW,CAAC;IAIvB;;;;;;;OAOG;IACG,IAAI,CACR,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,UAAU,CAAC;IAItB;;;;;OAKG;IACG,cAAc,CAClB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,UAAU,CAAC;IAOtB;;OAEG;IACG,iBAAiB,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAI9C;;OAEG;IACG,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAMlE;;OAEG;IACG,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAIlF;;OAEG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAIxE;;;;;OAKG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAIvE;;;;OAIG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAMxE;;OAEG;IACG,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAIpD;;OAEG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAMtD;;OAEG;IACH,YAAY,IAAI,SAAS;IAIzB;;OAEG;IACH,uBAAuB,IAAI,oBAAoB;IAI/C;;OAEG;IACH,cAAc,IAAI,WAAW;IAI7B;;OAEG;IACH,SAAS,IAAI,MAAM,CAAC,MAAM;IAI1B;;OAEG;IACH,WAAW,IAAI,MAAM,CAAC,SAAS,CAAC,eAAe;CAGhD"}