@barfinex/detector
v1.0.6
Published
Detector module for the Barfinex ecosystem. Provides plugin lifecycle management, real-time market data processing, trade/order monitoring, and integration with Redis, MongoDB, and external services.
Maintainers
Readme
@barfinex/detector
Event-driven detection layer of the Barfinex ecosystem — the analytics engine that consumes market data from the Provider, runs strategies and plugins, and emits signals for Advisor and Inspector.
Detector is the component that turns raw candles, trades, and orderbook updates into actionable signals and position requests. It runs as a separate service, connects to the event bus (Redis), and can be extended with plugins (e.g. orderflow analytics, trade journal).
What it does
- Real-time processing — subscribes to Provider channels (candles, trades, orderbook, account/orders) and runs detection logic.
- Modular instances — multiple detector configs and strategies; each instance has its own lifecycle and plugins.
- Plugin system — integrates with
@barfinex/plugin-driverand plugins like@barfinex/detector-plugin-orderflow-trade-analyticsand@barfinex/detector-plugin-trade-journal. - Signals & metrics — emits signals to the bus, exposes REST for status and metrics, and works with
@barfinex/ordersand@barfinex/connectors.
Installation
npm install @barfinex/detectoror
yarn add @barfinex/detectorWhat's included
| Export | Purpose |
|--------|--------|
| DetectorModule / DetectorCoreModule | NestJS modules for detector app wiring. |
| DetectorService | Core service: lifecycle, plugins, detection loop. |
| DetectorManagerService | Manages detector instances and config. |
| DetectorPluginService | Plugin registration and execution. |
| DetectorController | REST API for detector operations. |
| DetectorPerformanceMetrics | Performance metrics. |
| Signal types & helpers | From ./signal. |
Documentation
- Detector — Installation detector — Redis channels, config, connecting to Provider, verifying signals.
- Barfinex overview — First Steps, Architecture, Glossary.
- Provider (data source) — Installation provider, Understanding Provider Logs, Provider API reference.
- Studio — Terminal Configuration, Registering Provider in Studio.
- APIs & signals — Detector API reference, Signals context API, Building with the API.
- Troubleshooting — Typical problems and solutions.
Contributing
New detection strategies and plugin ideas are welcome. Open an issue or PR. Community: Telegram · GitHub.
License
Licensed under the Apache License 2.0 with additional terms. Attribution to Barfin Network Limited and a link to https://barfinex.com are required. Commercial use requires explicit permission. See LICENSE and the Barfinex site for details.
