tyndale-ai-service/artifacts/exchanges/base_exchange.yaml

66 lines
1.9 KiB
YAML

source_file: exch_live/__init__.py
schema_version: v1.1
factual_summary: >
Defines shared utilities and base behavior for exchange integrations,
including standardized order string formatting and basic exchange
health/state tracking used across concrete exchange implementations.
methods:
- name: order_str
signature: "(inst, order_dict, eOid) -> str"
description: >
Formats a human-readable string representation of an order, including
side, quantity, symbol, price, exchange name, and external order ID.
- name: all_up
signature: "() -> bool"
description: >
Returns whether all tracked exchange subsystems are currently marked
as operational.
- name: set_up
signature: "(kind) -> None"
description: >
Marks a specific exchange subsystem as operational and logs the updated
exchange state, including any remaining subsystems that are not yet up.
interpretive_summary: >
Provides a minimal base abstraction for exchange integrations, centralizing
shared concerns such as operational state tracking and consistent logging.
This base class deliberately avoids order placement or strategy logic,
serving instead as a foundation that concrete exchange implementations
can extend while preserving uniform health semantics and observability.
invariants:
- Exchange operational state is represented consistently via string values
- An exchange is considered fully operational only when all subsystems are up
- Logging reflects partial readiness when subsystems are still initializing
tags:
domain:
- exchange_integration
- monitoring
trading_function:
- order_execution
strategy_layer:
- execution
system_layer:
- engine
intent:
- abstraction
- observability
data_type:
- orders
- configs
risk:
- latency
- data_corruption
maturity:
- production
provenance:
generated_at: 2026-02-02
generated_by: llm_assisted
confidence_score: 0.70