qBTC-core DEV NET

qBTC-core is a modern blockchain implementation inspired by Satoshi Nakamoto's original design for Bitcoin. It stays true to foundational concepts such as:

Proof-of-Work (PoW)
UTXO-based accounting
Bitcoin-style block headers
Mining compatibility
Standard RPC methods like getblocktemplate and submitblock

Built from the ground up in Python to demonstrate a proof-of-concept, qBTC introduces key innovations for the future of Bitcoin:

Post-Quantum Security using the ML-DSA signature scheme
Decentralized validator discovery via a Kademlia DHT
Fast, scalable propagation through an asynchronous gossip network

The cryptographic layer is modular, allowing ML-DSA to be replaced with other post-quantum algorithms as standards evolve.

🌐 Key Features

🛡 Post-Quantum Cryptography (ML-DSA-87 signatures)
🔁 UTXO-Based Ledger with Merkle root verification
🌱 Validator Discovery via Kademlia DHT
📡 Gossip Protocol for fast block and transaction propagation
🧠 Protobuf-encoded Transactions and Blocks
📊 Prometheus Metrics & Grafana Dashboards
🔄 Automatic Genesis Block Creation (21M coins)
🌐 Full P2P Networking with NAT traversal support
🚀 Built with Python, FastAPI, and asyncio

📦 Architecture Overview

+-------------------+       +-----------------------+
|   Kademlia DHT    |<----->| Validator Peer Nodes  |
+-------------------+       +-----------------------+
         |                               |
         v                               v
+-------------------+         +----------------------+
| Gossip Network    | <-----> |  GossipNode Class    |
| (async TCP/JSON)  |         +----------------------+
         |                               |
         v                               v
+-------------------+         +----------------------+
| Blockchain Logic  | <-----> | Protobuf Structures  |
| - Merkle Root     |         | - Blocks, Txns       |
| - UTXO State      |         +----------------------+
| - Chain Manager   |                 |
+-------------------+                 v
         |                   +----------------------+
         |                   | Mempool Manager      |
         |                   | - Conflict Detection |
         |                   | - Fee Prioritization |
         |                   | - Size Limits        |
         |                   +----------------------+
         v
+----------------------+       +----------------------+
| Local DB (RocksDB)   | <---> | Event Bus System     |
+----------------------+       +----------------------+
         |
         v
+----------------------+       +----------------------+
| Web API (FastAPI)    | <---> | RPC Server (Mining)  |
| - /debug endpoints   |       | - getblocktemplate   |
| - /worker (broadcast)|       | - submitblock        |
| - /health (metrics)  |       +----------------------+
+----------------------+

🛠 Getting Started

1. Clone the Repository & Install Dependencies

git clone https://github.com/q-btc/qBTC-core.git
cd qBTC-core
pip install -r requirements.txt

Follow the instructions here to install liboqs-python: https://github.com/open-quantum-safe/liboqs-python

2. Generate a Wallet

Before starting a node, you must generate a wallet file:

python3 wallet/wallet.py

This will create a wallet.json file containing your ML-DSA public/private keypair encrypted with a passphrase.

Keep it safe — this is your validator's identity and signing authority.

3. Start a Node via CLI

You can start qBTC-core either as a bootstrap server or connect to an existing bootstrap peer. Networking (DHT and Gossip) is always enabled and required for node operation.

CLI Usage

usage: main.py [-h] [--bootstrap] [--bootstrap_server BOOTSTRAP_SERVER]
               [--bootstrap_port BOOTSTRAP_PORT] [--dht-port DHT_PORT]
               [--gossip-port GOSSIP_PORT] [--external-ip EXTERNAL_IP]

Optional arguments:

--bootstrap: Run as bootstrap server
--bootstrap_server: Bootstrap server host (default: api.bitcoinqs.org)
--bootstrap_port: Bootstrap server port (default: 8001)
--dht-port: DHT port (default: 8001)
--gossip-port: Gossip port (default: 8002)
--external-ip: External IP address for NAT traversal

a) Start as a Bootstrap Server

python3 main.py --bootstrap

This initializes a bootstrap node that other nodes can connect to.

b) Connect to Default Bootstrap Server (api.bitcoinqs.org)

python3 main.py

This connects to the default bootstrap server at api.bitcoinqs.org:8001.

c) Connect to Custom Bootstrap Server

python3 main.py --bootstrap_server 192.168.1.10 --bootstrap_port 9001

Replace 192.168.1.10 and 9001 with your custom bootstrap server details.

d) Use Custom Ports

python3 main.py --dht-port 8009 --gossip-port 8010

This starts a node with custom DHT and gossip ports while connecting to the default bootstrap server.

🐳 Docker Usage

The project includes three Docker Compose configurations for different deployment scenarios. Note that there is no default docker-compose.yml file - you must specify which configuration to use.

Available Configurations

docker-compose.test.yml - Development/testing environment with 3 nodes
docker-compose.bootstrap.yml - Production bootstrap server with monitoring
docker-compose.validator.yml - Production validator node that connects to mainnet

For detailed deployment instructions, see DEPLOYMENT.md.

Quick Start: Test Network (3 Nodes)

Perfect for development and testing:

# Start a test network with 1 bootstrap node and 2 validators
docker compose -f docker-compose.test.yml up -d

# View logs
docker compose -f docker-compose.test.yml logs -f

# Access services:
# - Bootstrap API: http://localhost:8080 (via nginx load balancer)
# - Validator1 API: http://localhost:8081
# - Validator2 API: http://localhost:8082
# - Grafana: http://localhost:3000 (admin/admin123)
# - Prometheus: http://localhost:9090
# - RPC ports: 8332 (bootstrap), 8333 (validator1), 8334 (validator2)

# Stop the network
docker compose -f docker-compose.test.yml down

# Stop and remove all data
docker compose -f docker-compose.test.yml down --volumes

Production Bootstrap Server

Run a bootstrap server that other nodes can connect to:

# Set required environment variables
export BOOTSTRAP_WALLET_PASSWORD=your-secure-password
export ADMIN_ADDRESS=your-admin-address
export GRAFANA_ADMIN_USER=admin
export GRAFANA_ADMIN_PASSWORD=secure-password
export GRAFANA_DOMAIN=your-domain.com

# Generate SSL certificates (or provide your own)
mkdir -p ./monitoring/nginx/ssl
openssl req -x509 -nodes -days 365 -newkey rsa:2048 \
  -keyout ./monitoring/nginx/ssl/server.key \
  -out ./monitoring/nginx/ssl/server.crt \
  -subj "/C=US/ST=State/L=City/O=Organization/CN=your-domain.com"

# Start bootstrap server
docker compose -f docker-compose.bootstrap.yml up -d

# View logs
docker compose -f docker-compose.bootstrap.yml logs -f bootstrap

# Access services:
# - API: https://localhost:8080 (SSL via nginx)
# - Grafana: https://localhost:443 (public read-only access)
# - RPC: localhost:8332
# - DHT: localhost:8001/udp
# - Gossip: localhost:8002/tcp

Production Validator Node

Connect to the mainnet as a validator:

# Set required environment variables
export VALIDATOR_WALLET_PASSWORD=your-secure-password
export ADMIN_ADDRESS=your-admin-address
export GRAFANA_ADMIN_USER=admin
export GRAFANA_ADMIN_PASSWORD=secure-password
export GRAFANA_DOMAIN=your-domain.com

# Generate SSL certificates (same as bootstrap)
mkdir -p ./monitoring/nginx/ssl
openssl req -x509 -nodes -days 365 -newkey rsa:2048 \
  -keyout ./monitoring/nginx/ssl/server.key \
  -out ./monitoring/nginx/ssl/server.crt \
  -subj "/C=US/ST=State/L=City/O=Organization/CN=your-domain.com"

# Connect to default mainnet (api.bitcoinqs.org)
docker compose -f docker-compose.validator.yml up -d

# OR connect to custom bootstrap server
BOOTSTRAP_SERVER=your.bootstrap.server BOOTSTRAP_PORT=8001 \
  docker compose -f docker-compose.validator.yml up -d

# View logs
docker compose -f docker-compose.validator.yml logs -f validator

# Access services (same ports as bootstrap):
# - API: https://localhost:8080 (SSL via nginx)
# - Grafana: https://localhost:443 (public read-only access)
# - RPC: localhost:8332

Key Docker Features

All configurations include:

Automatic wallet generation with secure passwords
Redis for caching and rate limiting
Prometheus metrics collection
Grafana dashboards for monitoring
Persistent storage using Docker volumes
Automatic peer discovery between containers
Health checks for all services
Resource limits to prevent runaway processes
Security hardening (no-new-privileges, read-only filesystems where possible)

Production configurations additionally include:

SSL/TLS encryption via nginx
DDoS protection and attack detection
Rate limiting on API endpoints
Public read-only Grafana dashboards
Enhanced security logging

🧪 Testing Multi-Node

You can simulate multiple validators by launching separate containers or Python processes with unique ports and wallet keys.

Docker Multi-Node Network

The test network (docker-compose.test.yml) creates:

1 Bootstrap node (internal port 8080, accessed via nginx on 8080)
2 Validator nodes (ports 8081, 8082)
Prometheus monitoring (port 9090)
Grafana dashboards (port 3000)
Redis cache (with 3 databases for separate node caching)
Nginx reverse proxy (port 8080 for load-balanced API access)

All nodes automatically discover each other and maintain peer connections.

📜 Core Components

Component	Description
`main.py`	Entry point - starts web/RPC servers
`blockchain/`	Block, transaction, UTXO, Merkle logic
`chain_manager.py`	Manages blockchain state and fork resolution
`dht/`	Kademlia-based peer discovery
`gossip/`	Gossip protocol for block/tx propagation
`web/`	FastAPI web server with API endpoints
`rpc/`	Bitcoin-compatible RPC for mining
`wallet/`	Post-quantum key management (ML-DSA)
`database/`	RocksDB storage layer
`monitoring/`	Health checks and Prometheus metrics
`events/`	Event bus for internal communication
`security/`	Rate limiting and DDoS protection
`mempool/`	Transaction pool with conflict detection

⛏️ Submitting & Mining Transactions

Submitting a Transaction to the Mempool

You can broadcast a signed transaction using the test harness:

python3 broadcast_tx_test_harness.py \
  --node http://localhost:8080 \
  --receiver bqs1Bo4quBsE6f5aitv42X5n1S9kASsphn9At \
  --amount 500 \
  --wallet ~/Desktop/ledger.json

This sends 500 qBTC to the specified address using your signed wallet. The transaction includes:

Chain ID for replay protection
Timestamp for transaction expiration
ML-DSA signature for post-quantum security

Mining Transactions in the Mempool

To mine blocks (including mempool transactions), use cpuminer-opt connected to any node's RPC endpoint:

docker run --rm -it cpuminer-opt \
  -a sha256d \
  -o http://localhost:8332 \
  -u someuser -p x \
  --coinbase-addr=bqs1YourAddressHere

The RPC server automatically:

Includes pending transactions from the mempool
Creates proper coinbase transactions with fees
Broadcasts mined blocks to all peers via gossip

📊 Monitoring & Debugging

Health & Metrics Endpoints

Health Check: http://localhost:8080/health - Prometheus metrics
Network Status: http://localhost:8080/debug/network - Peer connections
Peer Details: http://localhost:8080/debug/peers - Detailed peer info
Mempool: http://localhost:8080/debug/mempool - Pending transactions
UTXOs: http://localhost:8080/debug/utxos - Available UTXOs
Genesis Debug: http://localhost:8080/debug/genesis - Genesis block info

Prometheus Metrics (http://localhost:9090)

Key metrics include:

qbtc_connected_peers_total - Number of connected peers
qbtc_blockchain_height - Current blockchain height
qbtc_pending_transactions - Mempool size
qbtc_uptime_seconds - Node uptime
qbtc_health_check_status - Component health status

Grafana Dashboards (http://localhost:3000)

Pre-configured dashboards show:

Network topology and peer connections
Blockchain growth and sync status
Transaction throughput
System performance metrics

🔐 Security Features

Post-Quantum Signatures: All transactions use ML-DSA-87 for quantum resistance
Chain ID: Prevents replay attacks across different networks
Transaction Expiration: Transactions expire after 1 hour by default
Rate Limiting: Redis-based rate limiting on all API endpoints
DDoS Protection: Integrated security middleware with IP blocking
Peer Reputation: Automatic tracking and scoring of peer reliability
Secure WebSockets: Authenticated WebSocket connections for real-time updates

Security Audits

Internal and external audits can be found in the audits/ folder. We are actively addressing issues in order of criticality.

🌐 Network Architecture

Peer Discovery

Nodes use Kademlia DHT for decentralized peer discovery:

Bootstrap nodes maintain the DHT network
New nodes query the DHT for active validators
Validators announce their presence with gossip endpoints
NAT traversal support for nodes behind firewalls

Block & Transaction Propagation

The gossip protocol ensures fast network-wide propagation:

Transactions are broadcast to all connected peers
Blocks are propagated immediately upon mining
Nodes sync missing blocks automatically
Failed peers are tracked and retried with exponential backoff

Consensus & Fork Resolution

Longest chain rule with proper difficulty validation
Chain manager tracks multiple chain tips
Automatic reorganization when longer chains are found
Full validation of all blocks and transactions

📈 Roadmap

Completed ✅

Merkle Root validation
Gossip protocol implementation
Kademlia DHT integration
UTXO state management
Genesis block with 21M coin distribution
Prometheus metrics & monitoring
Docker containerization
NAT traversal support
Chain reorganization
Transaction mempool
RPC mining interface
Event-driven architecture

In Progress 🚧

TLS encryption for all connections
Peer authentication with ML-DSA
Advanced fork choice rules
State pruning optimizations

Planned 📋

Fee market implementation
Smart contract support
Light client protocol
Mobile wallet SDK
Hardware wallet integration

🧠 License

MIT License. See LICENSE for more information.

🤝 Contributing

PRs and issues welcome! To contribute:

Fork the repo
Create your feature branch (git checkout -b feature/foo)
Commit your changes
Push to the branch
Open a PR

Name		Name	Last commit message	Last commit date
Latest commit History 178 Commits
.github/workflows		.github/workflows
audits/internal-audit		audits/internal-audit
blockchain		blockchain
config		config
database		database
dht		dht
errors		errors
events		events
gossip		gossip
log_utils		log_utils
mempool		mempool
middleware		middleware
models		models
monitoring		monitoring
network		network
node		node
rpc		rpc
scripts		scripts
security		security
state		state
sync		sync
test-tools		test-tools
tests		tests
utils		utils
wallet		wallet
web		web
.env.blocked_ips		.env.blocked_ips
.env.example		.env.example
.gitattributes		.gitattributes
.gitignore		.gitignore
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
DEPLOYMENT.md		DEPLOYMENT.md
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
Readme.md		Readme.md
clean.sh		clean.sh
docker-compose.bootstrap.yml		docker-compose.bootstrap.yml
docker-compose.test.yml		docker-compose.test.yml
docker-compose.validator.yml		docker-compose.validator.yml
docker-entrypoint.sh		docker-entrypoint.sh
harness.py		harness.py
main.py		main.py
oqs.py		oqs.py
pytest.ini		pytest.ini
requirements.txt		requirements.txt
start_with_blocks.sh		start_with_blocks.sh
test_rpc_direct.py		test_rpc_direct.py
test_websocket.py		test_websocket.py

License

q-BTC/qBTC-core

Folders and files

Latest commit

History

Repository files navigation

qBTC-core DEV NET

🌐 Key Features

📦 Architecture Overview

🛠 Getting Started

1. Clone the Repository & Install Dependencies

2. Generate a Wallet

3. Start a Node via CLI

CLI Usage

a) Start as a Bootstrap Server

b) Connect to Default Bootstrap Server (api.bitcoinqs.org)

c) Connect to Custom Bootstrap Server

d) Use Custom Ports

🐳 Docker Usage

Available Configurations

Quick Start: Test Network (3 Nodes)

Production Bootstrap Server

Production Validator Node

Key Docker Features

🧪 Testing Multi-Node

Docker Multi-Node Network

📜 Core Components

⛏️ Submitting & Mining Transactions

Submitting a Transaction to the Mempool

Mining Transactions in the Mempool

📊 Monitoring & Debugging

Health & Metrics Endpoints

Prometheus Metrics (http://localhost:9090)

Grafana Dashboards (http://localhost:3000)

🔐 Security Features

Security Audits

🌐 Network Architecture

Peer Discovery

Block & Transaction Propagation

Consensus & Fork Resolution

📈 Roadmap

Completed ✅

In Progress 🚧

Planned 📋

🧠 License

🤝 Contributing

Development Tips

🚀 Authors

📚 Additional Resources

About

Resources

License

Code of conduct

Contributing

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors 4

Uh oh!

Languages

Packages