liquid-sdk 1.3.0 → 1.3.2

package/README.md

@@ -13,25 +13,20 @@ npm install liquid-sdk viem
 ## Quick Start
 
 ```typescript
-import { createPublicClient, createWalletClient, http } from "viem";
+import { createWalletClient, http } from "viem";
 import { privateKeyToAccount } from "viem/accounts";
 import { base } from "viem/chains";
 import { LiquidSDK } from "liquid-sdk";
 
 const account = privateKeyToAccount(process.env.PRIVATE_KEY as `0x${string}`);
 
-const publicClient = createPublicClient({
-  chain: base,
-  transport: http(),
-});
-
 const walletClient = createWalletClient({
   account,
   chain: base,
   transport: http(),
 });
 
-const liquid = new LiquidSDK({ publicClient, walletClient });
+const liquid = new LiquidSDK({ walletClient });
 ```
 
 ## Deploy a Token
@@ -219,11 +214,11 @@ import {
 #### Constructor
 
 ```typescript
-new LiquidSDK({ publicClient, walletClient? })
+new LiquidSDK({ walletClient, publicClient? })
 ```
 
-- `publicClient` (required) - viem `PublicClient` connected to Base
 - `walletClient` (optional) - viem `WalletClient` for write operations
+- `publicClient` (optional) - viem `PublicClient` connected to Base (auto-created if omitted)
 
 #### Methods
 

package/dist/index.d.mts

@@ -194,7 +194,7 @@ interface TokenRewardInfo {
     rewardRecipients: Address[];
 }
 interface LiquidSDKConfig {
-    publicClient: any;
+    publicClient?: any;
     walletClient?: any;
 }
 interface DeployTokenResult {
@@ -2311,6 +2311,38 @@ interface SniperAuctionConfig {
  * ```
  */
 declare function encodeSniperAuctionData(config: SniperAuctionConfig): Hex;
+/**
+ * Fee preference for LP_LOCKER_FEE_CONVERSION.
+ * Determines which token each reward recipient receives their fees in.
+ *
+ * - `Both` (0): No conversion, fees paid in whichever token accrues
+ * - `Paired` (1): Convert fees to paired token (usually WETH)
+ * - `Liquid` (2): Convert fees to the liquid token
+ */
+declare enum FeePreference {
+    Both = 0,
+    Paired = 1,
+    Liquid = 2
+}
+/**
+ * Encode lockerData for LP_LOCKER_FEE_CONVERSION.
+ *
+ * The fee conversion locker requires a `FeeIn[]` array with one entry per
+ * reward recipient, specifying how each recipient wants their fees.
+ *
+ * @param feePreferences - Array of FeePreference values, one per reward recipient
+ * @returns Encoded lockerData hex string
+ *
+ * @example
+ * ```ts
+ * // Single recipient, fees converted to ETH
+ * const lockerData = encodeFeeConversionLockerData([FeePreference.Paired]);
+ *
+ * // Two recipients: first gets ETH, second gets the token
+ * const lockerData = encodeFeeConversionLockerData([FeePreference.Paired, FeePreference.Liquid]);
+ * ```
+ */
+declare function encodeFeeConversionLockerData(feePreferences: FeePreference[]): Hex;
 
 /** Provenance — who launched the token and from where. */
 interface LiquidContext {
@@ -2364,4 +2396,4 @@ declare function parseContext(contextString: string): LiquidContext | null;
  */
 declare function parseMetadata(metadataString: string): LiquidMetadata | null;
 
-export { ADDRESSES, type AirdropInfo, 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, 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, encodeSniperAuctionData, encodeStaticFeePoolData, getTickFromMarketCapETH, getTickFromMarketCapStable, getTickFromMarketCapUSD, marketCapFromTickETH, marketCapFromTickUSD, parseContext, parseMetadata };
+export { ADDRESSES, type AirdropInfo, 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 };

package/dist/index.d.ts

@@ -194,7 +194,7 @@ interface TokenRewardInfo {
     rewardRecipients: Address[];
 }
 interface LiquidSDKConfig {
-    publicClient: any;
+    publicClient?: any;
     walletClient?: any;
 }
 interface DeployTokenResult {
@@ -2311,6 +2311,38 @@ interface SniperAuctionConfig {
  * ```
  */
 declare function encodeSniperAuctionData(config: SniperAuctionConfig): Hex;
+/**
+ * Fee preference for LP_LOCKER_FEE_CONVERSION.
+ * Determines which token each reward recipient receives their fees in.
+ *
+ * - `Both` (0): No conversion, fees paid in whichever token accrues
+ * - `Paired` (1): Convert fees to paired token (usually WETH)
+ * - `Liquid` (2): Convert fees to the liquid token
+ */
+declare enum FeePreference {
+    Both = 0,
+    Paired = 1,
+    Liquid = 2
+}
+/**
+ * Encode lockerData for LP_LOCKER_FEE_CONVERSION.
+ *
+ * The fee conversion locker requires a `FeeIn[]` array with one entry per
+ * reward recipient, specifying how each recipient wants their fees.
+ *
+ * @param feePreferences - Array of FeePreference values, one per reward recipient
+ * @returns Encoded lockerData hex string
+ *
+ * @example
+ * ```ts
+ * // Single recipient, fees converted to ETH
+ * const lockerData = encodeFeeConversionLockerData([FeePreference.Paired]);
+ *
+ * // Two recipients: first gets ETH, second gets the token
+ * const lockerData = encodeFeeConversionLockerData([FeePreference.Paired, FeePreference.Liquid]);
+ * ```
+ */
+declare function encodeFeeConversionLockerData(feePreferences: FeePreference[]): Hex;
 
 /** Provenance — who launched the token and from where. */
 interface LiquidContext {
@@ -2364,4 +2396,4 @@ declare function parseContext(contextString: string): LiquidContext | null;
  */
 declare function parseMetadata(metadataString: string): LiquidMetadata | null;
 
-export { ADDRESSES, type AirdropInfo, 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, 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, encodeSniperAuctionData, encodeStaticFeePoolData, getTickFromMarketCapETH, getTickFromMarketCapStable, getTickFromMarketCapUSD, marketCapFromTickETH, marketCapFromTickUSD, parseContext, parseMetadata };
+export { ADDRESSES, type AirdropInfo, 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 };

package/dist/index.js

@@ -29,6 +29,7 @@ __export(index_exports, {
   ERC20Abi: () => ERC20Abi,
   EXTERNAL: () => EXTERNAL,
   FEE: () => FEE,
+  FeePreference: () => FeePreference,
   LiquidAirdropV2Abi: () => LiquidAirdropV2Abi,
   LiquidFactoryAbi: () => LiquidFactoryAbi,
   LiquidFeeLockerAbi: () => LiquidFeeLockerAbi,
@@ -51,6 +52,7 @@ __export(index_exports, {
   createPositionsUSD: () => createPositionsUSD,
   describePositions: () => describePositions,
   encodeDynamicFeePoolData: () => encodeDynamicFeePoolData,
+  encodeFeeConversionLockerData: () => encodeFeeConversionLockerData,
   encodeSniperAuctionData: () => encodeSniperAuctionData,
   encodeStaticFeePoolData: () => encodeStaticFeePoolData,
   getTickFromMarketCapETH: () => getTickFromMarketCapETH,
@@ -260,6 +262,25 @@ function encodeSniperAuctionData(config) {
     }
   ]);
 }
+var FeePreference = /* @__PURE__ */ ((FeePreference2) => {
+  FeePreference2[FeePreference2["Both"] = 0] = "Both";
+  FeePreference2[FeePreference2["Paired"] = 1] = "Paired";
+  FeePreference2[FeePreference2["Liquid"] = 2] = "Liquid";
+  return FeePreference2;
+})(FeePreference || {});
+function encodeFeeConversionLockerData(feePreferences) {
+  return (0, import_viem.encodeAbiParameters)(
+    [
+      {
+        type: "tuple",
+        components: [
+          { name: "feePreference", type: "uint8[]" }
+        ]
+      }
+    ],
+    [{ feePreference: feePreferences }]
+  );
+}
 
 // src/utils/context.ts
 function buildContext(input) {
@@ -1061,7 +1082,10 @@ var LiquidSDK = class {
   publicClient;
   walletClient;
   constructor(config) {
-    this.publicClient = config.publicClient;
+    this.publicClient = config.publicClient ?? (0, import_viem2.createPublicClient)({
+      chain: import_chains2.base,
+      transport: (0, import_viem2.http)()
+    });
     this.walletClient = config.walletClient;
   }
   // ── Dev Buy Helper ───────────────────────────────────────────────
@@ -1235,16 +1259,27 @@ var LiquidSDK = class {
           DEFAULTS.PAIRED_FEE_BPS
         )
       },
-      lockerConfig: {
-        locker: params.locker ?? DEFAULTS.LOCKER,
-        rewardAdmins: params.rewardAdmins ?? [account],
-        rewardRecipients: params.rewardRecipients ?? [account],
-        rewardBps: params.rewardBps ?? [1e4],
-        tickLower: params.tickLower ?? POOL_POSITIONS.Liquid.map((p) => p.tickLower),
-        tickUpper: params.tickUpper ?? POOL_POSITIONS.Liquid.map((p) => p.tickUpper),
-        positionBps: params.positionBps ?? POOL_POSITIONS.Liquid.map((p) => p.positionBps),
-        lockerData: params.lockerData ?? "0x"
-      },
+      lockerConfig: (() => {
+        const locker = params.locker ?? DEFAULTS.LOCKER;
+        const rewardRecipients = params.rewardRecipients ?? [account];
+        const rewardBps = params.rewardBps ?? [1e4];
+        let lockerData = params.lockerData ?? "0x";
+        if (lockerData === "0x" && (0, import_viem2.getAddress)(locker) === (0, import_viem2.getAddress)(ADDRESSES.LP_LOCKER_FEE_CONVERSION)) {
+          lockerData = encodeFeeConversionLockerData(
+            rewardRecipients.map(() => 1 /* Paired */)
+          );
+        }
+        return {
+          locker,
+          rewardAdmins: params.rewardAdmins ?? [account],
+          rewardRecipients,
+          rewardBps,
+          tickLower: params.tickLower ?? POOL_POSITIONS.Liquid.map((p) => p.tickLower),
+          tickUpper: params.tickUpper ?? POOL_POSITIONS.Liquid.map((p) => p.tickUpper),
+          positionBps: params.positionBps ?? POOL_POSITIONS.Liquid.map((p) => p.positionBps),
+          lockerData
+        };
+      })(),
       mevModuleConfig: {
         mevModule: params.mevModule ?? DEFAULTS.MEV_MODULE,
         mevModuleData: params.mevModuleData ?? encodeSniperAuctionData({
@@ -2125,6 +2160,7 @@ function describePositions(positions, ethPriceUSD) {
   ERC20Abi,
   EXTERNAL,
   FEE,
+  FeePreference,
   LiquidAirdropV2Abi,
   LiquidFactoryAbi,
   LiquidFeeLockerAbi,
@@ -2147,6 +2183,7 @@ function describePositions(positions, ethPriceUSD) {
   createPositionsUSD,
   describePositions,
   encodeDynamicFeePoolData,
+  encodeFeeConversionLockerData,
   encodeSniperAuctionData,
   encodeStaticFeePoolData,
   getTickFromMarketCapETH,