hyperliquid-cli-python 0.1.0__py3-none-any.whl

hyperliquid_cli_python-0.1.0.dist-info/METADATA

@@ -0,0 +1,269 @@
+Metadata-Version: 2.4
+Name: hyperliquid-cli-python
+Version: 0.1.0
+Summary: Python CLI for Hyperliquid DEX
+Author: hyperliquid-cli contributors
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rich>=13.7.1
+Requires-Dist: hyperliquid-python-sdk>=0.18.0
+Requires-Dist: eth-account>=0.13.4
+Dynamic: license-file
+
+# Hyperliquid CLI (Python)
+
+## Installation
+
+```bash
+cd hl
+make install
+```
+
+After installation, the `hl` command is available:
+
+```bash
+hl --help
+```
+
+Manual install is still available:
+
+```bash
+pip install .
+```
+
+## Bash Completion
+
+`hl` can print a Bash completion script for top-level commands and subcommands.
+
+`make install` installs the package and appends a managed completion line to
+`~/.bashrc` if it is not already present.
+
+Enable it for the current shell:
+
+```bash
+eval "$(hl completion bash)"
+```
+
+Persist it in `~/.bashrc`:
+
+```bash
+echo 'eval "$(hl completion bash)"' >> ~/.bashrc
+```
+
+`make uninstall` removes the managed completion line from `~/.bashrc`.
+
+`pip install .` alone still does not edit shell startup files automatically.
+
+To remove both the package and the managed `~/.bashrc` completion line:
+
+```bash
+make uninstall
+```
+
+## Global Options
+
+- `--json` Output JSON
+- `--testnet` Use testnet
+
+## Supported Commands
+
+- `hl account add|ls|set-default|remove`
+- `hl account positions|orders|balances|portfolio`
+- `hl order ls|limit|market|tpsl|twap|twap-cancel|cancel|cancel-all|set-leverage|configure`
+- `hl asset price|book|leverage`
+- `hl markets ls|search`
+- `hl referral set|status`
+
+## Configuration
+
+- DB: `~/.hl/hl.db`
+- Order config: `~/.hl/order-config.json`
+
+Environment variable fallback (when DB account is not configured):
+
+- `HYPERLIQUID_PRIVATE_KEY`
+- `HYPERLIQUID_WALLET_ADDRESS`
+
+## Security Notes
+
+Account data stored in `~/.hl/hl.db` is encrypted at rest for these fields:
+
+- `user_address`
+- `api_wallet_public_key`
+- `api_wallet_private_key`
+
+The current implementation derives a 32-byte key as follows:
+
+1. Resolve the command path used to run `hl`
+2. Hash that path with SHA-256
+3. Use the resulting digest as the ChaCha20 key
+
+Each stored value is encrypted independently with its own random nonce.
+
+This means:
+
+- the same installed command path can transparently decrypt the saved values
+- changing the executable path can make existing saved account data undecryptable
+- this is path-bound encryption, not password-based encryption
+
+Example:
+
+```bash
+$ which hl
+/home/haturatu/.local/bin/hl
+```
+
+If `hl` is installed at a user-local path like `/home/haturatu/.local/bin/hl`, then
+the encryption key is effectively tied to that installed command path. In normal usage,
+that often behaves like "the user who has this `hl` on their path can decrypt the DB".
+So in practice it can look close to per-user decryption when each user has their own
+home directory and their own local install path.
+
+Important limitation:
+
+- this mechanism does **not** prove OS user identity by itself
+- if another OS user can both read `~/.hl/hl.db` and execute the same `hl` binary
+  path, path-based derivation alone does not prevent that user from decrypting the data
+
+So this mechanism is mainly useful as a coupling between the saved DB contents and the
+specific installed command path. It helps prevent casual reuse of the DB from a different
+binary location, but it is not a substitute for filesystem permissions or disk encryption.
+
+Environment variable fallback still exists when DB account data is not configured:
+
+- `HYPERLIQUID_PRIVATE_KEY`
+- `HYPERLIQUID_WALLET_ADDRESS`
+
+These environment variables are not stored in the encrypted DB. They are read as
+plain process environment values at runtime.
+
+Practical guidance:
+
+- Use wallets or API keys that would not be catastrophic if leaked
+- Restrict which OS user can run this tool
+- If you need stronger protection, use disk encryption as the higher-level control
+
+## Run for Development
+
+```bash
+cd hl
+PYTHONPATH=src python -m hl_cli.cli.argparse_main --help
+```
+
+## JSON Pattern Tests
+
+`tests/` validates that every subcommand pattern produces parseable raw JSON output in `--json` mode.
+
+```bash
+cd hl
+PYTHONPATH=src python -m unittest -v tests.test_json_patterns
+```
+
+## TWAP Orders
+
+`hyperliquid-python-sdk` does not provide a high-level TWAP method, so this CLI signs and submits the official
+`exchange` actions `twapOrder` / `twapCancel`.
+
+```bash
+# 30-minute native TWAP
+hl order twap buy 1.0 BTC 30
+
+# Derive total TWAP size from USD margin (stake * leverage)
+hl order twap buy 0 BTC 30 --stake 5
+
+# Compatibility format: 5,10 is sent as total 50 minutes
+hl order twap sell 2.0 ETH 5,10 --randomize
+
+# Cancel TWAP
+hl order twap-cancel BTC 12345
+```
+
+## Stake-Based Orders
+
+`--stake` is used by the CLI to derive order size.
+
+- If you pass `--stake 50 --leverage 20`, the CLI derives size from about `$1000`
+  of notional (`50 * 20`).
+- If you pass `--stake 50` without `--leverage`, the CLI derives size from about
+  `$50` of notional.
+
+Important: omitting `--leverage` does **not** mean your account or position is forced
+to `1x`. It only means the CLI does not multiply `--stake` by leverage when calculating
+the order size. If the exchange/account already has leverage set for that asset, the
+resulting position can still show that existing leverage in `hl account positions`.
+
+This means:
+
+- `--stake 50` means the CLI sizes the order from about `$50` of notional
+- `--stake 50 --leverage 20` means about `$1000` of position notional
+
+So:
+
+- `--leverage` changes how `--stake` is converted into order size
+- existing leverage on the exchange can still affect margin usage and the leverage
+  shown later in `hl account positions`
+
+```bash
+# No --leverage: CLI sizes the order from about $50 of BTC notional
+hl order market buy BTC --stake 50
+
+# No --leverage: CLI sizes the order from about $50 of ETH notional
+hl order market buy ETH --stake 50
+
+# With --leverage 20: CLI sizes the order from about $1,000 of BTC notional
+hl order limit buy BTC 65000 --stake 50 --leverage 20 --cross
+
+# With --leverage 20: CLI sizes the order from about $1,000 of BTC notional
+hl order market buy BTC --stake 50 --leverage 20 --isolated
+
+# Example:
+# BTC at 69,000
+# - --stake 50                 => about 0.000724 BTC of order size
+# - --stake 50 --leverage 20   => about 0.01449 BTC
+#
+# ETH at 2,020
+# - --stake 50                 => about 0.02475 ETH of order size
+# - --stake 50 --leverage 20   => about 0.2475 ETH
+
+# Set leverage and margin mode at order time
+hl order limit buy BTC 65000 --stake 50 --leverage 20 --cross
+hl order market buy BTC --stake 50 --leverage 20 --isolated
+
+# Set leverage directly
+hl order set-leverage BTC 20 --cross
+
+# If leverage is invalid, show warning and retry with coin maxLeverage from /info type=meta
+hl order set-leverage BTC 60
+
+# Close full position by coin
+hl order market close ETH
+hl order market close xyz:TSLA
+
+# Close 50% of a position
+hl order market close ETH --ratio 0.5
+
+# Set TP/SL trigger orders for an open position
+hl order tpsl ETH --tp 1900 --sl 1800
+hl order tpsl ETH --sl 1800 --ratio 0.5
+```
+
+## Acknowledgments
+
+- https://app.hyperliquid.xyz/
+- https://github.com/chrisling-dev/hyperliquid-cli
+- https://github.com/ehfuzzz/hyperliquid-CLI
+
+This project is primarily a Python implementation of
+https://github.com/chrisling-dev/hyperliquid-cli.
+Some features, including the TWAP order implementation, are also based on ideas from
+https://github.com/ehfuzzz/hyperliquid-CLI.
+
+This repository also includes changes such as expanded `order` subcommands, the
+`--stake` option, and additional `market` subcommand functionality.
+
+At the moment, I am not fully sure how this should be handled from a licensing and
+attribution perspective, so this repository is being published under my BSD 3-Clause
+License as a temporary choice. If you have a better idea for the appropriate license
+notice or attribution, please open an issue.

hyperliquid_cli_python-0.1.0.dist-info/RECORD

@@ -0,0 +1,25 @@
+hl_cli/__init__.py,sha256=bJB1Z_wpf672ABdQVD5JqVOz1H-VIinI1LmyC9I0haI,38
+hl_cli/cli/__init__.py,sha256=0v5LgBUFK9Sv9Xksq5llyygc1s0qDKMul3wtenezKns,43
+hl_cli/cli/argparse_main.py,sha256=PEE8s25qVQIlhrOD40zjIErypym8gK-1VORKZT5vjdQ,30405
+hl_cli/cli/markets_tui.py,sha256=OfGwbIU_SoA8zUwjRrm8Xe6AdZYbftWjFzHwOouhcmA,13046
+hl_cli/cli/runtime.py,sha256=cy7ESOsWCUIXzFCJNHI4OsZMqUhXBwJ_0BBISWgJW78,2085
+hl_cli/commands/__init__.py,sha256=P8lZ_2wMBwhuqPm8wE-xuPydwT4JWWPQ2W09PZLVxE0,31
+hl_cli/commands/app.py,sha256=_JzC1wJL3MmjBoZ4AbdZakL4sIHCKXvLzC-MmvQLsTQ,36328
+hl_cli/commands/order.py,sha256=mSO7fYWUS44H1iD1_xuo--wPJDXKa9mJvFAqmo0XAa8,29726
+hl_cli/core/__init__.py,sha256=jnzp3snw1CCFRBaqfFMCn_zSloV7O3aT9ZwnF3hIT40,33
+hl_cli/core/context.py,sha256=nuMnzcBS1WeKpevOvWc0iLGGFsYrxU6VjWq3M0sr_fU,5396
+hl_cli/core/order_config.py,sha256=SP_M3jMUq0kb-atT4cgEh5M2RcpkQ3UNdtm59bVbcPc,604
+hl_cli/infra/__init__.py,sha256=lL6lKVaAUaEsRHpMqEET-ZgMXrDX9vJ2FwnyNSmSB5c,47
+hl_cli/infra/db.py,sha256=kK1A9DAVRpn2Cg4cg_N3Ttrh_bA3WQkkx5QpdNzbn7c,9321
+hl_cli/infra/paths.py,sha256=8K6QUg7bBzWaDdkrUOMHS3dGGxo1vExcVde_z_G57gc,131
+hl_cli/utils/__init__.py,sha256=vTzpzAhwZwhp9xdzSN95SWmf02qgw7Asc0ULXG4aEok,23
+hl_cli/utils/market_table.py,sha256=MrrcDdzUnnn65cm55kc6rYp76BGFAcIb3QlDVfXGZ7o,2099
+hl_cli/utils/output.py,sha256=Q3jzCArvjjfcY92QvGZ-5Q9P74G-dUQ3TjrU2t_BDe0,15243
+hl_cli/utils/validators.py,sha256=hJ1hQmajfceGl9DDv-WS2D_WbTxfGrWuvN7D0qhSB-Q,1271
+hl_cli/utils/watch.py,sha256=WZHbQ1q0GVqDmQYutzPp8wMuxdKfq23ZvPJ8yUFjBT0,581
+hyperliquid_cli_python-0.1.0.dist-info/licenses/LICENSE,sha256=v78TwQbwNwXwMPEbrZ2W0fK3RFScNu5lfjxKi7Ug7mk,1604
+hyperliquid_cli_python-0.1.0.dist-info/METADATA,sha256=1gZ8WGwDiUwdBuqlYciAZPotpZkq-4P2OWyGTKKBwdQ,7945
+hyperliquid_cli_python-0.1.0.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
+hyperliquid_cli_python-0.1.0.dist-info/entry_points.txt,sha256=Og8LGmpVd-oTJ4Z2Ic5Z87JzcCSJRJ5urQTAdiDTuIM,53
+hyperliquid_cli_python-0.1.0.dist-info/top_level.txt,sha256=Z59lGaZW-HWWilKpRriLr0dL9ZA-gDHvcCycQnHYgj0,7
+hyperliquid_cli_python-0.1.0.dist-info/RECORD,,

hyperliquid_cli_python-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

hyperliquid_cli_python-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+hl = hl_cli.cli.argparse_main:main

hyperliquid_cli_python-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,32 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, haturau
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Inspired by:
+- https://github.com/chrisling-dev/hyperliquid-cli
+- https://github.com/ehfuzzz/hyperliquid-CLI

hyperliquid_cli_python-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+hl_cli