Hummingbot + Hydration Quickstart

This repository provides scripts to quickly set up Hummingbot for market-making using Hydration (HDX).

While fully functional, this repository serves as a product preview until the Hummingbot Foundation officially merges the code. In the meantime, the setup process demonstrated here remains compatible with the latest Hummingbot versions by updating the docker-compose.yml file as needed.

We strongly encourage you to review all the provided scripts and configuration files to understand how the setup scripts, Docker Compose, and Python scripts function and interact.

Instructions

Prerequisites

• Docker or Docker Desktop
• Unix-like operating system (Linux, macOS) or WSL (Windows)

Create and configure the Hummingbot Client

git clone https://github.com/robotter-ai/hydration.git
cd hydration

./setup

After executing the commands above, follow the instructions provided to configure your Hummingbot Client and Gateway. You will be prompted to set separate passwords for the Hummingbot Client and the Gateway certificates.

The setup script performs the following steps:

• Pulls Docker images from Docker Hub (this may take time initially but will occur only once).
• Creates a shared volume folder with three subfolders (client, gateway, and common), which contain certificates, strategy scripts, log files, encrypted wallet files, etc.
• Prompts for the Hummingbot Client password and configures it automatically using a Python script. (This simplifies the Gateway configuration. If preferred, you can configure this manually by running ./setup hummingbot).
• Prompts for the Hummingbot Gateway certificates passphrase and configures the GATEWAY_PASSPHRASE automatically with a Python script. (You may configure this manually by running ./setup gateway).
• Restarts the containers and attaches to the Hummingbot Client. After entering your password, you should see confirmation that the Gateway is online and operational.

Running Strategies

Once the configuration is complete, you can run your preferred trading strategies. Please refer to the official Hummingbot documentation for detailed guidance on strategy setup and usage.

Note: Hydration is an AMM (Automated Market Maker) connector, so only strategies compatible with AMMs can be used.

• Hummingbot Documentation
• Hummingbot v1 Strategies
• Hummingbot Strategies

Recommended strategies and scripts include:

• scripts/amm_portfolio_manager.py: A highly customizable strategy developed by us, providing numerous features to build upon.
• amm_arb: Hummingbot v1 arbitrage strategy for arbitraging between different connectors.
• scripts/amm_price_example.py: Demonstrates retrieving prices from an AMM connector.
• scripts/amm_trade_example.py: Demonstrates placing trades via an AMM connector.
• scripts/amm_data_feed.py: Fetches data from an AMM connector.

Other strategies and enhancements are currently under development by the Hummingbot Foundation, with further exciting AMM-compatible strategies expected soon.