liquid-sdk 1.7.1 → 1.7.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -289,9 +289,25 @@ declare class LiquidSDK {
289
289
  getPoolFeeState(poolId: Hex, hookAddress?: Address): Promise<PoolDynamicFeeVars>;
290
290
  getPoolCreationTimestamp(poolId: Hex, hookAddress?: Address): Promise<bigint>;
291
291
  isLiquidToken0(poolId: Hex, hookAddress?: Address): Promise<boolean>;
292
- getAvailableFees(feeOwner: Address, tokenAddress: Address): Promise<bigint>;
293
- getFeesToClaim(feeOwner: Address, tokenAddress: Address): Promise<bigint>;
294
- claimFees(feeOwner: Address, tokenAddress: Address): Promise<Hash>;
292
+ /**
293
+ * Get uncollected fees for a fee owner.
294
+ * @param feeOwner - Address that receives fees (reward recipient)
295
+ * @param feeToken - The token fees are denominated in. Defaults to WETH
296
+ * (correct for all pools using LP_LOCKER_FEE_CONVERSION).
297
+ */
298
+ getAvailableFees(feeOwner: Address, feeToken?: Address): Promise<bigint>;
299
+ /**
300
+ * Get collected, claimable fees for a fee owner.
301
+ * @param feeOwner - Address that receives fees (reward recipient)
302
+ * @param feeToken - The token fees are denominated in. Defaults to WETH.
303
+ */
304
+ getFeesToClaim(feeOwner: Address, feeToken?: Address): Promise<bigint>;
305
+ /**
306
+ * Claim all accumulated fees for a fee owner.
307
+ * @param feeOwner - Address that receives fees (reward recipient)
308
+ * @param feeToken - The token fees are denominated in. Defaults to WETH.
309
+ */
310
+ claimFees(feeOwner: Address, feeToken?: Address): Promise<Hash>;
295
311
  getVaultAllocation(tokenAddress: Address): Promise<VaultAllocation>;
296
312
  getVaultClaimable(tokenAddress: Address): Promise<bigint>;
297
313
  claimVault(tokenAddress: Address): Promise<Hash>;
package/dist/index.d.ts CHANGED
@@ -289,9 +289,25 @@ declare class LiquidSDK {
289
289
  getPoolFeeState(poolId: Hex, hookAddress?: Address): Promise<PoolDynamicFeeVars>;
290
290
  getPoolCreationTimestamp(poolId: Hex, hookAddress?: Address): Promise<bigint>;
291
291
  isLiquidToken0(poolId: Hex, hookAddress?: Address): Promise<boolean>;
292
- getAvailableFees(feeOwner: Address, tokenAddress: Address): Promise<bigint>;
293
- getFeesToClaim(feeOwner: Address, tokenAddress: Address): Promise<bigint>;
294
- claimFees(feeOwner: Address, tokenAddress: Address): Promise<Hash>;
292
+ /**
293
+ * Get uncollected fees for a fee owner.
294
+ * @param feeOwner - Address that receives fees (reward recipient)
295
+ * @param feeToken - The token fees are denominated in. Defaults to WETH
296
+ * (correct for all pools using LP_LOCKER_FEE_CONVERSION).
297
+ */
298
+ getAvailableFees(feeOwner: Address, feeToken?: Address): Promise<bigint>;
299
+ /**
300
+ * Get collected, claimable fees for a fee owner.
301
+ * @param feeOwner - Address that receives fees (reward recipient)
302
+ * @param feeToken - The token fees are denominated in. Defaults to WETH.
303
+ */
304
+ getFeesToClaim(feeOwner: Address, feeToken?: Address): Promise<bigint>;
305
+ /**
306
+ * Claim all accumulated fees for a fee owner.
307
+ * @param feeOwner - Address that receives fees (reward recipient)
308
+ * @param feeToken - The token fees are denominated in. Defaults to WETH.
309
+ */
310
+ claimFees(feeOwner: Address, feeToken?: Address): Promise<Hash>;
295
311
  getVaultAllocation(tokenAddress: Address): Promise<VaultAllocation>;
296
312
  getVaultClaimable(tokenAddress: Address): Promise<bigint>;
297
313
  claimVault(tokenAddress: Address): Promise<Hash>;
package/dist/index.js CHANGED
@@ -1528,23 +1528,39 @@ var LiquidSDK = class {
1528
1528
  });
1529
1529
  }
1530
1530
  // ── Fee Claims ────────────────────────────────────────────────────
1531
- async getAvailableFees(feeOwner, tokenAddress) {
1531
+ /**
1532
+ * Get uncollected fees for a fee owner.
1533
+ * @param feeOwner - Address that receives fees (reward recipient)
1534
+ * @param feeToken - The token fees are denominated in. Defaults to WETH
1535
+ * (correct for all pools using LP_LOCKER_FEE_CONVERSION).
1536
+ */
1537
+ async getAvailableFees(feeOwner, feeToken = EXTERNAL.WETH) {
1532
1538
  return await this.publicClient.readContract({
1533
1539
  address: ADDRESSES.FEE_LOCKER,
1534
1540
  abi: LiquidFeeLockerAbi,
1535
1541
  functionName: "availableFees",
1536
- args: [feeOwner, tokenAddress]
1542
+ args: [feeOwner, feeToken]
1537
1543
  });
1538
1544
  }
1539
- async getFeesToClaim(feeOwner, tokenAddress) {
1545
+ /**
1546
+ * Get collected, claimable fees for a fee owner.
1547
+ * @param feeOwner - Address that receives fees (reward recipient)
1548
+ * @param feeToken - The token fees are denominated in. Defaults to WETH.
1549
+ */
1550
+ async getFeesToClaim(feeOwner, feeToken = EXTERNAL.WETH) {
1540
1551
  return await this.publicClient.readContract({
1541
1552
  address: ADDRESSES.FEE_LOCKER,
1542
1553
  abi: LiquidFeeLockerAbi,
1543
1554
  functionName: "feesToClaim",
1544
- args: [feeOwner, tokenAddress]
1555
+ args: [feeOwner, feeToken]
1545
1556
  });
1546
1557
  }
1547
- async claimFees(feeOwner, tokenAddress) {
1558
+ /**
1559
+ * Claim all accumulated fees for a fee owner.
1560
+ * @param feeOwner - Address that receives fees (reward recipient)
1561
+ * @param feeToken - The token fees are denominated in. Defaults to WETH.
1562
+ */
1563
+ async claimFees(feeOwner, feeToken = EXTERNAL.WETH) {
1548
1564
  if (!this.walletClient?.account) {
1549
1565
  throw new Error("walletClient with account required for claimFees");
1550
1566
  }
@@ -1552,7 +1568,7 @@ var LiquidSDK = class {
1552
1568
  address: ADDRESSES.FEE_LOCKER,
1553
1569
  abi: LiquidFeeLockerAbi,
1554
1570
  functionName: "claim",
1555
- args: [feeOwner, tokenAddress],
1571
+ args: [feeOwner, feeToken],
1556
1572
  chain: import_chains2.base,
1557
1573
  account: this.walletClient.account
1558
1574
  });