release notes 2.2.0

hummingbot · Dec 20, 2024 · 1f20d29 · 1f20d29
1 parent 725a3fd
commit 1f20d29
Show file tree

Hide file tree

Showing 6 changed files with 337 additions and 42 deletions.
diff --git a/docs/exchanges/dexalot.md b/docs/exchanges/dexalot.md
@@ -5,79 +5,65 @@
 
 | Component | Status | Notes | 
 | --------- | ------ | ----- |
-| [🔀 Spot Connector](#spot-connector) | ✅ |
+| [🔀 Spot Connector](#spot-connector) | ✅ | Supports testnet
 | [🔀 Perp Connector](#perp-connector) | Not available
-| [🕯 AMM Data Feed](#amm-data-feed) | ✅ |
-| [📓 Connector Guide](/academy-content/using-dexalot-with-hummingbot/) | ✅ |
+|| [🕯 Spot Candles Feed](#spot-candles-feed) | Not available | 
+| [🕯 Perp Candles Feed](#perp-candles-feed) | Not available | 
+| [📓 Connector Guide](../blog/posts/using-dexalot-with-hummingbot/index.md) | ✅ |
 
 ## ℹ️ Exchange Info
 
 - **Website**: <https://dexalot.com>
 - **CoinMarketCap**: <https://coinmarketcap.com/exchanges/dexalot/>
 - **CoinGecko**: <https://www.coingecko.com/en/exchanges/dexalot>
-- **API Docs**: <https://docs.dexalot.com/>
+- **API Docs**: <https://docs.dexalot.com/en/apiv2/>
 - **Fees**: 
 
 ## 🔑 How to Connect
 
 !!! tip
-    See the [Dexalot Connector Guide](/academy-content/using-dexalot-with-hummingbot/) for step-by-step instructions.
+    See the [Dexalot Connector Guide](../blog/posts/using-dexalot-with-hummingbot/index.md) for step-by-step instructions.
 
 Create a wallet on one of the supported networks below:
 
 | Chain | Networks | 
 | ----- | -------- |
 | `avalanche` | `dexalot`
 
-From inside the Hummingbot client, run `gateway connect dexalot` in order to connect your wallet:
+From inside the Hummingbot client, run `connect dexalot` in order to connect your wallet:
 
 ```
-Which chain do you want dexalot to connect to? (avalanche) >>>
-Which network do you want dexalot to connect to? (dexalot)
-Enter your dexalot-avalanche-dexalot wallet private key >>>
+Enter your Dexalot private key >>>
+Enter your Dexalot wallet address >>>
 
-Enter your Dexalot API Key (you can request one from the Dexalot team) >>> 
 ```
 
 If connection is successful:
 
 ```
-The dexalot connector now uses wallet [pubKey] on avalanche-dexalot
+You are now connected to Dexalot!
 ```
 
 
 ## 🔀 Spot Connector
 *Integration to spot markets API endpoints*
 
 - **ID**: `dexalot`
-- **Connection Type**: REST via [Gateway](/gateway)
-- **API Docs**: <https://docs.dexalot-test.com/api>
-- **Folder**: <https://github.com/hummingbot/gateway/tree/main/src/connectors/dexalot>
-- **Default Configs**: <https://github.com/hummingbot/gateway/blob/main/src/templates/dexalot.yml>
+- **Connection Type**: Websocket
+- **API Docs**: <https://docs.dexalot.com/en/apiv2/>
+- **Folder**: <https://github.com/hummingbot/hummingbot/tree/master/hummingbot/connector/exchange/dexalot>
 
-### Endpoints
 
-- `/clob/orders`
-- `/clob/batchOrders`
-- `/chain/balances`
-- `/chain/poll`
+### Order Types
 
-For more info, run Gateway and go to <https:localhost:8080> in your browser to see detailed documentation for each endpoint.
+This connector supports the following `OrderType` constants:
 
-## 🕯 AMM Data Feed
-*Data feed of this exchange's real-time prices*
+- `LIMIT`
+- `LIMIT_MAKER`
+- `MARKET`
 
-- **ID**: `dexalot_[CHAIN]_[NETWORK]`
-- **Connection Type**: REST via [Gateway](/gateway)
-- **Folder**: <https://github.com/hummingbot/hummingbot/blob/master/hummingbot/data_feed/amm_gateway_data_feed.py>
+### Paper Trading
 
-### Usage
+This perp exchange offers a paper trading mode: 
 
-```python
-from hummingbot.data_feed.amm_gateway_data_feed import AmmGatewayDataFeed
-prices = AmmGatewayDataFeed(
-        connector_chain_network="dexalot_avalanche_dexalot",
-        trading_pairs={"WAVAX-USDC", "ALOT-USDC"},
-        order_amount_in_base=Decimal("1"),
-    )
-```
+Afer you create an account and create the API keys, you can enter them by using the `connect dexalot_testnet` command within the Hummingbot client. Once connected, you should be able to use the testnet with the available spot strategies / scripts. 
diff --git a/docs/exchanges/hyperliquid.md b/docs/exchanges/hyperliquid.md
@@ -5,11 +5,11 @@
 
 | Component | Status | Notes | 
 | --------- | ------ | ----- |
-| [🔀 Spot Connector](#spot-connector) | Not available |
+| [🔀 Spot Connector](#spot-connector) | ✅ |
 | [🔀 Perp Connector](#perp-connector) | ✅ | Supports testnet
-| [🕯 Spot Candles Feed](#spot-candles-feed) | Not available | 
-| [🕯 Perp Candles Feed](#perp-candles-feed) | Not available | 
-| [📓 Connector Guide](/academy-content/using-hyperliquid-vaults-with-hummingbot/) | ✅ |
+| [🕯 Spot Candles Feed](#spot-candles-feed) | ✅ | 
+| [🕯 Perp Candles Feed](#perp-candles-feed) | ✅ | 
+| [📓 Connector Guide](../blog/posts/using-hyperliquid-vaults-with-hummingbot/index.md) | ✅ |
 
 ## ℹ️ Exchange Info
 
@@ -23,11 +23,11 @@
 ## 🔑 How to Connect
 
 !!! tip
-    See the [Hyperliquid Vault Guide](/academy-content/using-hyperliquid-vaults-with-hummingbot/) for more details on how to use Hyperliquid VauLts.
+    See the [Hyperliquid Vault Guide](../blog/posts/using-hyperliquid-vaults-with-hummingbot/index.md) for more details on how to use Hyperliquid VauLts.
 
 ### Add Keys to Hummingbot
 
-From inside the Hummingbot client, run `connect hyperliquid_perpetual` in Hummingbot in order to connect your wallet:
+From inside the Hummingbot client, run `connect hyperliquid` in Hummingbot in order to connect your wallet:
 
 ```
 Enter your Arbitrum wallet address >>>
@@ -37,9 +37,26 @@ Enter your Arbitrum wallet private key >>>
 If connection is successful:
 
 ```
-You are now connected to hyperliquid_perpetual.
+You are now connected to hyperliquid.
 ```
 
+## 🔀 Spot Connector
+*Integration to spot markets API endpoints*
+
+- **ID**: `hyperliquid`
+- **Connection Type**: WebSocket
+- **API Docs**: <https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api>
+- **[Github Folder](https://github.com/hummingbot/hummingbot/tree/master/hummingbot/connector/exchange/hyperliquid)** 
+
+### Order Types
+
+This connector supports the following `OrderType` constants:
+
+- `LIMIT`
+- `LIMIT_MAKER`
+- `MARKET`
+
+
 
 ## 🔀 Perp Connector
 *Integration to perpetual futures markets API endpoints*
@@ -48,6 +65,27 @@ You are now connected to hyperliquid_perpetual.
 - **Connection Type**: WebSocket
 - **Folder**: <https://github.com/hummingbot/hummingbot/tree/master/hummingbot/connector/derivative/hyperliquid_perpetual>
 
+
+### Usage
+
+From inside the Hummingbot client, run `connect hyperliquid_perpetual`:
+
+```
+>>> connect hyperliquid_perpetual
+
+```
+
+```
+Enter your Arbitrum wallet address >>>
+Enter your Arbitrum wallet private key >>>
+```
+
+If connection is successful:
+
+```
+You are now connected to hyperliquid_perpetual
+```
+
 ### Order Types
 
 This connector supports the following `OrderType` constants:
@@ -68,3 +106,40 @@ This perp exchange offers a paper trading mode: <https://app.hyperliquid-testnet
 
 Afer you create an account and create the API keys, you can enter them by using the `connect hyperliquid_perpetual_testnet` command within the Hummingbot client. Once connected, you should be able to use the testnet with the available perpetual strategies / scripts. 
 
+## 🕯 Spot Candles Feed
+*OHLCV candles data collector from spot markets*
+
+- **ID**: `hyperliquid`
+- **Supported Intervals**: 1m | 3m | 5m | 15m | 30m | 1h | 2h | 4h | 6h | 8h | 12h | 1d | 1w | 1M
+- **API Docs**: <https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api>
+- **[Github Folder](https://github.com/hummingbot/hummingbot/tree/master/hummingbot/data_feed/candles_feed/hyperliquid_spot_candles)** 
+
+### Usage
+
+In a Hummingbot script, import `CandlesFactory` to create the candles that you want:
+```python
+    from hummingbot.data_feed.candles_feed.candles_factory import CandlesFactory
+    candles = CandlesFactory.get_candle(connector="hyperliquid",
+                                        trading_pair="ETH-USDT",
+                                        interval="1m", max_records=50)
+```
+
+
+## 🕯 Perp Candles Feed
+*OHLCV candles data collector from perpetual futures markets*
+
+- **ID**: `hyperliquid_perpetual`
+- **Supported Intervals**: 1m | 3m | 5m | 15m | 30m | 1h | 2h | 4h | 6h | 8h | 12h | 1d | 1w | 1M
+- **[Github Folder](https://github.com/hummingbot/hummingbot/tree/master/hummingbot/data_feed/candles_feed/hyperliquid_perpetual_candles)** 
+
+### Usage
+
+In a Hummingbot script, import `CandlesFactory` to create the candles that you want:
+```python
+    from hummingbot.data_feed.candles_feed.candles_factory import CandlesFactory
+    candles = CandlesFactory.get_candle(connector="hyperliquid_perpetual",
+                                        trading_pair=trading_pair,
+                                        interval="3m", max_records=50)
+```
+
+
diff --git a/docs/release-notes/2.2.0.md b/docs/release-notes/2.2.0.md
@@ -0,0 +1,119 @@
+# Hummingbot v2.2.0 Release Notes
+
+*Released on December 23, 2024*
+
+## Introduction
+
+
+| Repository | Description | GitHub Release | DockerHub Release |
+|------------|-------------|----------------|-------------------|
+| [Hummingbot](https://github.com/hummingbot/hummingbot) | Core Client | [`v2.2.0`](https://github.com/hummingbot/hummingbot/releases/tag/v2.2.0) | [`version-2.2.0`](https://hub.docker.com/r/hummingbot/hummingbot/tags?name=version-2.2.0) |
+| [Dashboard](https://github.com/hummingbot/dashboard) | Hummingbot Frontend  | [`v2.2.0`](https://github.com/hummingbot/dashboard/releases/tag/v2.2.0) | [`version-2.2.0`](https://hub.docker.com/r/hummingbot/dashboard/tags?name=version-2.2.0) |
+| [Backend-API](https://github.com/hummingbot/backend-api) | Hummingbot Backend | [`v2.2.0`](https://github.com/hummingbot/backend-api/releases/tag/v2.2.0) | [`version-2.2.0`](https://hub.docker.com/r/hummingbot/backend-api/tags?name=version-2.2.0) |
+| [Gateway](https://github.com/hummingbot/gateway) | DEX Middleware | [`v2.2.0`](https://github.com/hummingbot/gateway/releases/tag/v2.2.0) | [`version-2.2.0`](https://hub.docker.com/r/hummingbot/gateway/tags?name=version-2.2.0) |
+| [Deploy](https://github.com/hummingbot/deploy) | Deployment Repo |
+
+## How to Update
+
+### Docker
+
+Re-run the [Deploy](https://github.com/hummingbot/deploy) setup script:
+```bash
+git clone https://github.com/hummingbot/deploy.git
+cd deploy
+bash setup.sh
+```
+
+For individual images, exit running containers, pull the latest images, and restart:
+```bash
+docker compose down
+docker pull hummingbot/hummingbot:latest
+docker compose up -d
+```
+
+### Source
+
+Update the branches of each repo to this release by running:
+```bash
+git pull origin master
+```
+
+## Hummingbot 2.2.0 Highlights
+
+
+### New Dashboard Controller - Grid Strike
+
+The **Grid Strike** strategy creates a grid of orders within specified price ranges, offering new tools to enhance strategy setup and execution:  
+
+- Dynamic Price Range Defaults: Auto-adjusts grid ranges using live market data for adaptive trading.  
+
+- Visual Grid Configuration: Displays grid ranges and orders on charts for precise adjustments.  
+
+- Multi-Range Support: Enables up to 5 grid ranges with independent settings and allocations.  
+
+- Advanced Risk Management Tools: Adds bounds, time limits, and minimum spreads for controlled trading.  
+
+[Hummingbot #7285](https://github.com/hummingbot/hummingbot/pull/7285) | [Backend-API #46](https://github.com/hummingbot/backend-api/pull/46) | [Dashboard #190](https://github.com/hummingbot/dashboard/pull/190).
+
+### New Connectors
+
+- This release now adds support for the `Hyperliquid Spot` market in [Hummingbot #7282](https://github.com/hummingbot/hummingbot/pull/7282). **Thanks to [isreallee82](https://github.com/isreallee82) for this contribution! 🙏**
+
+### New DEX Connectors
+
+- In this release, [Hummingbot #7334](https://github.com/hummingbot/hummingbot/pull/7334) & [Gateway #374](https://github.com/hummingbot/gateway/pull/374), introduces new connectors for the `Solana` blockchain and the `Jupiter` aggregator. These additions enable Hummingbot to interact with the Solana network and utilize Jupiter for token swaps.
+
+### Connector Improvements
+
+- The `dexalot` connector has been upgraded to the latest API version in [#7291](https://github.com/hummingbot/hummingbot/pull/7291). **Thanks to [yancong001](https://github.com/yancong001) for this contribution! 🙏**
+
+- Improved `bybit_perpetual` balance fetching in [#7279](https://github.com/hummingbot/hummingbot/pull/7279). **Thanks to [tomasgaudino](https://github.com/tomasgaudino) for this fix! 🙏**
+
+- Fixed the `binance` websocket reconnection issue in [#7310](https://github.com/hummingbot/hummingbot/pull/7310). **Thanks to [komposter](https://github.com/komposter) for this fix! 🙏**
+
+- The issue with the `hyperliquid` auth exemption for public data has been fixed in [#7328](https://github.com/hummingbot/hummingbot/pull/7328). **Thanks to [isreallee82](https://github.com/isreallee82) for this fix! 🙏**
+
+
+### General Improvements
+
+- Enhanced Backtesting Framework: Improved simulation accuracy and performance [Hummingbot #7307](https://github.com/hummingbot/hummingbot/pull/7307).
+
+- Performance Observability: Backend-API endpoints were added to enable better performance monitoring [Backend-API #36](https://github.com/hummingbot/backend-api/pull/36).
+
+- Candlestick Data Processing: Added improvements that enhanced the processing of candlestick data in [#7276](https://github.com/hummingbot/hummingbot/pull/7276).
+
+- Improved `status` Output: Improved the `status` output for directional scripts in [#7341](https://github.com/hummingbot/hummingbot/pull/7341).
+
+
+## Other Updates by Repository
+
+### Hummingbot
+
+
+- [#7289](https://github.com/hummingbot/hummingbot/pull/7289) - Fixed hard coded symbols in `simple_xemm` script
+- [#7319](https://github.com/hummingbot/hummingbot/pull/7319) - Added gas variables to `AMM arbitrage` strategy 
+
+
+### Gateway
+
+- [#370](https://github.com/hummingbot/gateway/pull/370) - Fixed poll route for `Base`approvals 
+- [#371](https://github.com/hummingbot/gateway/pull/371) - Improved `PancakeSwap` V2 pool fetching 
+
+
+### Backend-API
+
+- [#36](https://github.com/hummingbot/backend-api/pull/36) - Added performance page endpoints **Thanks to [tomasgaudino](https://github.com/tomasgaudino) for this fix! 🙏**
+- [#37](https://github.com/hummingbot/backend-api/pull/37) - Enhanced observability and security 
+- [#47](https://github.com/hummingbot/backend-api/pull/47) - Added manage accounts router **Thanks to [tomasgaudino](https://github.com/tomasgaudino) for this fix! 🙏**
+- [#49](https://github.com/hummingbot/backend-api/pull/49) - Used new backtesting interface 
+
+### Dashboard
+
+- [#184](https://github.com/hummingbot/dashboard/pull/184) - Added Strategy Performance v2 page **Thanks to [tomasgaudino](https://github.com/tomasgaudino) for this fix! 🙏**
+- [#188](https://github.com/hummingbot/dashboard/pull/188) - Added Backend API security and minor fixes 
+- [#215](https://github.com/hummingbot/dashboard/pull/215) - Fixed missing executor handling in Performance page **Thanks to [tomasgaudino](https://github.com/tomasgaudino) for this fix! 🙏**
+
+### Quants-Lab
+
+- [#12](https://github.com/hummingbot/quants-lab/pull/12) - Added security to Backend API
+
diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md
@@ -1,5 +1,14 @@
 We generally release a new version of Hummingbot **every month**. See below for information about each release.
 
+## [2.2.0](./2.2.0/)
+
+*Released December 23, 2024*
+
+**Hummingbot**
+
+* Github: [`v2.2.0`](https://github.com/hummingbot/hummingbot/releases/tag/v2.2.0)
+* DockerHub: [`version-2.2.0`](https://hub.docker.com/r/hummingbot/hummingbot/tags?name=version-2.2.0) 
+
 ## [2.1.0](./2.1.0/)
 
 *Released October 28, 2024*