@barfinex/plugin-driver
v1.0.5
Published
Plugin Driver module for the Barfinex ecosystem. Handles plugin discovery, registration, lifecycle management, and integration with detectors and services in a NestJS environment.
Maintainers
Readme
@barfinex/plugin-driver
Plugin runtime for the Barfinex ecosystem — discover, register, and run plugins inside Detector (and other services) with a clear lifecycle and execution context.
Plugins extend detection strategies, analytics, and trade logic without changing core code. This library provides the driver that loads plugins, passes context (config, market data, signals), and hooks into NestJS.
What it does
- Plugin registration — register plugin modules and their capabilities.
- Lifecycle — init, start, stop, and event hooks so plugins integrate with Detector lifecycle.
- Execution context — pass config, candles, account state, and signals into plugin code.
- Extensibility — used by detector plugins such as
@barfinex/detector-plugin-orderflow-trade-analyticsand@barfinex/detector-plugin-trade-journal.
Installation
npm install @barfinex/plugin-driverWhat's included
| Export | Purpose |
|--------|--------|
| PluginDriverModule | NestJS module for plugin discovery and DI. |
| PluginDriverService | Register plugins, run lifecycle, provide execution context. |
Documentation
- Detector (plugin host) — Installation detector — detector config and plugin list.
- Barfinex overview — First Steps, Architecture, Glossary.
- Building & APIs — Building with the API, Detector API reference, Typical problems and solutions.
Contributing
New plugin ideas and driver improvements 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. See LICENSE and the Barfinex site for details.
