Skip to content

SOVEREIGN-NET/lib-protocols

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sovereign Network Protocols Library (lib-protocols)

Complete Web4 Protocol Stack - Internet Replacement

This documentation provides comprehensive coverage of the lib-protocols library, which implements ZHTP (Zero Knowledge Hypertext Transfer Protocol) and ZDNS (Zero Knowledge Domain Name System) - the foundation of Web4.

📚 Documentation Structure

  • OVERVIEW - Complete architecture and design philosophy
  • Module Documentation - Detailed docs for each component

🏗️ Core Protocol Modules

Protocol Stack

  • types: Core protocol types - requests, responses, headers, status codes
  • zhtp: ZHTP server, routing, content management, sessions
  • zdns: Zero-knowledge DNS with ownership proofs
  • handlers: Request handlers for all ZHTP methods
  • validation: Protocol validation, ZK proofs, rate limiting

Integration Layer

  • integration: Unified system orchestrating all components
  • crypto: Cryptographic operations and ZK proof validation
  • economics: Economic models, fee calculation, DAO integration
  • storage: Distributed storage integration with lib-storage
  • identity: Identity management with ZK-DID support
  • secure_transfer: Secure wallet transfers with signature verification

Utilities

  • testing: Mock implementations and test utilities

Quick Start

See OVERVIEW.md for complete examples and getting started guide.

Key Features

  • ZHTP v1.0: HTTP replacement with built-in economics and privacy
  • ZDNS v1.0: Censorship-resistant domain resolution
  • Post-Quantum Security: CRYSTALS-Dilithium, CRYSTALS-Kyber
  • Zero-Knowledge Proofs: Privacy-preserving validation
  • Economic Incentives: 2% DAO fees for UBI funding
  • ****: Complete mesh networking capability

📖 Documentation Resources

Getting Started

  1. OVERVIEW - Architecture, design philosophy, and quick start
  2. API_REFERENCE - Complete API documentation with method signatures
  3. EXAMPLES - Practical code examples for common use cases

Module Documentation

Each module is documented with:

  • Purpose and scope
  • Key types and structures
  • Feature highlights
  • Usage examples

💡 Learning Path

For New Users:

  1. Read OVERVIEW.md to understand the architecture
  2. Review EXAMPLES.md for practical usage patterns
  3. Explore individual module docs as needed

For API Integration:

  1. Check API_REFERENCE.md for function signatures
  2. Review types.md for data structures
  3. See integration.md for system-wide usage

For Protocol Development:

  1. Study zhtp.md and zdns.md
  2. Review crypto.md and validation.md
  3. Understand economics.md for fee models

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages