northroot-proof-engine 0.3.0

Core proof computation and validation library for PoSH (Proof of Shape) and PoX (Proof of Execution)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! Engine v0.2.0 - LOCKED
//! DO NOT MODIFY without version bump
//! Last frozen: 2025-11-06
//!
//! Northroot Proof Engine v0.2 — Core proof computation and validation library
//!
//! This library provides the foundational cryptographic and validation primitives
//! for the modular proof architecture (PoSH, PoX).
//!
//! # Architecture
//!
//! - **PoSH (Proof of Shape)**: Method transformation contracts
//! - **PoX (Proof of Execution)**: Run evidence and commitments
//!
//! # Modules
//!
//! - `types`: v0.2 proof type definitions
//! - `canonical`: Deterministic JSON canonicalization
//! - `hash`: SHA-256 hash computation
//! - `signature`: ed25519 signature handling
//! - `validation`: Input validation functions
//! - `data_shape`: Data shape hashing
//! # Usage Example
//!
//! ```rust
//! use northroot_proof_engine::{compute_sha256, validate_trace_id, SpanCommitment, SpanStatus};
//!
//! // Compute SHA-256 hash
//! let hash = compute_sha256("Hello, world!");
//! assert!(hash.starts_with("sha256:"));
//!
//! // Validate trace ID
//! assert!(validate_trace_id("tr_01H1234567890").is_ok());
//! assert!(validate_trace_id("invalid").is_err());
//! ```
//!
//! # See Also
//!
//! - [README](../README.md) - Overview and quick start guide
//! - [CLI Guide](../docs/CLI_GUIDE.md) - Command-line tool usage
//! - [Benchmarks](../docs/BENCHMARKS.md) - Performance characteristics

pub mod canonical;
pub mod data_shape;
pub mod hash;
pub mod ids;
pub mod signature;
pub mod types;
pub mod validation;

// Re-export commonly used types
pub use types::{
    ArtifactRef, Did, IsoTime, MethodRef, MethodShapeManifest, RuntimePins, Sha256, Signature,
    SignedSpan, SpanCommitment, SpanMeta, SpanShape, SpanStatus, Trace, TraceRoots, Uri,
};

// Re-export canonicalization functions
pub use canonical::{
    canonicalize_method_shape, canonicalize_span_commitment, canonicalize_span_shape,
    canonicalize_trace, canonicalize_trace_roots, normalize_timestamp, CanonicalError,
};

// Re-export hash functions
pub use hash::{
    compute_identity_root, compute_method_shape_hash, compute_method_shape_root, compute_sha256,
    compute_span_commitment_hash, compute_span_shape_hash, compute_trace_hash,
    compute_trace_roots_hash, compute_trace_seq_root, compute_trace_set_root, HashError,
};

// Re-export signature functions
pub use signature::{
    sign_message, sign_span_commitment, validate_signature_format, verify_signature,
    verify_span_commitment_signature, SignatureError,
};

// Re-export validation functions
pub use validation::{
    validate_iso_time, validate_method_ref, validate_sha256_format, validate_span_commitment,
    validate_span_id, validate_trace_id, ValidationError,
};

// Re-export data shape functions
pub use data_shape::{compute_data_shape_hash, validate_data_shape_hash, DataShapeError};

// Re-export ID validation (for OTEL compatibility)
pub use ids::{
    validate_span_id as validate_otel_span_id, validate_trace_id as validate_otel_trace_id,
    OtelIdError,
};