robotproof-studio-verifiabl.../AGENTS.md

1.7 KiB

RobotProof Studio Agents

Overview

  • This repository contains a minimal production-oriented MVP for a contract-driven multi-robot coordination platform.
  • It introduces four canonical GoC primitives: LocalProblem, SharedSignals, PlanDelta, DualVariables.
  • Starter adapters bridge to ROS2 navigation and Gazebo simulation for end-to-end demonstration.

Architecture

  • Core primitives:
    • LocalProblem: per-robot planning task with constraints (energy, timing).
    • SharedSignals: versioned signals carrying summaries and priors.
    • PlanDelta: incremental decisions with cryptographic-like tags.
    • DualVariables: coupling constraints (e.g., energy, time).
  • Coordinator:
    • Lightweight ADMM-like solver coordinating LocalProblems through SharedSignals and PlanDelta with DualVariables.
  • Adapters:
    • ROS2NavigatorAdapter: binds to ROS2 topics for navigation goals and telemetry.
    • GazeboSimulatorAdapter: binds to Gazebo-based environment for simulation of robots.
  • Registry:
    • GraphOfContractsRegistry: version adapters and data schemas; supports per-message governance metadata.
  • Governance/logging:
    • AuditLog: tamper-evident records for plan deltas and signals.

Developer workflow

  • Run tests with test.sh (pytest + python -m build).
  • Use the tests as the baseline for API compatibility and contract conformance.
  • Extend with additional adapters, keeping the contract primitives stable.

Testing commands

  • pytest: run unit tests.
  • python -m build: verify packaging metadata and build readiness.
  • The test script test.sh orchestrates the above.

Contributing

  • Implement new adapters by following the existing LocalProblem / SharedSignals / PlanDelta contract shape.
  • Ensure tests cover new contracts and adapter conformance.