liquid-sdk 1.1.0 → 1.3.0

package/dist/index.js

@@ -39,9 +39,13 @@ __export(index_exports, {
   LiquidSDK: () => LiquidSDK,
   LiquidSniperAuctionV2Abi: () => LiquidSniperAuctionV2Abi,
   LiquidSniperUtilV2Abi: () => LiquidSniperUtilV2Abi,
+  LiquidTokenAbi: () => LiquidTokenAbi,
+  LiquidUniv4EthDevBuyAbi: () => LiquidUniv4EthDevBuyAbi,
   LiquidVaultAbi: () => LiquidVaultAbi,
   POOL_POSITIONS: () => POOL_POSITIONS,
   TOKEN: () => TOKEN,
+  buildContext: () => buildContext,
+  buildMetadata: () => buildMetadata,
   createDefaultPositions: () => createDefaultPositions,
   createPositions: () => createPositions,
   createPositionsUSD: () => createPositionsUSD,
@@ -53,7 +57,9 @@ __export(index_exports, {
   getTickFromMarketCapStable: () => getTickFromMarketCapStable,
   getTickFromMarketCapUSD: () => getTickFromMarketCapUSD,
   marketCapFromTickETH: () => marketCapFromTickETH,
-  marketCapFromTickUSD: () => marketCapFromTickUSD
+  marketCapFromTickUSD: () => marketCapFromTickUSD,
+  parseContext: () => parseContext,
+  parseMetadata: () => parseMetadata
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -145,6 +151,8 @@ var POOL_POSITIONS = {
 };
 var DEFAULTS = {
   HOOK: ADDRESSES.HOOK_STATIC_FEE_V2,
+  /** LP Locker with fee conversion (converts fees to ETH before distributing) */
+  LOCKER: ADDRESSES.LP_LOCKER_FEE_CONVERSION,
   TICK_SPACING: 200,
   TICK_IF_TOKEN0_IS_LIQUID: -230400,
   /** Static fee on buys (ETH → token): 1% (100 bps). Fees collected in ETH. */
@@ -253,6 +261,68 @@ function encodeSniperAuctionData(config) {
   ]);
 }
 
+// src/utils/context.ts
+function buildContext(input) {
+  const ctx = {
+    interface: input?.interface ?? "SDK"
+  };
+  if (input?.platform !== void 0) ctx.platform = input.platform;
+  if (input?.messageId !== void 0) ctx.messageId = input.messageId;
+  if (input?.id !== void 0) ctx.id = input.id;
+  return JSON.stringify(ctx);
+}
+function buildMetadata(input) {
+  if (!input) return "{}";
+  const meta = {};
+  if (input.description !== void 0) meta.description = input.description;
+  if (input.socialMediaUrls !== void 0 && input.socialMediaUrls.length > 0) {
+    meta.socialMediaUrls = input.socialMediaUrls;
+  }
+  if (input.auditUrls !== void 0 && input.auditUrls.length > 0) {
+    meta.auditUrls = input.auditUrls;
+  }
+  return JSON.stringify(meta);
+}
+function parseContext(contextString) {
+  if (!contextString || contextString === "") return null;
+  try {
+    const parsed = JSON.parse(contextString);
+    if (typeof parsed !== "object" || parsed === null) return null;
+    return {
+      interface: typeof parsed.interface === "string" ? parsed.interface : "unknown",
+      ...typeof parsed.platform === "string" && { platform: parsed.platform },
+      ...typeof parsed.messageId === "string" && { messageId: parsed.messageId },
+      ...typeof parsed.id === "string" && { id: parsed.id }
+    };
+  } catch {
+    return null;
+  }
+}
+function parseMetadata(metadataString) {
+  if (!metadataString || metadataString === "") return null;
+  try {
+    const parsed = JSON.parse(metadataString);
+    if (typeof parsed !== "object" || parsed === null) return null;
+    const result = {};
+    if (typeof parsed.description === "string") {
+      result.description = parsed.description;
+    }
+    if (Array.isArray(parsed.socialMediaUrls)) {
+      result.socialMediaUrls = parsed.socialMediaUrls.filter(
+        (item) => typeof item === "object" && item !== null && typeof item.platform === "string" && typeof item.url === "string"
+      );
+    }
+    if (Array.isArray(parsed.auditUrls)) {
+      result.auditUrls = parsed.auditUrls.filter(
+        (item) => typeof item === "string"
+      );
+    }
+    return result;
+  } catch {
+    return null;
+  }
+}
+
 // src/abis/LiquidFactory.ts
 var LiquidFactoryAbi = [
   {
@@ -871,6 +941,52 @@ var LiquidLpLockerAbi = [
   }
 ];
 
+// src/abis/LiquidToken.ts
+var LiquidTokenAbi = [
+  {
+    type: "function",
+    name: "updateImage",
+    inputs: [{ name: "image_", type: "string" }],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "updateMetadata",
+    inputs: [{ name: "metadata_", type: "string" }],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "updateAdmin",
+    inputs: [{ name: "admin_", type: "address" }],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "event",
+    name: "UpdateImage",
+    inputs: [{ name: "image", type: "string", indexed: false }],
+    anonymous: false
+  },
+  {
+    type: "event",
+    name: "UpdateMetadata",
+    inputs: [{ name: "metadata", type: "string", indexed: false }],
+    anonymous: false
+  },
+  {
+    type: "event",
+    name: "UpdateAdmin",
+    inputs: [
+      { name: "oldAdmin", type: "address", indexed: false },
+      { name: "newAdmin", type: "address", indexed: false }
+    ],
+    anonymous: false
+  }
+];
+
 // src/abis/ERC20.ts
 var ERC20Abi = [
   {
@@ -1106,7 +1222,7 @@ var LiquidSDK = class {
         ),
         image: params.image ?? "",
         metadata: params.metadata ?? "",
-        context: params.context ?? "",
+        context: params.context ?? buildContext(),
         originatingChainId: BigInt(DEFAULT_CHAIN_ID)
       },
       poolConfig: {
@@ -1120,7 +1236,7 @@ var LiquidSDK = class {
         )
       },
       lockerConfig: {
-        locker: params.locker ?? ADDRESSES.LP_LOCKER,
+        locker: params.locker ?? DEFAULTS.LOCKER,
         rewardAdmins: params.rewardAdmins ?? [account],
         rewardRecipients: params.rewardRecipients ?? [account],
         rewardBps: params.rewardBps ?? [1e4],
@@ -1510,7 +1626,7 @@ var LiquidSDK = class {
   }
   // ── LP Locker ───────────────────────────────────────────────────────
   async getTokenRewards(tokenAddress, lockerAddress) {
-    const locker = lockerAddress ?? ADDRESSES.LP_LOCKER;
+    const locker = lockerAddress ?? DEFAULTS.LOCKER;
     const result = await this.publicClient.readContract({
       address: locker,
       abi: LiquidLpLockerAbi,
@@ -1532,7 +1648,7 @@ var LiquidSDK = class {
     if (!this.walletClient?.account) {
       throw new Error("walletClient with account required for collectRewards");
     }
-    const locker = lockerAddress ?? ADDRESSES.LP_LOCKER;
+    const locker = lockerAddress ?? DEFAULTS.LOCKER;
     return await this.walletClient.writeContract({
       address: locker,
       abi: LiquidLpLockerAbi,
@@ -1548,7 +1664,7 @@ var LiquidSDK = class {
         "walletClient with account required for collectRewardsWithoutUnlock"
       );
     }
-    const locker = lockerAddress ?? ADDRESSES.LP_LOCKER;
+    const locker = lockerAddress ?? DEFAULTS.LOCKER;
     return await this.walletClient.writeContract({
       address: locker,
       abi: LiquidLpLockerAbi,
@@ -1564,7 +1680,7 @@ var LiquidSDK = class {
         "walletClient with account required for updateRewardRecipient"
       );
     }
-    const locker = lockerAddress ?? ADDRESSES.LP_LOCKER;
+    const locker = lockerAddress ?? DEFAULTS.LOCKER;
     return await this.walletClient.writeContract({
       address: locker,
       abi: LiquidLpLockerAbi,
@@ -1599,8 +1715,298 @@ var LiquidSDK = class {
       args: [poolId]
     });
   }
+  // ── Token Metadata Updates ──────────────────────────────────────────
+  /**
+   * Update a token's image. Must be called by the token admin.
+   */
+  async updateImage(tokenAddress, newImage) {
+    if (!this.walletClient?.account) {
+      throw new Error("walletClient with account required for updateImage");
+    }
+    return await this.walletClient.writeContract({
+      address: tokenAddress,
+      abi: LiquidTokenAbi,
+      functionName: "updateImage",
+      args: [newImage],
+      chain: import_chains2.base,
+      account: this.walletClient.account
+    });
+  }
+  /**
+   * Update a token's metadata. Must be called by the token admin.
+   */
+  async updateMetadata(tokenAddress, newMetadata) {
+    if (!this.walletClient?.account) {
+      throw new Error("walletClient with account required for updateMetadata");
+    }
+    return await this.walletClient.writeContract({
+      address: tokenAddress,
+      abi: LiquidTokenAbi,
+      functionName: "updateMetadata",
+      args: [newMetadata],
+      chain: import_chains2.base,
+      account: this.walletClient.account
+    });
+  }
+  // ── Token Discovery ─────────────────────────────────────────────────
+  /**
+   * Get all tokens deployed by a specific address by querying TokenCreated events.
+   * @param deployer - The address that deployed the tokens (msgSender)
+   * @param fromBlock - Starting block to search from (defaults to 0n)
+   * @param toBlock - Ending block to search to (defaults to 'latest')
+   */
+  async getDeployedTokens(deployer, fromBlock, toBlock) {
+    return this.getTokens({ deployer, fromBlock, toBlock });
+  }
+  /**
+   * Query TokenCreated events with optional filtering.
+   *
+   * Use this for token discovery, indexing, or building token lists.
+   * Returns events in chronological order with block numbers for pagination.
+   *
+   * @example
+   * // Get all tokens
+   * const allTokens = await sdk.getTokens();
+   *
+   * // Get tokens by deployer
+   * const myTokens = await sdk.getTokens({ deployer: myAddress });
+   *
+   * // Paginate with block ranges
+   * const page1 = await sdk.getTokens({ fromBlock: 20000000n, toBlock: 20100000n });
+   * const page2 = await sdk.getTokens({ fromBlock: 20100001n, toBlock: 20200000n });
+   */
+  async getTokens(options) {
+    const logs = await this.publicClient.getLogs({
+      address: ADDRESSES.FACTORY,
+      event: (0, import_viem2.parseAbiItem)(
+        "event TokenCreated(address msgSender, address indexed tokenAddress, address indexed tokenAdmin, string tokenImage, string tokenName, string tokenSymbol, string tokenMetadata, string tokenContext, int24 startingTick, address poolHook, bytes32 poolId, address pairedToken, address locker, address mevModule, uint256 extensionsSupply, address[] extensions)"
+      ),
+      fromBlock: options?.fromBlock ?? 0n,
+      toBlock: options?.toBlock ?? "latest"
+    });
+    const deployer = options?.deployer;
+    return logs.filter((log) => {
+      if (!deployer) return true;
+      const sender = log.args.msgSender;
+      return sender && (0, import_viem2.getAddress)(sender) === (0, import_viem2.getAddress)(deployer);
+    }).map((log) => {
+      const args = log.args;
+      return {
+        msgSender: args.msgSender,
+        tokenAddress: args.tokenAddress,
+        tokenAdmin: args.tokenAdmin,
+        tokenImage: args.tokenImage,
+        tokenName: args.tokenName,
+        tokenSymbol: args.tokenSymbol,
+        tokenMetadata: args.tokenMetadata,
+        tokenContext: args.tokenContext,
+        startingTick: args.startingTick,
+        poolHook: args.poolHook,
+        poolId: args.poolId,
+        pairedToken: args.pairedToken,
+        locker: args.locker,
+        mevModule: args.mevModule,
+        extensionsSupply: args.extensionsSupply,
+        extensions: args.extensions,
+        blockNumber: log.blockNumber
+      };
+    });
+  }
+  /**
+   * Look up a single token's on-chain event data by contract address.
+   *
+   * Returns the full TokenCreated event including metadata, context, poolId,
+   * hook, locker, extensions — everything a wallet or aggregator needs to
+   * display the token. Returns `null` if not found.
+   *
+   * This is indexed on-chain (tokenAddress is indexed in the event), so it's
+   * a single RPC call regardless of how many tokens exist.
+   */
+  async getTokenEvent(tokenAddress) {
+    const logs = await this.publicClient.getLogs({
+      address: ADDRESSES.FACTORY,
+      event: (0, import_viem2.parseAbiItem)(
+        "event TokenCreated(address msgSender, address indexed tokenAddress, address indexed tokenAdmin, string tokenImage, string tokenName, string tokenSymbol, string tokenMetadata, string tokenContext, int24 startingTick, address poolHook, bytes32 poolId, address pairedToken, address locker, address mevModule, uint256 extensionsSupply, address[] extensions)"
+      ),
+      args: { tokenAddress },
+      fromBlock: 0n,
+      toBlock: "latest"
+    });
+    if (logs.length === 0) return null;
+    const log = logs[0];
+    const args = log.args;
+    return {
+      msgSender: args.msgSender,
+      tokenAddress: args.tokenAddress,
+      tokenAdmin: args.tokenAdmin,
+      tokenImage: args.tokenImage,
+      tokenName: args.tokenName,
+      tokenSymbol: args.tokenSymbol,
+      tokenMetadata: args.tokenMetadata,
+      tokenContext: args.tokenContext,
+      startingTick: args.startingTick,
+      poolHook: args.poolHook,
+      poolId: args.poolId,
+      pairedToken: args.pairedToken,
+      locker: args.locker,
+      mevModule: args.mevModule,
+      extensionsSupply: args.extensionsSupply,
+      extensions: args.extensions,
+      blockNumber: log.blockNumber
+    };
+  }
 };
 
+// src/abis/LiquidUniv4EthDevBuy.ts
+var LiquidUniv4EthDevBuyAbi = [
+  {
+    type: "constructor",
+    inputs: [
+      { name: "factory_", type: "address" },
+      { name: "weth_", type: "address" },
+      { name: "universalRouter_", type: "address" },
+      { name: "permit2_", type: "address" }
+    ],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "factory",
+    inputs: [],
+    outputs: [{ name: "", type: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "weth",
+    inputs: [],
+    outputs: [{ name: "", type: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "universalRouter",
+    inputs: [],
+    outputs: [{ name: "", type: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "permit2",
+    inputs: [],
+    outputs: [{ name: "", type: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "receiveTokens",
+    inputs: [
+      {
+        name: "deploymentConfig",
+        type: "tuple",
+        components: [
+          {
+            name: "tokenConfig",
+            type: "tuple",
+            components: [
+              { name: "tokenAdmin", type: "address" },
+              { name: "name", type: "string" },
+              { name: "symbol", type: "string" },
+              { name: "salt", type: "bytes32" },
+              { name: "image", type: "string" },
+              { name: "metadata", type: "string" },
+              { name: "context", type: "string" },
+              { name: "originatingChainId", type: "uint256" }
+            ]
+          },
+          {
+            name: "poolConfig",
+            type: "tuple",
+            components: [
+              { name: "hook", type: "address" },
+              { name: "pairedToken", type: "address" },
+              { name: "tickIfToken0IsLiquid", type: "int24" },
+              { name: "tickSpacing", type: "int24" },
+              { name: "poolData", type: "bytes" }
+            ]
+          },
+          {
+            name: "lockerConfig",
+            type: "tuple",
+            components: [
+              { name: "locker", type: "address" },
+              { name: "rewardAdmins", type: "address[]" },
+              { name: "rewardRecipients", type: "address[]" },
+              { name: "rewardBps", type: "uint16[]" },
+              { name: "tickLower", type: "int24[]" },
+              { name: "tickUpper", type: "int24[]" },
+              { name: "positionBps", type: "uint16[]" },
+              { name: "lockerData", type: "bytes" }
+            ]
+          },
+          {
+            name: "mevModuleConfig",
+            type: "tuple",
+            components: [
+              { name: "mevModule", type: "address" },
+              { name: "mevModuleData", type: "bytes" }
+            ]
+          },
+          {
+            name: "extensionConfigs",
+            type: "tuple[]",
+            components: [
+              { name: "extension", type: "address" },
+              { name: "msgValue", type: "uint256" },
+              { name: "extensionBps", type: "uint16" },
+              { name: "extensionData", type: "bytes" }
+            ]
+          }
+        ]
+      },
+      {
+        name: "tokenPoolKey",
+        type: "tuple",
+        components: [
+          { name: "currency0", type: "address" },
+          { name: "currency1", type: "address" },
+          { name: "fee", type: "uint24" },
+          { name: "tickSpacing", type: "int24" },
+          { name: "hooks", type: "address" }
+        ]
+      },
+      { name: "token", type: "address" },
+      { name: "extensionSupply", type: "uint256" },
+      { name: "extensionIndex", type: "uint256" }
+    ],
+    outputs: [],
+    stateMutability: "payable"
+  },
+  {
+    type: "function",
+    name: "supportsInterface",
+    inputs: [{ name: "interfaceId", type: "bytes4" }],
+    outputs: [{ name: "", type: "bool" }],
+    stateMutability: "pure"
+  },
+  {
+    type: "event",
+    name: "EthDevBuy",
+    inputs: [
+      { name: "token", type: "address", indexed: true },
+      { name: "user", type: "address", indexed: true },
+      { name: "ethAmount", type: "uint256", indexed: false },
+      { name: "tokenAmount", type: "uint256", indexed: false }
+    ],
+    anonymous: false
+  },
+  { type: "error", name: "InvalidEthDevBuyPercentage", inputs: [] },
+  { type: "error", name: "InvalidMsgValue", inputs: [] },
+  { type: "error", name: "InvalidPairedTokenPoolKey", inputs: [] },
+  { type: "error", name: "ReentrancyGuardReentrantCall", inputs: [] },
+  { type: "error", name: "Unauthorized", inputs: [] }
+];
+
 // src/utils/tick-math.ts
 var LOG_BASE = Math.log(1.0001);
 var DEFAULT_TICK_SPACING = 200;
@@ -1729,9 +2135,13 @@ function describePositions(positions, ethPriceUSD) {
   LiquidSDK,
   LiquidSniperAuctionV2Abi,
   LiquidSniperUtilV2Abi,
+  LiquidTokenAbi,
+  LiquidUniv4EthDevBuyAbi,
   LiquidVaultAbi,
   POOL_POSITIONS,
   TOKEN,
+  buildContext,
+  buildMetadata,
   createDefaultPositions,
   createPositions,
   createPositionsUSD,
@@ -1743,6 +2153,8 @@ function describePositions(positions, ethPriceUSD) {
   getTickFromMarketCapStable,
   getTickFromMarketCapUSD,
   marketCapFromTickETH,
-  marketCapFromTickUSD
+  marketCapFromTickUSD,
+  parseContext,
+  parseMetadata
 });
 //# sourceMappingURL=index.js.map