@catalyst-team/poly-sdk 0.2.1 → 0.4.0

package/dist/src/services/swap-service.d.ts

@@ -0,0 +1,217 @@
+/**
+ * Swap Service
+ *
+ * Provides DEX swap functionality on Polygon using QuickSwap V3.
+ * Supports swapping between various tokens including MATIC, WETH, USDC, USDC.e, USDT, DAI.
+ */
+import { ethers } from 'ethers';
+export declare const QUICKSWAP_ROUTER = "0xf5b509bB0909a69B1c207E495f687a596C168E12";
+export declare const QUICKSWAP_QUOTER = "0xa15F0D7377B2A0C0c10db057f641beD21028FC89";
+export declare const QUICKSWAP_FACTORY = "0x411b0fAcC3489691f28ad58c47006AF5E3Ab3A28";
+export declare const WMATIC = "0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270";
+/**
+ * Supported tokens on Polygon
+ *
+ * ⚠️ IMPORTANT: USDC vs USDC.e for Polymarket CTF
+ *
+ * | Token       | Address                                    | Polymarket CTF |
+ * |-------------|--------------------------------------------|-----------------
+ * | USDC_E      | 0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174 | ✅ Required    |
+ * | USDC/NATIVE | 0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359 | ❌ Not accepted|
+ *
+ * For Polymarket CTF operations (split/merge/redeem):
+ * - Use transferUsdcE() to send USDC.e
+ * - Use swap('USDC', 'USDC_E', amount) to convert native USDC to USDC.e
+ *
+ * For general transfers:
+ * - transferUsdc() sends native USDC (most DEXs, CEXs use this)
+ * - transferUsdcE() sends bridged USDC.e (Polymarket CTF requires this)
+ */
+export declare const POLYGON_TOKENS: {
+    readonly MATIC: "0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270";
+    readonly WMATIC: "0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270";
+    readonly USDC: "0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359";
+    readonly NATIVE_USDC: "0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359";
+    readonly USDC_E: "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174";
+    readonly USDT: "0xc2132D05D31c914a87C6611C10748AEb04B58e8F";
+    readonly DAI: "0x8f3Cf7ad23Cd3CaDbD9735AFf958023239c6A063";
+    readonly WETH: "0x7ceB23fD6bC0adD59E62ac25578270cFf1b9f619";
+};
+export declare const TOKEN_DECIMALS: Record<string, number>;
+export type SupportedToken = keyof typeof POLYGON_TOKENS;
+export interface SwapQuote {
+    tokenIn: string;
+    tokenOut: string;
+    amountIn: string;
+    estimatedAmountOut: string;
+    minAmountOut: string;
+    slippage: number;
+    priceImpact: string;
+}
+/** Quote result from Quoter contract */
+export interface QuoteResult {
+    possible: boolean;
+    tokenIn: string;
+    tokenOut: string;
+    amountIn: string;
+    amountOut: string | null;
+    route: string[];
+    poolExists: boolean;
+    reason?: string;
+}
+/** Pool info */
+export interface PoolInfo {
+    tokenA: string;
+    tokenB: string;
+    poolAddress: string | null;
+    exists: boolean;
+}
+export interface SwapResult {
+    success: boolean;
+    transactionHash: string;
+    tokenIn: string;
+    tokenOut: string;
+    amountIn: string;
+    amountOut: string;
+    gasUsed: string;
+}
+export interface TokenBalance {
+    token: string;
+    symbol: string;
+    balance: string;
+    decimals: number;
+}
+export interface TransferResult {
+    success: boolean;
+    transactionHash: string;
+    token: string;
+    to: string;
+    amount: string;
+    gasUsed: string;
+}
+export declare class SwapService {
+    private signer;
+    private provider;
+    private router;
+    private quoter;
+    private factory;
+    constructor(signer: ethers.Wallet);
+    /**
+     * Get dynamic gas options for Polygon network
+     * Uses RPC fee data with minimum priority fee of 30 gwei
+     */
+    private getGasOptions;
+    /**
+     * Get the wallet address
+     */
+    get address(): string;
+    /**
+     * Get token address from symbol
+     */
+    getTokenAddress(token: string): string;
+    /**
+     * Get token decimals
+     */
+    getTokenDecimals(token: string): number;
+    /**
+     * Check if a pool exists for a token pair
+     */
+    checkPool(tokenA: string, tokenB: string): Promise<PoolInfo>;
+    /**
+     * Get all available pools for supported tokens
+     */
+    getAvailablePools(): Promise<PoolInfo[]>;
+    /**
+     * Get a quote for a swap (checks if route is possible)
+     */
+    getQuote(tokenIn: string, tokenOut: string, amountIn: string): Promise<QuoteResult>;
+    /**
+     * Execute a multi-hop swap
+     */
+    swapMultiHop(tokenIn: string, tokenOut: string, amountIn: string, route: string[], options?: {
+        slippage?: number;
+        deadline?: number;
+    }): Promise<SwapResult>;
+    /**
+     * Get balances for all supported tokens
+     */
+    getBalances(): Promise<TokenBalance[]>;
+    /**
+     * Get balance for a specific token
+     */
+    getBalance(token: string): Promise<string>;
+    /**
+     * Wrap native MATIC to WMATIC
+     */
+    wrapMatic(amount: string): Promise<SwapResult>;
+    /**
+     * Unwrap WMATIC to native MATIC
+     */
+    unwrapMatic(amount: string): Promise<SwapResult>;
+    /**
+     * Execute a token swap using QuickSwap V3
+     */
+    swap(tokenIn: string, tokenOut: string, amountIn: string, options?: {
+        slippage?: number;
+        deadline?: number;
+    }): Promise<SwapResult>;
+    /**
+     * Swap any supported token to USDC (for deposit)
+     */
+    swapToUsdc(tokenIn: string, amountIn: string, options?: {
+        usdcType?: 'NATIVE_USDC' | 'USDC_E';
+        slippage?: number;
+    }): Promise<SwapResult>;
+    /**
+     * Get list of supported tokens
+     */
+    getSupportedTokens(): string[];
+    /**
+     * Get balances for any wallet address (static method, no signer required)
+     */
+    static getWalletBalances(address: string, provider?: ethers.providers.Provider): Promise<TokenBalance[]>;
+    /**
+     * Get balance for a specific token for any wallet (static)
+     */
+    static getWalletBalance(address: string, token: string, provider?: ethers.providers.Provider): Promise<string>;
+    /**
+     * Transfer native MATIC (POL) to another address
+     */
+    transferMatic(to: string, amount: string): Promise<TransferResult>;
+    /**
+     * Transfer an ERC20 token to another address
+     */
+    transfer(token: string, to: string, amount: string): Promise<TransferResult>;
+    /**
+     * Transfer native USDC to another address
+     *
+     * ⚠️ WARNING: This transfers NATIVE USDC (0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359)
+     *
+     * For Polymarket CTF operations, you need USDC.e instead.
+     * Use transferUsdcE() for Polymarket CTF compatibility.
+     *
+     * @see transferUsdcE - For Polymarket CTF operations
+     */
+    transferUsdc(to: string, amount: string): Promise<TransferResult>;
+    /**
+     * Transfer USDC.e (bridged USDC) to another address
+     *
+     * ✅ This is the correct method for Polymarket CTF operations.
+     *
+     * Polymarket's Conditional Token Framework (CTF) only accepts
+     * USDC.e (0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174).
+     *
+     * If you're funding a wallet for CTF trading, use this method.
+     *
+     * @example
+     * ```typescript
+     * // Fund a session wallet for Polymarket trading
+     * await swapService.transferUsdcE(sessionWallet, '100');
+     *
+     * // The session wallet can now perform CTF operations
+     * await ctf.split(conditionId, '100');
+     * ```
+     */
+    transferUsdcE(to: string, amount: string): Promise<TransferResult>;
+}
+//# sourceMappingURL=swap-service.d.ts.map

package/dist/src/services/swap-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"swap-service.d.ts","sourceRoot":"","sources":["../../../src/services/swap-service.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,MAAM,EAAuB,MAAM,QAAQ,CAAC;AAGrD,eAAO,MAAM,gBAAgB,+CAA+C,CAAC;AAC7E,eAAO,MAAM,gBAAgB,+CAA+C,CAAC;AAC7E,eAAO,MAAM,iBAAiB,+CAA+C,CAAC;AAG9E,eAAO,MAAM,MAAM,+CAA+C,CAAC;AAEnE;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,cAAc;;;;;;;;;CAajB,CAAC;AAGX,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CASjD,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,cAAc,CAAC;AA+BzD,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,wCAAwC;AACxC,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,gBAAgB;AAChB,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,qBAAa,WAAW;IACtB,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,QAAQ,CAA4B;IAC5C,OAAO,CAAC,MAAM,CAAW;IACzB,OAAO,CAAC,MAAM,CAAW;IACzB,OAAO,CAAC,OAAO,CAAW;gBAEd,MAAM,EAAE,MAAM,CAAC,MAAM;IAUjC;;;OAGG;YACW,aAAa;IAc3B;;OAEG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED;;OAEG;IACH,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAatC;;OAEG;IACH,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAKvC;;OAEG;IACG,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAwBlE;;OAEG;IACG,iBAAiB,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAkB9C;;OAEG;IACG,QAAQ,CACZ,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,WAAW,CAAC;IAoGvB;;OAEG;IACG,YAAY,CAChB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EAAE,EACf,OAAO,GAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAO,GACrD,OAAO,CAAC,UAAU,CAAC;IAwEtB;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;IAkC5C;;OAEG;IACG,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAehD;;OAEG;IACG,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAmBpD;;OAEG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAmBtD;;OAEG;IACG,IAAI,CACR,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE;QACP,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACd,GACL,OAAO,CAAC,UAAU,CAAC;IA+FtB;;OAEG;IACG,UAAU,CACd,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE;QACP,QAAQ,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;QACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;KACd,GACL,OAAO,CAAC,UAAU,CAAC;IA2CtB;;OAEG;IACH,kBAAkB,IAAI,MAAM,EAAE;IAI9B;;OAEG;WACU,iBAAiB,CAC5B,OAAO,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,GACnC,OAAO,CAAC,YAAY,EAAE,CAAC;IAmC1B;;OAEG;WACU,gBAAgB,CAC3B,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,GACnC,OAAO,CAAC,MAAM,CAAC;IAsBlB;;OAEG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IA6BxE;;OAEG;IACG,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAsClF;;;;;;;;;OASG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAIvE;;;;;;;;;;;;;;;;;;OAkBG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;CAGzE"}