web3-mcp

🚀 Web3 工具文档

本 Web3 工具支持多种区块链网络的交互操作，如查询余额、交易转账、代币管理等。您只需配置 .env 文件中的私钥和环境变量，就能轻松实现对各链的操作。

🚀 快速开始

安装依赖项

npm install

配置环境变量

在 .env 文件中添加以下内容：

PRIVATE_KEY="your_private_key_here"
ETHEREUM_RPC_URL="https://eth-mainnet.g.alchemy.com/v1/your_api_key"
SOLANA_RPC_URL="http://localhost:8899"

开始使用

import { Web3Provider } from '@ethersproject/providers';

const provider = new Web3Provider(window.ethereum);
const balance = await provider.getBalance('0x1234567890123456789012345678901234');
console.log(`余额: ${balance}`);

✨ 主要特性

• 支持多种区块链网络的交互操作，包括查询余额、交易转账、代币管理等。
• 可通过配置 .env 文件中的私钥和环境变量实现对各链的操作。
• 支持自动化任务，可通过配置 cron 作业实现定期检查余额或执行代币转账。
• 支持打包成可执行文件，方便部署。

📦 安装指南

安装依赖项

npm install

💻 使用示例

基础用法

import { Web3Provider } from '@ethersproject/providers';

const provider = new Web3Provider(window.ethereum);
const balance = await provider.getBalance('0x1234567890123456789012345678901234');
console.log(`余额: ${balance}`);

📚 详细文档

支持的区块链网络

原子转移协议 (UTXO) 链

• 比特币 (Bitcoin) - 使用 BlockCypher 和 Haskoin 提供的 API。
• 莱特币 (Litecoin) - 使用 BlockCypher 和 Haskoin 提供的 API。
• 波场 (Tron) - 支持波场网络上的操作。
• 狗狗币 (Dogecoin) - 支持狗狗币网络上的操作。

智能合约链

• 以太坊 (Ethereum) - 支持 Ethereum、Base、Arbitrum、Optimism、BSC（币安智能链）、Polygon 和 avax 网络。
• Cosmos - 使用 CosmJS 库与 Cosmos 网络进行交互。
• Polkadot - 使用 Polkadot JS API 与 Polkadot 生态系统进行交互。

其他区块链网络

• Solana - 支持 Solana 网络上的操作。
• Sudt (Stargaze) - 支持 Stargaze 生态系统的操作。

配置选项

环境变量

所有私钥和敏感信息都存储在 .env 文件中，并且该文件会被 gitignore 忽略，以防止意外泄露。 | 属性 | 详情 | |------|------| | PRIVATE_KEY | 你的钱包私钥（测试用途，请勿使用真实资金） | | ETHEREUM_RPC_URL | 以太坊网络的 RPC 端点地址 | | SOLANA_RPC_URL | Solana 网络的 RPC 端点地址 | | COSMOS_NODE_URL | Cosmos 网络的节点 URL | | POLKADOT_WS_URL | Polkadot 网络的 WebSocket URL | | SUDT_RPC_URL | Stargaze 生态系统的 RPC 端点地址 |

网络选择

对于以太坊网络，可以通过设置不同的环境变量来选择不同的链：

• ETHEREUM_NETWORK=mainnet - 主网
• ETHEREUM_NETWORK=testnet - 测试网

高级功能

自动化任务

可以通过配置 cron 作业来实现自动化操作，例如定期检查余额或执行代币转账。

打包和部署

要将此工具打包成可执行文件：

npm run build

文档扩展

如果需要更多详细的 API 文档，请参考项目仓库中的 docs 目录。

支持的生态系统

• 以太坊生态：支持 ERC20、ERC721 等标准代币的操作。
• Solana 生态：支持 SPL 代币和 Solana 原生代币的操作。
• Cosmos 生态：支持 IBC 跨鏈通信和 ATOM 等原生代币的操作。

错误处理

常见错误

1. 连接超时

   • 检查 RPC 端点是否可用
   • 确保网络配置正确

2. 私钥格式错误

   • 确认私钥格式为十六进制字符串
   • 确保私钥长度为 64 字符

3. 余额查询失败

   • 检查地址是否有效
   • 确认网络选择正确

问题反馈

如果在使用过程中遇到任何问题，请通过以下方式提交工单：

• 邮件：support@web3toolbox.com
• GitHub Issues：https://github.com/web3toolbox

🔧 技术细节

本工具使用了不同的库和 API 来与各种区块链网络进行交互，如使用 @ethersproject/providers 库进行以太坊相关操作，使用 CosmJS 库与 Cosmos 网络交互，使用 Polkadot JS API 与 Polkadot 生态系统交互等。通过配置环境变量，工具可以灵活地切换不同的网络和节点。

📄 许可证

此项目遵循 MIT 许可证，具体内容请参考 LICENSE 文件。