liquid-sdk 1.7.1 → 1.7.3

package/dist/index.mjs

@@ -103,7 +103,7 @@ var POOL_POSITIONS = {
 };
 var DEFAULTS = {
   HOOK: ADDRESSES.HOOK_STATIC_FEE_V2,
-  /** LP Locker with fee conversion (converts fees to ETH before distributing) */
+  /** LP Locker with fee conversion (converts fees to WETH before distributing) */
   LOCKER: ADDRESSES.LP_LOCKER_FEE_CONVERSION,
   TICK_SPACING: 200,
   TICK_IF_TOKEN0_IS_LIQUID: -230400,
@@ -1143,6 +1143,73 @@ var LiquidSDK = class {
       extensionData
     };
   }
+  // ── Airdrop Extension ──────────────────────────────────────────
+  /**
+   * Build an ExtensionConfig that reserves a percentage of supply into
+   * the LiquidAirdropV2 contract for merkle-tree-based distribution.
+   *
+   * The airdrop contract expects `AirdropV2ExtensionData`:
+   *   { address admin, bytes32 merkleRoot, uint256 lockupDuration, uint256 vestingDuration }
+   *
+   * Leaf encoding used by LiquidAirdropV2.claim (note: **double hashed**
+   * — OZ's standard 2nd-preimage-resistant pattern):
+   *   leaf = keccak256(bytes.concat(keccak256(abi.encode(recipient, allocatedAmount))))
+   *
+   * @example
+   * ```typescript
+   * const airdropExt = sdk.buildAirdropExtension({
+   *   admin: account.address,
+   *   merkleRoot: "0x…",
+   *   allocationBps: 2000,          // 20%
+   *   lockupDuration: 86400,        // 1 day (minimum)
+   *   vestingDuration: 0,           // instant claim after lockup
+   * });
+   * ```
+   */
+  buildAirdropExtension(airdrop) {
+    const MIN_LOCKUP = 86400;
+    const MAX_BPS = 9e3;
+    if (airdrop.allocationBps < 1 || airdrop.allocationBps > MAX_BPS) {
+      throw new Error(
+        `Airdrop allocationBps must be 1\u2013${MAX_BPS} (0.01%\u201390%). Got ${airdrop.allocationBps}.`
+      );
+    }
+    if (airdrop.lockupDuration < MIN_LOCKUP) {
+      throw new Error(
+        `Airdrop lockupDuration must be \u2265 ${MIN_LOCKUP} seconds (1 day). Got ${airdrop.lockupDuration}.`
+      );
+    }
+    if (airdrop.vestingDuration !== void 0 && airdrop.vestingDuration < 0) {
+      throw new Error("Airdrop vestingDuration cannot be negative.");
+    }
+    const extensionData = encodeAbiParameters2(
+      [
+        {
+          type: "tuple",
+          components: [
+            { type: "address", name: "admin" },
+            { type: "bytes32", name: "merkleRoot" },
+            { type: "uint256", name: "lockupDuration" },
+            { type: "uint256", name: "vestingDuration" }
+          ]
+        }
+      ],
+      [
+        {
+          admin: airdrop.admin,
+          merkleRoot: airdrop.merkleRoot,
+          lockupDuration: BigInt(airdrop.lockupDuration),
+          vestingDuration: BigInt(airdrop.vestingDuration ?? 0)
+        }
+      ]
+    );
+    return {
+      extension: ADDRESSES.AIRDROP_V2,
+      msgValue: 0n,
+      extensionBps: airdrop.allocationBps,
+      extensionData
+    };
+  }
   // ── Validation ─────────────────────────────────────────────────
   /**
    * Validate a DeploymentConfig before sending to the contract.
@@ -1307,13 +1374,27 @@ var LiquidSDK = class {
       (sum, ext) => sum + ext.msgValue,
       0n
     );
+    let gas;
+    try {
+      const estimated = await this.publicClient.estimateContractGas({
+        address: ADDRESSES.FACTORY,
+        abi: LiquidFactoryAbi,
+        functionName: "deployToken",
+        args: [deploymentConfig],
+        value: msgValue,
+        account: this.walletClient.account
+      });
+      gas = estimated * 120n / 100n;
+    } catch {
+      gas = 6000000n;
+    }
     const txHash = await this.walletClient.writeContract({
       address: ADDRESSES.FACTORY,
       abi: LiquidFactoryAbi,
       functionName: "deployToken",
       args: [deploymentConfig],
       value: msgValue,
-      gas: 5000000n,
+      gas,
       chain: base2,
       account: this.walletClient.account
     });
@@ -1470,23 +1551,39 @@ var LiquidSDK = class {
     });
   }
   // ── Fee Claims ────────────────────────────────────────────────────
-  async getAvailableFees(feeOwner, tokenAddress) {
+  /**
+   * Get uncollected fees for a fee owner.
+   * @param feeOwner - Address that receives fees (reward recipient)
+   * @param feeToken - The token fees are denominated in. Defaults to WETH
+   *   (correct for all pools using LP_LOCKER_FEE_CONVERSION).
+   */
+  async getAvailableFees(feeOwner, feeToken = EXTERNAL.WETH) {
     return await this.publicClient.readContract({
       address: ADDRESSES.FEE_LOCKER,
       abi: LiquidFeeLockerAbi,
       functionName: "availableFees",
-      args: [feeOwner, tokenAddress]
+      args: [feeOwner, feeToken]
     });
   }
-  async getFeesToClaim(feeOwner, tokenAddress) {
+  /**
+   * Get collected, claimable fees for a fee owner.
+   * @param feeOwner - Address that receives fees (reward recipient)
+   * @param feeToken - The token fees are denominated in. Defaults to WETH.
+   */
+  async getFeesToClaim(feeOwner, feeToken = EXTERNAL.WETH) {
     return await this.publicClient.readContract({
       address: ADDRESSES.FEE_LOCKER,
       abi: LiquidFeeLockerAbi,
       functionName: "feesToClaim",
-      args: [feeOwner, tokenAddress]
+      args: [feeOwner, feeToken]
     });
   }
-  async claimFees(feeOwner, tokenAddress) {
+  /**
+   * Claim all accumulated fees for a fee owner.
+   * @param feeOwner - Address that receives fees (reward recipient)
+   * @param feeToken - The token fees are denominated in. Defaults to WETH.
+   */
+  async claimFees(feeOwner, feeToken = EXTERNAL.WETH) {
     if (!this.walletClient?.account) {
       throw new Error("walletClient with account required for claimFees");
     }
@@ -1494,7 +1591,7 @@ var LiquidSDK = class {
       address: ADDRESSES.FEE_LOCKER,
       abi: LiquidFeeLockerAbi,
       functionName: "claim",
-      args: [feeOwner, tokenAddress],
+      args: [feeOwner, feeToken],
       chain: base2,
       account: this.walletClient.account
     });