Hyperlane MCP Server

hyperlane-mcp/ ├── src/ # Source code │ ├── index.ts # Main MCP server entry point │ ├── localRegistry.ts # Local registry implementation │ ├── hyperlaneDeployer.ts # Core contract deployment │ ├── RunValidator.ts # Validator Docker management │ ├── RunRelayer.ts # Relayer Docker management │ ├── warpRoute.ts # Warp route deployment │ ├── msgTransfer.ts # Message transfer logic │ ├── assetTransfer.ts # Asset transfer logic │ ├── config.ts # Configuration utilities │ ├── utils.ts # Utility functions │ ├── types.ts # Type definitions │ ├── logger.ts # Logging configuration │ ├── gcr.ts # Google Container Registry utilities │ ├── file.ts # File system utilities │ ├── configOpts.ts # Configuration options │ └── consts.ts # Constants ├── build/ # Compiled JavaScript output ├── node_modules/ # Dependencies ├── package.json # Project configuration ├── tsconfig.json # TypeScript configuration ├── .env # Environment variables (create this) └── README.md # This file

The server creates and manages several directories and files during operation:

~/.hyperlane-mcp/ # Main cache directory ├── chains/ # Chain configurations │ ├── {chainName}.yaml # Chain metadata │ ├── {chainName}.deploy.yaml # Deployed contract addresses │ └── {chainName}-core-config.yaml # Core deployment config ├── routes/ # Warp route configurations │ └── {symbol}-{hash}.yaml # Warp route configs ├── agents/ # Agent configurations │ └── {chainName}-agent-config.json # Validator/relayer configs └── logs/ # Runtime data and logs ├── hyperlane_db_validator_{chain}/ # Validator database ├── hyperlane_db_relayer/ # Relayer database └── hyperlane-validator-signatures-{chain}/ # Validator signatures

- {chainName}.yaml: Contains chain metadata (RPC URLs, chain ID, native token info)
- {chainName}.deploy.yaml: Deployed contract addresses (mailbox, ISM, hooks, etc.)
- {chainName}-core-config.yaml: Core deployment configuration

- {symbol}-{hash}.yaml: Warp route configuration for cross-chain asset transfers

- {chainName}-agent-config.json: Configuration for validators and relayers

- Validator databases: Persistent storage for validator state
- Relayer databases: Persistent storage for relayer state
- Signature storage: Validator checkpoint signatures

- Docker containers: Validator and relayer containers (managed automatically)
- Log files: Runtime logs from validators and relayers

Deploy Hyperlane core contracts to a new blockchain called "mytestnet" with chain ID 12345, RPC URL "https://rpc.mytestnet.com", native token symbol "MTN", and token name "MyTestNet Token". This should be marked as a testnet.

Send a cross-chain message from Ethereum to Polygon. The recipient address should be 0x742d35Cc6634C0532925a3b8D4C9db96c4b4d8b6 and the message body should be "Hello from Ethereum!"

Deploy a warp route for asset transfers between Ethereum and Arbitrum chains. Use collateral token type for Ethereum and synthetic token type for Arbitrum.

Transfer assets using the USDC warp route from Ethereum to Arbitrum. Transfer 100 USDC to recipient address 0x742d35Cc6634C0532925a3b8D4C9db96c4b4d8b6. First, fetch the warp route configuration for USDC on these chains using the resources.

Start a validator for the "mytestnet" chain that we deployed earlier.

Start a relayer to handle message delivery between Ethereum and mytestnet chains. Use "mytestnet" as the validator chain name.

Transfer 50 USDC from Ethereum to Polygon, then from Polygon to Arbitrum, using the existing USDC warp routes. The final recipient should be 0x742d35Cc6634C0532925a3b8D4C9db96c4b4d8b6.

Show me the available warp route configurations for USDC token across Ethereum and Polygon chains.

Deploy a new warp route for a custom token called "MyToken" (symbol: MTK) between three chains: Ethereum (collateral type), Polygon (synthetic type), and Arbitrum (synthetic type).

# Add user to docker group (Linux) sudo usermod -aG docker $USER # Restart shell or logout/login

- Ensure your wallet has sufficient native tokens for gas
- Check current gas prices on target networks

- Verify RPC URLs are accessible
- Check for rate limiting on RPC providers
- Consider using multiple RPC endpoints

# Check Docker logs docker logs <container_id> # Verify Docker image availability docker pull gcr.io/abacus-labs-dev/hyperlane-agent:agents-v1.4.0

Run with MCP Inspector for detailed debugging:

# Validator logs tail -f ~/.hyperlane-mcp/logs/validator-{chain}.log # Relayer logs tail -f ~/.hyperlane-mcp/logs/relayer.log

Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests if applicable
- Submit a pull request

- Use TypeScript for all new code
- Follow existing code formatting (Prettier)
- Add JSDoc comments for public APIs
- Include error handling

This project is licensed under the MIT License.