Skip to content

ReOneSec/BunkNet

Repository files navigation

A Functional Proof-of-Work Blockchain Ecosystem for Education

GitHub License Python Version Contributions Welcome Maintenance GitHub Stars

BunkNet is a complete blockchain ecosystem built from the ground up as a practical and educational implementation of the core principles that power cryptocurrencies. Our mission is to provide a hands-on "flight simulator" for Web3, empowering the next million developers from India and across the globe.


📚 Table of Contents


🎯 Live Ecosystem

Service Link Status
🌐 Explorer explorer.bunknet.online
💧 Faucet faucet.bunknet.online
💼 Web Wallet wallet.bunknet.online
💻 CLI Wallet github.com/ReOneSec/BunkNet

💡 Why BunkNet? The Educational Advantage

Learning blockchain is difficult. BunkNet is architected to provide the most authentic and comprehensive learning experience possible by focusing on foundational concepts like Proof-of-Work.

Feature Public Testnets (e.g., Sepolia) Local Chains (e.g., Hardhat) ✅ BunkNet (The Solution)
Consensus Model Proof-of-Stake (Abstracted) Instant (Not a real consensus) Tangible Proof-of-Work: Experience a real, low-difficulty PoW environment. See mining and consensus in action.
Cost Costly/Inconvenient: Requires real ETH for bridging or unreliable faucets. Free: No real funds needed. Truly Free & Accessible: Our high-throughput faucet provides all the test $BUNK you need to experiment.
Realism & Collaboration Realistic: A shared, persistent state for collaboration. Isolated: Runs only on your machine. Cannot build with others. Shared & Realistic: A persistent, public network where you can deploy dApps and interact with other learners.
Focus Speculative: Often treated as a "pre-mainnet" for airdrops and bots. Focused: Purely for development. Purely Educational: Our $BUNK token has zero monetary value, ensuring the entire ecosystem remains focused on building skills.

🌍 Ecosystem Components: A Deep Dive

BunkNet provides a complete suite of integrated tools designed for a seamless, end-to-end learning journey.

Component Description
⛓️ Proof-of-Work Blockchain A fully functional blockchain built from scratch that uses a simple but effective PoW algorithm to secure the network. It's the perfect environment to understand mining, consensus, and decentralization.
🔎 BunkScan Explorer A responsive Single-Page Application to view all on-chain activity in real-time. It translates raw blockchain data into human-readable insights, helping you trace transactions and understand block creation.
💰 The $BUNK Token The native cryptocurrency of the BunkChain, featuring transaction fees and a block reward halving schedule to simulate real-world tokenomics. Its zero-value design keeps the focus on learning.
💼 Web Wallet A full-featured, client-side web wallet with secure, encrypted login. It allows users to easily create wallets, save their seed phrase, and send/receive $BUNK through a user-friendly interface.
💻 CLI Wallet A powerful interactive command-line interface for developers and power users. Perfect for scripting, automation, and understanding how wallets work under the hood.
💧 The Faucet An automated web service that dispenses free test $BUNK to new users, providing a frictionless onboarding experience for anyone wanting to try out the ecosystem.

🏗️ System Architecture

BunkNet operates on a three-tiered architecture to separate concerns and improve scalability. This is a common pattern for production-grade blockchain applications.

User ↔️ [Frontend Apps] ↔️ [Explorer BFF API] ↔️ [Core Blockchain Node] ↔️ [MongoDB]

  • Frontend Apps: The static Web Wallet, Explorer, and Faucet files (HTML, CSS, JS).
  • Explorer BFF API (explorer.py): A smart middle-layer (Backend-for-Frontend) that simplifies API calls and provides aggregated data to the frontends.
  • Core Blockchain Node (blockchain.py): The main server that handles all blockchain logic, including the Proof-of-Work algorithm, P2P communication, and consensus rules.
  • MongoDB: A robust NoSQL database that provides persistent, indexed storage for all blockchain data (blocks, transactions, etc.), ensuring data integrity and fast queries.

🚀 Getting Started: Your First 5 Minutes

Get the BunkNet CLI Wallet running on your local machine and start building.

1️⃣ Prerequisites

  • Git installed on your system.
  • Python 3.8+ and pip installed.

2️⃣ Clone the Repository

Open your terminal and clone the project:

git clone [https://github.com/ReOneSec/BunkNet.git](https://github.com/ReOneSec/BunkNet.git)

cd BunkNet

3️⃣ Set Up Environment & Install Dependencies Using a virtual environment is highly recommended to avoid conflicts.

Create and activate a virtual environment

python3 -m venv venv source venv/bin/activate # On Windows, use: venv\Scripts\activate

Install all required Python packages

pip install -r requirements.txt

Note: The requirements.txt file contains all necessary packages, including requests, mnemonic, ecdsa, and pycryptodome.

4️⃣ Launch the Wallet! You're all set. Run the interactive application: python3 wallet.py

IMPORTANT: On your first run, select option 1 to create a new wallet. Immediately write down your 12-word seed phrase on paper and store it in a secure, offline location. This is your master key!

🛠️ Technology Stack & Design Rationale Every technology in our stack was deliberately chosen to provide a realistic and educational development experience.

Expand to see the detailed Technology Stack and our reasoning...
| Category | Technology | Rationale | |---|---|---| | Blockchain Core | Python | Chosen for its exceptional readability and extensive libraries, making the core logic approachable for learners to study and understand. | | Consensus | Proof-of-Work (PoW) | Implemented to provide a hands-on understanding of the foundational consensus mechanism that powers Bitcoin and early Ethereum. It makes concepts like mining and difficulty tangible. | | Database | MongoDB | A scalable NoSQL database used for persistent blockchain storage. It allows for fast, indexed queries, which is essential for a functional block explorer. | | Cryptography | ecdsa, pycryptodome | Implements industry-standard cryptography (SECP256k1, AES-256) to teach and enforce best practices for transaction signing and wallet security. | | Web Frontend | HTML, Tailwind CSS, JS | Tailwind CSS allows for the rapid development of a modern, responsive, and highly customizable user interface without writing extensive custom CSS. | | Web Server | Nginx | A high-performance, battle-tested web server used as a reverse proxy to securely manage and route traffic to our various backend services. |
🗺️ Project Roadmap We are committed to the long-term growth and evolution of BunkNet. | Phase | Status | Key Objectives | |---|---|---| | One | ✅ Completed |
  • Launch BunkChain PoW Testnet v1.0
  • Deploy Faucet, Explorer & Web Wallet
  • Release interactive CLI Wallet
  • Host first virtual hackathon with Indian tech institutes
| | Two | ⏳ In Progress |
  • Develop interactive web-based learning platform
  • Establish partnerships with top universities
  • Initiate the "BunkNet Builders Grant" program
| | Three | 🚀 Future |
  • Enhance PoW algorithm with dynamic difficulty adjustment
  • Launch a mock DAO for governance education
  • Expand educational initiatives to a global scale
| 🤝 Contributing & Community BunkNet is built by the community, for the community. We welcome contributions with open arms! * 🐛 Report a Bug * 💡 Suggest a Feature * ✍️ Start Contributing Please read our CONTRIBUTING.md file for detailed guidelines on how to contribute effectively. Join our community to ask questions, share your projects, and connect with other learners:

Discord Twitter

📜 License This project is proudly open source and licensed under the Apache 2.0 License. GitHub License

Built with ❤️ for the next generation of developers.

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published