Feat: add tool to call contract function and track staked tokens (#25)

Author: rishi-tal-12

package-lock.json

@@ -9,7 +9,6 @@ import { privateKeyToAccount } from "viem/accounts";
 import dotenv from "dotenv";
 import { privateKeySchema } from "./tools/hyper-evm/sendFunds/schemas.js";
 import * as hyper from "@nktkas/hyperliquid";
-
 dotenv.config();
 
 export const hyperEvmConfig = defineChain({

src/config.ts

@@ -5,22 +5,27 @@ import {
   ListToolsRequestSchema,
   type CallToolRequest,
 } from "@modelcontextprotocol/sdk/types.js";
+
 import {
   GET_BALANCE_TOOL,
   GET_LATEST_BLOCK_TOOL,
   DEPLOY_CONTRACTS_TOOL,
   SEND_FUNDS_TOOL,
   GET_TRANSACTION_RECEIPT_TOOL,
   GET_TOKEN_BALANCE_TOOL,
+  GET_LOGS_TOOL,
+  CALL_CONTRACT_FUNCTION,
   STAKE_TOOL,
   UNSTAKE_TOOL,
-  GET_LOGS_TOOL,
   GET_HISTORICAL_ORDERS_TOOL,
+  TRACK_STAKED_TOKENS,
 } from "./tools/tools.js";
 import { getBalance } from "./tools/hyper-evm/getBalance/index.js";
 import { getLatestBlock } from "./tools/hyper-evm/getBlockNumber/index.js";
 import { deployContracts } from "./tools/hyper-evm/deployContracts/index.js";
 import type { DeployContractsInput } from "./tools/hyper-evm/deployContracts/schemas.js";
+import { callContracts } from "./tools/hyper-evm/callContracts/index.js";
+import { CallContractSchema } from "./tools/hyper-evm/callContracts/schema.js";
 import { sendFunds } from "./tools/hyper-evm/sendFunds/index.js";
 import { sendFundsInputSchema } from "./tools/hyper-evm/sendFunds/schemas.js";
 import { getTransactionReceipt } from "./tools/hyper-evm/getTransactionReceipt/index.js";
@@ -37,9 +42,12 @@ import {
 } from "./tools/hyper-evm/handleStake/schemas.js";
 import { getLogs } from "./tools/hyper-evm/getLogs/index.js";
 import { getHistoricalOrders } from "./tools/hypercore/getHistoricalOrders/index.js";
+import { getStakedtokens } from "./tools/hypercore/trackstakedtokens/index.js";
+import { StakedInputSchema } from "./tools/hypercore/trackstakedtokens/schema.js";
 
 async function main() {
   console.error("Starting Hyperliquid MCP server...");
+
   const server = new Server(
     {
       name: "hyperliquid",
@@ -68,6 +76,54 @@ async function main() {
             return balance;
           }
 
+          case "call_contract_function": {
+            try {
+              const { contractAddress, functionName, abi, functionArgs } =
+                args as {
+                  contractAddress: string;
+                  functionName: string;
+                  abi: any;
+                  functionArgs?: any[];
+                };
+
+              const validatedInput = CallContractSchema.parse({
+                contractAddress,
+                functionName,
+                abi,
+                functionArgs,
+              });
+
+              const result = await callContracts(validatedInput);
+
+              return {
+                content: [
+                  {
+                    type: "text",
+                    text: JSON.stringify(
+                      result,
+                      (_, v) => (typeof v === "bigint" ? v.toString() : v),
+                      2
+                    ),
+                  },
+                ],
+              };
+            } catch (validationError) {
+              console.error("Validation error:", validationError);
+              return {
+                content: [
+                  {
+                    type: "text",
+                    text: `Error: ${
+                      validationError instanceof Error
+                        ? validationError.message
+                        : String(validationError)
+                    }`,
+                  },
+                ],
+              };
+            }
+          }
+
           case "deploy_contracts": {
             const input = args as DeployContractsInput;
             const result = await deployContracts(input);
@@ -151,9 +207,19 @@ async function main() {
             return result;
           }
 
+          case "track_staked_tokens": {
+            const input = args as {
+              userAddress: string;
+              isTestnet: boolean | string;
+            };
+            const validatedInput = StakedInputSchema.parse(input);
+            const result = await getStakedtokens(validatedInput);
+            return result;
+          }
+
           default: {
             throw new Error(
-              `Tool '${name}' not found. Available tools: get_latest_block, get_balance, deploy_contracts, send_funds, get_transaction_receipt, get_token_balance, stake, unstake`
+              `Tool '${name}' not found. Available tools: get_latest_block, get_balance, deploy_contracts, send_funds, get_transaction_receipt, get_token_balance, stake, unstake, get_logs, call_contract_function, track_staked_tokens`
             );
           }
         }
@@ -181,10 +247,12 @@ async function main() {
         SEND_FUNDS_TOOL,
         GET_TRANSACTION_RECEIPT_TOOL,
         GET_TOKEN_BALANCE_TOOL,
+        CALL_CONTRACT_FUNCTION,
         STAKE_TOOL,
         UNSTAKE_TOOL,
         GET_LOGS_TOOL,
         GET_HISTORICAL_ORDERS_TOOL,
+        TRACK_STAKED_TOKENS,
       ],
     };
   });

src/main.ts

@@ -0,0 +1,98 @@
+import {
+  encodeFunctionData,
+  type Abi,
+  type AbiFunction,
+  isAddress,
+} from "viem";
+import { createWalletClient, http } from "viem";
+import { publicClient, walletClient } from "../../../config.js";
+import { hyperEvmConfig } from "../../../config.js";
+import type { GetContractDetails } from "./schema.js";
+import { privateKeySchema } from "../sendFunds/schemas.js";
+import { privateKeyToAccount } from "viem/accounts";
+
+export async function callContracts(contractDetails: GetContractDetails) {
+  try {
+    const address = contractDetails.contractAddress;
+    if (!isAddress(address)) {
+      throw new Error(`Invalid HyperEVM address: ${address}`);
+    }
+
+    let abi: Abi;
+    if (typeof contractDetails.abi === "string") {
+      try {
+        abi = JSON.parse(contractDetails.abi) as Abi;
+      } catch (error) {
+        throw new Error(`Invalid ABI string: ${error}`);
+      }
+    } else {
+      abi = contractDetails.abi as Abi;
+    }
+
+    const functionAbi = abi.find(
+      (item): item is AbiFunction =>
+        "type" in item &&
+        item.type === "function" &&
+        "name" in item &&
+        item.name === contractDetails.functionName
+    );
+
+    if (!functionAbi) {
+      throw new Error(
+        `Function ${contractDetails.functionName} not found in ABI`
+      );
+    }
+
+    if (
+      functionAbi.stateMutability === "view" ||
+      functionAbi.stateMutability === "pure"
+    ) {
+      const callParams: any = {
+        address: contractDetails.contractAddress,
+        abi,
+        functionName: contractDetails.functionName,
+      };
+
+      if (functionAbi.inputs && functionAbi.inputs.length > 0) {
+        if (
+          !contractDetails.functionArgs ||
+          contractDetails.functionArgs.length !== functionAbi.inputs.length
+        ) {
+          throw Error(
+            `Function ${contractDetails.functionName} expects ${functionAbi.inputs.length} arguments, ` +
+              `${contractDetails.functionArgs?.length || 0} provided`
+          );
+        }
+        callParams.args = contractDetails.functionArgs;
+      }
+
+      return await publicClient.readContract(callParams);
+    }
+
+    const callParams: any = {
+      address: contractDetails.contractAddress,
+      abi,
+      functionName: contractDetails.functionName,
+    };
+
+    if (functionAbi.inputs && functionAbi.inputs.length > 0) {
+      if (
+        !contractDetails.functionArgs ||
+        contractDetails.functionArgs.length !== functionAbi.inputs.length
+      ) {
+        throw Error(
+          `Function ${contractDetails.functionName} expects ${functionAbi.inputs.length} arguments, ` +
+            `${contractDetails.functionArgs?.length || 0} provided`
+        );
+      }
+      callParams.args = contractDetails.functionArgs;
+    }
+
+    return await walletClient.writeContract(callParams);
+  } catch (error) {
+    console.log(error);
+    throw Error(
+      `Failed to call contract function: ${error instanceof Error ? error.message : String(error)}`
+    );
+  }
+}

src/tools/hyper-evm/callContracts/index.ts

@@ -0,0 +1,22 @@
+import { z } from "zod";
+import { isAddress } from "viem";
+
+export const CallContractSchema = z.object({
+  contractAddress: z.string().refine(address => isAddress(address), {
+    message: "Must be a valid HyperEVM address (0x format, 42 characters)",
+  }),
+  functionName: z.string().min(1, "Function name cannot be empty"),
+  abi: z.union([z.string(), z.array(z.any())]),
+  functionArgs: z.preprocess(val => {
+    if (typeof val === "string") {
+      try {
+        return JSON.parse(val);
+      } catch {
+        return [val];
+      }
+    }
+    return val;
+  }, z.array(z.any()).optional()),
+});
+
+export type GetContractDetails = z.infer<typeof CallContractSchema>;

src/tools/hyper-evm/callContracts/schema.ts

@@ -0,0 +1,34 @@
+import { Hyperliquid } from "hyperliquid";
+import type { GetStakedInput } from "./schema.js";
+
+export async function getStakedtokens(stackingInputDetails: GetStakedInput) {
+  try {
+    const address = stackingInputDetails.userAddress;
+    const isTestnet = stackingInputDetails.isTestnet;
+
+    const sdk = new Hyperliquid({ testnet: isTestnet });
+
+    const delegatorrwards = await sdk.info.getDelegatorRewards(address);
+    const delegatorsummary = await sdk.info.getDelegatorSummary(address);
+
+    const safeStringify = (obj: unknown) =>
+      JSON.stringify(
+        obj,
+        (_, v) => (typeof v === "bigint" ? v.toString() : v),
+        2
+      );
+
+    return {
+      content: [
+        {
+          type: "text",
+          text: `Delegator rewards for ${address}:\n${safeStringify(delegatorrwards)}\n\nDelegator summary:\n${safeStringify(delegatorsummary)}`,
+        },
+      ],
+    };
+  } catch (error) {
+    throw new Error(
+      `Failed to track staked token status: ${error instanceof Error ? error.message : String(error)}`
+    );
+  }
+}

src/tools/hypercore/trackstakedtokens/index.ts

@@ -0,0 +1,33 @@
+import { z } from "zod";
+import { isAddress } from "viem";
+
+export const StakedInputSchema = z.object({
+  userAddress: z
+    .string()
+    .refine(address => isAddress(address), {
+      message: "Must be a valid Ethereum address (0x format)",
+    })
+    .describe(
+      "The address of the validator to stake to (must be a valid Ethereum address starting with 0x)."
+    ),
+  isTestnet: z
+    .union([
+      z.boolean(),
+      z.string().transform(val => {
+        if (val === "true" || val === "1") {
+          return true;
+        }
+        if (val === "false" || val === "0") {
+          return false;
+        }
+        throw new Error(
+          "isTestnet must be a boolean or string representation of boolean"
+        );
+      }),
+    ])
+    .describe(
+      "Set to true if staking on testnet, false for mainnet. Accepts boolean or string 'true'/'false'."
+    ),
+});
+
+export type GetStakedInput = z.infer<typeof StakedInputSchema>;

src/tools/hypercore/trackstakedtokens/schema.ts

@@ -1,5 +1,6 @@
 import type { Tool } from "@modelcontextprotocol/sdk/types.js";
 import { getBalanceInputSchema } from "./hyper-evm/getBalance/schemas.js";
+import { CallContractSchema } from "./hyper-evm/callContracts/schema.js";
 import { deployContractsSchema } from "./hyper-evm/deployContracts/schemas.js";
 import { sendFundsInputSchema } from "./hyper-evm/sendFunds/schemas.js";
 import { getTransactionReceiptInputSchema } from "./hyper-evm/getTransactionReceipt/schemas.js";
@@ -10,6 +11,7 @@ import {
 } from "./hyper-evm/handleStake/schemas.js";
 import { getLogsInputSchema } from "./hyper-evm/getLogs/schemas.js";
 import { getOrdersInputSchema } from "./hypercore/getHistoricalOrders/schemas.js";
+import { StakedInputSchema } from "./hypercore/trackstakedtokens/schema.js";
 
 export const GET_BALANCE_TOOL: Tool = {
   name: "get_balance",
@@ -31,6 +33,16 @@ export const GET_LATEST_BLOCK_TOOL: Tool = {
   },
 };
 
+export const CALL_CONTRACT_FUNCTION: Tool = {
+  name: "call_contract_function",
+  description: "Call a contract function on HyperEVM",
+  inputSchema: {
+    type: "object",
+    properties: CallContractSchema.shape,
+    required: ["contractAddress", "functionName", "abi"],
+  },
+};
+
 export const DEPLOY_CONTRACTS_TOOL: Tool = {
   name: "deploy_contracts",
   description: "Deploy a contract",
@@ -112,3 +124,14 @@ export const GET_HISTORICAL_ORDERS_TOOL: Tool = {
     required: ["userAddress"],
   },
 };
+
+export const TRACK_STAKED_TOKENS: Tool = {
+  name: "track_staked_tokens",
+  description:
+    "Get the rewards and summary of a user address present on hyperliquid",
+  inputSchema: {
+    type: "object",
+    properties: StakedInputSchema.shape,
+    required: ["userAddress", "isTestnet"],
+  },
+};