Skip to main content

Crate peat_protocol

Crate peat_protocol 

Source
Expand description

§Peat Protocol - Hierarchical Intelligence for Versatile Entities

A hierarchical capability composition protocol using CRDTs for autonomous systems.

§Overview

The Peat protocol enables scalable coordination of autonomous nodes through:

  • Three-phase protocol: Discovery, Cell Formation, Hierarchical Operations
  • CRDT-based state: Eventual consistency via Automerge over Iroh QUIC
  • Capability composition: Additive, emergent, redundant, and constraint-based patterns

§Facade

peat-protocol is the public entry point to the Peat stack. It re-exports peat_schema (wire types) and peat_mesh (P2P plumbing) so downstream consumers can depend on peat-protocol alone:

# During an rc window, Cargo does not pick pre-release versions by default
# — use the exact pin:
peat-protocol = "=0.9.0-rc.1"

# Once 0.9.0 stable is published, the normal caret selector is fine:
# peat-protocol = "0.9"

§Architecture

┌──────────────┐  ┌──────────────┐  ┌──────────────┐
│   Phase 1:   │→ │   Phase 2:   │→ │   Phase 3:   │
│  Discovery   │  │    Cell      │  │ Hierarchical │
│              │  │  Formation   │  │  Operations  │
└──────────────┘  └──────────────┘  └──────────────┘

Re-exports§

pub use error::Error;
pub use error::Result;
pub use peat_mesh;
pub use peat_schema;

Modules§

cell
Cell formation module (Phase 2)
command
Hierarchical Command Coordination
composition
Capability composition engine
cot
Cursor-on-Target (CoT) Translation Layer
credentials
Peat Credentials
discovery
Discovery phase implementation (Phase 1)
distribution
Software Distribution for Peat - ADR-012 / ADR-026
error
Error types for the Peat protocol
event
Event Routing and Aggregation (ADR-027)
ffi
FFI (Foreign Function Interface) for Peat Protocol
geohash
Vendored geohash implementation for supply chain security.
hierarchy
Hierarchical operations module (Phase 3)
mesh_integration
Mesh integration adapters
models
Data models for the Peat protocol
network
Network layer for Peat Protocol
policy
Generic policy engine for conflict resolution and resource management
qos
Quality of Service (QoS) framework for data prioritization (ADR-019)
security
Security Module - Device Authentication (PKI) for Peat Protocol
storage
Storage abstractions and implementations
sync
Data Synchronization Abstraction Layer
testing
Testing utilities and infrastructure for Peat Protocol
traits
Core trait definitions for the Peat protocol
transport
Transport abstraction for mesh topology connections

Constants§

DEFAULT_CELL_SIZE
Default cell size (nodes per cell)
DEFAULT_DISCOVERY_TIMEOUT_SECS
Default discovery timeout in seconds
DEFAULT_HIERARCHY_DEPTH
Default hierarchy depth (node -> cell -> zone -> network)
VERSION
Protocol version