@mcp-dockmaster/mcp-cryptowallet-evm 1.0.0

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@mcp-dockmaster/mcp-cryptowallet-evm",
+  "version": "1.0.0",
+  "description": "MCP server for EVM crypto wallet operations using ethers.js v5",
+  "main": "build/index.js",
+  "type": "module",
+  "bin": {
+    "mcp-cryptowallet-evm": "./build/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "start": "node build/index.js",
+    "test": "jest",
+    "lint": "eslint src/**/*.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dcSpark/mcp-cryptowallet-evm.git"
+  },
+  "keywords": [
+    "mcp",
+    "ethereum",
+    "evm",
+    "wallet",
+    "ethers"
+  ],
+  "author": "dcSpark",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/dcSpark/mcp-cryptowallet-evm/issues"
+  },
+  "homepage": "https://github.com/dcSpark/mcp-cryptowallet-evm#readme",
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.6.1",
+    "@scure/bip39": "^1.5.4",
+    "ethers": "^5.7.2"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.0",
+    "@types/node": "^18.15.11",
+    "@typescript-eslint/eslint-plugin": "^5.57.1",
+    "@typescript-eslint/parser": "^5.57.1",
+    "eslint": "^8.38.0",
+    "jest": "^29.5.0",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.0.4"
+  }
+}

package/required-methods.md

@@ -0,0 +1,53 @@
+# Required Methods for EVM Crypto Wallet MCP Server
+
+Based on the ethers.js v5 documentation and the example MCP servers, the following methods should be implemented for our crypto wallet MCP server:
+
+## Wallet Creation and Management
+- `wallet_create_random` - Create a new wallet with a random private key
+- `wallet_from_private_key` - Create a wallet from a private key
+- `wallet_from_mnemonic` - Create a wallet from a mnemonic phrase
+- `wallet_from_encrypted_json` - Create a wallet by decrypting an encrypted JSON wallet
+- `wallet_encrypt` - Encrypt a wallet with a password
+
+## Wallet Properties
+- `wallet_get_address` - Get the wallet address
+- `wallet_get_public_key` - Get the wallet public key
+- `wallet_get_private_key` - Get the wallet private key (with appropriate security warnings)
+- `wallet_get_mnemonic` - Get the wallet mnemonic phrase (if available)
+
+## Blockchain Methods
+- `wallet_get_balance` - Get the balance of the wallet
+- `wallet_get_chain_id` - Get the chain ID the wallet is connected to
+- `wallet_get_gas_price` - Get the current gas price
+- `wallet_get_transaction_count` - Get the number of transactions sent from this account (nonce)
+- `wallet_call` - Call a contract method without sending a transaction
+
+## Transaction Methods
+- `wallet_send_transaction` - Send a transaction
+- `wallet_sign_transaction` - Sign a transaction without sending it
+- `wallet_populate_transaction` - Populate a transaction with missing fields
+
+## Signing Methods
+- `wallet_sign_message` - Sign a message
+- `wallet_sign_typed_data` - Sign typed data (EIP-712)
+- `wallet_verify_message` - Verify a signed message
+- `wallet_verify_typed_data` - Verify signed typed data
+
+## Provider Methods
+- `provider_get_block` - Get a block by number or hash
+- `provider_get_transaction` - Get a transaction by hash
+- `provider_get_transaction_receipt` - Get a transaction receipt
+- `provider_get_code` - Get the code at an address
+- `provider_get_storage_at` - Get the storage at a position for an address
+- `provider_estimate_gas` - Estimate the gas required for a transaction
+- `provider_get_logs` - Get logs that match a filter
+- `provider_get_ens_resolver` - Get the ENS resolver for a name
+- `provider_lookup_address` - Lookup the ENS name for an address
+- `provider_resolve_name` - Resolve an ENS name to an address
+
+## Network Methods
+- `network_get_network` - Get the current network information
+- `network_get_block_number` - Get the current block number
+- `network_get_fee_data` - Get the current fee data (base fee, max priority fee, etc.)
+
+These methods cover the core functionality needed for a comprehensive EVM crypto wallet implementation using ethers.js v5.

package/src/handlers/utils.ts

@@ -0,0 +1,97 @@
+import { ethers } from "ethers";
+import { ToolResultSchema } from "../types.js";
+
+/**
+ * Creates a success response with the given result
+ * @param result The result to include in the response
+ * @param message Optional message to include in the response
+ * @returns A ToolResultSchema with the result and message
+ */
+export const createSuccessResponse = <T>(result: T, message?: string): ToolResultSchema<T> => {
+  return {
+    content: [
+      {
+        type: "text",
+        text: message || "Operation completed successfully"
+      }
+    ],
+    isError: false,
+    toolResult: result
+  };
+};
+
+/**
+ * Creates an error response with the given message
+ * @param message The error message
+ * @returns A ToolResultSchema with the error message
+ */
+export const createErrorResponse = (message: string): ToolResultSchema<any> => {
+  return {
+    content: [
+      {
+        type: "text",
+        text: message
+      }
+    ],
+    isError: true,
+    toolResult: { error: message }
+  };
+};
+
+/**
+ * Gets a provider from a provider URL
+ * @param providerUrl The provider URL
+ * @returns An ethers.js provider
+ */
+export const getProvider = (providerUrl?: string): ethers.providers.Provider => {
+  if (!providerUrl) {
+    // Default to Ethereum mainnet if no provider URL is specified
+    return ethers.getDefaultProvider();
+  }
+  
+  try {
+    return new ethers.providers.JsonRpcProvider(providerUrl);
+  } catch (error) {
+    throw new Error(`Invalid provider URL: ${providerUrl}`);
+  }
+};
+
+/**
+ * Gets a wallet from a private key, mnemonic, or JSON wallet
+ * @param walletData The wallet data (private key, mnemonic, or JSON)
+ * @param password Optional password for encrypted JSON wallets
+ * @param provider Optional provider to connect the wallet to
+ * @returns An ethers.js wallet
+ */
+export const getWallet = async (
+  walletData: string, 
+  password?: string,
+  providerUrl?: string
+): Promise<ethers.Wallet> => {
+  const provider = providerUrl ? getProvider(providerUrl) : undefined;
+  
+  try {
+    // Try to parse as JSON first
+    if (walletData.startsWith("{")) {
+      if (!password) {
+        throw new Error("Password is required for encrypted JSON wallets");
+      }
+      
+      const wallet = await ethers.Wallet.fromEncryptedJson(walletData, password);
+      return provider ? wallet.connect(provider) : wallet;
+    }
+    
+    // Check if it's a mnemonic (12, 15, 18, 21, or 24 words)
+    const words = walletData.trim().split(/\s+/);
+    if ([12, 15, 18, 21, 24].includes(words.length)) {
+      const wallet = ethers.Wallet.fromMnemonic(walletData);
+      return provider ? wallet.connect(provider) : wallet;
+    }
+    
+    // Assume it's a private key
+    const wallet = new ethers.Wallet(walletData);
+    return provider ? wallet.connect(provider) : wallet;
+  } catch (error) {
+    throw new Error(`Invalid wallet data: ${(error as Error).message}`);
+  }
+};