@barfinex/key
v1.0.6
Published
Key management module for the Barfinex ecosystem. Provides initialization, secure storage, and retrieval of unique application identification keys using NestJS services.
Maintainers
Readme
@barfinex/key
API keys and credential management for the Barfinex ecosystem — secure storage and retrieval of exchange/broker API keys used by connectors and Provider.
Centralize key handling so sandbox vs production and multi-connector setups stay consistent and keys are not scattered across config files.
What it does
- Key storage and retrieval — one service for API keys and secrets used by trading connectors.
- Multiple connectors — support for different exchanges and sandbox/production modes.
- NestJS integration —
KeyModuleandKeyServicefor dependency injection and env-based or vault-based config.
Installation
npm install @barfinex/keyWhat's included
| Export | Purpose |
|--------|--------|
| KeyModule | NestJS module for key management. |
| KeyService | Get/store API keys and credentials for connectors. |
Documentation
- Provider (uses keys for exchanges) — Installation provider, Docker Compose for Provider, Understanding Provider Logs.
- Security & setup — Local Certificates Setup, Registering Provider in Studio.
- Barfinex — First Steps, Architecture, Typical problems and solutions.
Contributing
Improvements and security best-practice suggestions welcome. 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.
