@clawnch/clawncher-sdk 0.1.0

package/dist/liquidity.d.ts

@@ -0,0 +1,111 @@
+/**
+ * ClawnchLiquidity - Uniswap V3 & V4 Liquidity Management
+ *
+ * Manages liquidity positions on both Uniswap V3 and V4 pools on Base.
+ * Supports minting, adding/removing liquidity, and fee collection.
+ *
+ * V4 uses the PositionManager with multicall + command encoding.
+ * V3 uses the NonfungiblePositionManager directly.
+ *
+ * @example
+ * ```typescript
+ * import { ClawnchLiquidity } from '@clawnch/clawncher-sdk';
+ * import { createWalletClient, createPublicClient, http } from 'viem';
+ * import { privateKeyToAccount } from 'viem/accounts';
+ * import { base } from 'viem/chains';
+ *
+ * const account = privateKeyToAccount('0x...');
+ * const wallet = createWalletClient({ account, chain: base, transport: http() });
+ * const publicClient = createPublicClient({ chain: base, transport: http() });
+ *
+ * const liquidity = new ClawnchLiquidity({ wallet, publicClient });
+ *
+ * // Read a V3 position
+ * const pos = await liquidity.v3GetPosition(123456n);
+ * console.log(pos.liquidity, pos.unclaimedFees);
+ * ```
+ */
+import { type Address, type Hex, type Hash } from 'viem';
+import type { LiquidityConfig, V4PoolKey, V4PoolState, V4MintParams, V3MintParams, V3AddLiquidityParams, V3RemoveLiquidityParams, V3CollectFeesParams, PositionInfo, MintResult, ModifyLiquidityResult, CollectFeesResult } from './liquidity-types.js';
+export type { LiquidityConfig, V4PoolKey, V4PoolState, V4MintParams, V4AddLiquidityParams, V4RemoveLiquidityParams, V4CollectFeesParams, V3MintParams, V3AddLiquidityParams, V3RemoveLiquidityParams, V3CollectFeesParams, PositionInfo, MintResult, ModifyLiquidityResult, CollectFeesResult, } from './liquidity-types.js';
+export declare class ClawnchLiquidity {
+    private readonly wallet;
+    private readonly publicClient;
+    private readonly network;
+    constructor(config: LiquidityConfig);
+    private getChain;
+    private getWalletAddress;
+    /**
+     * Approve an ERC20 token for a spender if current allowance is insufficient
+     */
+    private ensureApproval;
+    /**
+     * Get V4 pool state via StateView
+     */
+    v4GetPoolState(poolKey: V4PoolKey): Promise<V4PoolState>;
+    /**
+     * Get V4 position details from a token ID
+     */
+    v4GetPosition(tokenId: bigint): Promise<PositionInfo>;
+    /**
+     * Mint a new V4 liquidity position
+     *
+     * Note: For full V4 SDK integration (Pool/Position math, calldata encoding),
+     * the @uniswap/v4-sdk package is required. This method provides a lower-level
+     * interface using direct contract calls for environments where the Uniswap SDK
+     * may not be available.
+     *
+     * For production use, consider using the Uniswap V4 SDK's
+     * V4PositionManager.addCallParameters() for proper slippage calculation.
+     */
+    v4MintPosition(params: V4MintParams): Promise<MintResult>;
+    /**
+     * Execute a V4 PositionManager multicall with pre-built calldata
+     *
+     * Use this with calldata generated by @uniswap/v4-sdk's
+     * V4PositionManager.addCallParameters(), removeCallParameters(), or
+     * collectCallParameters().
+     *
+     * @param calldata - Encoded calldata bytes from V4 SDK
+     * @param value - ETH value to send (for native ETH positions)
+     * @returns Transaction hash and receipt
+     */
+    v4ExecuteMulticall(calldata: Hex, value?: bigint): Promise<{
+        txHash: Hash;
+        receipt: any;
+    }>;
+    /**
+     * Get V3 position details from a token ID
+     */
+    v3GetPosition(tokenId: bigint): Promise<PositionInfo>;
+    /**
+     * List all V3 positions for a wallet
+     */
+    v3GetPositionsForWallet(wallet?: Address): Promise<PositionInfo[]>;
+    /**
+     * Mint a new V3 liquidity position
+     */
+    v3MintPosition(params: V3MintParams): Promise<MintResult>;
+    /**
+     * Add liquidity to an existing V3 position
+     */
+    v3AddLiquidity(tokenId: bigint, params: V3AddLiquidityParams): Promise<ModifyLiquidityResult>;
+    /**
+     * Remove liquidity from a V3 position
+     *
+     * This decreases liquidity and then collects the withdrawn tokens.
+     * If removing 100% and burnToken is true, also burns the NFT.
+     */
+    v3RemoveLiquidity(tokenId: bigint, params: V3RemoveLiquidityParams): Promise<ModifyLiquidityResult>;
+    /**
+     * Collect unclaimed fees from a V3 position
+     *
+     * This calls collect() with max amounts to sweep all available fees.
+     */
+    v3CollectFees(tokenId: bigint, params?: V3CollectFeesParams): Promise<CollectFeesResult>;
+    /**
+     * Get all V3 positions for a wallet, optionally filtered by a specific token
+     */
+    getPositionsForToken(tokenAddress: Address, wallet?: Address): Promise<PositionInfo[]>;
+}
+//# sourceMappingURL=liquidity.d.ts.map

package/dist/liquidity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"liquidity.d.ts","sourceRoot":"","sources":["../src/liquidity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,GAAG,EACR,KAAK,IAAI,EAKV,MAAM,MAAM,CAAC;AAKd,OAAO,KAAK,EACV,eAAe,EACf,SAAS,EACT,WAAW,EACX,YAAY,EAIZ,YAAY,EACZ,oBAAoB,EACpB,uBAAuB,EACvB,mBAAmB,EACnB,YAAY,EACZ,UAAU,EACV,qBAAqB,EACrB,iBAAiB,EAClB,MAAM,sBAAsB,CAAC;AAG9B,YAAY,EACV,eAAe,EACf,SAAS,EACT,WAAW,EACX,YAAY,EACZ,oBAAoB,EACpB,uBAAuB,EACvB,mBAAmB,EACnB,YAAY,EACZ,oBAAoB,EACpB,uBAAuB,EACvB,mBAAmB,EACnB,YAAY,EACZ,UAAU,EACV,qBAAqB,EACrB,iBAAiB,GAClB,MAAM,sBAAsB,CAAC;AA4B9B,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA4B;IACnD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAkC;IAC/D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA6B;gBAEzC,MAAM,EAAE,eAAe;IAmBnC,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,gBAAgB;IAQxB;;OAEG;YACW,cAAc;IA8B5B;;OAEG;IACG,cAAc,CAAC,OAAO,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;IA8C9D;;OAEG;IACG,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IA+E3D;;;;;;;;;;OAUG;IACG,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC;IAwD/D;;;;;;;;;;OAUG;IACG,kBAAkB,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,GAAE,MAAW,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,GAAG,CAAA;KAAE,CAAC;IA4BpG;;OAEG;IACG,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IA8B3D;;OAEG;IACG,uBAAuB,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAsCxE;;OAEG;IACG,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC;IA6E/D;;OAEG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA2DnG;;;;;OAKG;IACG,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA8GzG;;;;OAIG;IACG,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,GAAE,mBAAwB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA8ClG;;OAEG;IACG,oBAAoB,CACxB,YAAY,EAAE,OAAO,EACrB,MAAM,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,YAAY,EAAE,CAAC;CAQ3B"}