Skip to content

kynesyslabs/demos_network_technical_documentation

Repository files navigation

Demos Blockchain - Complete Diagram Documentation

Overview

This directory contains comprehensive Mermaid diagram documentation for all major features of the Demos blockchain. Each feature has 10 detailed diagrams covering architecture, flows, state machines, and complete system lifecycles.

Total Features Documented: 13 Total Diagrams: 130 Diagram Types: Flowcharts, Sequence Diagrams, State Machines, Class Diagrams, ER Diagrams, Graph Diagrams

View All Diagrams: Open UNIVERSAL_DIAGRAM_VIEWER.html for an interactive dark-themed viewer with zoom, pan, and navigation for all 130 diagrams.


Quick Navigation

Core Blockchain Features

Location: diagrams/blockchain-core/

Complete blockchain fundamentals including block structure, chain management, genesis initialization, database operations, and native hashing.

Key Topics:

  • Block Structure & Properties (hash, prevHash, number, timestamp, signer, content, nonce)
  • Chain Management (genesis, growth, validation, reorganization)
  • Block Database Operations (storage, retrieval, indexing)
  • Native SHA256 Hashing Implementation
  • Block Lifecycle State Machine
  • Genesis Block Initialization
  • Block Properties & Metadata
  • Chain Continuity & Integrity
  • Database Schema (blocks, transactions, state)
  • Complete System Architecture

Location: diagrams/gcr/

Global mutable state registry managing balances, identities, nonces, and incentives with cryptographic traceability.

Key Topics:

  • GCR Architecture (HandleGCR core, routines, operations)
  • Balance Management (add, remove, rollback operations)
  • Nonce Management (increment, decrement, tracking)
  • Identity Management (XM, Web2, PQC identities across chains)
  • GCR Edit Operations (Transaction → Operation flow)
  • Cross-Chain Identity Support (Solana, EVM, MultiversX, TON, etc.)
  • Rollback Mechanisms
  • GCR Database Schema
  • State Change Traceability
  • Complete GCR Lifecycle

Innovations:

  • Cryptographically traceable state modifications
  • Multi-chain identity management
  • Transaction-derived operations model
  • Rollback-safe state transitions

Location: diagrams/consensus-v2/

Advanced Proof of Representation Byzantine Fault Tolerant consensus mechanism with validator voting, finalization, and supermajority requirements.

Key Topics:

  • PoR-BFT Architecture (Proposer, Validators, Voters)
  • Block Proposal & Validation Flow
  • Vote Collection & Aggregation (2/3+ threshold)
  • Block Finalization Process
  • Fork Resolution & Chain Selection
  • Byzantine Fault Tolerance (33% dishonest tolerance)
  • Validator Rotation & Selection
  • Vote Verification & Signatures
  • Consensus State Machine (Proposed → Voting → Finalized)
  • Finality Guarantees

Security:

  • BFT consensus (tolerates up to 33% Byzantine validators)
  • 2/3+ supermajority for finalization
  • Cryptographic vote signatures
  • Fork resolution with longest chain rule

Network & Communication

Location: diagrams/validator-management/

Complete peer and validator lifecycle management including discovery, registration, authentication, and health monitoring.

Key Topics:

  • Peer Discovery (Bootstrap, DNS, mDNS, DHT)
  • Peer Connection Management (handshake, authentication)
  • Validator Registration & Staking
  • Validator Selection Algorithm (weighted random by stake)
  • Peer Health Monitoring (heartbeat, latency, uptime)
  • Peer Reputation System (scoring, penalties, banning)
  • Validator Slashing Conditions
  • Peer Database Schema
  • Connection Pool Management
  • Complete Peer Lifecycle State Machine

Features:

  • Multi-method peer discovery
  • Reputation-based peer selection
  • Stake-weighted validator selection
  • Slashing for misbehavior

Location: diagrams/p2p-network/

Peer-to-peer networking infrastructure with fast sync, RPC server, block propagation, and rate limiting.

Key Topics:

  • P2P Network Architecture (WebSocket, TCP/IP)
  • Fast Sync Protocol (header sync → state sync → catch up)
  • RPC Server & Message Routing
  • Block Propagation (gossip protocol)
  • Peer Discovery & Authentication
  • Node Call API (query blocks, transactions, state)
  • Mempool Synchronization
  • Rate Limiting & DDoS Protection
  • Network Message Types & Handlers
  • Complete Network Flow State Machine

Performance:

  • Fast sync with parallel downloads
  • Gossip-based block propagation
  • Rate limiting (100 req/min/peer)
  • Efficient state synchronization

Transaction Processing

Location: diagrams/transactions-mempool/

Complete transaction lifecycle from creation through mempool management to block inclusion with post-quantum signatures.

Key Topics:

  • Transaction Structure (hash, from, to, amount, nonce, timestamp, signatures)
  • Post-Quantum Signatures (ML-DSA Dilithium, SL-DSA Sphincs+)
  • Transaction Validation (signature, nonce, balance, format)
  • Mempool Management (priority queue, size limits, expiry)
  • Transaction Broadcasting & Propagation
  • Fee Market & Priority Calculation
  • Transaction Replacement (nonce-based)
  • Double-Spend Prevention
  • Transaction Lifecycle State Machine
  • Mempool Database Schema

Security:

  • Dual PQC signatures (ML-DSA + SL-DSA)
  • Quantum-resistant cryptography
  • Nonce-based replay protection
  • Multi-layer validation

Location: diagrams/block-creation/

Block assembly, validation voting, finalization, rollback, and complete block lifecycle management.

Key Topics:

  • Block Structure (header, transactions, encrypted_transactions, metadata)
  • Block Creation Process (transaction selection, merkle root, nonce)
  • Validation Voting (validator selection, vote collection, 2/3+ threshold)
  • Block Finalization (irreversible commitment)
  • Block Rollback & Fork Handling
  • Native SHA256 Hashing for Blocks
  • Chain Continuity Validation
  • Block Database Schema
  • Block Sync & Propagation
  • Complete Block Lifecycle State Machine

Workflow:

  1. Transaction selection from mempool
  2. Block assembly with merkle root
  3. Validator voting (2/3+ approval)
  4. Finalization & chain commitment
  5. Propagation to network

Advanced Features

Location: diagrams/bridges-multichain/

Cross-chain bridges enabling interoperability with EVM chains, Solana, Aptos, and multi-chain transaction execution.

Key Topics:

  • XM Script System (cross-chain scripting language)
  • Cross-Chain Operation Flow (lock → bridge → unlock)
  • Native Bridge Architecture (Demos ↔ External chains)
  • Rubic Swap Integration (DEX aggregation)
  • Multi-Chain Transaction Execution
  • Bridge Validators & Consensus
  • Cross-Chain State Verification
  • Bridge Security (multisig, timelock, fraud proofs)
  • Supported Chains (EVM, Solana, Aptos)
  • Complete Bridge Lifecycle

Interoperability:

  • XM scripts for multi-chain logic
  • Native bridges to major chains
  • Rubic integration for swaps
  • Cross-chain state proofs

Location: diagrams/web2-integration/

Data Agnostic HTTPS Relay enabling blockchain applications to interact with traditional Web2 services with cryptographic integrity.

Key Topics:

  • DAHR Architecture (Factory pattern, session management)
  • Proxy Server Initialization & Lifecycle
  • HTTP Request Flow & Forwarding
  • Session Management (UUID-based, 24h TTL)
  • URL Validation & Normalization
  • Request/Response Hashing (SHA256 for integrity)
  • Action Routing (CREATE vs START_PROXY)
  • Error Handling & Validation
  • SSL/TLS Configuration
  • Complete DAHR Lifecycle State Machine

Features:

  • Factory pattern with singleton DAHRFactory
  • Session-based proxy instances
  • Cryptographic request/response hashing
  • URL validation with security checks
  • 24-hour session expiry with cleanup

Location: diagrams/cryptography/

Advanced cryptography with Fully Homomorphic Encryption, Zero-Knowledge Proofs, and Post-Quantum Cryptography.

Key Topics:

FHE (Fully Homomorphic Encryption):

  • Microsoft SEAL Library with BFV Scheme
  • 4096 Polynomial Modulus Degree, tc128 Security
  • Homomorphic Operations (add, multiply, negate on encrypted data)
  • Noise Budget Management
  • Private Computation

ZK (Zero-Knowledge Proofs):

  • Interactive Proof System (Prover/Verifier)
  • Challenge-Response Protocol
  • k=20 rounds → 2^-20 cheating probability
  • Security Properties (completeness, soundness, zero-knowledge)
  • Modular Arithmetic with Large Primes

PQC (Post-Quantum Cryptography):

  • SuperDilithium (ML-DSA Standard)
  • Enigma Wrapper for Quantum-Safe Signatures
  • Lattice-Based Cryptography
  • Resistant to Shor's Algorithm
  • NIST Post-Quantum Compliance

Use Cases:

  • Private transactions with FHE-encrypted amounts
  • Proof-based authentication without revealing secrets
  • Quantum-safe transaction signing

Location: diagrams/activitypub/

Federated social networking protocol implementation with Express.js server, SQLite storage, and ActivityStreams support.

Key Topics:

  • ActivityPub Server Architecture (Express.js + SQLite)
  • Actor Model & Collections (Person, Note, Activity types)
  • SQLite Storage Schema (14 collections)
  • REST API Endpoints (GET/PUT/:collection/:id)
  • ActivityStreams Object Model (core objects, activities, collections)
  • Inbox/Outbox Message Flow (federated delivery)
  • Federation Protocol (WebFinger, HTTP signatures)
  • Collection Management (Followers, Following, Liked, etc.)
  • Data Persistence & Retrieval (CRUD operations)
  • Complete ActivityPub Lifecycle

Features:

  • Express.js REST API with universal handlers
  • 14 SQLite collections with JSON blob storage
  • ActivityStreams protocol compliance
  • HTTP signature verification for federation
  • Session-based inbox/outbox management

Location: diagrams/incentive/

Comprehensive point-based incentive system with referrals, levels, rewards, and gamification for network participation.

Key Topics:

  • Incentive System Architecture (points, levels, rewards)
  • Point Earning Mechanisms (transactions, referrals, validation)
  • Referral System (multi-level tracking, commissions)
  • Level Progression (Bronze → Diamond tiers)
  • Reward Distribution (automatic payouts)
  • Point Validation & Security
  • User Progress Tracking
  • Leaderboard & Rankings
  • Incentive Database Schema
  • Complete Incentive Lifecycle

Features:

  • Multi-level referral system with commission tiers
  • 5-tier level progression (Bronze, Silver, Gold, Platinum, Diamond)
  • Activity-based point earning (tx fees, referrals, staking, validation)
  • Automatic reward distribution
  • Anti-gaming protection and validation

Location: diagrams/mcp/

Model Context Protocol server enabling AI assistants to interact with blockchain operations via standardized tools.

Key Topics:

  • MCP Server Architecture (stdio + SSE transports)
  • Tool Registration & Management
  • Request/Response Flow (ListTools, CallTool)
  • Transport Layer (stdio for local, SSE for remote)
  • Blockchain Tools (blocks, transactions, chain status)
  • Network Tools (peers, node identity, health)
  • Tool Execution & Validation
  • Session Management
  • MCP Protocol Compliance
  • Complete MCP Lifecycle

Features:

  • Dual transport support (stdio + Server-Sent Events)
  • Comprehensive blockchain tool suite
  • Tool validation with Zod schemas
  • Remote network access via SSE/HTTP
  • Full MCP SDK compliance

Documentation Standards

Each feature documentation includes:

  1. 10 Comprehensive Diagrams covering all aspects of the feature
  2. Mermaid Syntax for interactive, version-controllable diagrams
  3. Detailed Descriptions explaining each diagram's purpose and components
  4. Architecture Overviews showing system-wide integration
  5. Sequence Diagrams for time-based workflows
  6. State Machines for lifecycle management
  7. Flowcharts for decision logic and processes
  8. Database Schemas where applicable
  9. Complete System Lifecycles from initialization to shutdown
  10. Universal Viewer Integration - all diagrams accessible from one interface

Diagram Categories

By Type

  • Architecture Diagrams: System overviews and component relationships
  • Sequence Diagrams: Time-based interactions and message flows
  • State Machines: Lifecycle management and state transitions
  • Flowcharts: Decision logic and process flows
  • ER Diagrams: Database schemas and relationships
  • Graph Diagrams: Network topologies and hierarchies

By Domain

  • Core Blockchain: Blocks, chains, hashing, genesis
  • Consensus: Voting, finalization, BFT, validator rotation
  • Networking: P2P, sync, RPC, propagation, discovery
  • Transactions: Creation, validation, mempool, PQC signatures
  • Security: Cryptography (FHE, ZK, PQC), slashing, reputation
  • Interoperability: Bridges, cross-chain, multi-chain execution
  • Infrastructure: GCR clustering, Web2 integration, DAHR

Technology Stack

Diagram Rendering

  • Mermaid.js v10: Declarative diagram syntax with live rendering
  • CommonMark: Markdown specification for documentation
  • HTML5 + CSS3: Interactive viewers with navigation

Cryptography

  • Microsoft SEAL: FHE library with BFV scheme
  • SuperDilithium: Post-quantum signatures (ML-DSA)
  • BigInteger.js: Large number arithmetic for ZK proofs
  • Node-forge: RSA cryptography for L2PS
  • Native SHA256: Blockchain-native hashing

Blockchain

  • Custom Consensus: BFT with validator voting
  • LevelDB/RocksDB: Persistent block storage
  • WebSocket: Real-time P2P communication
  • Rubic SDK: Cross-chain swap integration

File Structure

diagrams/
├── README.md                           # This file - Documentation index
├── UNIVERSAL_DIAGRAM_VIEWER.html       # Universal viewer for all 130 diagrams
├── server.ts                           # Bun development server with no-cache
│
├── blockchain-core/
│   └── BLOCKCHAIN_CORE.md              # 10 blockchain core diagrams
│
├── gcr/
│   └── GCR.md                          # 10 GCR diagrams
│
├── consensus-v2/
│   └── CONSENSUS_V2.md                 # 10 consensus diagrams
│
├── validator-management/
│   └── VALIDATOR_PEER_MANAGEMENT.md    # 10 validator/peer diagrams
│
├── transactions-mempool/
│   └── TRANSACTIONS_MEMPOOL.md         # 10 transaction diagrams
│
├── block-creation/
│   └── BLOCK_CREATION_VALIDATION.md    # 10 block creation diagrams
│
├── p2p-network/
│   └── P2P_NETWORK_SYNC.md             # 10 P2P network diagrams
│
├── bridges-multichain/
│   └── BRIDGES_MULTICHAIN.md           # 10 bridge diagrams
│
├── web2-integration/
│   └── WEB2_DAHR.md                    # 10 Web2/DAHR diagrams
│
├── cryptography/
│   └── CRYPTOGRAPHY_SYSTEMS.md         # 10 cryptography diagrams
│
├── activitypub/
│   └── ACTIVITYPUB_INTEGRATION.md      # 10 ActivityPub diagrams
│
├── incentive/
│   └── INCENTIVE_MANAGEMENT.md         # 10 incentive system diagrams
│
└── mcp/
    └── MCP_PROTOCOL.md                 # 10 MCP protocol diagrams

Usage

Development Server

For the best viewing experience with automatic cache-busting and no-cache headers, use the included Bun development server:

# Install Bun (if not already installed)
curl -fsSL https://bun.sh/install | bash
source ~/.bashrc

# Start the development server
cd diagrams
bun run server.ts

The server will run at http://localhost:8000/ and automatically serve the Universal Diagram Viewer with proper headers to prevent caching issues.

Viewing Diagrams

Option 1: Universal Diagram Viewer (Recommended)

Open UNIVERSAL_DIAGRAM_VIEWER.html for the complete interactive experience:

  • Dark theme inspired by demos.sh
  • All 130 diagrams accessible from a single interface
  • Zoom & pan functionality on all diagrams
  • Sidebar navigation with 13 feature sets
  • Cache-busting to ensure fresh content
  • Responsive design for mobile and desktop

Option 2: Markdown Files

Navigate to any feature's markdown file and view directly in GitHub or any markdown viewer with Mermaid support.

Option 3: Development Server (Best Performance)

Use bun run server.ts to serve diagrams with no-cache headers for the freshest content during development.

Editing Diagrams

  1. Edit the Mermaid syntax in the markdown files
  2. Diagrams use standard Mermaid syntax (flowchart, sequenceDiagram, stateDiagram-v2, etc.)
  3. Test changes by opening the HTML viewer or using Mermaid Live Editor
  4. Commit changes to version control

Creating New Diagrams

  1. Create a new directory: diagrams/feature-name/
  2. Create markdown file: FEATURE_NAME.md with 10 diagrams
  3. Add the new feature to UNIVERSAL_DIAGRAM_VIEWER.html in the diagrams array:
    { name: 'Feature Name', path: 'feature-name/FEATURE_NAME.md', icon: '📦' }
  4. Update this README.md to include the new feature
  5. Test with the development server: bun run server.ts

Best Practices

Diagram Design

  • Clarity: Use clear, descriptive labels and titles
  • Consistency: Follow the same color scheme and style across diagrams
  • Completeness: Cover all aspects of a feature in 10 diagrams
  • Detail: Include notes, descriptions, and annotations
  • Flow: Show clear progression and relationships

Color Coding (Standard across all diagrams)

  • fill:#e1f5ff - Primary components (blue)
  • fill:#fff4e1 - Secondary components (yellow/orange)
  • fill:#e8f5e9 - Success/completed states (green)
  • fill:#ffebee - Important/security components (red)
  • fill:#f3e5f5 - Additional/supporting components (purple)
  • fill:#ffcccc - Error states (light red)

Documentation

  • Descriptions: Each diagram should have a 2-3 sentence description
  • Context: Explain why the diagram matters and what it shows
  • References: Link related diagrams and documentation
  • Examples: Include concrete examples where helpful

Contribution Guidelines

When adding or updating diagrams:

  1. Maintain Quality: Follow the 10-diagram standard for each feature
  2. Use Mermaid: All diagrams must use Mermaid syntax (avoid numbered lists in state diagram notes)
  3. Update Universal Viewer: Add new features to the diagrams array in UNIVERSAL_DIAGRAM_VIEWER.html
  4. Update Index: Update this README with the new feature documentation
  5. Test Rendering: Verify diagrams render correctly using bun run server.ts
  6. Add Descriptions: Include clear descriptions for each diagram
  7. Follow Structure: Use the established directory and file naming conventions
  8. Mermaid Syntax: Avoid numbered lists (1., 2., 3.) in state diagram notes - use bullet points (-) instead

Version History

  • v1.2 - Universal Viewer and Development Server (Current)

    • Added UNIVERSAL_DIAGRAM_VIEWER.html with dark theme
    • Created Bun TypeScript development server (server.ts)
    • Removed 14 individual HTML viewers (unified into one)
    • Added zoom & pan functionality to all diagrams
    • Implemented cache-busting for fresh content
    • Fixed all Mermaid syntax errors (numbered lists in state diagrams)
    • Dark theme inspired by demos.sh with white diagram containers
  • v1.1 - Added 3 new feature sets (130 diagrams total)

    • ActivityPub Integration
    • Incentive Management
    • MCP Protocol
  • v1.0 - Initial release with 10 complete feature sets (100 diagrams total)

    • Blockchain Core
    • Global Cluster Registry (GCR)
    • Consensus V2
    • Validator & Peer Management
    • Transaction Processing & Mempool
    • Block Creation & Validation
    • P2P Network & Synchronization
    • Bridges & Multichain Integration
    • Web2 Integration (DAHR)
    • Cryptography Systems (FHE, ZK, PQC)

Related Documentation


License

This documentation is part of the Demos blockchain project. © 2024 Kynesys Labs


Quick Links

Feature Documentation
Blockchain Core BLOCKCHAIN_CORE.md
Global Change Registry GCR.md
PoR-BFT Consensus CONSENSUS_V2.md
Validator Management VALIDATOR_PEER_MANAGEMENT.md
Transactions & Mempool TRANSACTIONS_MEMPOOL.md
Block Creation BLOCK_CREATION_VALIDATION.md
P2P Network P2P_NETWORK_SYNC.md
Bridges & Multichain BRIDGES_MULTICHAIN.md
Web2 Integration WEB2_DAHR.md
Cryptography Systems CRYPTOGRAPHY_SYSTEMS.md
ActivityPub Integration ACTIVITYPUB_INTEGRATION.md
Incentive Management INCENTIVE_MANAGEMENT.md
MCP Protocol MCP_PROTOCOL.md

For the best experience:

  1. Run bun run server.ts from the diagrams directory
  2. Open http://localhost:8000/ in your browser
  3. Or directly open UNIVERSAL_DIAGRAM_VIEWER.html

About

Technical Documentation with diagrams and references for the Demos Network

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published