Skip to content

Crates & API

This page indexes the Rust crates and firmware that power the PoT-O validator and related services. Full API documentation is generated by cargo doc and published on docs.rs when crates are released.

Rust crates (pot-o-validator workspace)

The off-chain validator lives under gateway.tribewarez.com/testnet.rpc.gateway.tribewarez.com/pot-o-validator/. The workspace includes:

CrateDescriptiondocs.rscrates.io
pot-o-validatorPoT-O validator HTTP service and library (config, consensus, device registry, HTTP API)docs.rs/pot-o-validatorWhen published
pot-o-coreCore types and utilities: block, transaction, errors, constantsdocs.rs/pot-o-coreWhen published
ai3-libAI3 support: tensor engine, ESP compatibility, mining operationsdocs.rs/ai3-libWhen published
pot-o-miningMining coordination: challenge generation, MML/neural path validation, PoT-O consensusdocs.rs/pot-o-miningWhen published
pot-o-extensionsDeFi, staking, pool strategy, device protocol, chain bridge, peer network, proof authoritydocs.rs/pot-o-extensionsWhen published

Build docs locally from the validator directory:

bash
cd gateway.tribewarez.com/testnet.rpc.gateway.tribewarez.com/pot-o-validator
cargo doc --no-deps --open

Auxiliary binaries

  • pot-o-validator — main HTTP server (health, status, challenge, submit, devices, DeFi endpoints).
  • pot-o-mml-calibrate — CLI to compare DEFLATE-based MML scores with ESP-style entropy approximation.
  • pot-o-timing — timing harness for PoT-O operations and mining loop.
  • pot-o-golden-proofs — generates golden proofs for fixed slots (JSONL to stdout).

Firmware (C/C++)

ESP32-S and ESP8266 mining firmware is not a Rust crate. It lives under:

  • pot-o-validator/firmware/esp-pot-o-miner/ — PlatformIO project for on-device tensor mining.

See ESP Mining and the esp-pot-o-miner repository for build and flash instructions.

Tests

LocationDescription
pot-o-validator/tests/Integration tests (e.g. http_status_smoke for validator HTTP).
pot-o-validator/ai3-lib/tests/Engine smoke tests.

Run all tests:

bash
cd gateway.tribewarez.com/testnet.rpc.gateway.tribewarez.com/pot-o-validator
cargo test --all

See also

TribeWarez Blockchain Ecosystem