Merge pull request #421 from hummingbot/release-notes-2.2.0

release notes 2.2.0

README.md

@@ -6,34 +6,30 @@ Welcome to the official website and documentation for Hummingbot and the Humming
 
 This documentation site uses [MkDocs](https://www.mkdocs.org/) documentation-focused static site engine, along with [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme, of which Hummingbot is a proud sponsor.
 
-The deployed site at https://hummingbot.org uses the [Insiders build](https://squidfunk.github.io/mkdocs-material/insiders/) of MkDocs-Material, which features experimental features like tags and social cards. For site editors, please request access to the CoinAlpha fork of the Insiders repo, so that you can deploy the site in your local development environment and Netlify.
+The deployed site at https://hummingbot.org uses the [Insiders build](https://squidfunk.github.io/mkdocs-material/insiders/) of MkDocs-Material, which features experimental features like tags and social cards. 
 
-Create new `hummingbot-site` conda environment:
 ```
-conda create -n hummingbot-site
+  - pip:
+    - git+ssh://[email protected]/hummingbot/mkdocs-material-insiders
 ```
 
-Activate new environment:
-```
-conda activate hummingbot-site
+Create and activate new `hummingbot-site` conda environment using the environment file:
+```bash
+conda env create -f environment.yml
 ```
 
-Install `pip`:
+For core site editors, please request access to the Insiders repo, so that you can deploy the site in your local development environment. You also comment out the following lines in `environment.yml`:
 
 ```
-conda install pip
+  - pip:
+    - git+ssh://[email protected]/hummingbot/mkdocs-material-insiders
 ```
 
-Install dependencies:
+Activate the environment:
 ```bash
-pip install git+ssh://[email protected]/hummingbot/mkdocs-material-insiders  # fetch via SSH
-# pip install git+https://github.com/hummingbot/mkdocs-material-insiders.git  # fetch via SSH
-pip install mkdocs-git-revision-date-plugin mkdocs-charts-plugin mkdocs-table-reader-plugin
-pip install pillow cairosvg
+conda activate hummingbot-site
 ```
 
-## Running local site
-
 Run site locally at http://localhost:8000:
 ```bash
 mkdocs serve

docs/blog/posts/quickstart-dashboard/index.md

@@ -9,7 +9,7 @@ categories:
 
 # Hummingbot Dashboard Quickstart Guide
 
-In this tutorial, we'll guide you through installing Hummingbot 2.0, which provide an easy-to-use Dashboard app that helps you connect exchange credentials, create/backtest a strategy configuration, and deploy a fleet of bots!
+In this tutorial, we'll guide you through installing Hummingbot 2.0, which provides an easy-to-use Dashboard app that helps you connect exchange credentials, create/backtest a strategy configuration, and deploy a fleet of bots!
 
 Watch this video for an overview and walkthrough of the features in Hummingbot 2.0:
 
@@ -89,7 +89,7 @@ Once API keys are added, you can view the tokens available and their allocation
 
 [![](./portfolio-1.png)](./portfolio-1.png)
 
-The table above shows the list of available tokens for the `Kucoin` exchange. The graphs below will show your `Portfoliio Evolution over Time` as well as `Token Value Evolution over time`
+The table above shows the list of available tokens for the `Kucoin` exchange. The graphs below will show your `Portfolio Evolution over Time` as well as `Token Value Evolution over time`
 
 [![](./portfolio-2.png)](./portfolio-2.png)
 
@@ -121,7 +121,7 @@ We can also set the `Total amount of quote` which is how much we want to trade w
 
 [![](./config-3.png)](./config-3.png)
 
-Under `Executors Configuration`, we can set the the spread and amount for both buy and sell orders manually or we can choose from the following distributions:
+Under `Executors Configuration`, we can set the spread and amount for both buy and sell orders manually or we can choose from the following distributions:
 
 - GeoCustom
 - Geometric
@@ -258,4 +258,4 @@ The dashboard uses `admin` and `abc` as the default username and password respec
 
 ### Known Issues
 
-- Refreshing the browser window may log you out and display the login screen again. This is a known issue that might be addressed in future updates.
+- Refreshing the browser window may log you out and display the login screen again. This is a known issue that might be addressed in future updates.

docs/chains/osmosis-chain.md

@@ -1,6 +1,6 @@
 # `osmosis`
 
-`osmosis` is a [Chain](/chains) connector in Hummingbot Gateway that helps users connect to Osmoisis DEX on the Osmosis Blockchain.
+`osmosis` is a [Chain](/chains) connector in Hummingbot Gateway that helps users connect to Osmosis DEX on the Osmosis Blockchain.
 
 ## 📁 Connector Info
 

docs/chains/solana.md

@@ -0,0 +1,18 @@
+## 📁 Connector Info
+
+* Folder: [/gateway/src/chains/solana](https://github.com/hummingbot/gateway/tree/development/src/chains/solana)
+* Configs: [/gateway/src/templates/solana.yml](https://github.com/hummingbot/gateway/tree/development/src/templates/solana.yml)
+
+## ℹ️ Chain Info
+
+* Website: <https://solana.com/>
+* Block Explorer: <https://solscan.io/>
+* CoinMarketCap: <https://coinmarketcap.com/currencies/solana/>
+* CoinGecko: <https://www.coingecko.com/en/coins/solana>
+
+## 🕸️ Supported Networks
+
+| Network | Type |
+|---------|---------|
+| `mainnet-beta` | mainnet |
+| `devnet` | testnet |

docs/dashboard/index.md

@@ -14,7 +14,7 @@ Not only does Dashboard simplify the process of managing bots at scale, but it a
 
 ## Getting Started
 
-To get started, check out the [Hummingbot Dashboard Quickstart](docs/hummingbot-site/docs/academy/posts/quickstart-dashboard/index.md) guide, or the links below with a short explanation of each page (also in the sidebar).
+To get started, check out the [Hummingbot Dashboard Quickstart](../blog/posts/quickstart-dashboard/index.md) guide, or the links below with a short explanation of each page (also in the sidebar).
 
 - [Adding Credentials:](credentials.md)
 

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. 

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)
+```
+
+