pot-o-validator 0.2.0

PoT-O (Proof of Tensor Optimizations) Validator Service
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
90
91
92
93
94
95
96
97
98

# pot-o-validator

[![crates.io](https://img.shields.io/crates/v/pot-o-validator.svg)](https://crates.io/crates/pot-o-validator)
[![crates.io downloads](https://img.shields.io/crates/d/pot-o-validator.svg)](https://crates.io/crates/pot-o-validator)
[![docs.rs](https://img.shields.io/docsrs/pot-o-validator)](https://docs.rs/pot-o-validator)
[![CI](https://img.shields.io/github/actions/workflow/status/TribeWarez/pot-o-validator/ci.yml?branch=main)](https://github.com/TribeWarez/pot-o-validator/actions/workflows/ci.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

PoT-O (Proof of Tensor Optimizations) Validator Service — HTTP API and consensus node for the TribeWarez testnet.

**Current Version**: v0.1.6-alpha | **Planned**: v0.2.0 with Dependency Injection + Tensor Network integration

- **Crate:** [crates.io/crates/pot-o-validator](https://crates.io/crates/pot-o-validator)
- **Docs:** [docs.rs/pot-o-validator](https://docs.rs/pot-o-validator)
- **Repository:** [github.com/TribeWarez/pot-o-validator](https://github.com/TribeWarez/pot-o-validator)

## Crates

- **pot-o-validator** (this crate): binary and library; HTTP API, config, consensus, device registry, extensions bootstrap.
- **pot-o-core**: block/transaction types, errors, constants.
- **ai3-lib**: tensor engine, ESP compat, mining operations.
- **pot-o-mining**: challenge generation, MML/neural path validation, PoT-O consensus.
- **pot-o-extensions**: DeFi, pool strategy, device protocol, chain bridge, peer network, security.

See [docs.tribewarez.com/crates-and-api](https://docs.tribewarez.com/crates-and-api/) and [Implementation Mapping](https://docs.tribewarez.com/public/implementation-map) for details.

## Architecture

### v0.1.6-alpha (Current)
- **Monolithic service design** with modular crate organization
- **HTTP API** for proof submission and validation
- **Device registry** for miner management
- **Challenge generation** with MML and neural path validation
- **Consensus engine** with difficulty adjustment

### v0.2.0 (Planned - see MIGRATION_GUIDE.md)
- **Dependency Injection** service architecture
- **Service traits** for ProofValidator, ChallengeGenerator, ConsensusEngine
- **ServiceRegistry** for flexible component composition
- **Tensor Network Model** (REALMS Part IV) for entropy-based calculations
- **Event system** for state tracking and off-chain monitoring

## Documentation

- **[CHANGELOG.md](CHANGELOG.md)** - Version history and feature timeline
- **[MIGRATION_GUIDE.md](MIGRATION_GUIDE.md)** - v0.1.x → v0.2.0 upgrade path
- **[SECURITY.md](SECURITY.md)** - Security guidelines and vulnerability reporting

## Error Handling

All crates use **custom error types** and **Result<T> pattern**:

```rust
use pot_o_validator::{TribeError, TribeResult};

// Example
fn validate_proof() -> TribeResult<bool> {
    // Returns Err(TribeError::...) on failure
    Ok(true)
}
```

## Service Architecture (v0.2.0 Pattern)

```rust
// TraitService abstractions (planned for v0.2.0)
pub trait ProofValidator { ... }
pub trait ChallengeGenerator { ... }
pub trait ConsensusEngine { ... }

// Multiple implementations
impl ProofValidator for StandardValidator { ... }
impl ProofValidator for TensorAwareValidator { ... }

// ServiceRegistry for composition
let registry = ServiceRegistry::new(config);
let validator = registry.create_validator()?;
```

## Build & run

```bash
cargo build --release
cargo run --release --bin pot-o-validator
```

## Versioning

Releases follow semantic versioning. To publish a new release:

1. Bump `version` in `Cargo.toml`.
2. Update `CHANGELOG.md` if present.
3. Commit and push, then create a tag: `git tag pot-o-validator-v0.1.1 && git push origin pot-o-validator-v0.1.1`.
4. GitHub Actions will run tests, then publish to crates.io and create a GitHub Release.

## License

[MIT](LICENSE) — TribeWarez.