bsv-mcp 0.0.21 → 0.0.23

package/tools/bsv/getPrice.ts

@@ -13,7 +13,10 @@ let cachedPrice: { value: number; timestamp: number } | null = null;
  */
 async function getBsvPriceWithCache(): Promise<number> {
 	// Return cached price if it's still valid
-	if (cachedPrice && (Date.now() - cachedPrice.timestamp) < PRICE_CACHE_DURATION) {
+	if (
+		cachedPrice &&
+		Date.now() - cachedPrice.timestamp < PRICE_CACHE_DURATION
+	) {
 		return cachedPrice.value;
 	}
 
@@ -22,22 +25,23 @@ async function getBsvPriceWithCache(): Promise<number> {
 		"https://api.whatsonchain.com/v1/bsv/main/exchangerate",
 	);
 	if (!res.ok) throw new Error("Failed to fetch price");
-	
+
 	const data = (await res.json()) as {
 		currency: string;
 		rate: string;
 		time: number;
 	};
-	
+
 	const price = Number(data.rate);
-	if (Number.isNaN(price) || price <= 0) throw new Error("Invalid price received");
-	
+	if (Number.isNaN(price) || price <= 0)
+		throw new Error("Invalid price received");
+
 	// Update cache
-	cachedPrice = { 
-		value: price, 
-		timestamp: Date.now() 
+	cachedPrice = {
+		value: price,
+		timestamp: Date.now(),
 	};
-	
+
 	return price;
 }
 
@@ -50,7 +54,12 @@ export function registerGetPriceTool(server: McpServer): void {
 		"bsv_getPrice",
 		"Retrieves the current price of Bitcoin SV (BSV) in USD from a reliable exchange API. This tool provides real-time market data that can be used for calculating transaction values, monitoring market conditions, or converting between BSV and fiat currencies.",
 		{
-			args: z.object({}).optional().describe("No parameters required - simply returns the current BSV price in USD"),
+			args: z
+				.object({})
+				.optional()
+				.describe(
+					"No parameters required - simply returns the current BSV price in USD",
+				),
 		},
 		async () => {
 			try {

package/tools/bsv/index.ts

@@ -1,7 +1,7 @@
 import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { registerDecodeTransactionTool } from "./decodeTransaction";
-import { registerGetPriceTool } from "./getPrice";
 import { registerExploreTool } from "./explore";
+import { registerGetPriceTool } from "./getPrice";
 
 /**
  * Register all BSV tools with the MCP server

package/tools/index.ts

@@ -1,25 +1,25 @@
 import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { registerBsvTools } from "./bsv";
+import { registerMneeTools } from "./mnee";
 import { registerOrdinalsTools } from "./ordinals";
 import { registerUtilsTools } from "./utils";
-import { registerMneeTools } from "./mnee";
 
 /**
  * Register all tools with the MCP server
  * @param server The MCP server instance
  */
 export function registerAllTools(server: McpServer): void {
-  // Register BSV-related tools
-  registerBsvTools(server);
+	// Register BSV-related tools
+	registerBsvTools(server);
 
-  // Register Ordinals-related tools
-  registerOrdinalsTools(server);
+	// Register Ordinals-related tools
+	registerOrdinalsTools(server);
 
-  // Register utility tools
-  registerUtilsTools(server);
+	// Register utility tools
+	registerUtilsTools(server);
 
-  // Register MNEE tools
-  registerMneeTools(server);
+	// Register MNEE tools
+	registerMneeTools(server);
 
-  // Add more tool categories as needed
+	// Add more tool categories as needed
 }

package/tools/mnee/getBalance.ts

@@ -1,56 +1,66 @@
+import { PrivateKey } from "@bsv/sdk";
 import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
-import { z } from "zod";
-import { PrivateKey } from "@bsv/sdk";
+import type {
+	ServerNotification,
+	ServerRequest,
+} from "@modelcontextprotocol/sdk/types.js";
 import type { MneeInterface } from "mnee";
+import { z } from "zod";
 
 export const getBalanceArgsSchema = z.object({});
 
 export type GetBalanceArgs = z.infer<typeof getBalanceArgsSchema>;
 
 export function registerGetBalanceTool(
-  server: McpServer,
-  mnee: MneeInterface
+	server: McpServer,
+	mnee: MneeInterface,
 ): void {
-  server.tool(
-    "mnee_getBalance",
-    "Retrieves the current MNEE token balance for the wallet. Returns the balance in MNEE tokens.",
-    {
-      args: getBalanceArgsSchema,
-    },
-    async (
-      { args }: { args: GetBalanceArgs },
-      extra: RequestHandlerExtra<any, any>
-    ) => {
-      try {
-        // Get private key from wallet
-        const privateKey = PrivateKey.fromWif(process.env.PRIVATE_KEY_WIF!);
-        if (!privateKey) {
-          throw new Error("No private key available");
-        }
+	server.tool(
+		"mnee_getBalance",
+		"Retrieves the current MNEE token balance for the wallet. Returns the balance in MNEE tokens.",
+		{
+			args: getBalanceArgsSchema,
+		},
+		async (
+			{ args }: { args: GetBalanceArgs },
+			extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
+		) => {
+			try {
+				// Get private key from wallet
+				const privateKeyWif = process.env.PRIVATE_KEY_WIF;
+				if (!privateKeyWif) {
+					throw new Error(
+						"Private key WIF not available in environment variables",
+					);
+				}
+				const privateKey = PrivateKey.fromWif(privateKeyWif);
+				if (!privateKey) {
+					throw new Error("No private key available");
+				}
 
-        const address = privateKey.toAddress().toString();
-        const balance = await mnee.balance(address);
+				const address = privateKey.toAddress().toString();
+				const balance = await mnee.balance(address);
 
-        return {
-          content: [
-            {
-              type: "text",
-              text: JSON.stringify({ balance }, null, 2),
-            },
-          ],
-        };
-      } catch (error) {
-        return {
-          content: [
-            {
-              type: "text",
-              text: error instanceof Error ? error.message : String(error),
-            },
-          ],
-          isError: true,
-        };
-      }
-    }
-  );
+				return {
+					content: [
+						{
+							type: "text",
+							text: JSON.stringify({ balance }, null, 2),
+						},
+					],
+				};
+			} catch (error) {
+				return {
+					content: [
+						{
+							type: "text",
+							text: error instanceof Error ? error.message : String(error),
+						},
+					],
+					isError: true,
+				};
+			}
+		},
+	);
 }

package/tools/mnee/index.ts

@@ -1,21 +1,21 @@
 import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-import { registerGetBalanceTool } from "./getBalance";
 import Mnee from "mnee";
-import { registerSendMneeTool } from "./sendMnee";
+import { registerGetBalanceTool } from "./getBalance";
 import { registerParseTxTool } from "./parseTx";
+import { registerSendMneeTool } from "./sendMnee";
 
 const mnee = new Mnee({
-  environment: "production",
+	environment: "production",
 });
 /**
  * Register all MNEE tools with the MCP server
  * @param server The MCP server instance
  */
 export function registerMneeTools(server: McpServer): void {
-  // Register MNEE-related tools
-  registerGetBalanceTool(server, mnee);
+	// Register MNEE-related tools
+	registerGetBalanceTool(server, mnee);
 
-  registerSendMneeTool(server, mnee);
+	registerSendMneeTool(server, mnee);
 
-  registerParseTxTool(server, mnee);
+	registerParseTxTool(server, mnee);
 }

package/tools/mnee/parseTx.ts

@@ -1,6 +1,10 @@
 import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
 import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import type {
+	ServerNotification,
+	ServerRequest,
+} from "@modelcontextprotocol/sdk/types.js";
 import type { MneeInterface, ParseTxResponse } from "mnee";
 import { z } from "zod";
 
@@ -8,38 +12,38 @@ import { z } from "zod";
  * Schema for the parseTx tool arguments.
  */
 export const parseTxArgsSchema = z.object({
-  txid: z.string().describe("Transaction ID to parse"),
+	txid: z.string().describe("Transaction ID to parse"),
 });
 
 export type ParseTxArgs = z.infer<typeof parseTxArgsSchema>;
 
 export function registerParseTxTool(
-  server: McpServer,
-  mnee: MneeInterface
+	server: McpServer,
+	mnee: MneeInterface,
 ): void {
-  server.tool(
-    "mnee_parseTx",
-    "Parse an MNEE transaction to get detailed information about its operations and amounts. All amounts are in atomic units with 5 decimal precision (e.g. 1000 atomic units = 0.01 MNEE).",
-    { args: parseTxArgsSchema },
-    async (
-      { args }: { args: ParseTxArgs },
-      extra: RequestHandlerExtra<any, any>
-    ): Promise<CallToolResult> => {
-      try {
-        const result: ParseTxResponse = await mnee.parseTx(args.txid);
+	server.tool(
+		"mnee_parseTx",
+		"Parse an MNEE transaction to get detailed information about its operations and amounts. All amounts are in atomic units with 5 decimal precision (e.g. 1000 atomic units = 0.01 MNEE).",
+		{ args: parseTxArgsSchema },
+		async (
+			{ args }: { args: ParseTxArgs },
+			extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
+		): Promise<CallToolResult> => {
+			try {
+				const result: ParseTxResponse = await mnee.parseTx(args.txid);
 
-        return {
-          content: [
-            {
-              type: "text",
-              text: JSON.stringify(result, null, 2),
-            },
-          ],
-        };
-      } catch (error) {
-        const msg = error instanceof Error ? error.message : String(error);
-        return { content: [{ type: "text", text: msg }], isError: true };
-      }
-    }
-  );
+				return {
+					content: [
+						{
+							type: "text",
+							text: JSON.stringify(result, null, 2),
+						},
+					],
+				};
+			} catch (error) {
+				const msg = error instanceof Error ? error.message : String(error);
+				return { content: [{ type: "text", text: msg }], isError: true };
+			}
+		},
+	);
 }

package/tools/mnee/sendMnee.ts

@@ -1,6 +1,10 @@
 import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
 import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import type {
+	ServerNotification,
+	ServerRequest,
+} from "@modelcontextprotocol/sdk/types.js";
 import type Mnee from "mnee";
 import type { SendMNEE, TransferResponse } from "mnee";
 import { z } from "zod";
@@ -9,12 +13,12 @@ import { z } from "zod";
  * Schema for the sendMnee tool arguments.
  */
 export const sendMneeArgsSchema = z.object({
-  address: z.string().describe("The recipient's address"),
-  amount: z.number().describe("Amount to send"),
-  currency: z
-    .enum(["MNEE", "USD"])
-    .default("MNEE")
-    .describe("Currency of the amount (MNEE or USD)"),
+	address: z.string().describe("The recipient's address"),
+	amount: z.number().describe("Amount to send"),
+	currency: z
+		.enum(["MNEE", "USD"])
+		.default("MNEE")
+		.describe("Currency of the amount (MNEE or USD)"),
 });
 
 export type SendMneeArgs = z.infer<typeof sendMneeArgsSchema>;
@@ -23,75 +27,75 @@ export type SendMneeArgs = z.infer<typeof sendMneeArgsSchema>;
  * Format a number as USD
  */
 function formatUSD(amount: number): string {
-  return new Intl.NumberFormat("en-US", {
-    style: "currency",
-    currency: "USD",
-    minimumFractionDigits: 2,
-    maximumFractionDigits: 2,
-  }).format(amount);
+	return new Intl.NumberFormat("en-US", {
+		style: "currency",
+		currency: "USD",
+		minimumFractionDigits: 2,
+		maximumFractionDigits: 2,
+	}).format(amount);
 }
 
 /**
  * Registers the mnee_sendMnee tool for sending MNEE tokens
  */
 export function registerSendMneeTool(server: McpServer, mnee: Mnee): void {
-  server.tool(
-    "mnee_sendMnee",
-    "Send MNEE tokens to a specified address",
-    { args: sendMneeArgsSchema },
-    async (
-      { args }: { args: SendMneeArgs },
-      extra: RequestHandlerExtra<any, any>
-    ): Promise<CallToolResult> => {
-      try {
-        // Since 1 MNEE = $1, the amount is the same in both currencies
-        const mneeAmount = args.amount;
+	server.tool(
+		"mnee_sendMnee",
+		"Send MNEE tokens to a specified address",
+		{ args: sendMneeArgsSchema },
+		async (
+			{ args }: { args: SendMneeArgs },
+			extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
+		): Promise<CallToolResult> => {
+			try {
+				// Since 1 MNEE = $1, the amount is the same in both currencies
+				const mneeAmount = args.amount;
 
-        const transferRequest: SendMNEE[] = [
-          {
-            address: args.address,
-            amount: mneeAmount,
-          },
-        ];
+				const transferRequest: SendMNEE[] = [
+					{
+						address: args.address,
+						amount: mneeAmount,
+					},
+				];
 
-        // Get WIF from environment
-        const wif = process.env.PRIVATE_KEY_WIF;
-        if (!wif) {
-          throw new Error("PRIVATE_KEY_WIF environment variable is not set");
-        }
+				// Get WIF from environment
+				const wif = process.env.PRIVATE_KEY_WIF;
+				if (!wif) {
+					throw new Error("PRIVATE_KEY_WIF environment variable is not set");
+				}
 
-        const result: TransferResponse = await mnee.transfer(
-          transferRequest,
-          wif
-        );
+				const result: TransferResponse = await mnee.transfer(
+					transferRequest,
+					wif,
+				);
 
-        if (result.error) {
-          throw new Error(result.error);
-        }
+				if (result.error) {
+					throw new Error(result.error);
+				}
 
-        return {
-          content: [
-            {
-              type: "text",
-              text: JSON.stringify(
-                {
-                  success: true,
-                  txid: result.txid,
-                  rawtx: result.rawtx,
-                  mneeAmount: mneeAmount,
-                  usdAmount: formatUSD(mneeAmount),
-                  recipient: args.address,
-                },
-                null,
-                2
-              ),
-            },
-          ],
-        };
-      } catch (error) {
-        const msg = error instanceof Error ? error.message : String(error);
-        return { content: [{ type: "text", text: msg }], isError: true };
-      }
-    }
-  );
+				return {
+					content: [
+						{
+							type: "text",
+							text: JSON.stringify(
+								{
+									success: true,
+									txid: result.txid,
+									rawtx: result.rawtx,
+									mneeAmount: mneeAmount,
+									usdAmount: formatUSD(mneeAmount),
+									recipient: args.address,
+								},
+								null,
+								2,
+							),
+						},
+					],
+				};
+			} catch (error) {
+				const msg = error instanceof Error ? error.message : String(error);
+				return { content: [{ type: "text", text: msg }], isError: true };
+			}
+		},
+	);
 }

package/tools/ordinals/getTokenByIdOrTicker.ts

@@ -3,14 +3,21 @@ import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/proto
 import { z } from "zod";
 
 // Schema for get token by ID or ticker arguments
-export const getTokenByIdOrTickerArgsSchema = z.object({
-	id: z.string().optional().describe("BSV20 token ID in outpoint format (txid_vout)"),
-	tick: z.string().optional().describe("BSV20 token ticker symbol"),
-}).refine(data => data.id || data.tick, {
-	message: "Either id or tick must be provided",
-});
+export const getTokenByIdOrTickerArgsSchema = z
+	.object({
+		id: z
+			.string()
+			.optional()
+			.describe("BSV20 token ID in outpoint format (txid_vout)"),
+		tick: z.string().optional().describe("BSV20 token ticker symbol"),
+	})
+	.refine((data) => data.id || data.tick, {
+		message: "Either id or tick must be provided",
+	});
 
-export type GetTokenByIdOrTickerArgs = z.infer<typeof getTokenByIdOrTickerArgsSchema>;
+export type GetTokenByIdOrTickerArgs = z.infer<
+	typeof getTokenByIdOrTickerArgsSchema
+>;
 
 // BSV20 token response type
 interface TokenResponse {

package/tools/ordinals/marketListings.ts

@@ -18,16 +18,16 @@ export const marketListingsArgsSchema = z.object({
 		.default("desc")
 		.describe("Sort direction (asc or desc)"),
 	address: z.string().optional().describe("Bitcoin address"),
-	
+
 	// NFT-specific parameters
 	origin: z.string().optional().describe("Origin outpoint"),
 	mime: z.string().optional().describe("MIME type filter"),
 	num: z.string().optional().describe("Inscription number"),
-	
+
 	// General market parameters
 	minPrice: z.number().optional().describe("Minimum price in satoshis"),
 	maxPrice: z.number().optional().describe("Maximum price in satoshis"),
-	
+
 	// Token-specific parameters
 	tokenType: z
 		.enum(["nft", "bsv20", "bsv21", "all"])
@@ -39,7 +39,11 @@ export const marketListingsArgsSchema = z.object({
 		.describe("Sort method (recent, price, num, height, price_per_token)"),
 	id: z.string().optional().describe("Token ID in outpoint format"),
 	tick: z.string().optional().describe("Token ticker symbol"),
-	pending: z.boolean().default(false).optional().describe("Include pending sales"),
+	pending: z
+		.boolean()
+		.default(false)
+		.optional()
+		.describe("Include pending sales"),
 });
 
 export type MarketListingsArgs = z.infer<typeof marketListingsArgsSchema>;
@@ -118,7 +122,7 @@ export function registerMarketListingsTool(server: McpServer): void {
 				// Determine the API endpoint based on tokenType
 				let baseUrl = "https://ordinals.gorillapool.io/api";
 				let useTokenParams = false;
-				
+
 				if (tokenType === "bsv20" || tokenType === "bsv21") {
 					baseUrl += "/bsv20/market";
 					useTokenParams = true;
@@ -131,11 +135,15 @@ export function registerMarketListingsTool(server: McpServer): void {
 				url.searchParams.append("limit", limit.toString());
 				url.searchParams.append("offset", offset.toString());
 				url.searchParams.append("dir", dir);
-				
+
 				// Add sort parameter based on token type
 				if (useTokenParams) {
 					// BSV20/BSV21 specific sort options
-					if (sort === "height" || sort === "price" || sort === "price_per_token") {
+					if (
+						sort === "height" ||
+						sort === "price" ||
+						sort === "price_per_token"
+					) {
 						url.searchParams.append("sort", sort);
 					}
 					// Add token-specific parameters
@@ -144,10 +152,13 @@ export function registerMarketListingsTool(server: McpServer): void {
 					}
 					if (id) url.searchParams.append("id", id);
 					if (tick) url.searchParams.append("tick", tick);
-					if (pending !== undefined) url.searchParams.append("pending", pending.toString());
+					if (pending !== undefined)
+						url.searchParams.append("pending", pending.toString());
 					// For BSV20/21, min/max price parameters have slightly different names
-					if (minPrice !== undefined) url.searchParams.append("min_price", minPrice.toString());
-					if (maxPrice !== undefined) url.searchParams.append("max_price", maxPrice.toString());
+					if (minPrice !== undefined)
+						url.searchParams.append("min_price", minPrice.toString());
+					if (maxPrice !== undefined)
+						url.searchParams.append("max_price", maxPrice.toString());
 				} else {
 					// NFT specific sort options
 					if (sort === "recent" || sort === "price" || sort === "num") {
@@ -158,10 +169,12 @@ export function registerMarketListingsTool(server: McpServer): void {
 					if (mime) url.searchParams.append("mime", mime);
 					if (num) url.searchParams.append("num", num);
 					// For NFTs, min/max price parameters use short names
-					if (minPrice !== undefined) url.searchParams.append("min", minPrice.toString());
-					if (maxPrice !== undefined) url.searchParams.append("max", maxPrice.toString());
+					if (minPrice !== undefined)
+						url.searchParams.append("min", minPrice.toString());
+					if (maxPrice !== undefined)
+						url.searchParams.append("max", maxPrice.toString());
 				}
-				
+
 				// Add common parameters
 				if (address) url.searchParams.append("address", address);
 

package/tools/ordinals/marketSales.ts

@@ -26,7 +26,11 @@ export const marketSalesArgsSchema = z.object({
 		.describe("Type of token to search for (bsv20, bsv21, or all)"),
 	id: z.string().optional().describe("Token ID in outpoint format"),
 	tick: z.string().optional().describe("Token ticker symbol"),
-	pending: z.boolean().default(false).optional().describe("Include pending sales"),
+	pending: z
+		.boolean()
+		.default(false)
+		.optional()
+		.describe("Include pending sales"),
 });
 
 export type MarketSalesArgs = z.infer<typeof marketSalesArgsSchema>;
@@ -71,21 +75,10 @@ export function registerMarketSalesTool(server: McpServer): void {
 		{
 			args: marketSalesArgsSchema,
 		},
-		async (
-			{ args }: { args: MarketSalesArgs },
-			extra: RequestHandlerExtra,
-		) => {
+		async ({ args }: { args: MarketSalesArgs }, extra: RequestHandlerExtra) => {
 			try {
-				const { 
-					limit, 
-					offset, 
-					dir, 
-					tokenType, 
-					id, 
-					tick, 
-					pending, 
-					address 
-				} = args;
+				const { limit, offset, dir, tokenType, id, tick, pending, address } =
+					args;
 
 				// Determine the API endpoint based on tokenType
 				let baseUrl = "https://ordinals.gorillapool.io/api";
@@ -98,7 +91,7 @@ export function registerMarketSalesTool(server: McpServer): void {
 				url.searchParams.append("limit", limit.toString());
 				url.searchParams.append("offset", offset.toString());
 				url.searchParams.append("dir", dir);
-				
+
 				// Add type parameter for bsv21 if needed
 				if (tokenType === "bsv21") {
 					url.searchParams.append("type", "v2");
@@ -106,7 +99,8 @@ export function registerMarketSalesTool(server: McpServer): void {
 
 				if (id) url.searchParams.append("id", id);
 				if (tick) url.searchParams.append("tick", tick);
-				if (pending !== undefined) url.searchParams.append("pending", pending.toString());
+				if (pending !== undefined)
+					url.searchParams.append("pending", pending.toString());
 				if (address) url.searchParams.append("address", address);
 
 				// Fetch market sales from GorillaPool API