Ultra-Low-Power, Verifiable Telemetry (Barnacle Sentinel)
This project has been archived.
The maintainers of this project have marked this project as archived. No new releases are expected.
Project description
TrackOne
TrackOne is an alpha-stage telemetry and verification workspace for low-power devices, gateway-side ingest, deterministic artifact generation, and publishable release artifacts.
The repository combines:
- Python tooling for gateway, verification, and demo/pipeline flows
- Rust workspace crates for shared protocol, ledger, gateway bindings, and pod firmware helpers
- Helm packaging for Kubernetes deployment
- Release automation for crates, wheels, and chart artifacts
What TrackOne is for
TrackOne is organized around a simple idea:
- Device-side telemetry should be bounded and replay-resistant
- Gateway-side processing should converge toward canonical, deterministic artifacts
- Verification outputs should be machine-checkable and releaseable
- Deployment artifacts should be reproducible and version-aligned
At a high level, the repo covers:
- Shared protocol and crypto-adjacent types
- Deterministic canonicalization and ledger helpers
- Python-facing gateway bindings
- Pod firmware support helpers
- Pipeline/demo and verification tooling
- Kubernetes packaging via Helm
Repository layout
.
├── crates/ # Rust workspace crates
│ ├── trackone-core
│ ├── trackone-constants
│ ├── trackone-ledger
│ ├── trackone-gateway
│ └── trackone-pod-fw
├── trackone_core/ # Python package surface for native bindings
├── scripts/ # Gateway/demo/verification tooling
├── tests/ # Python test suites
├── deploy/helm/trackone/ # Helm chart
├── docs/ # Project documentation
├── adr/ # Architecture Decision Records
├── Cargo.toml # Rust workspace root
└── pyproject.toml # Python package + tooling config
Main components
Rust workspace crates
trackone-core— core protocol, framing, bounded types, and shared invariantstrackone-constants— shared constants used across cratestrackone-ledger— canonicalization and deterministic ledger/commitment helperstrackone-gateway— PyO3-backed Rust gateway crate exposed to Pythontrackone-pod-fw— firmware-side helpers for pod integration
Python/tooling side
trackone_core/— Python package wrapper around the native extensionscripts/— gateway, verification, and demo pipeline scriptstests/— unit, integration, and end-to-end validation
Deployment side
deploy/helm/trackone/— Helm chart for published-artifact deployments and optional local overrides
Quick start
Python development setup
This project uses uv for Python environment and dependency management.
uv sync
If you want the broader local developer toolset:
uv sync --extra ci --extra test --extra security
Rust workspace checks
cargo check --workspace
cargo test --workspace
Python test run
uv run pytest
Common developer workflows
Run focused Rust checks
cargo check -p trackone-core
cargo test -p trackone-ledger
cargo test -p trackone-pod-fw
Build the Python extension locally
uv run maturin develop --manifest-path crates/trackone-gateway/Cargo.toml
Run project-wide quality checks
uv run tox
Or run a focused tox environment:
uv run tox -e lint
uv run tox -e type
uv run tox -e security
Releases
Tagged releases publish release artifacts through GitHub Actions.
Current release outputs include:
- Rust crates
- Python wheel artifacts
- Helm chart OCI artifacts
Version alignment matters across workspace crates, Python packaging, and deployment artifacts, so release cuts should be treated as coordinated workspace releases rather than isolated per-language bumps.
Deployment
Recommended: install the published Helm chart artifact
For normal deployments, use the published OCI chart:
helm upgrade --install trackone oci://ghcr.io/<owner>/trackone/charts/trackone \
--version <release-version> \
--namespace trackone \
--create-namespace \
--set postgres.auth.existingSecret=<your-postgres-secret>
If registry images are private, add your image-pull secret and any deployment-specific values overrides.
Optional local / Minikube-style workflow
Use the local chart and local image overrides only when you explicitly want local image builds and in-cluster development behavior.
eval "$(minikube -p ${MINIKUBE_PROFILE:-minikube} docker-env)"
docker build -t trackone/ots-calendar:local -f docker/calendar/Dockerfile docker/calendar
docker build -t trackone/gateway:local -f docker/gateway/Dockerfile .
docker build -t trackone/core:local -f docker/core/Dockerfile .
docker build -t trackone/constants:local -f docker/constants/Dockerfile .
docker build -t trackone/pod-fw:local -f docker/pod-fw/Dockerfile .
helm upgrade --install trackone deploy/helm/trackone \
-f deploy/helm/trackone/values-local.yaml
For detailed chart configuration and deployment options, see deploy/helm/trackone/README.md.
How it works (pipeline)
End-to-end (see scripts/gateway/run_pipeline.sh):
- Pod simulator emits framed telemetry (
pod_sim.py --framed). - Gateway verifies frames, enforces replay window, emits canonical facts (
frame_verifier.py). - Gateway derives a read-only SensorThings projection from the verified fact set (
sensorthings_projection.py). - Facts are batched into a daily Merkle tree and persisted with headers (
merkle_batcher.py). - Day blob is anchored with OpenTimestamps (
ots_anchor.py). - Independent verification recomputes the Merkle root and checks the OTS proof (
verify_cli.py).
Outputs live under out/site_demo/ by default:
facts/— authoritative CBOR facts plus JSON projectionsblocks/— block headers that record the authoritative daily Merkle rootday/YYYY-MM-DD.cbor— the day blob, with*.otsproofprovisioning/records.json— canonical provisioning-record bundle used for projection contextsensorthings/YYYY-MM-DD.observations.json— read-only SensorThings-style projection artifact
Machine-readable contract split:
- JSON projection and operational artifact contracts live under
toolset/unified/schemas/as JSON Schema. - The authoritative CBOR commitment family is described separately in
toolset/unified/cddl/commitment-artifacts-v1.cddl.
Alpha.9 boundary
0.1.0-alpha.9 is the current release.
-
Done in
alpha.9:- Workspace and internal crates bumped to alpha.9
- Python package version aligned to
0.1.0a9 - Helm chart deployment defaults and image tags aligned to alpha.9
- The CBOR-authoritative commitment family now has a checked-in CDDL contract plus a parser-backed Rust gate
- Unified JSON Schema contracts now share common definitions and centralized cross-file
$refvalidation
-
Carried over from
alpha.8:- Read-only SensorThings projection remains outside the trust root
- Projection requires provisioning-backed sensor identity instead of projection-time fallback
- Demo pipeline emits a canonical
provisioning/records.jsonartifact for projection input
-
Partial in
alpha.9:- Live Python gateway uses canonical top-level fact emission
- Provisioning records are materialized from current device-table/deployment metadata
- Pipeline manifests exist, but ADR-041/043 Phase B fields (
disclosure_class,commitment_profile_id,checks_executed) are not yet a locked emitted contract verify_cli.pyis less sensitive to optional peer-verification imports, but demo/frame-ingest path still expectsPyNaCl
-
Deferred past
alpha.9:- End-to-end
trackone-core::Fact/EnvFactconvergence in the live gateway path - Formal provisioning/deployment identity contract enforced before projection time
- Phase B disclosure manifest emission and verification
- Locked SensorThings projection artifact schema plus broader ADR parity tests
- End-to-end
Documentation
adr/— architecture decisions and protocol boundariesdocs/— supporting docs and operational notes- Per-crate
README.mdfiles undercrates/— crate-local purpose and usage CHANGELOG.md— workspace-level release notes
Configuration knobs
Most demo defaults are set in scripts/gateway/run_pipeline.sh and the Makefile:
SITE(default:an-001)DATE(default:2025-10-07)DEVICE(default:pod-003)COUNT(default:10) — frames to emitOUT_DIR(default:out/site_demo)
You can also pass CLI flags to individual scripts (see --help on each):
frame_verifier.pysupports--window,--device-table, etc.merkle_batcher.pysupports--facts,--out,--site,--date,--validate-schemas.verify_cli.pysupports--rootand--facts.
OpenTimestamps configuration
The gateway uses OpenTimestamps (OTS) to anchor daily Merkle roots. There are three environment variables that control how the OTS client behaves:
-
OTS_STATIONARY_STUB-
When set to
1,scripts/gateway/ots_anchor.pydoes not call the realotsbinary. Instead it writes a deterministic stub proof (STATIONARY-OTS:<sha256(day.cbor)>) and anots_metasidecar. This mode is used by the test suite to avoid slow or flaky network calls. -
Default in tests (via
tests/conftest.py):OTS_STATIONARY_STUB=1. -
To exercise the real OTS client, unset or override this variable:
OTS_STATIONARY_STUB=0 pytest -m real_ots
-
-
OTS_CALENDARS-
Optional comma-separated list of calendar URLs that is forwarded to the underlying
otsclient via theOTS_CALENDARSenvironment variable. -
Example (local real calendar first, then public):
export OTS_CALENDARS="http://127.0.0.1:8468,https://a.pool.opentimestamps.org" python scripts/gateway/ots_anchor.py out/site_demo/day/2025-10-07.cbor
-
-
RUN_REAL_OTS-
Used by a small set of integration tests (marked
real_ots) to control whether they should exercise the realotsclient. -
These tests are skipped by default. To run them (for example against a locally running OTS calendar), use:
export OTS_STATIONARY_STUB=0 export OTS_CALENDARS="http://127.0.0.1:8468" export RUN_REAL_OTS=1 pytest -m real_ots tests/integration/test_ots_integration.py
-
In day-to-day development and CI, you do not need to configure anything: tests run in stationary stub mode and still enforce the ots_meta + artifact hashing contract without talking to external calendaring services.
Testing
We use pytest and tox:
# Fast local run
pytest -q
# Multi-env via tox (3.12, 3.13, 3.14)
tox -e py312,py313,py314
# Coverage reports
tox -e coverage
# Lint and type-check
tox -e lint
tox -e type
# End-to-end tests
tox -e e2e
Real OTS integration tests require RUN_REAL_OTS=1 and an ots binary in PATH:
RUN_REAL_OTS=1 tox -e slow
Makefile shortcuts
Useful targets (run make help for the full list):
make install— install runtime dependenciesmake dev-setup— install dev dependencies (lint, typing, tests, security)make export-requirements— export pinnedout/requirements*.txtfromuv.lockmake run— run the end-to-end pipeline via toxmake test— run the test suitemake tox-readme— format/validate README and ADR indexmake tox-security— Bandit and pip-auditmake bench— run pytest-benchmark suite
Security notes
- Cryptographic randomness and nonce policy are documented in ADR-018; we standardize on OS-backed CSPRNGs.
- AEAD is XChaCha20-Poly1305 with a 24-byte nonce (salt||fc||rand) per ADR-002.
- OTS verification uses a validated full path to
otsand avoids shells; tests include placeholder paths and mocks. - For production use, run security scans and audits:
tox -e security
Project status
TrackOne is currently in an alpha phase.
That means:
- APIs and release boundaries may still tighten
- Crate surfaces are stabilizing, but not yet final
- Deployment and verification workflows are actively being refined
- Changelogs and ADRs should be treated as the source of truth for current release behavior
Contributing
Contributions are welcome! Please read CONTRIBUTING.md, file or reference ADRs for significant changes, and keep tests green. We follow a forward-only schema policy (ADR-006) and document major decisions as ADRs.
Schema notes:
- JSON artifact contracts live under
toolset/unified/schemas/. - Shared reusable JSON Schema definitions live in
toolset/unified/schemas/common.schema.json. - Runtime schema loading and cross-file
$refresolution are centralized inscripts/gateway/schema_validation.py. - New schema work should use JSON Schema draft 2020-12 and prefer
$defs/$refreuse over copy-pasted inline fragments.
License
MIT — see LICENSE.
Links
- Repository: https://github.com/bilalobe/trackone
- ADR index:
adr/README.md - Changelog:
CHANGELOG.md
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file trackone-0.1.0a9-cp312-abi3-manylinux_2_39_x86_64.whl.
File metadata
- Download URL: trackone-0.1.0a9-cp312-abi3-manylinux_2_39_x86_64.whl
- Upload date:
- Size: 298.6 kB
- Tags: CPython 3.12+, manylinux: glibc 2.39+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fa2d21d90e859bdc0721114269e04840b26cf64bb5db7f08733b1d728470349b
|
|
| MD5 |
18d62ca06df50772f6c1e90f398e51aa
|
|
| BLAKE2b-256 |
cfdac884a74cea0b811062429a95f420b5e0660232ca43ba7504c5a7dac549b9
|
Provenance
The following attestation bundles were made for trackone-0.1.0a9-cp312-abi3-manylinux_2_39_x86_64.whl:
Publisher:
release.yml on bilalobe/trackone
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
trackone-0.1.0a9-cp312-abi3-manylinux_2_39_x86_64.whl -
Subject digest:
fa2d21d90e859bdc0721114269e04840b26cf64bb5db7f08733b1d728470349b - Sigstore transparency entry: 1093031674
- Sigstore integration time:
-
Permalink:
bilalobe/trackone@c897adfda1881c6d66d585222847c70f6db44deb -
Branch / Tag:
refs/tags/v0.1.0-alpha.9 - Owner: https://github.com/bilalobe
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@c897adfda1881c6d66d585222847c70f6db44deb -
Trigger Event:
push
-
Statement type: