edgeoptionx-edge-first-late.../AGENTS.md

1.5 KiB

EdgeOptionX Agents Guide

This repository contains a pragmatic MVP scaffold for EdgeOptionX: an edge-first latency-aware options hedging studio.

What this repo provides:

  • A lightweight Python-based core for local hedging problems (HedgeObject, LocalProblem, SharedVariables, PlanDelta, AuditLog).
  • A minimal delta-sync ledger with tamper-evident logging for governance/audit trails.
  • Starter adapters for broker/data feed integration (two adapters as MVP).
  • A tiny DSL parser to express hedging tasks in a friendly syntax.
  • A provisional testing/packaging setup to verify production readiness.

How to use:

  • Implement and wire adapters for your venues; the MVP focuses on local problem declaration and a basic solver skeleton.
  • Run tests and build using the provided test.sh script (see below).

Development workflow:

  • Write/adjust DSL or core primitives, implement adapters, and ensure the delta-sync ledger can replay confidently.
  • Validate with unit tests; extend tests for new hedging objectives.
  • Ensure packaging metadata remains consistent (pyproject.toml).

Testing and packaging commands:

  • Run tests: ./test.sh
  • Build distribution: python3 -m build
  • Check linting and type hints as needed (not enforced in this MVP).

Contributing:

  • Open a PR with a clear description of the feature or bug fix.
  • Add/adjust tests to reflect new behavior.
  • Update AGENTS.md if workflow or architecture changes are made.

Note: This is a production-oriented scaffold. As the project evolves, components may be refined or split into more granular packages.