HieraChain 0.0.1

HieraChain - The Hierarchical Blockchain Enterprise Ledger

HieraChain - The Hierarchical Blockchain Enterprise Ledger

English | Tiếng Việt

Overview

HieraChain is an enterprise ledger built on hierarchical blockchain technology, designed specifically for business applications without any cryptocurrency concepts. Rather than being a general-purpose blockchain platform focused on digital currencies, HieraChain provides a secure, hierarchical ledger structure for managing business operations and processes.

This ledger implements a multi-layer hierarchical architecture where Main Chains supervise Sub-Chains, enabling scalable and secure business process management. All operations within the system are referred to as "events" rather than "transactions," emphasizing its focus on business applications.

Project Ecosystem

HieraChain is part of a larger ecosystem of blockchain tools:

Project	Language	Description
HieraChain	Python	Main hierarchical blockchain ledger (this repository)
HieraChain-Consensus	Rust	Official Core Consensus - optimized implementation with Python/C bindings

Note: While this repository includes a pure Python consensus implementation, the HieraChain-Consensus library is recommended for production deployments requiring high performance.

Key Features

• Hierarchical Structure: Multi-layer architecture with Main Chains (supervisors) and Sub-Chains (domain experts).
• Consensus Mechanisms: Supports Proof of Authority (PoA), Proof of Federation (PoF), and Byzantine Fault Tolerant (BFT) consensus.
• Enterprise Security: Ed25519 signatures, AES-256-GCM encryption, Membership Service Provider (MSP), and robust API Key authentication.
• High Performance: Columnar storage with Apache Arrow, hybrid caching, and parallel event processing.
• Reliability & Recovery: Durable transaction journaling, automated failure recovery, and state rollback capabilities.

Documentation

Comprehensive documentation is available at our official website docs.hierachain.org:

• Getting Started - Installation and basic setup
• Architecture - System design and hierarchical model
• Core Modules - Detailed breakdown of system components
• Guides & How-To - Step-by-step implementation guides
• API Reference - REST API and configuration details

Quick Start

Installation

Via PIP (recommended)

pip install HieraChain

From source (for development)

git clone https://github.com/VanDung-dev/HieraChain.git
cd HieraChain
python -m venv venv
source venv/bin/activate  # Linux/macOS (or venv\Scripts\activate on Windows)

# Install dependencies and project in dev mode
pip install -r requirements.txt
pip install -e .

Basic Usage

from hierachain.hierarchical import HierarchyManager

manager = HierarchyManager()
manager.create_sub_chain("supply_chain")

# Add an event
manager.add_event("supply_chain", {
    "entity_id": "PROD-001",
    "event": "production_complete",
    "timestamp": 1703088000.0,
    "details": {"quantity": 100}
})

# Submit proof to main chain
manager.submit_proof("supply_chain")

API Server:

python -m hierachain

API available at http://localhost:2661/docs

Technical Specifications

Metric	Value
Test Cases	>600
Python Support	3.10, 3.11, 3.12, 3.13
Consensus Types	PoA, PoF, BFT
Signature Algorithm	Ed25519
Encryption	AES-256-GCM

License

This project is dual licensed under either the Apache-2.0 License or the MIT License. You may choose either license.