31 lines
1.4 KiB
Markdown
31 lines
1.4 KiB
Markdown
Repository Agent Guide — BlockEnergy Mesh (idea85-blockenergy-mesh-verifiable)
|
|
=============================================================
|
|
|
|
Purpose
|
|
- This repository holds a protocol skeleton and a focused Phase-0 implementation for the BlockEnergy Mesh idea. Agents must preserve the registry, primitives, adapters, and the toy proof mechanism. Future agents will extend with solvers, ZK proofs, and ledger integrations.
|
|
|
|
Tech stack
|
|
- Python 3.8+
|
|
- pydantic for canonical models and schema validation
|
|
- cryptography for signature-based attestations
|
|
- numpy for small numerical helpers
|
|
- pytest for tests
|
|
|
|
Key paths
|
|
- src/idea85_blockenergy_mesh_verifiable/: package root
|
|
- primitives.py: LocalProblem, SharedVariables, PlanDelta, AuditLog
|
|
- registry.py: GraphOfContracts (in-memory registry)
|
|
- adapters.py: sample adapters and adapter base class
|
|
- proofs.py: toy proof generation and verification
|
|
|
|
Testing
|
|
- Run `bash test.sh`. The script executes `pytest` and `python3 -m build` to validate packaging.
|
|
|
|
Git / CI notes for agents
|
|
- Do not run git commands from the agent unless the user explicitly requests commits or pushes.
|
|
- When extending interfaces or changing persisted schema, update registry tests and include a migration plan.
|
|
|
|
Contribution rules
|
|
- Keep changes minimal and focused. Follow the repo's dataclass/pydantic patterns.
|
|
- Add unit tests for any new behavior. Ensure `pytest` remains green.
|