@nirholas/bnbchain-mcp 1.0.0

package/BNB-Chain-MCP-README-UPDATE.md

@@ -0,0 +1,450 @@
+# BNB Chain MCP
+
+> **Talk to BNB Chain like you talk to ChatGPT.**
+
+A production-ready Model Context Protocol server for BNB Smart Chain, opBNB, and Greenfield.
+
+---
+
+## Example Prompts
+
+No coding required. Just type what you want in natural language:
+
+### Check Balances & Portfolio
+```
+"What's the BNB balance of 0x1234...?"
+"Show me all BEP-20 tokens in this wallet"
+"How much USDT do I have on BSC?"
+"What's my portfolio value across BSC and opBNB?"
+```
+
+### Research & Security
+```
+"Is this token safe to buy on PancakeSwap? 0xTokenAddress"
+"Check if this BSC contract is a honeypot"
+"What's the TVL of PancakeSwap?"
+"Show me the top holders of CAKE token"
+"Is this BNB Chain dApp legit or a phishing site?"
+```
+
+### Market Data & Prices
+```
+"What's the price of BNB?"
+"Show me trending tokens on BSC"
+"What are the best yield farming opportunities on BNB Chain?"
+"Get me the latest BNB Chain news"
+"What's the Fear & Greed Index?"
+```
+
+### Swaps & DeFi
+```
+"Get me a quote to swap 1 BNB for USDT on PancakeSwap"
+"What's the best DEX on BSC to swap CAKE to BNB?"
+"Show me the liquidity pools for BNB/USDT on PancakeSwap"
+"What are the current gas prices on BSC?"
+```
+
+### Bridging
+```
+"How do I bridge USDT from Ethereum to BSC?"
+"Get me a quote to bridge 100 USDT from BSC to opBNB"
+"What's the cheapest way to bridge assets to BNB Chain?"
+```
+
+### Lending & Borrowing (Venus, Lista DAO)
+```
+"What's the supply APY for USDT on Venus?"
+"Show me my health factor on Venus Protocol"
+"What can I borrow against my BNB collateral on Lista DAO?"
+"Compare lending rates between Venus and Lista"
+```
+
+### Staking
+```
+"How do I stake BNB?"
+"What's the current BNB staking APY?"
+"Show me liquid staking options on BNB Chain"
+```
+
+### Wallet Security
+```
+"Show me all token approvals for my BSC wallet"
+"Which BEP-20 approvals should I revoke?"
+"Has this wallet interacted with any scam contracts on BSC?"
+```
+
+### News & Sentiment
+```
+"What's the latest news about BNB Chain?"
+"Show me social sentiment for CAKE"
+"What are the top trending projects on BSC?"
+```
+
+---
+
+## Quick Start
+
+### For Claude Desktop
+
+1. Open Claude Desktop settings
+2. Add this to your config:
+
+```json
+{
+  "mcpServers": {
+    "bnb-chain-mcp": {
+      "command": "npx",
+      "args": ["-y", "@nirholas/universal-crypto-mcp@latest"]
+    }
+  }
+}
+```
+
+3. Restart Claude Desktop
+4. Start asking questions about BNB Chain
+
+### For Cursor
+
+Add to your MCP settings (Cursor Settings → MCP):
+
+```json
+{
+  "mcpServers": {
+    "bnb-chain-mcp": {
+      "command": "npx",
+      "args": ["-y", "@nirholas/universal-crypto-mcp@latest"]
+    }
+  }
+}
+```
+
+### For ChatGPT (Developer Mode)
+
+```bash
+npx @nirholas/universal-crypto-mcp --http
+```
+
+Then connect ChatGPT to `http://localhost:3001/mcp`
+
+---
+
+## Real-World Use Cases
+
+### Due Diligence Before Buying on PancakeSwap
+> "I found this new token on BSC. Can you check if it's safe? Here's the contract: 0x..."
+
+The AI will automatically:
+- Check for honeypot traps using GoPlus
+- Analyze holder distribution for whale concentration
+- Look for rug pull risks (mint functions, ownership)
+- Check if ownership is renounced
+- Verify liquidity is locked on PancakeSwap
+
+### Find the Best Yields on BNB Chain
+> "Where can I earn the highest APY on my USDT on BNB Chain?"
+
+The AI will:
+- Compare lending rates on Venus Protocol
+- Check Lista DAO borrowing rates
+- Show PancakeSwap liquidity pool APYs
+- Factor in risks and TVL
+- Recommend the best options for your risk profile
+
+### Clean Up Your BSC Wallet
+> "Audit my BSC wallet and tell me what approvals I should revoke"
+
+The AI will:
+- List all active BEP-20 token approvals
+- Flag unlimited approvals (high risk)
+- Identify old/unused approvals from forgotten dApps
+- Help you revoke dangerous ones
+
+### Optimize Bridging to BNB Chain
+> "I need to move $1000 USDT from Ethereum to BSC. What's the cheapest way?"
+
+The AI will:
+- Compare bridge options (Stargate, LayerZero, cBridge)
+- Calculate total fees including gas
+- Estimate transfer time
+- Recommend the best route
+
+### Bridge Between BSC and opBNB
+> "How do I move my tokens from BSC to opBNB?"
+
+The AI will:
+- Show native bridge options
+- Compare fees and speeds
+- Guide you through the process
+
+### Track Your BNB Chain Portfolio
+> "Give me a complete breakdown of my holdings on BSC and opBNB"
+
+The AI will:
+- Fetch all BEP-20 token balances
+- Show token values in USD
+- Calculate your allocation
+- Highlight any security concerns with tokens you hold
+
+### Analyze Venus Protocol Position
+> "What's my current position on Venus? Am I at risk of liquidation?"
+
+The AI will:
+- Show your supplied assets
+- Display borrowed amounts
+- Calculate health factor
+- Warn if approaching liquidation threshold
+
+---
+
+## Platform Compatibility
+
+| AI Platform | Status | Setup |
+|-------------|--------|-------|
+| **Claude Desktop** | Supported | Native MCP support |
+| **Cursor** | Supported | Native MCP support |
+| **ChatGPT** | Supported | Developer Mode (HTTP) |
+| **VS Code + Copilot** | Supported | Via MCP extension |
+| **Any MCP Client** | Supported | stdio or HTTP |
+
+---
+
+## Supported Networks
+
+| Network | Chain ID | Status |
+|---------|----------|--------|
+| **BNB Smart Chain (BSC)** | 56 | Full Support |
+| **opBNB** | 204 | Full Support |
+| **BSC Testnet** | 97 | Full Support |
+| **opBNB Testnet** | 5611 | Full Support |
+| **Ethereum** | 1 | Full Support |
+| **Arbitrum One** | 42161 | Full Support |
+| **Polygon** | 137 | Full Support |
+| **Base** | 8453 | Full Support |
+| **Optimism** | 10 | Full Support |
+
+---
+
+## BNB Chain Protocols Supported
+
+| Protocol | Category | Features |
+|----------|----------|----------|
+| **PancakeSwap** | DEX | Swaps, liquidity, farms, IFO |
+| **Venus Protocol** | Lending | Supply, borrow, liquidations |
+| **Lista DAO** | Lending/CDP | lisUSD minting, collateral |
+| **Stargate** | Bridge | Cross-chain transfers |
+| **Biswap** | DEX | Swaps, liquidity |
+| **Thena** | DEX | ve(3,3) swaps, liquidity |
+| **Alpaca Finance** | Yield | Leveraged yield farming |
+| **Belt Finance** | Yield | Stablecoin yields |
+
+---
+
+## Capabilities
+
+| Category | Features |
+|----------|----------|
+| **Tokens** | BEP-20 balances, transfers, approvals, token info |
+| **Swaps** | PancakeSwap quotes, execute swaps, liquidity pools |
+| **Bridges** | BSC to opBNB, cross-chain transfers, quotes |
+| **Lending** | Venus supply/borrow, health factor, liquidations |
+| **Security** | Honeypot check, rug detection, GoPlus audits |
+| **Data** | BNB price, TVL, yields, gas prices |
+| **News** | BNB Chain news, sentiment, trending |
+| **Governance** | Snapshot votes, on-chain proposals |
+| **Signing** | Messages, typed data, verification |
+| **Deployment** | BEP-20 contracts, proxies, verification |
+
+---
+
+## Security
+
+- **Read-only by default** - No transactions without your private key
+- **Keys stay local** - Never transmitted externally
+- **Review before signing** - Always displays transaction details
+- **Open source** - Verify the code yourself
+
+---
+
+## Documentation
+
+Full documentation: **https://sperax.cloud**
+
+---
+
+## Support
+
+- Twitter: [@nichxbt](https://x.com/nichxbt)
+- GitHub: [github.com/speraxos/BNB-Chain-MCP](https://github.com/speraxos/BNB-Chain-MCP)
+- Docs: [sperax.cloud](https://sperax.cloud)
+
+---
+
+<details>
+<summary><h2>Technical Documentation (Click to Expand)</h2></summary>
+
+## Supported Networks
+
+- BNB Smart Chain (BSC) - Chain ID: 56
+- opBNB - Chain ID: 204
+- BSC Testnet - Chain ID: 97
+- opBNB Testnet - Chain ID: 5611
+- Ethereum, Arbitrum, Polygon, Base, Optimism
+
+## Features
+
+- **Swap/DEX** - Token swaps via PancakeSwap, 1inch, 0x, ParaSwap
+- **Bridge** - Cross-chain transfers via LayerZero, Stargate, cBridge
+- **Gas** - BSC/opBNB gas prices, EIP-1559 suggestions
+- **Multicall** - Batch read/write operations
+- **Events/Logs** - Query historical events, decode logs
+- **Security** - Rug pull detection, honeypot check, GoPlus token/address security, dApp phishing detection
+- **Staking** - BNB staking, liquid staking, LP farming
+- **Signatures** - Sign messages, verify signatures, EIP-712
+- **Lending** - Venus/Lista positions, borrow rates, health factor
+- **Price Feeds** - Historical prices, TWAP, Chainlink oracles
+- **Portfolio** - Track holdings across BSC, opBNB, and other chains
+- **Governance** - Snapshot votes, on-chain proposals
+- **Deployment** - Deploy BEP-20 contracts, CREATE2, upgradeable proxies, BSCScan verification
+- **MEV Protection** - Private transactions, bundle simulation
+- **Domains** - Space ID (.bnb) resolution
+- **Market Data** - CoinGecko & CoinStats prices, OHLCV, trending
+- **DeFi Analytics** - DefiLlama TVL, yields, fees, protocol data
+- **Social Sentiment** - LunarCrush social metrics, influencers
+- **DEX Analytics** - GeckoTerminal pools, trades, OHLCV, trending tokens
+
+## Quick Start
+
+### Claude Desktop
+
+Add to your `claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "bnb-chain-mcp": {
+      "command": "npx",
+      "args": ["-y", "@nirholas/universal-crypto-mcp@latest"],
+      "env": {
+        "PRIVATE_KEY": "your_private_key_here (optional)"
+      }
+    }
+  }
+}
+```
+
+### Cursor
+
+Add to your MCP settings:
+
+```json
+{
+  "mcpServers": {
+    "bnb-chain-mcp": {
+      "command": "npx",
+      "args": ["-y", "@nirholas/universal-crypto-mcp@latest"],
+      "env": {
+        "PRIVATE_KEY": "your_private_key_here (optional)"
+      }
+    }
+  }
+}
+```
+
+### ChatGPT Developer Mode
+
+```bash
+PORT=3001 npx @nirholas/universal-crypto-mcp --http
+```
+
+Then in ChatGPT Developer Mode, add the MCP endpoint: `http://localhost:3001/mcp`
+
+## Server Modes
+
+| Mode | Command | Use Case |
+|------|---------|----------|
+| stdio | `npx @nirholas/universal-crypto-mcp` | Claude Desktop, Cursor |
+| HTTP | `npx @nirholas/universal-crypto-mcp --http` | ChatGPT Developer Mode |
+| SSE | `npx @nirholas/universal-crypto-mcp --sse` | Legacy HTTP clients |
+
+## Local Development
+
+```bash
+# Clone
+git clone https://github.com/speraxos/BNB-Chain-MCP
+cd BNB-Chain-MCP
+
+# Install
+bun install
+
+# Run dev server (stdio - Claude)
+bun dev
+
+# Run dev server (HTTP - ChatGPT)
+bun dev:http
+
+# Run dev server (SSE - legacy)
+bun dev:sse
+```
+
+## Environment Variables
+
+| Variable | Description | Required |
+|----------|-------------|----------|
+| `PRIVATE_KEY` | Wallet private key for write operations | No |
+| `PORT` | Server port (default: 3001) | No |
+| `LOG_LEVEL` | DEBUG, INFO, WARN, ERROR | No |
+| `COINGECKO_API_KEY` | CoinGecko API key | No |
+| `COINSTATS_API_KEY` | CoinStats API key | No |
+| `LUNARCRUSH_API_KEY` | LunarCrush API key | No |
+| `CRYPTOPANIC_API_KEY` | CryptoPanic API key | No |
+
+## Data Sources
+
+| Provider | Data Type | API Key Required |
+|----------|-----------|------------------|
+| [BscScan](https://bscscan.com) | BSC blockchain data | Optional |
+| [CoinGecko](https://coingecko.com) | Market data, prices, OHLCV | Optional |
+| [CoinStats](https://coinstats.app) | Portfolio, prices, wallets | Yes |
+| [DefiLlama](https://defillama.com) | TVL, yields, fees, protocols | No |
+| [LunarCrush](https://lunarcrush.com) | Social sentiment, influencers | Yes |
+| [GoPlus](https://gopluslabs.io) | Security analysis, honeypot detection | No |
+| [GeckoTerminal](https://geckoterminal.com) | DEX pools, trades, OHLCV | No |
+| [DexPaprika](https://dexpaprika.com) | DEX analytics, pools | No |
+| [CryptoPanic](https://cryptopanic.com) | Crypto news | Yes |
+
+---
+
+## Roadmap
+
+Full roadmap with 500+ planned features available in the repository.
+
+### Implemented
+- BEP-20 token operations (balances, transfers, approvals)
+- PancakeSwap integration (swaps, quotes, liquidity)
+- Venus Protocol (supply, borrow, health factor)
+- Cross-chain bridging (Stargate, LayerZero)
+- Security analysis (GoPlus honeypot, rug detection)
+- BSC gas price monitoring
+- Portfolio tracking across BSC/opBNB
+- Market data and prices
+- Social sentiment analysis
+
+### Planned
+- Lista DAO full integration
+- Space ID (.bnb) domain registration
+- opBNB native bridge
+- BNB staking
+- Greenfield storage integration
+- More BNB Chain protocols
+
+</details>
+
+---
+
+## Credits
+
+Built by **[nich](https://x.com/nichxbt)** ([github.com/nirholas](https://github.com/nirholas))
+
+## License
+
+MIT

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.