rugproof-metamask-snap/README.md

RugProof MetaMask Snap for real-time crypto security analysis including honeypot detection, contract verification, and wallet scanning

# RugProof MetaMask Snap

A MetaMask Snap that provides real-time crypto security analysis including honeypot detection, contract verification, and wallet scanning.

## Features

- 🔍 **Real-time Transaction Analysis**: Automatically analyzes transactions before signing
- 🍯 **Honeypot Detection**: Identifies honeypot tokens and scam contracts
- ✅ **Contract Verification**: Checks if contracts are verified and safe
- 👛 **Wallet Scanning**: Scans wallets for spam tokens and NFTs
- 🚨 **Security Warnings**: Displays clear warnings for risky transactions
- 🤖 **AI-Powered Analysis**: Advanced AI analysis for comprehensive security assessment

## Installation

### For Users

1. Install MetaMask Flask (development version of MetaMask)
2. Navigate to the RugProof Snap in MetaMask's Snap directory
3. Click "Install" to add the snap to your MetaMask wallet

### For Developers

```bash
npm install @rugproofai/snap
```

## Usage

Once installed, the RugProof Snap will automatically:

- Analyze all transactions before you sign them
- Display security warnings for risky contracts
- Provide detailed risk assessments
- Block potentially dangerous transactions

### Custom RPC Methods

The snap provides several RPC methods for integration:

```javascript
// Check if a token is a honeypot
const honeypotResult = await ethereum.request({
  method: "wallet_invokeSnap",
  params: {
    snapId: "@rugproofai/snap",
    request: {
      method: "rugproof_honeypot_check",
      params: {
        address: "0x...",
        chain: "1",
      },
    },
  },
});

// Analyze a contract
const contractResult = await ethereum.request({
  method: "wallet_invokeSnap",
  params: {
    snapId: "@rugproofai/snap",
    request: {
      method: "rugproof_contract_analysis",
      params: {
        address: "0x...",
        chain: "1",
      },
    },
  },
});

// Scan a wallet
const walletResult = await ethereum.request({
  method: "wallet_invokeSnap",
  params: {
    snapId: "@rugproofai/snap",
    request: {
      method: "rugproof_wallet_scan",
      params: {
        address: "0x...",
        chain: "1",
      },
    },
  },
});
```

## Supported Networks

- Ethereum Mainnet
- Binance Smart Chain
- Polygon
- Base
- Optimism
- Arbitrum
- And more...

## Security

This snap uses the RugProof API to provide security analysis. No private keys or sensitive data are transmitted. All analysis is performed on public blockchain data.

## Support

- Website: [https://rugproofai.com](https://rugproofai.com)
- Documentation: [https://docs.rugproofai.com](https://docs.rugproofai.com)
- Issues: [GitHub Issues](https://github.com/vmmuthu31/RugproofAI/issues)

## License

MIT License - see LICENSE file for details.

## Contributing

Contributions are welcome! Please read our contributing guidelines and submit pull requests to our GitHub repository.