Web3 MCP

🚀 Web3 Tool Documentation

This Web3 tool enables interaction with multiple blockchain networks, including Ethereum, Solana, Cosmos, Polkadot, and Sudt. It supports operations such as balance queries, transaction transfers, and token management. You can configure the private key and environment variables in the .env file to operate these chains.

✨ Features

Supported Blockchain Networks

UTXO Chains

• Bitcoin: Utilizes APIs provided by BlockCypher and Haskoin.
• Litecoin: Utilizes APIs provided by BlockCypher and Haskoin.
• Tron: Supports operations on the Tron network.
• Dogecoin: Supports operations on the Dogecoin network.

Smart Contract Chains

• Ethereum: Supports networks including Ethereum, Base, Arbitrum, Optimism, BSC (Binance Smart Chain), Polygon, and Avalanche.
• Cosmos: Interacts with the Cosmos network using the CosmJS library.
• Polkadot: Interacts with the Polkadot ecosystem using the Polkadot JS API.

Other Blockchain Networks

• Solana: Supports operations on the Solana network.
• Sudt (Stargaze): Supports operations in the Stargaze ecosystem.

🚀 Quick Start

Step 1: Install Dependencies

npm install

Step 2: Configure Environment Variables

Add the following content to the .env file:

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"

Step 3: Start Using

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

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

📦 Installation

Environment Variables

All private keys and sensitive information are stored in the .env file, which is ignored by gitignore to prevent accidental disclosure.

Network Selection

For the Ethereum network, you can select different chains by setting different environment variables:

• ETHEREUM_NETWORK=mainnet: Mainnet
• ETHEREUM_NETWORK=testnet: Testnet

⚠️ Important Note

• Private Key Management: Ensure the security of the .env file and do not commit it to the version control system.
• Testing Purposes: It is recommended to use test wallets and test networks for development and debugging to avoid fund losses due to misoperations on the mainnet.
• Multi - factor Authentication: In a production environment, consider adding an authentication layer to the RPC endpoint.

💻 Usage Examples

Basic Usage

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

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

Advanced Usage

Automated Tasks

You can configure cron jobs to implement automated operations, such as regularly checking balances or performing token transfers.

Packaging and Deployment

To package this tool into an executable file:

npm run build

Documentation Extension

For more detailed API documentation, please refer to the docs directory in the project repository.

📚 Documentation

Supported Ecosystems

• Ethereum Ecosystem: Supports operations on standard tokens such as ERC20 and ERC721.
• Solana Ecosystem: Supports operations on SPL tokens and Solana native tokens.
• Cosmos Ecosystem: Supports IBC cross - chain communication and operations on native tokens such as ATOM.

Error Handling

Common Errors

• Connection Timeout
  • Check if the RPC endpoint is available.
  • Ensure the network configuration is correct.
• Private Key Format Error
  • Confirm that the private key is in a hexadecimal string format.
  • Ensure the private key length is 64 characters.
• Balance Query Failure
  • Check if the address is valid.
  • Confirm that the network selection is correct.

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for specific details.

📫 Issue Reporting

If you encounter any issues during use, please submit a ticket through the following methods:

• Email: support@web3toolbox.com
• GitHub Issues: https://github.com/web3toolbox

This comprehensive Web3 tool documentation covers everything from getting started to advanced features.