liquid-sdk 1.7.1 → 1.7.3

package/dist/index.d.ts

@@ -63,6 +63,21 @@ interface VaultExtensionParams {
     /** Vesting duration in seconds after lockup ends (0 = no vesting, tokens unlock all at once) */
     vestingDuration?: number;
 }
+interface AirdropExtensionParams {
+    /** Address allowed to `updateAdmin`, `updateMerkleRoot` (under conditions),
+     *  and `adminClaim` the remainder after claim expiration. */
+    admin: Address;
+    /** Merkle root over leaves `keccak256(bytes.concat(keccak256(abi.encode(
+     *  recipient, allocatedAmount))))`. Double-hashed per OZ convention. */
+    merkleRoot: Hex;
+    /** Percentage of supply to reserve for the airdrop, in BPS (1–9000). */
+    allocationBps: number;
+    /** Lockup in seconds before any recipient can claim. Min 86400 (1 day). */
+    lockupDuration: number;
+    /** Linear vesting after lockup. 0 = instant claim of full entitlement at
+     *  lockup end. */
+    vestingDuration?: number;
+}
 interface DeployTokenParams {
     name: string;
     symbol: string;
@@ -270,6 +285,29 @@ declare class LiquidSDK {
      * ```
      */
     buildVaultExtension(vault: VaultExtensionParams): ExtensionConfig;
+    /**
+     * 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: AirdropExtensionParams): ExtensionConfig;
     /**
      * Validate a DeploymentConfig before sending to the contract.
      * Catches common mistakes client-side with clear error messages.
@@ -289,9 +327,25 @@ declare class LiquidSDK {
     getPoolFeeState(poolId: Hex, hookAddress?: Address): Promise<PoolDynamicFeeVars>;
     getPoolCreationTimestamp(poolId: Hex, hookAddress?: Address): Promise<bigint>;
     isLiquidToken0(poolId: Hex, hookAddress?: Address): Promise<boolean>;
-    getAvailableFees(feeOwner: Address, tokenAddress: Address): Promise<bigint>;
-    getFeesToClaim(feeOwner: Address, tokenAddress: Address): Promise<bigint>;
-    claimFees(feeOwner: Address, tokenAddress: Address): Promise<Hash>;
+    /**
+     * 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).
+     */
+    getAvailableFees(feeOwner: Address, feeToken?: Address): Promise<bigint>;
+    /**
+     * 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.
+     */
+    getFeesToClaim(feeOwner: Address, feeToken?: Address): Promise<bigint>;
+    /**
+     * 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.
+     */
+    claimFees(feeOwner: Address, feeToken?: Address): Promise<Hash>;
     getVaultAllocation(tokenAddress: Address): Promise<VaultAllocation>;
     getVaultClaimable(tokenAddress: Address): Promise<bigint>;
     claimVault(tokenAddress: Address): Promise<Hash>;
@@ -473,7 +527,7 @@ declare const POOL_POSITIONS: {
  */
 declare const DEFAULTS: {
     readonly HOOK: `0x${string}`;
-    /** LP Locker with fee conversion (converts fees to ETH before distributing) */
+    /** LP Locker with fee conversion (converts fees to WETH before distributing) */
     readonly LOCKER: `0x${string}`;
     readonly TICK_SPACING: 200;
     readonly TICK_IF_TOKEN0_IS_LIQUID: -230400;
@@ -2480,7 +2534,7 @@ declare enum FeePreference {
  *
  * @example
  * ```ts
- * // Single recipient, fees converted to ETH
+ * // Single recipient, fees converted to WETH
  * const lockerData = encodeFeeConversionLockerData([FeePreference.Paired]);
  *
  * // Two recipients: first gets ETH, second gets the token
@@ -2541,4 +2595,4 @@ declare function parseContext(contextString: string): LiquidContext | null;
  */
 declare function parseMetadata(metadataString: string): LiquidMetadata | null;
 
-export { ADDRESSES, type AirdropInfo, type BidInAuctionParams, type BidInAuctionResult, DEFAULTS, DEFAULT_CHAIN, DEFAULT_CHAIN_ID, DEFAULT_RPC_URL, DEFAULT_TRANCHES_USD, type DeployTokenParams, type DeployTokenResult, type DeploymentConfig, type DeploymentInfo, type DevBuyParams, type DynamicFeeConfig, ERC20Abi, EXTERNAL, type ExtensionConfig, FEE, FeePreference, type GetTokensOptions, LiquidAirdropV2Abi, type LiquidContext, LiquidFactoryAbi, LiquidFeeLockerAbi, LiquidHookDynamicFeeV2Abi, LiquidLpLockerAbi, type LiquidMetadata, LiquidMevBlockDelayAbi, LiquidMevDescendingFeesAbi, LiquidPoolExtensionAllowlistAbi, LiquidSDK, type LiquidSDKConfig, LiquidSniperAuctionV2Abi, LiquidSniperUtilV2Abi, LiquidTokenAbi, LiquidUniv4EthDevBuyAbi, LiquidVaultAbi, type LockerConfig, type MarketCapTranche, type MarketCapTrancheUSD, type MevModuleConfig, POOL_POSITIONS, type PoolConfig, type PoolDynamicConfigVars, type PoolDynamicFeeVars, type PoolKey, type PoolPosition, type PositionArrays, type PositionConfig, type SniperAuctionConfig, type SniperAuctionFeeConfig, type SniperAuctionState, type SocialMediaUrl, TOKEN, type TokenConfig, type TokenCreatedEvent, type TokenRewardInfo, type VaultAllocation, type VaultExtensionParams, buildContext, buildMetadata, createDefaultPositions, createPositions, createPositionsUSD, describePositions, encodeDynamicFeePoolData, encodeFeeConversionLockerData, encodeSniperAuctionData, encodeStaticFeePoolData, getTickFromMarketCapETH, getTickFromMarketCapStable, getTickFromMarketCapUSD, marketCapFromTickETH, marketCapFromTickUSD, parseContext, parseMetadata };
+export { ADDRESSES, type AirdropExtensionParams, type AirdropInfo, type BidInAuctionParams, type BidInAuctionResult, DEFAULTS, DEFAULT_CHAIN, DEFAULT_CHAIN_ID, DEFAULT_RPC_URL, DEFAULT_TRANCHES_USD, type DeployTokenParams, type DeployTokenResult, type DeploymentConfig, type DeploymentInfo, type DevBuyParams, type DynamicFeeConfig, ERC20Abi, EXTERNAL, type ExtensionConfig, FEE, FeePreference, type GetTokensOptions, LiquidAirdropV2Abi, type LiquidContext, LiquidFactoryAbi, LiquidFeeLockerAbi, LiquidHookDynamicFeeV2Abi, LiquidLpLockerAbi, type LiquidMetadata, LiquidMevBlockDelayAbi, LiquidMevDescendingFeesAbi, LiquidPoolExtensionAllowlistAbi, LiquidSDK, type LiquidSDKConfig, LiquidSniperAuctionV2Abi, LiquidSniperUtilV2Abi, LiquidTokenAbi, LiquidUniv4EthDevBuyAbi, LiquidVaultAbi, type LockerConfig, type MarketCapTranche, type MarketCapTrancheUSD, type MevModuleConfig, POOL_POSITIONS, type PoolConfig, type PoolDynamicConfigVars, type PoolDynamicFeeVars, type PoolKey, type PoolPosition, type PositionArrays, type PositionConfig, type SniperAuctionConfig, type SniperAuctionFeeConfig, type SniperAuctionState, type SocialMediaUrl, TOKEN, type TokenConfig, type TokenCreatedEvent, type TokenRewardInfo, type VaultAllocation, type VaultExtensionParams, buildContext, buildMetadata, createDefaultPositions, createPositions, createPositionsUSD, describePositions, encodeDynamicFeePoolData, encodeFeeConversionLockerData, encodeSniperAuctionData, encodeStaticFeePoolData, getTickFromMarketCapETH, getTickFromMarketCapStable, getTickFromMarketCapUSD, marketCapFromTickETH, marketCapFromTickUSD, parseContext, parseMetadata };

package/dist/index.js

@@ -161,7 +161,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,
@@ -1201,6 +1201,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 = (0, import_viem2.encodeAbiParameters)(
+      [
+        {
+          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.
@@ -1365,13 +1432,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: import_chains2.base,
       account: this.walletClient.account
     });
@@ -1528,23 +1609,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");
     }
@@ -1552,7 +1649,7 @@ var LiquidSDK = class {
       address: ADDRESSES.FEE_LOCKER,
       abi: LiquidFeeLockerAbi,
       functionName: "claim",
-      args: [feeOwner, tokenAddress],
+      args: [feeOwner, feeToken],
       chain: import_chains2.base,
       account: this.walletClient.account
     });