@barfinex/detector-plugin-trade-journal
v1.0.5
Published
Detector plugin Trade Journal for the Barfinex ecosystem. Provides trade logging, journaling, and lifecycle hooks for managing trading activity inside detectors.
Downloads
402
Maintainers
Readme
@barfinex/detector-plugin-trade-journal
Trade journal plugin for the Barfinex Detector — record and query trades (manual or detector-driven) with metadata, filters, and a persistent store.
Keep a structured log of executions for analysis, compliance, or strategy tuning. The plugin implements detector lifecycle hooks and exposes a CRUD API so Studio or other services can create and query journal entries.
What it does
- Trade CRUD — create, find (with filters), get one, update, remove journal entries via service or controller.
- Detector plugin — implements
PluginHook.onInit/onStartand integrates with@barfinex/plugin-driver; registers with Provider for Studio plugin API. - Metadata — strategy name, symbol, timeframe, side, prices, risk/reward, tags, and timestamps stored in
TradeJournalEntity. - Filtering — query by symbol, strategy, date range, and other fields for reports and dashboards.
Installation
npm install @barfinex/detector-plugin-trade-journalor
yarn add @barfinex/detector-plugin-trade-journalWhat's included
| Export | Purpose |
|--------|--------|
| TradeJournalModule | NestJS module (includes entity and service). |
| TradeJournalService | CRUD and plugin hooks; extends DetectorPluginService. |
| TradeJournalEntity | TypeORM entity for persistent trade records. |
Documentation
- Detector (host for this plugin) — Installation detector — config and plugin list (e.g.
trade-journal). - Barfinex overview — First Steps, Architecture, Glossary.
- APIs — Detector API reference, Provider API reference, Building with the API.
- Troubleshooting — Typical problems and solutions.
Contributing
Ideas for metrics and export features 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.
