hak-saucerswap-plugin 1.0.1 → 2.0.0

package/dist/index.js

@@ -1,7 +1,7 @@
+import { BaseTool, handleTransaction } from '@hashgraph/hedera-agent-kit';
 import { z } from 'zod';
 import axios from 'axios';
-import { ContractFunctionParameters, ContractExecuteTransaction, AccountId, TokenId, ContractId } from '@hashgraph/sdk';
-import { AgentMode } from 'hedera-agent-kit';
+import { ContractFunctionParameters, ContractExecuteTransaction, AccountId, TokenId, ContractId } from '@hiero-ledger/sdk';
 
 // src/tools/farms.ts
 
@@ -34,7 +34,8 @@ var SaucerSwapClient = class {
     this.retries = options.retries ?? 2;
     this.http = options.http ?? axios.create({
       baseURL: options.baseUrl ?? "https://api.saucerswap.finance",
-      timeout: options.timeoutMs ?? 1e4
+      timeout: options.timeoutMs ?? 1e4,
+      headers: options.apiKey ? { "x-api-key": options.apiKey } : void 0
     });
   }
   async request(path, params) {
@@ -176,6 +177,7 @@ var resolveSaucerSwapConfig = (context) => {
     baseUrl: ctxConfig.baseUrl ?? process.env.SAUCERSWAP_BASE_URL ?? DEFAULT_CONFIG.baseUrl,
     timeoutMs: ctxConfig.timeoutMs ?? toNumber(process.env.SAUCERSWAP_TIMEOUT_MS, DEFAULT_CONFIG.timeoutMs),
     retries: ctxConfig.retries ?? toNumber(process.env.SAUCERSWAP_RETRIES, DEFAULT_CONFIG.retries),
+    apiKey: ctxConfig.apiKey ?? process.env.SAUCERSWAP_API_KEY,
     routerContractId: ctxConfig.routerContractId ?? process.env.SAUCERSWAP_ROUTER_CONTRACT_ID,
     routerV2ContractId: ctxConfig.routerV2ContractId ?? process.env.SAUCERSWAP_ROUTER_V2_CONTRACT_ID,
     wrappedHbarTokenId: ctxConfig.wrappedHbarTokenId ?? process.env.SAUCERSWAP_WRAPPED_HBAR_TOKEN_ID,
@@ -193,13 +195,18 @@ var resolveSaucerSwapConfig = (context) => {
 var farmsInputSchema = z.object({
   poolId: z.number().int().positive().optional().describe("Optional pool ID to filter farms")
 });
-var farmsTool = {
-  method: "saucerswap_get_farms",
-  name: "SaucerSwap Get Farms",
-  description: "Get active farming opportunities on SaucerSwap.",
-  parameters: farmsInputSchema,
-  execute: async (_client, context, params) => {
-    const args = farmsInputSchema.parse(params);
+var FarmsTool = class extends BaseTool {
+  constructor() {
+    super(...arguments);
+    this.method = "saucerswap_get_farms";
+    this.name = "SaucerSwap Get Farms";
+    this.description = "Get active farming opportunities on SaucerSwap.";
+    this.parameters = farmsInputSchema;
+  }
+  async normalizeParams(params, _context, _client) {
+    return farmsInputSchema.parse(params);
+  }
+  async coreAction(args, context, _client) {
     const config = resolveSaucerSwapConfig(context);
     const api = context.saucerswapClient ?? createSaucerSwapClient(config);
     try {
@@ -216,7 +223,14 @@ var farmsTool = {
       };
     }
   }
+  async shouldSecondaryAction(_coreActionResult, _context) {
+    return false;
+  }
+  async secondaryAction(_request, _client, _context) {
+    return null;
+  }
 };
+var farmsTool = new FarmsTool();
 
 // src/utils/amm.ts
 var calculatePriceImpact = (inputAmount, outputAmount, poolReserveIn, poolReserveOut) => {
@@ -266,25 +280,6 @@ var accountIdToSolidityAddress = (accountId) => {
 var contractIdFromString = (contractId) => {
   return ContractId.fromString(contractId);
 };
-var finalizeTransaction = async (transaction, client, context, extra) => {
-  const mode = context.mode;
-  if (mode === AgentMode.RETURN_BYTES || mode === "returnBytes" || mode === "RETURN_BYTES") {
-    const txBytes = await transaction.toBytes();
-    return {
-      success: true,
-      transactionBytes: Buffer.from(txBytes).toString("base64"),
-      ...extra
-    };
-  }
-  const response = await transaction.execute(client);
-  const receipt = await response.getReceipt(client);
-  return {
-    success: true,
-    transactionId: response.transactionId?.toString(),
-    status: receipt.status.toString(),
-    ...extra
-  };
-};
 
 // src/utils/units.ts
 var parseUnits = (amount, decimals) => {
@@ -323,6 +318,9 @@ var removeLiquidityInputSchema = z.object({
   minAmountA: z.string().describe("Minimum amount of tokenA to receive"),
   minAmountB: z.string().describe("Minimum amount of tokenB to receive")
 });
+var isLiquidityCorePayload = (value) => typeof value === "object" && value !== null && "transaction" in value;
+var addLiquidityPostProcess = (response) => `SaucerSwap add liquidity submitted. Status: ${response.status}. Transaction ID: ${response.transactionId}`;
+var removeLiquidityPostProcess = (response) => `SaucerSwap remove liquidity submitted. Status: ${response.status}. Transaction ID: ${response.transactionId}`;
 var resolveDeadline = (defaultMinutes) => {
   return Math.floor(Date.now() / 1e3) + defaultMinutes * 60;
 };
@@ -333,13 +331,18 @@ var resolveRouterContract = (config) => {
   }
   return routerContractId;
 };
-var addLiquidityTool = {
-  method: "saucerswap_add_liquidity",
-  name: "SaucerSwap Add Liquidity",
-  description: "Add liquidity to a SaucerSwap pool.",
-  parameters: addLiquidityInputSchema,
-  execute: async (client, context, params) => {
-    const args = addLiquidityInputSchema.parse(params);
+var AddLiquidityTool = class extends BaseTool {
+  constructor() {
+    super(...arguments);
+    this.method = "saucerswap_add_liquidity";
+    this.name = "SaucerSwap Add Liquidity";
+    this.description = "Add liquidity to a SaucerSwap pool.";
+    this.parameters = addLiquidityInputSchema;
+  }
+  async normalizeParams(params, _context, _client) {
+    return addLiquidityInputSchema.parse(params);
+  }
+  async coreAction(args, context, client) {
     const config = resolveSaucerSwapConfig(context);
     const operatorAccountId = client?.operatorAccountId?.toString();
     const slippageTolerance = args.slippageTolerance ?? 0.5;
@@ -370,14 +373,13 @@ var addLiquidityTool = {
       const routerContractId = resolveRouterContract(config);
       const deadline = resolveDeadline(config.deadlineMinutes);
       const toAddress = accountIdToSolidityAddress(operatorAccountId);
-      const params2 = new ContractFunctionParameters().addAddress(tokenIdToSolidityAddress(requireTokenId(tokenAId))).addAddress(tokenIdToSolidityAddress(requireTokenId(tokenBId))).addUint256(amountADesired).addUint256(amountBDesired).addUint256(amountAMin).addUint256(amountBMin).addAddress(toAddress).addUint256(deadline);
-      const transaction = new ContractExecuteTransaction().setContractId(contractIdFromString(routerContractId)).setGas(config.gasLimit).setFunction("addLiquidity", params2);
-      return await finalizeTransaction(transaction, client, context, {
-        amountADesired,
-        amountBDesired,
-        amountAMin,
-        amountBMin
-      });
+      const params = new ContractFunctionParameters().addAddress(tokenIdToSolidityAddress(requireTokenId(tokenAId))).addAddress(tokenIdToSolidityAddress(requireTokenId(tokenBId))).addUint256(amountADesired).addUint256(amountBDesired).addUint256(amountAMin).addUint256(amountBMin).addAddress(toAddress).addUint256(deadline);
+      const transaction = new ContractExecuteTransaction().setContractId(contractIdFromString(routerContractId)).setGas(config.gasLimit).setFunction("addLiquidity", params);
+      const payload = {
+        transaction,
+        extras: { amountADesired, amountBDesired, amountAMin, amountBMin }
+      };
+      return payload;
     } catch (error) {
       return {
         success: false,
@@ -385,14 +387,31 @@ var addLiquidityTool = {
       };
     }
   }
+  async shouldSecondaryAction(coreActionResult, _context) {
+    return isLiquidityCorePayload(coreActionResult);
+  }
+  async secondaryAction(payload, client, context) {
+    const result = await handleTransaction(
+      payload.transaction,
+      client,
+      context,
+      addLiquidityPostProcess
+    );
+    return { ...result, ...payload.extras };
+  }
 };
-var removeLiquidityTool = {
-  method: "saucerswap_remove_liquidity",
-  name: "SaucerSwap Remove Liquidity",
-  description: "Remove liquidity from a SaucerSwap pool.",
-  parameters: removeLiquidityInputSchema,
-  execute: async (client, context, params) => {
-    const args = removeLiquidityInputSchema.parse(params);
+var RemoveLiquidityTool = class extends BaseTool {
+  constructor() {
+    super(...arguments);
+    this.method = "saucerswap_remove_liquidity";
+    this.name = "SaucerSwap Remove Liquidity";
+    this.description = "Remove liquidity from a SaucerSwap pool.";
+    this.parameters = removeLiquidityInputSchema;
+  }
+  async normalizeParams(params, _context, _client) {
+    return removeLiquidityInputSchema.parse(params);
+  }
+  async coreAction(args, context, client) {
     const config = resolveSaucerSwapConfig(context);
     const operatorAccountId = client?.operatorAccountId?.toString();
     if (!operatorAccountId) {
@@ -428,13 +447,13 @@ var removeLiquidityTool = {
       const routerContractId = resolveRouterContract(config);
       const deadline = resolveDeadline(config.deadlineMinutes);
       const toAddress = accountIdToSolidityAddress(operatorAccountId);
-      const params2 = new ContractFunctionParameters().addAddress(tokenIdToSolidityAddress(requireTokenId(tokenAId))).addAddress(tokenIdToSolidityAddress(requireTokenId(tokenBId))).addUint256(lpAmount).addUint256(minAmountA).addUint256(minAmountB).addAddress(toAddress).addUint256(deadline);
-      const transaction = new ContractExecuteTransaction().setContractId(contractIdFromString(routerContractId)).setGas(config.gasLimit).setFunction("removeLiquidity", params2);
-      return await finalizeTransaction(transaction, client, context, {
-        lpAmount,
-        minAmountA,
-        minAmountB
-      });
+      const params = new ContractFunctionParameters().addAddress(tokenIdToSolidityAddress(requireTokenId(tokenAId))).addAddress(tokenIdToSolidityAddress(requireTokenId(tokenBId))).addUint256(lpAmount).addUint256(minAmountA).addUint256(minAmountB).addAddress(toAddress).addUint256(deadline);
+      const transaction = new ContractExecuteTransaction().setContractId(contractIdFromString(routerContractId)).setGas(config.gasLimit).setFunction("removeLiquidity", params);
+      const payload = {
+        transaction,
+        extras: { lpAmount, minAmountA, minAmountB }
+      };
+      return payload;
     } catch (error) {
       return {
         success: false,
@@ -442,20 +461,39 @@ var removeLiquidityTool = {
       };
     }
   }
+  async shouldSecondaryAction(coreActionResult, _context) {
+    return isLiquidityCorePayload(coreActionResult);
+  }
+  async secondaryAction(payload, client, context) {
+    const result = await handleTransaction(
+      payload.transaction,
+      client,
+      context,
+      removeLiquidityPostProcess
+    );
+    return { ...result, ...payload.extras };
+  }
 };
+var addLiquidityTool = new AddLiquidityTool();
+var removeLiquidityTool = new RemoveLiquidityTool();
 var poolsInputSchema = z.object({
   tokenA: z.string().optional().describe("First token ID or symbol"),
   tokenB: z.string().optional().describe("Second token ID or symbol"),
   version: z.enum(["v1", "v2"]).optional().describe("Pool version"),
   limit: z.number().int().positive().optional().describe("Maximum number of pools to return")
 });
-var poolsTool = {
-  method: "saucerswap_get_pools",
-  name: "SaucerSwap Get Pools",
-  description: "Query SaucerSwap liquidity pools and reserves.",
-  parameters: poolsInputSchema,
-  execute: async (_client, context, params) => {
-    const args = poolsInputSchema.parse(params);
+var PoolsTool = class extends BaseTool {
+  constructor() {
+    super(...arguments);
+    this.method = "saucerswap_get_pools";
+    this.name = "SaucerSwap Get Pools";
+    this.description = "Query SaucerSwap liquidity pools and reserves.";
+    this.parameters = poolsInputSchema;
+  }
+  async normalizeParams(params, _context, _client) {
+    return poolsInputSchema.parse(params);
+  }
+  async coreAction(args, context, _client) {
     const config = resolveSaucerSwapConfig(context);
     const api = context.saucerswapClient ?? createSaucerSwapClient(config);
     try {
@@ -488,7 +526,14 @@ var poolsTool = {
       };
     }
   }
+  async shouldSecondaryAction(_coreActionResult, _context) {
+    return false;
+  }
+  async secondaryAction(_request, _client, _context) {
+    return null;
+  }
 };
+var poolsTool = new PoolsTool();
 
 // src/utils/quote.ts
 var readAmount = (value) => {
@@ -522,16 +567,21 @@ var quoteInputSchema = z.object({
   amount: z.string().describe("Amount to swap (decimal format)"),
   slippageTolerance: z.number().optional().default(0.5).describe("Maximum slippage tolerance percentage")
 });
-var quoteTool = {
-  method: "saucerswap_get_swap_quote",
-  name: "SaucerSwap Get Swap Quote",
-  description: "Get a price quote for swapping tokens on SaucerSwap.",
-  parameters: quoteInputSchema,
-  execute: async (_client, context, params) => {
-    const args = quoteInputSchema.parse(params);
+var QuoteTool = class extends BaseTool {
+  constructor() {
+    super(...arguments);
+    this.method = "saucerswap_get_swap_quote";
+    this.name = "SaucerSwap Get Swap Quote";
+    this.description = "Get a price quote for swapping tokens on SaucerSwap.";
+    this.parameters = quoteInputSchema;
+  }
+  async normalizeParams(params, _context, _client) {
+    return quoteInputSchema.parse(params);
+  }
+  async coreAction(args, context, _client) {
     const config = resolveSaucerSwapConfig(context);
-    const client = context.saucerswapClient;
-    const api = client ?? createSaucerSwapClient(config);
+    const cachedApi = context.saucerswapClient;
+    const api = cachedApi ?? createSaucerSwapClient(config);
     const slippageTolerance = args.slippageTolerance ?? 0.5;
     try {
       const fromToken = normalizeTokenAlias(args.fromToken, config);
@@ -577,7 +627,14 @@ var quoteTool = {
       };
     }
   }
+  async shouldSecondaryAction(_coreActionResult, _context) {
+    return false;
+  }
+  async secondaryAction(_request, _client, _context) {
+    return null;
+  }
 };
+var quoteTool = new QuoteTool();
 var swapInputSchema = z.object({
   fromToken: z.string().describe("Token ID to swap from (e.g., 'HBAR' or '0.0.123456')"),
   toToken: z.string().describe("Token ID to swap to"),
@@ -585,6 +642,8 @@ var swapInputSchema = z.object({
   slippageTolerance: z.number().optional().default(0.5).describe("Maximum slippage tolerance percentage"),
   deadline: z.number().optional().describe("Transaction deadline in minutes from now or a unix timestamp")
 });
+var isSwapCorePayload = (value) => typeof value === "object" && value !== null && "transaction" in value;
+var swapPostProcess = (response) => `SaucerSwap swap submitted. Status: ${response.status}. Transaction ID: ${response.transactionId}`;
 var resolveDeadline2 = (deadlineInput, defaultMinutes) => {
   const now = Math.floor(Date.now() / 1e3);
   if (!deadlineInput) {
@@ -601,13 +660,18 @@ var amountToSmallest = (amount, decimals) => {
 var expectedToSmallest = (amount, decimals) => {
   return amount.includes(".") ? parseUnits(amount, decimals) : amount;
 };
-var swapTool = {
-  method: "saucerswap_swap_tokens",
-  name: "SaucerSwap Swap Tokens",
-  description: "Execute a token swap on SaucerSwap DEX.",
-  parameters: swapInputSchema,
-  execute: async (client, context, params) => {
-    const args = swapInputSchema.parse(params);
+var SwapTool = class extends BaseTool {
+  constructor() {
+    super(...arguments);
+    this.method = "saucerswap_swap_tokens";
+    this.name = "SaucerSwap Swap Tokens";
+    this.description = "Execute a token swap on SaucerSwap DEX.";
+    this.parameters = swapInputSchema;
+  }
+  async normalizeParams(params, _context, _client) {
+    return swapInputSchema.parse(params);
+  }
+  async coreAction(args, context, client) {
     const config = resolveSaucerSwapConfig(context);
     const operatorAccountId = client?.operatorAccountId?.toString();
     const slippageTolerance = args.slippageTolerance ?? 0.5;
@@ -655,14 +719,18 @@ var swapTool = {
         tokenIdToSolidityAddress(requireTokenId(fromTokenId)),
         tokenIdToSolidityAddress(requireTokenId(toTokenId))
       ];
-      const params2 = new ContractFunctionParameters().addUint256(amountInSmallest).addUint256(minOutSmallest).addAddressArray(path).addAddress(toAddress).addUint256(deadline);
-      const transaction = new ContractExecuteTransaction().setContractId(contractIdFromString(routerContractId)).setGas(config.gasLimit).setFunction("swapExactTokensForTokens", params2);
-      return await finalizeTransaction(transaction, client, context, {
-        estimatedOutput: quote.expectedOutput,
-        minOutput: minOutSmallest,
-        priceImpact: quote.priceImpact,
-        route: quote.route
-      });
+      const params = new ContractFunctionParameters().addUint256(amountInSmallest).addUint256(minOutSmallest).addAddressArray(path).addAddress(toAddress).addUint256(deadline);
+      const transaction = new ContractExecuteTransaction().setContractId(contractIdFromString(routerContractId)).setGas(config.gasLimit).setFunction("swapExactTokensForTokens", params);
+      const payload = {
+        transaction,
+        extras: {
+          estimatedOutput: quote.expectedOutput,
+          minOutput: minOutSmallest,
+          priceImpact: quote.priceImpact,
+          route: quote.route
+        }
+      };
+      return payload;
     } catch (error) {
       return {
         success: false,
@@ -670,15 +738,36 @@ var swapTool = {
       };
     }
   }
+  async shouldSecondaryAction(coreActionResult, _context) {
+    return isSwapCorePayload(coreActionResult);
+  }
+  async secondaryAction(payload, client, context) {
+    const result = await handleTransaction(
+      payload.transaction,
+      client,
+      context,
+      swapPostProcess
+    );
+    return { ...result, ...payload.extras };
+  }
 };
+var swapTool = new SwapTool();
 
 // src/index.ts
+var saucerswapPluginToolNames = {
+  SAUCERSWAP_GET_SWAP_QUOTE_TOOL: "saucerswap_get_swap_quote",
+  SAUCERSWAP_SWAP_TOKENS_TOOL: "saucerswap_swap_tokens",
+  SAUCERSWAP_GET_POOLS_TOOL: "saucerswap_get_pools",
+  SAUCERSWAP_ADD_LIQUIDITY_TOOL: "saucerswap_add_liquidity",
+  SAUCERSWAP_REMOVE_LIQUIDITY_TOOL: "saucerswap_remove_liquidity",
+  SAUCERSWAP_GET_FARMS_TOOL: "saucerswap_get_farms"
+};
 var saucerswapPlugin = {
   name: "saucerswap",
   description: "Integration with SaucerSwap DEX for token swaps, liquidity provision, and yield farming",
   tools: () => [swapTool, quoteTool, poolsTool, addLiquidityTool, removeLiquidityTool, farmsTool]
 };
 
-export { saucerswapPlugin as default, saucerswapPlugin };
+export { saucerswapPlugin as default, saucerswapPlugin, saucerswapPluginToolNames };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map