liquid-sdk 1.6.5 → 1.7.1

package/dist/index.d.mts

@@ -53,6 +53,16 @@ interface DevBuyParams {
     /** Address to receive the purchased tokens */
     recipient: Address;
 }
+interface VaultExtensionParams {
+    /** Address that can claim vested tokens */
+    admin: Address;
+    /** Percentage of supply to lock, in BPS (1–9000 = 0.01%–90%) */
+    allocationBps: number;
+    /** Lockup duration in seconds (minimum 604800 = 7 days). Tokens are fully locked during this period. */
+    lockupDuration: number;
+    /** Vesting duration in seconds after lockup ends (0 = no vesting, tokens unlock all at once) */
+    vestingDuration?: number;
+}
 interface DeployTokenParams {
     name: string;
     symbol: string;
@@ -236,6 +246,30 @@ declare class LiquidSDK {
      * The paired token must be WETH for simple dev buys.
      */
     buildDevBuyExtension(devBuy: DevBuyParams): ExtensionConfig;
+    /**
+     * Build a vault extension config for token deployment.
+     *
+     * Locks a percentage of the token supply with a lockup period
+     * followed by optional linear vesting.
+     *
+     * @param vault - Vault parameters
+     * @returns ExtensionConfig to include in `deployToken({ extensions })`
+     *
+     * @example
+     * ```typescript
+     * const vaultExt = sdk.buildVaultExtension({
+     *   admin: account.address,
+     *   allocationBps: 2000,       // 20% of supply
+     *   lockupDuration: 2592000,   // 30 days in seconds
+     *   vestingDuration: 7776000,  // 90 days linear vesting after lockup
+     * });
+     * const result = await sdk.deployToken({
+     *   name: "My Token", symbol: "MTK",
+     *   extensions: [vaultExt],
+     * });
+     * ```
+     */
+    buildVaultExtension(vault: VaultExtensionParams): ExtensionConfig;
     /**
      * Validate a DeploymentConfig before sending to the contract.
      * Catches common mistakes client-side with clear error messages.
@@ -313,6 +347,8 @@ declare class LiquidSDK {
     collectRewardsWithoutUnlock(tokenAddress: Address, lockerAddress?: Address): Promise<Hash>;
     updateRewardRecipient(tokenAddress: Address, rewardIndex: bigint, newRecipient: Address, lockerAddress?: Address): Promise<Hash>;
     isExtensionEnabled(extensionAddress: Address): Promise<boolean>;
+    getMevDescendingFeesBlockDelay(): Promise<bigint>;
+    /** @deprecated Use getMevDescendingFeesBlockDelay() */
     getMevBlockDelay(): Promise<bigint>;
     getPoolUnlockTime(poolId: Hex): Promise<bigint>;
     /**
@@ -1603,6 +1639,29 @@ declare const LiquidPoolExtensionAllowlistAbi: readonly [{
     readonly stateMutability: "view";
 }];
 
+declare const LiquidMevDescendingFeesAbi: readonly [{
+    readonly type: "function";
+    readonly name: "blockDelay";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "poolUnlockTime";
+    readonly inputs: readonly [{
+        readonly name: "poolId";
+        readonly type: "bytes32";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+}];
+
 declare const LiquidMevBlockDelayAbi: readonly [{
     readonly type: "function";
     readonly name: "blockDelay";
@@ -2482,4 +2541,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, 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, buildContext, buildMetadata, createDefaultPositions, createPositions, createPositionsUSD, describePositions, encodeDynamicFeePoolData, encodeFeeConversionLockerData, encodeSniperAuctionData, encodeStaticFeePoolData, getTickFromMarketCapETH, getTickFromMarketCapStable, getTickFromMarketCapUSD, marketCapFromTickETH, marketCapFromTickUSD, parseContext, parseMetadata };
+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 };

package/dist/index.d.ts

@@ -53,6 +53,16 @@ interface DevBuyParams {
     /** Address to receive the purchased tokens */
     recipient: Address;
 }
+interface VaultExtensionParams {
+    /** Address that can claim vested tokens */
+    admin: Address;
+    /** Percentage of supply to lock, in BPS (1–9000 = 0.01%–90%) */
+    allocationBps: number;
+    /** Lockup duration in seconds (minimum 604800 = 7 days). Tokens are fully locked during this period. */
+    lockupDuration: number;
+    /** Vesting duration in seconds after lockup ends (0 = no vesting, tokens unlock all at once) */
+    vestingDuration?: number;
+}
 interface DeployTokenParams {
     name: string;
     symbol: string;
@@ -236,6 +246,30 @@ declare class LiquidSDK {
      * The paired token must be WETH for simple dev buys.
      */
     buildDevBuyExtension(devBuy: DevBuyParams): ExtensionConfig;
+    /**
+     * Build a vault extension config for token deployment.
+     *
+     * Locks a percentage of the token supply with a lockup period
+     * followed by optional linear vesting.
+     *
+     * @param vault - Vault parameters
+     * @returns ExtensionConfig to include in `deployToken({ extensions })`
+     *
+     * @example
+     * ```typescript
+     * const vaultExt = sdk.buildVaultExtension({
+     *   admin: account.address,
+     *   allocationBps: 2000,       // 20% of supply
+     *   lockupDuration: 2592000,   // 30 days in seconds
+     *   vestingDuration: 7776000,  // 90 days linear vesting after lockup
+     * });
+     * const result = await sdk.deployToken({
+     *   name: "My Token", symbol: "MTK",
+     *   extensions: [vaultExt],
+     * });
+     * ```
+     */
+    buildVaultExtension(vault: VaultExtensionParams): ExtensionConfig;
     /**
      * Validate a DeploymentConfig before sending to the contract.
      * Catches common mistakes client-side with clear error messages.
@@ -313,6 +347,8 @@ declare class LiquidSDK {
     collectRewardsWithoutUnlock(tokenAddress: Address, lockerAddress?: Address): Promise<Hash>;
     updateRewardRecipient(tokenAddress: Address, rewardIndex: bigint, newRecipient: Address, lockerAddress?: Address): Promise<Hash>;
     isExtensionEnabled(extensionAddress: Address): Promise<boolean>;
+    getMevDescendingFeesBlockDelay(): Promise<bigint>;
+    /** @deprecated Use getMevDescendingFeesBlockDelay() */
     getMevBlockDelay(): Promise<bigint>;
     getPoolUnlockTime(poolId: Hex): Promise<bigint>;
     /**
@@ -1603,6 +1639,29 @@ declare const LiquidPoolExtensionAllowlistAbi: readonly [{
     readonly stateMutability: "view";
 }];
 
+declare const LiquidMevDescendingFeesAbi: readonly [{
+    readonly type: "function";
+    readonly name: "blockDelay";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "poolUnlockTime";
+    readonly inputs: readonly [{
+        readonly name: "poolId";
+        readonly type: "bytes32";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+}];
+
 declare const LiquidMevBlockDelayAbi: readonly [{
     readonly type: "function";
     readonly name: "blockDelay";
@@ -2482,4 +2541,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, 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, buildContext, buildMetadata, createDefaultPositions, createPositions, createPositionsUSD, describePositions, encodeDynamicFeePoolData, encodeFeeConversionLockerData, encodeSniperAuctionData, encodeStaticFeePoolData, getTickFromMarketCapETH, getTickFromMarketCapStable, getTickFromMarketCapUSD, marketCapFromTickETH, marketCapFromTickUSD, parseContext, parseMetadata };
+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 };

package/dist/index.js

@@ -36,6 +36,7 @@ __export(index_exports, {
   LiquidHookDynamicFeeV2Abi: () => LiquidHookDynamicFeeV2Abi,
   LiquidLpLockerAbi: () => LiquidLpLockerAbi,
   LiquidMevBlockDelayAbi: () => LiquidMevBlockDelayAbi,
+  LiquidMevDescendingFeesAbi: () => LiquidMevDescendingFeesAbi,
   LiquidPoolExtensionAllowlistAbi: () => LiquidPoolExtensionAllowlistAbi,
   LiquidSDK: () => LiquidSDK,
   LiquidSniperAuctionV2Abi: () => LiquidSniperAuctionV2Abi,
@@ -873,8 +874,8 @@ var LiquidPoolExtensionAllowlistAbi = [
   }
 ];
 
-// src/abis/LiquidMevBlockDelay.ts
-var LiquidMevBlockDelayAbi = [
+// src/abis/LiquidMevDescendingFees.ts
+var LiquidMevDescendingFeesAbi = [
   {
     type: "function",
     name: "blockDelay",
@@ -1143,6 +1144,63 @@ var LiquidSDK = class {
       extensionData
     };
   }
+  /**
+   * Build a vault extension config for token deployment.
+   *
+   * Locks a percentage of the token supply with a lockup period
+   * followed by optional linear vesting.
+   *
+   * @param vault - Vault parameters
+   * @returns ExtensionConfig to include in `deployToken({ extensions })`
+   *
+   * @example
+   * ```typescript
+   * const vaultExt = sdk.buildVaultExtension({
+   *   admin: account.address,
+   *   allocationBps: 2000,       // 20% of supply
+   *   lockupDuration: 2592000,   // 30 days in seconds
+   *   vestingDuration: 7776000,  // 90 days linear vesting after lockup
+   * });
+   * const result = await sdk.deployToken({
+   *   name: "My Token", symbol: "MTK",
+   *   extensions: [vaultExt],
+   * });
+   * ```
+   */
+  buildVaultExtension(vault) {
+    const MIN_LOCKUP = 604800;
+    const MAX_BPS = 9e3;
+    if (vault.allocationBps < 1 || vault.allocationBps > MAX_BPS) {
+      throw new Error(`Vault allocationBps must be 1\u2013${MAX_BPS} (0.01%\u201390%). Got ${vault.allocationBps}.`);
+    }
+    if (vault.lockupDuration < MIN_LOCKUP) {
+      throw new Error(`Vault lockupDuration must be \u2265 ${MIN_LOCKUP} seconds (7 days). Got ${vault.lockupDuration}.`);
+    }
+    if (vault.vestingDuration !== void 0 && vault.vestingDuration < 0) {
+      throw new Error("Vault vestingDuration cannot be negative.");
+    }
+    const extensionData = (0, import_viem2.encodeAbiParameters)(
+      [
+        { type: "address" },
+        // admin
+        { type: "uint256" },
+        // lockupDuration
+        { type: "uint256" }
+        // vestingDuration
+      ],
+      [
+        vault.admin,
+        BigInt(vault.lockupDuration),
+        BigInt(vault.vestingDuration ?? 0)
+      ]
+    );
+    return {
+      extension: ADDRESSES.VAULT,
+      msgValue: 0n,
+      extensionBps: vault.allocationBps,
+      extensionData
+    };
+  }
   // ── Validation ─────────────────────────────────────────────────
   /**
    * Validate a DeploymentConfig before sending to the contract.
@@ -1863,18 +1921,22 @@ var LiquidSDK = class {
       args: [extensionAddress]
     });
   }
-  // ── MEV Block Delay ─────────────────────────────────────────────────
-  async getMevBlockDelay() {
+  // ── MEV Descending Fees ─────────────────────────────────────────────
+  async getMevDescendingFeesBlockDelay() {
     return await this.publicClient.readContract({
       address: ADDRESSES.MEV_DESCENDING_FEES,
-      abi: LiquidMevBlockDelayAbi,
+      abi: LiquidMevDescendingFeesAbi,
       functionName: "blockDelay"
     });
   }
+  /** @deprecated Use getMevDescendingFeesBlockDelay() */
+  async getMevBlockDelay() {
+    return this.getMevDescendingFeesBlockDelay();
+  }
   async getPoolUnlockTime(poolId) {
     return await this.publicClient.readContract({
       address: ADDRESSES.MEV_DESCENDING_FEES,
-      abi: LiquidMevBlockDelayAbi,
+      abi: LiquidMevDescendingFeesAbi,
       functionName: "poolUnlockTime",
       args: [poolId]
     });
@@ -2021,6 +2083,24 @@ var LiquidSDK = class {
   }
 };
 
+// src/abis/LiquidMevBlockDelay.ts
+var LiquidMevBlockDelayAbi = [
+  {
+    type: "function",
+    name: "blockDelay",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "poolUnlockTime",
+    inputs: [{ name: "poolId", type: "bytes32" }],
+    outputs: [{ name: "", type: "uint256" }],
+    stateMutability: "view"
+  }
+];
+
 // src/abis/LiquidUniv4EthDevBuy.ts
 var LiquidUniv4EthDevBuyAbi = [
   {
@@ -2296,6 +2376,7 @@ function describePositions(positions, ethPriceUSD) {
   LiquidHookDynamicFeeV2Abi,
   LiquidLpLockerAbi,
   LiquidMevBlockDelayAbi,
+  LiquidMevDescendingFeesAbi,
   LiquidPoolExtensionAllowlistAbi,
   LiquidSDK,
   LiquidSniperAuctionV2Abi,