mcpField
G
grimoire-hyperliquid

grimoire-hyperliquid

github.com/franalgabaOther61.1k installsUpdated 25w ago
Repository

About grimoire-hyperliquid

A CLI skill for querying Hyperliquid market data and generating snapshot inputs for Grimoire spells, with an explicitly confirmed withdrawal command for stateful actions. It is intended for agents and users working with Hyperliquid data or spell workflows.

Key features

  1. 01Perpetual mid-price queries
  2. 02L2 order book and open-order queries
  3. 03Perpetual and spot metadata
  4. 04Snapshot commands for spell inputs
  5. 05Confirmed withdrawal command

Use cases

  1. 01Inspecting Hyperliquid prices and order books
  2. 02Checking open orders for an address
  3. 03Preparing snapshot inputs for spells
  4. 04Withdrawing funds after explicit confirmation

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/franalgaba/grimoire --skill grimoire-hyperliquid

After installing, type/grimoire-hyperliquidin Claude Code to confirm it loaded.

Details

From the project README

Grimoire Hyperliquid Skill

Use this skill for Hyperliquid metadata snapshots and, when explicitly requested, withdrawals.

Preferred invocations:

  • grimoire venue hyperliquid ...
  • npx -y @grimoirelabs/cli venue hyperliquid ... (no-install)
  • bun run packages/cli/src/index.ts venue hyperliquid ... (repo-local)
  • grimoire-hyperliquid ... (direct binary from @grimoirelabs/venues)

Recommended preflight:

  • grimoire venue doctor --adapter hyperliquid --json
  • Ensure HYPERLIQUID_PRIVATE_KEY is set before stateful actions (withdraw).

Use --format spell for snapshot params: blocks.

Commands

Read-only data:

  • grimoire venue hyperliquid mids — mid prices for all perp assets
  • grimoire venue hyperliquid l2-book --coin <symbol> — L2 order book for a coin
  • grimoire venue hyperliquid open-orders --user <address> — open orders for an address
  • grimoire venue hyperliquid meta — perp market metadata (universe, margin tables)
  • grimoire venue hyperliquid spot-meta — spot market metadata (tokens, universe)

Snapshot commands (agent-only, generate spell params: blocks):

  • grimoire venue hyperliquid mids-snapshot
  • grimoire venue hyperliquid l2-book-snapshot --coin <symbol>
  • grimoire venue hyperliquid open-orders-snapshot --user <address>
  • grimoire venue hyperliquid meta-snapshot
  • grimoire venue hyperliquid spot-meta-snapshot

Stateful:

  • grimoire venue hyperliquid withdraw --amount <usdc> --keystore <path> [--password-env <name>] [--destination <addr>]

Examples

grimoire venue hyperliquid mids --format table
grimoire venue hyperliquid mids --format spell
grimoire venue hyperliquid l2-book --coin BTC
grimoire venue hyperliquid l2-book --coin BTC --format spell
grimoire venue hyperliquid open-orders --user 0x0000000000000000000000000000000000000000
grimoire venue hyperliquid meta
grimoire venue hyperliquid mids-snapshot
grimoire venue hyperliquid l2-book-snapshot --coin BTC
grimoire venue hyperliquid meta-snapshot

Use -snapshot variants to emit params: blocks for spell inputs. These are agent-only (output suppressed in interactive mode).

Spell Actions

Hyperliquid uses custom action type with op: "order" for order placement:

hyperliquid.custom(op="order", coin="ETH", price="3500", size="0.1", side="buy", order_type="Gtc")

The adapter does not support runtime constraints (max_slippage, etc.). Order parameters are validated at the adapter boundary.

Supported TIF values: Gtc, Ioc, Alo, FrontendMarket.

Metric Surface (Spell Comparisons)

Hyperliquid exposes mid_price for symbol midpoint comparisons:

hl_mid = metric("mid_price", hyperliquid, ETH)

The third argument is the Hyperliquid symbol to read (for example ETH, BTC, SOL).

Notes

  • withdraw is stateful and requires explicit user confirmation plus keystore credentials.
  • mids, l2-book, open-orders, meta, spot-meta are read-only info calls.
  • Use --format spell for snapshot-based spell inputs.
  • Use --format json for meta/spot-meta in automation; --format table shows compact summaries for nested payloads.
  • anvil/cast are EVM tools and are not applicable for Hyperliquid execution/diagnostics.

Comments

Markdown supported