76 lines
3.4 KiB
Markdown
76 lines
3.4 KiB
Markdown
## Functional Requirements:
|
|
|
|
### Strategy Configuration:
|
|
Users can create trading strategies via a web interface.
|
|
Strategies consist of conditions and associated actions.
|
|
Condition Configuration:
|
|
|
|
Conditions are triggered based on price movements of specified trading pairs.
|
|
Users define target price levels and directions (up to down or down to up) for each condition.
|
|
Conditions can enable/disable each other.
|
|
|
|
### Action Configuration:
|
|
Actions are executed when conditions are met.
|
|
Users specify actions such as placing market orders, enabling/disabling conditions, and closing positions.
|
|
Users can specify the exchange where orders will be placed (e.g., Bybit).
|
|
|
|
### Sequence Management:
|
|
Define a sequence of conditions and actions to execute a complete trading strategy.
|
|
Actions can be triggered based on condition outcomes.
|
|
|
|
### Stop-Loss and Take-Profit:
|
|
Specify stop-loss and take-profit percentages for risk management.
|
|
Stop-loss triggered upon reaching a specified percentage loss.
|
|
Take-profit triggers position closure upon reaching a specified price level.
|
|
|
|
### API Key Management:
|
|
Users can input and update their Bybit API keys from the web interface.
|
|
Notifications prompt users to update API keys close to expiration.
|
|
|
|
### Real-time Monitoring and Recovery:
|
|
Real-time monitoring system tracks the status of running strategies.
|
|
Strategies automatically recover and replay missed changes after a temporary connection loss.
|
|
Logs record missed events during connection loss for troubleshooting.
|
|
|
|
### Web Interface:
|
|
Intuitive web interface for strategy configuration and management.
|
|
Users can view a list of all strategies and their performance metrics.
|
|
Secure transmission of sensitive information (e.g., API keys) over the network.
|
|
|
|
### Strategy Blueprint Creation:
|
|
Users can save trading strategies as blueprints for future use.
|
|
Blueprints store the configuration of conditions, actions, and sequence of a strategy.
|
|
|
|
### Blueprint Instances:
|
|
Users can create instances of saved blueprints for different trading pairs or price limits.
|
|
Instances inherit the configuration of the blueprint and can be customized as needed.
|
|
|
|
### Blueprint Management:
|
|
Users can view, edit, and delete saved strategy blueprints from the web interface.
|
|
Blueprints are organized for easy access and retrieval.
|
|
|
|
## Non-Functional Requirements:
|
|
|
|
### Reliability:
|
|
The software ensures uninterrupted operation even in the event of temporary connection loss.
|
|
Reliable execution of trading strategies based on specified conditions and actions.
|
|
|
|
### Security:
|
|
API keys are securely stored and transmitted using encryption techniques.
|
|
Access to sensitive information (e.g., API keys) is restricted to authorized users.
|
|
|
|
### Scalability:
|
|
The software is designed to accommodate future enhancements and scaling as the user base grows.
|
|
Performance remains consistent with an increasing number of concurrent users and strategies.
|
|
|
|
### Usability:
|
|
The web interface is user-friendly, allowing for easy strategy creation, configuration, and management.
|
|
Clear and intuitive navigation for users of varying levels of expertise.
|
|
|
|
### Compatibility:
|
|
Compatibility with the Bybit exchange API for seamless order execution.
|
|
The software supports popular web browsers for optimal accessibility.
|
|
|
|
### Maintainability:
|
|
The software is modular and well-documented, facilitating ease of maintenance and updates.
|
|
Codebase adheres to best practices and coding standards for maintainability. |