Skip to main content

Autonomous trading terminal for Hyperliquid (testnet)

Project description

HyperAgent

PyPI version Python License: MIT

Autonomous Trading Terminal for Hyperliquid (testnet)

HyperAgent is an interactive terminal-based trading agent that watches the market in real-time, detects trading opportunities using multiple strategies, executes trades autonomously, manages risk with trailing stop-losses, and explains every decision with AI — all from a single terminal interface.

You pick a strategy. You hit Start. It trades by itself.

Quick Install (if you already have Python + pipx)

pipx install hyperliquidagent
hyperagent

First run launches a short setup wizard (asks for your main wallet address and an agent-wallet private key — see Safety below), then drops you into the TUI.

Upgrade any time:

pipx upgrade hyperliquidagent

Never used Python before? Jump to Beginner Setup — it walks you through everything from scratch.


Beginner Setup (no Python? no problem)

If you've never run a Python script, installed a CLI tool, or used a terminal before, follow this section from top to bottom. It takes ~10 minutes.

1. Prerequisites

You need three things on your computer:

  1. Python 3.9 or newer — the language HyperAgent is written in
  2. pipx — a tool that installs Python CLI apps cleanly (so they don't clash with anything else)
  3. A terminal — Command Prompt / PowerShell on Windows, Terminal on macOS, any shell on Linux

You also need:

  • A crypto wallet (MetaMask, Rabby, etc.) with a testnet-capable address
  • ~10 minutes and an internet connection

2. Install Python

Windows

  1. Go to python.org/downloads and download the latest Python 3.12+ installer.
  2. Run the installer. Check the box that says "Add python.exe to PATH" at the bottom of the first screen before clicking Install. This is the single most common thing beginners miss.
  3. Open PowerShell (press Win key, type powershell, hit Enter) and verify:
    python --version
    
    You should see Python 3.12.x or similar. If you see "command not found", close PowerShell, reopen it, and try again. If still broken, reinstall Python and double-check the PATH box.

macOS

Easiest path is Homebrew:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install python
python3 --version

Linux

Most distros ship Python 3. Verify with python3 --version. If missing:

# Debian/Ubuntu
sudo apt update && sudo apt install python3 python3-pip python3-venv
# Fedora
sudo dnf install python3 python3-pip

3. Install pipx

pipx installs command-line Python tools into their own sandbox so they don't break each other.

Windows (PowerShell)

python -m pip install --user pipx
python -m pipx ensurepath

Close and reopen PowerShell after this. ensurepath adds pipx to your PATH, but existing shells won't see the change.

macOS

brew install pipx
pipx ensurepath

Linux

python3 -m pip install --user pipx
python3 -m pipx ensurepath

Verify pipx works by running pipx --version in a fresh terminal window.

4. Install HyperAgent

Now the actual app. In your terminal:

pipx install hyperliquidagent

You should see pipx download the package and print something like installed package hyperliquidagent 0.1.x. If you ever need to update:

pipx upgrade hyperliquidagent

5. Get Testnet USDC

HyperAgent only trades Hyperliquid testnet, which uses play-money USDC. To fund your testnet wallet:

  1. Visit app.hyperliquid-testnet.xyz.
  2. Connect your wallet (MetaMask, Rabby, etc.).
  3. Click the faucet / "Claim testnet USDC" option. You'll get free testnet funds — no real money moves.

6. Generate an Agent Wallet (read this carefully)

HyperAgent never asks for your main wallet's private key. Instead, you create a disposable "agent key" that can only place/cancel trades — Hyperliquid's exchange itself blocks it from withdrawing funds.

  1. Go to app.hyperliquid-testnet.xyz/API.
  2. Click Generate.
  3. A approveAgent transaction pops up in your wallet. Sign it with your main wallet — this tells Hyperliquid "this agent key is allowed to trade on my behalf."
  4. Copy the agent private key shown on screen (long hex string starting with 0x…). Save it somewhere safe for now; you'll paste it into the wizard in step 8.
  5. Also copy your main wallet address (the public 0x… address you signed with).

You can revoke the agent key any time from the same page — one click, no email, no support ticket.

7. (Optional) Get a HypeDexer API Key

Only needed if you want to use the Liquidation Cascade v2 strategy. Skip this section otherwise — every other strategy works without it.

  1. Go to app.hypedexer.com/dashboard/keys.
  2. Sign in / create an account.
  3. Click Create API Key (or similar — the button on the Keys dashboard).
  4. Give it a name like hyperagent and create it.
  5. Copy the generated key. You'll paste it into the wizard when it asks for HYPEDEXER_API_KEY.

Keep this key private — treat it like a password. If it leaks, revoke it from the same dashboard.

8. (Optional) AWS Bedrock Credentials for AI Explanations

Only needed if you want Claude Haiku to explain trades in plain English. Skip if you don't care.

You need an AWS account with Bedrock access to Claude Haiku enabled. You'll be prompted for:

  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY
  • AWS_DEFAULT_REGION (default us-east-1)

9. Run the Setup Wizard

In your terminal:

hyperagent

The wizard will prompt you, one at a time, for:

Prompt Paste here
Main wallet address The 0x… public address from step 6
Agent private key (hidden) The agent key from step 6
Enable AI? y if you did step 8, else n
Enable HypeDexer? y if you did step 7, else n

Input is hidden for sensitive fields (you won't see the key as you type/paste — that's normal).

When done, HyperAgent saves config to:

  • Windows: C:\Users\<you>\.config\hyperagent\.env
  • macOS/Linux: ~/.config/hyperagent/.env

…with restrictive file permissions (chmod 600 on Unix).

10. Trade

You'll land in the TUI. Pick a strategy from the dropdown, hit Start, and watch it go. Use the keybindings below to navigate.

To reconfigure later (rotate keys, add AWS creds, etc.):

hyperagent setup

Troubleshooting

  • hyperagent: command not found after pipx install — close and reopen your terminal. If still missing, run pipx ensurepath again, then reopen.
  • 'utf-8' codec can't decode byte … on startup — your .env file got saved with non-UTF-8 encoding (common on Windows if edited in Notepad with a legacy codepage). Delete it and re-run hyperagent setup:
    • Windows: del C:\Users\<you>\.config\hyperagent\.env
    • macOS/Linux: rm ~/.config/hyperagent/.env
  • Python not found on Windows — reinstall Python and make sure "Add python.exe to PATH" is checked. Or use py -3 instead of python.
  • pipx install fails with SSL errors — you're behind a corporate proxy; try from a personal network.

Safety

  • Testnet only. This version signs only on Hyperliquid testnet. It cannot touch your mainnet funds.
  • Agent-wallet only — you never paste your main private key. HyperAgent uses Hyperliquid's native "agent wallet" feature. You generate an agent key on app.hyperliquid-testnet.xyz/API, sign one approval transaction with your main wallet, and paste only the agent key into the wizard. Hyperliquid's exchange enforces that agent keys cannot withdraw funds — only place and cancel trades.
  • Revocable any time. If you ever want to cut off the bot, click "Revoke" on the same Hyperliquid page. No key rotation, no emails, one click.

What It Does

Every second, HyperAgent:

  1. Watches — Pulls live prices, funding rates, open interest, and orderbook depth from Hyperliquid mainnet
  2. Listens — Polls HypeDexer's full liquidation firehose (Hyperliquid-wide) for ongoing cascade events
  3. Thinks — Runs the active strategy's logic: scoring cascades, counting indicator votes, measuring orderbook imbalance, or calculating funding carry
  4. Decides — Only trades when the signal passes confidence thresholds AND risk checks
  5. Executes — Places market orders on Hyperliquid testnet instantly, sets native TP/SL as safety nets
  6. Protects — Monitors every position every 2 seconds with a trailing stop-loss that locks in profits
  7. Explains — When AI is on, Claude Haiku writes why the agent made each trade

Architecture

┌──────────────────────────────────────────────────────────────────┐
│                     HYPERAGENT TUI (Textual)                      │
│     [Dashboard]      [Strategy Config]      [Trade Journal]       │
├──────────────────────────────────────────────────────────────────┤
│                                                                    │
│  STRATEGIES                    CORE                                │
│  ┌─────────────────────┐      ┌──────────────────────────────┐    │
│  │ Trend Follower      │      │ Dual Client                  │    │
│  │ Momentum            │─────>│  Mainnet Info (read-only)    │    │
│  │ Funding Carry       │      │  Testnet Exchange (trading)  │    │
│  │ Volatility Breakout │      └──────────────────────────────┘    │
│  │ Pairs Reversion     │      ┌──────────────────────────────┐    │
│  │ Liquidation Cascade │      │ Risk Manager                 │    │
│  └─────────┬───────────┘      │  Trailing stop (software)    │    │
│            │                   │  Native TP/SL (exchange)     │    │
│  ┌─────────▼──────────┐       │  Daily loss limits           │    │
│  │ AI Wrapper          │       │  Position sizing             │    │
│  │ (Claude Haiku via   │       └──────────────────────────────┘    │
│  │  AWS Bedrock)       │                                            │
│  └────────────────────┘                                            │
│                                                                    │
│  LIQUIDATION DATA              TUI                                 │
│  ┌────────────────────┐       ┌──────────────────────────────┐    │
│  │ HypeDexer Client   │       │ Market Ticker                │    │
│  │ Full liquidation   │       │ Liquidation Stats (v2)       │    │
│  │ firehose (30s)     │       │ AI Reasoning Panel           │    │
│  │ Rolling aggregator │       │ Positions + Trailing Stop    │    │
│  └────────────────────┘       │ Scrollable Trade Log         │    │
│                                └──────────────────────────────┘    │
└──────────────────────────────────────────────────────────────────┘

Trading Strategies

Strategy What It Does Speed
Trend Follower ADX(14) on 4h candles confirms trends, +DI/-DI for direction, EMA(21/55) confirms, pullback-to-EMA entries with ATR-based stops Every 15s
Momentum 6-signal weighted scoring (RSI, MACD+slope, EMA crossover, BB %B, volume-momentum, 4h confirmation) with ADX chop filter Every 15s
Funding Carry Research-calibrated funding arbitrage — requires >0.03% rate, settlement timing, trend filter, and funding persistence Every 15s
Volatility Breakout Detects Bollinger squeeze (BB inside Keltner), then trades the breakout with ATR-adaptive thresholds and volume confirmation Every 15s
Pairs Reversion Market-neutral stat-arb on BTC/ETH and SOL/AVAX — z-score on log price ratio, entry at 2σ, stop at 3.5σ Every 15s
Liquidation Cascade Polls HypeDexer's full liquidation firehose, trades in-cascade direction when dominant-side USD + 3× imbalance + 1.3× acceleration all confirm an ongoing cascade Every 15s

AI Layer: Any strategy can be wrapped with Claude Haiku (AWS Bedrock) for natural language trade explanations. Toggle with a key.


Run from source (contributors)

git clone https://github.com/yashj09/Hyperagent
cd hyperagent
python3 -m venv venv && source venv/bin/activate
pip install -e .
hyperagent

Keybindings

Key Action
d Dashboard
s Strategy Config
j Trade Journal
n Analytics
a Toggle AI
k Kill all positions
q Quit

Environment Variables

Variable Required Description
HL_MAIN_ADDRESS Yes Your main wallet address (0x…, public)
HL_AGENT_PRIVATE_KEY Yes Agent wallet private key from Hyperliquid — never your main key
AWS_ACCESS_KEY_ID For AI AWS credentials for Bedrock
AWS_SECRET_ACCESS_KEY For AI AWS secret key
AWS_DEFAULT_REGION For AI AWS region (default: us-east-1)
HYPEDEXER_API_KEY For Cascade v2 Required only for the Liquidation Cascade v2 strategy
HYPERAGENT_ENV_FILE No Override config file location

Data Flow

Price Feed (5s)    ──> Prices, Funding, OI ──> Shared State
Liq Poller (30s)   ──> HypeDexer firehose ──> Rolling Stats ──> Shared State
Strategy (15s)     ──> Read State ──> Generate Signal ──> Execute Trade
Risk Monitor (2s)  ──> Check Trailing Stops ──> Close on Breach
Dashboard (1s)     ──> Read State ──> Render All Panels

What Makes It Unique

  1. Liquidation Cascade Trader — Trades the full Hyperliquid liquidation firehose (via HypeDexer) when dominant-side USD, imbalance, and acceleration all confirm an ongoing cascade — catching the forced-flow move, not guessing at it
  2. Strategy platform, not a single bot — 6 strategies in a dropdown. Adding a new one is one file implementing generate_signal()
  3. AI reasoning on any strategy — Claude Haiku explains every trade in plain English
  4. Dual-network architecture — Real mainnet data, safe testnet execution
  5. Interactive TUI — Tabs, dropdowns, toggles, scrollable logs, keyboard shortcuts. Not a script — a terminal app
  6. Production risk management — Double stop-loss, per-coin dedup, daily loss limits, position sizing

Tech Stack

Library Purpose
Textual 8.2.3 Interactive TUI framework
hyperliquid-python-sdk 0.23.0 Exchange API
ta Technical analysis indicators (RSI, MACD, EMA, BB)
anthropic + boto3 Claude Haiku via AWS Bedrock
numpy Numerical computation
Python 3.9+ Runtime

Project Structure

hyperagent/
├── app.py                          # Textual App — entry point + background workers
├── config.py                       # All tunable constants
├── core/
│   ├── client.py                   # Dual Hyperliquid client (mainnet read + testnet trade)
│   ├── risk.py                     # Risk manager (trailing stop + native TP/SL + limits)
│   ├── state.py                    # Shared AgentState dataclass
│   ├── hypedexer_client.py         # HypeDexer API client (liquidation firehose)
│   └── liquidation_aggregator.py   # Rolling per-coin liquidation stats
├── strategies/
│   ├── base.py                     # Abstract BaseStrategy interface
│   ├── trend_follower.py           # ADX-based CTA trend follower
│   ├── momentum.py                 # 6-signal weighted momentum
│   ├── funding_sniper.py           # Funding carry arbitrage
│   ├── volatility_breakout.py      # Bollinger/Keltner squeeze breakout
│   ├── pairs_reversion.py          # Market-neutral pairs stat-arb
│   ├── liquidation_cascade_v2.py   # Tradable cascade on HypeDexer firehose
│   └── ai_wrapper.py               # Claude Haiku reasoning wrapper
├── tui/
│   ├── styles.tcss                 # Textual CSS (dark trading theme)
│   ├── screens/
│   │   ├── dashboard.py            # Live dashboard
│   │   ├── strategy_config.py      # Strategy selector + AI toggle + params
│   │   └── trade_journal.py        # Trade history table + stats
│   └── widgets/
│       ├── market_ticker.py        # Live price ticker bar
│       ├── liquidation_stats.py    # Per-coin v2 liquidation stats panel
│       └── positions_panel.py      # Active positions with trailing stop viz
├── requirements.txt
├── .env.example
└── .gitignore

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hyperliquidagent-0.1.5.tar.gz (105.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hyperliquidagent-0.1.5-py3-none-any.whl (130.9 kB view details)

Uploaded Python 3

File details

Details for the file hyperliquidagent-0.1.5.tar.gz.

File metadata

  • Download URL: hyperliquidagent-0.1.5.tar.gz
  • Upload date:
  • Size: 105.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for hyperliquidagent-0.1.5.tar.gz
Algorithm Hash digest
SHA256 4910d5445992c40e41d1a95b1c80e6defce5cc577c0c46e30bc0bba04f177fd2
MD5 e7492f6c780880484e66b2de83a00998
BLAKE2b-256 4e5f76b637e607976659f0910b1890947cd5edc72b83cf0fc314493918f91bdc

See more details on using hashes here.

Provenance

The following attestation bundles were made for hyperliquidagent-0.1.5.tar.gz:

Publisher: release.yml on yashj09/Hyperagent

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file hyperliquidagent-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for hyperliquidagent-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 170e95a259d617faae5dbd344651b57ca201d0e7b5ca666bd0b60a05d508c835
MD5 70a534620e33940a203843318ddd64e9
BLAKE2b-256 c2b55d2b873614f539dc0b4ff203230f97b86ef92e3a4ad4f575404cac04ebc0

See more details on using hashes here.

Provenance

The following attestation bundles were made for hyperliquidagent-0.1.5-py3-none-any.whl:

Publisher: release.yml on yashj09/Hyperagent

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page