@@ -5,25 +5,50 @@ This folder contains the main source code for Hummingbot.
5
5
## Project Breakdown
6
6
```
7
7
hummingbot
8
- ├── client # CLI related files
9
- ├── core
10
- │ ├── cpp # high performance data types written in .cpp
11
- │ ├── data_type # key data
12
- │ ├── event # defined events and event-tracking related files
13
- │ └── utils # helper functions and bot plugins
14
- ├── data_feed # price feeds such as CoinCap
15
- ├── logger # handles logging functionality
16
- ├── market # connectors to individual exchanges
17
- │ └── <market_name> # folder for specific exchange ("market")
18
- │ ├── *_market # handles trade execution (buy/sell/cancel)
19
- │ ├── *_data_source # initializes and maintains a websocket connection
20
- │ ├── *_order_book # takes order book data and formats it with a standard API
21
- │ ├── *_order_book_tracker # maintains a copy of the market's real-time order book
22
- │ ├── *_active_order_tracker # for DEXes that require keeping track of
23
- │ └── *_user_stream_tracker # tracker that process data specific to the user running the bot
24
- ├── notifier # connectors to services that sends notifications such as Telegram
25
- ├── strategy # high level strategies that works with every market
26
- ├── templates # templates for config files: general, strategy, and logging
27
- └── wallet # files that read from and submit transactions to blockchains
28
- └── ethereum # files that interact with the ethereum blockchain
8
+ │
9
+ ├── client # CLI related files
10
+ │
11
+ ├── connector # connectors to individual exchanges
12
+ │ ├── derivative # derivative connectors
13
+ │ ├── exchange # spot exchanges
14
+ │ ├── gateway # gateway connectors
15
+ │ ├── other # misc connectors
16
+ │ ├── test_support # utilities and frameworks for testing connectors
17
+ │ └── utilities # helper functions / libraries that support connector functions
18
+ │
19
+ ├── core
20
+ │ ├── api_throttler # api throttling mechanism
21
+ │ ├── cpp # high performance data types written in .cpp
22
+ │ ├── data_type # key data
23
+ │ ├── event # defined events and event-tracking related files
24
+ │ ├── gateway # gateway related components
25
+ │ ├── management # management related functionality such as console and diagnostic tools
26
+ │ ├── mock_api # mock implementation of APIs for testing
27
+ │ ├── rate_oracle # manages exchange rates from different sources
28
+ │ ├── utils # helper functions and bot plugins
29
+ │ └── web_assistant # web related functionalities
30
+ │
31
+ ├── data_feed # price feeds such as CoinCap
32
+ │
33
+ ├── logger # handles logging functionality
34
+ │
35
+ ├── model # data models for managing DB migrations and market data structures
36
+ │
37
+ ├── notifier # connectors to services that sends notifications such as Telegram
38
+ │
39
+ ├── pmm_script # Script Strategies
40
+ │
41
+ ├── remote_iface # remote interface for external services like MQTT
42
+ │
43
+ ├── smart_components # smart components like controllers, executors and frameworks for strategy implementation
44
+ │ ├── controllers # controllers scripts for various trading strategy or algorithm
45
+ │ ├── executors # various executors
46
+ │ ├── strategy_frameworks # base frameworks for strategies including backtesting and base classes
47
+ │ └── utils # utility scripts and modules that support smart components
48
+ │
49
+ ├── strategy # high level strategies that works with every market
50
+ │
51
+ ├── templates # templates for config files: general, strategy, and logging
52
+ │
53
+ └── user # handles user-specific data like balances across exchanges
29
54
```
0 commit comments