idea93-gridguard-verifiable.../README.md

36 lines
1.2 KiB
Markdown

# GridGuard-Inspired EnergiBridge Skeleton
This repository implements a compact, verifiable telemetry orchestration layer for multi-asset power facilities.
## What it provides
- Canonical contract schemas for `LocalProblem`, `SharedVariables`, `PlanDelta`, `DualVariables`, `AuditLog`, `PrivacyBudget`, and `RegistryMetadata`
- A versioned `ContractRegistry` for Graph-of-Contracts style adapter/schema tracking
- A `VerifiableTelemOrchestrator` that collects adapter telemetry, signs plan deltas, and emits audit and registry metadata
- Two deterministic starter adapters:
- `SolarMeterAdapter`
- `DERAggregatorAdapter`
- Pytest coverage for schema validation, registry versioning, adapter replay behavior, and orchestration output
## Layout
- `energi_bridge/`: core package
- `energi_bridge/adapters/`: starter adapters
- `tests/`: pytest suite
- `test.sh`: installs the package, runs tests, and builds the distribution
## Run
```bash
bash test.sh
```
```bash
python -m build
```
## Notes
- The code is deterministic by default to support replayable tests and audit trails.
- The registry records contract version, adapter identity, schema name, and replay hints for each adapter contract.