hyperliquid 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 184e215d2d80056cb19bd6a20b273134d9997979d160d154318c5e155cdf02bb
-  data.tar.gz: 1f2bd8b08ef2e99e3732bd7775eeb70fe00ad7c2f4210312d07d237d28e670ed
+  metadata.gz: 324ff762cbf5edcea7fc532f853b7295ffcd34476f6273fdef4e03bcc0f9eaee
+  data.tar.gz: 98b1b88b378bb8ae010301c656c833282cd406822fa0c8a7d6c134911b0f2cce
 SHA512:
-  metadata.gz: 1b8645b6f40ae9163343fbc6d7d5c814417643469d75ac320073546243d601055c26f92e1ecb272baf9d839dc4b983b19d56be01cc2bcf4709de9f0e6bf81116
-  data.tar.gz: 462b64553e8ee0939bf0284b0647ec602f9be2f3b2389144e64188813cf52d1bca1daf3feb233eab1167fb1337bda7028208acc38398e55a6279e2593ab26181
+  metadata.gz: fe9e447e5500312f98e8f8e602071372847963daacfd51475e92d4db5a7bc988546e4cf106479a9c899bcecf113612c2aa9ebe0dd50a5384bd438bb0d6429865
+  data.tar.gz: 7cd7d2e048c4bf25e128dd7fd41814621bd95305d613199cb4c41abdf1901fdc4c665635000112aafeb7c395dbf01dae81cba74042557d86643c6ac169e3d201

data/.rubocop.yml

@@ -4,6 +4,7 @@ AllCops:
   SuggestExtensions: false
   Exclude:
     - 'test_*.rb'  # Exclude ad-hoc integration test scripts
+    - 'scripts/**/*'  # Exclude integration test scripts
     - 'vendor/**/*'  # Exclude vendored gems (CI bundles here)
 
 # Allow longer methods for complex logic

data/CHANGELOG.md

@@ -1,6 +1,28 @@
 ## [Ruby Hyperliquid SDK Changelog]
 
-## [0.4.1] - 2025-01-28
+## [0.6.0] - 2026-01-28
+
+- Add transfers and account management to Exchange API
+  - USD transfers: `usd_send`, `usd_class_transfer`, `withdraw_from_bridge`
+  - Spot transfers: `spot_send`, `send_asset`
+  - Sub-accounts: `create_sub_account`, `sub_account_transfer`, `sub_account_spot_transfer`
+  - Vaults: `vault_transfer`
+  - Referrals: `set_referrer`
+- Add user-signed action signing (`sign_user_signed_action`) for EIP-712 typed data with `HyperliquidSignTransaction` domain
+- Add Python SDK parity test vectors for `usd_send`, `withdraw_from_bridge`, `create_sub_account`, and `sub_account_transfer`
+- Reorganize integration tests into individual scripts under `scripts/` for easier debugging
+
+## [0.5.0] - 2026-01-28
+
+- Add core trading features to Exchange API
+  - Order modification: `modify_order`, `batch_modify`
+  - Position management: `update_leverage`, `update_isolated_margin`, `market_close`
+  - Dead man's switch: `schedule_cancel`
+- Add `market_close` helper for closing positions at market price with auto-detection of size and direction
+- Add integration tests for leverage updates, order modification, and market close
+- Add GitHub Release workflow (`.github/workflows/release.yml`)
+
+## [0.4.1] - 2026-01-28
 
 - Reorganize documentation for improved readability
   - Streamline README with basic setup and links to detailed docs
@@ -10,7 +32,7 @@
   - Add `docs/ERRORS.md` with error handling guide
   - Add `docs/DEVELOPMENT.md` with setup and testing instructions
 
-## [0.4.0] - 2025-01-27
+## [0.4.0] - 2026-01-27
 
 - Add Exchange API for authenticated write operations (trading)
   - Order placement: `order`, `bulk_orders`, `market_order`

data/CLAUDE.md

@@ -45,16 +45,15 @@ ruby example.rb
 
 ### Integration Testing (Testnet)
 ```bash
-# Run the testnet integration test (requires private key)
+# Run all integration tests (requires private key)
 # Get testnet funds from: https://app.hyperliquid-testnet.xyz
-HYPERLIQUID_PRIVATE_KEY=0x... ruby test_integration.rb
+HYPERLIQUID_PRIVATE_KEY=0x... ruby scripts/test_all.rb
+
+# Run a single integration test
+HYPERLIQUID_PRIVATE_KEY=0x... ruby scripts/test_08_usd_class_transfer.rb
 ```
 
-The integration test executes real trades on testnet:
-1. Spot market roundtrip (buy/sell PURR/USDC)
-2. Spot limit order (place and cancel)
-3. Perp market roundtrip (long/close BTC)
-4. Perp limit order (place short, cancel)
+Integration tests live in `scripts/` as individual files. Each can be run standalone for debugging. `test_integration.rb` at the project root is a convenience wrapper that runs them all.
 
 ### Setup
 ```bash

data/README.md

@@ -1,5 +1,9 @@
 # Hyperliquid Ruby SDK
 
+[![Gem Version](https://badge.fury.io/rb/hyperliquid.svg)](https://rubygems.org/gems/hyperliquid)
+[![Downloads](https://img.shields.io/gem/dt/hyperliquid.svg)](https://rubygems.org/gems/hyperliquid)
+[![CI](https://github.com/carter2099/hyperliquid/actions/workflows/main.yml/badge.svg)](https://github.com/carter2099/hyperliquid/actions)
+
 A Ruby SDK for interacting with the Hyperliquid decentralized exchange API.
 
 The SDK supports both read operations (Info API) and authenticated write operations (Exchange API) for trading.
@@ -54,14 +58,6 @@ exchange = trading_sdk.exchange
 - [Error Handling](docs/ERRORS.md) - Error types and handling
 - [Development](docs/DEVELOPMENT.md) - Contributing and running tests
 
-## Roadmap
-
-The SDK now supports both Info API (read) and Exchange API (trading). Future versions will include:
-
-- WebSocket support for real-time data
-- Additional exchange operations (leverage, margin adjustments, transfers)
-- Advanced trading features (TWAP, etc.)
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/carter2099/hyperliquid.

data/SECURITY.md

@@ -0,0 +1,7 @@
+# Security Policy
+
+## For Issues in Hyperliquid
+
+If you have discovered a vulnerability or security issue related to the Hyperliquid service (e.g., buffer overflow, SQL
+injection, cross-site scripting, etc.), please refer to the
+[Hyperliquid Security Policy](https://github.com/hyperliquid-dex/hyperliquid-python-sdk/blob/master/SECURITY.md).

data/docs/API.md

@@ -59,16 +59,49 @@ Read-only methods for querying market data and user information.
 
 **Note:** Exchange methods require initializing the SDK with a `private_key`.
 
+### Order Placement
+
 - `order(coin:, is_buy:, size:, limit_px:, ...)` - Place a single limit order
 - `bulk_orders(orders:, grouping:, ...)` - Place multiple orders in a batch
 - `market_order(coin:, is_buy:, size:, slippage:, ...)` - Place a market order with slippage
+
+### Order Modification
+
+- `modify_order(oid:, coin:, is_buy:, size:, limit_px:, ...)` - Modify an existing order by oid or cloid
+- `batch_modify(modifies:, ...)` - Modify multiple orders at once
+
+### Order Cancellation
+
 - `cancel(coin:, oid:, ...)` - Cancel an order by order ID
 - `cancel_by_cloid(coin:, cloid:, ...)` - Cancel an order by client order ID
 - `bulk_cancel(cancels:, ...)` - Cancel multiple orders by order ID
 - `bulk_cancel_by_cloid(cancels:, ...)` - Cancel multiple orders by client order ID
+- `schedule_cancel(time:, ...)` - Auto-cancel all orders at a given time
+
+### Position Management
+
+- `market_close(coin:, size:, slippage:, ...)` - Close a position at market price (auto-detects position size)
+- `update_leverage(coin:, leverage:, is_cross:, ...)` - Set cross or isolated leverage for a coin
+- `update_isolated_margin(coin:, amount:, ...)` - Add or remove isolated margin for a position
+
+### Transfers & Account Management
+
+- `usd_send(amount:, destination:)` - Transfer USDC to another address
+- `spot_send(amount:, destination:, token:)` - Transfer a spot token to another address
+- `usd_class_transfer(amount:, to_perp:)` - Move USDC between perp and spot accounts
+- `withdraw_from_bridge(amount:, destination:)` - Withdraw USDC via the bridge
+- `send_asset(destination:, source_dex:, destination_dex:, token:, amount:)` - Move assets between DEX instances
+- `create_sub_account(name:)` - Create a sub-account
+- `sub_account_transfer(sub_account_user:, is_deposit:, usd:)` - Transfer USDC to/from a sub-account
+- `sub_account_spot_transfer(sub_account_user:, is_deposit:, token:, amount:)` - Transfer spot tokens to/from a sub-account
+- `vault_transfer(vault_address:, is_deposit:, usd:)` - Deposit or withdraw USDC to/from a vault
+- `set_referrer(code:)` - Set referral code
+
+### Other
+
 - `address` - Get the wallet address associated with the private key
 
-All exchange methods support an optional `vault_address:` parameter for vault trading.
+Order placement and management methods support an optional `vault_address:` parameter for vault trading.
 
 ### Order Types
 

data/docs/DEVELOPMENT.md

@@ -11,13 +11,42 @@ bin/setup
 ## Running Tests
 
 ```bash
-# Run all tests
+# Run all unit tests
 rake spec
 
-# Run tests and linting together (default)
+# Run unit tests and linting together (default)
 rake
 ```
 
+### Integration Testing (Testnet)
+
+Integration tests live in `scripts/` and execute real trades on testnet. No real funds are at risk. Get testnet funds from https://app.hyperliquid-testnet.xyz.
+
+```bash
+# Run all integration tests
+HYPERLIQUID_PRIVATE_KEY=0x... ruby scripts/test_all.rb
+
+# Run a single integration test
+HYPERLIQUID_PRIVATE_KEY=0x... ruby scripts/test_08_usd_class_transfer.rb
+```
+
+The convenience wrapper `ruby test_integration.rb` also runs all tests.
+
+Available test scripts:
+
+| Script | Description |
+|--------|-------------|
+| `test_01_spot_market_roundtrip.rb` | Buy/sell PURR/USDC at market |
+| `test_02_spot_limit_order.rb` | Place and cancel a spot limit order |
+| `test_03_perp_market_roundtrip.rb` | Long/close BTC at market |
+| `test_04_perp_limit_order.rb` | Place and cancel a perp short |
+| `test_05_update_leverage.rb` | Set cross, isolated, and reset leverage |
+| `test_06_modify_order.rb` | Place, modify, and cancel an order |
+| `test_07_market_close.rb` | Open a position and close via `market_close` |
+| `test_08_usd_class_transfer.rb` | Transfer USDC between perp and spot |
+| `test_09_sub_account_lifecycle.rb` | Create sub-account, deposit, withdraw |
+| `test_10_vault_transfer.rb` | Deposit/withdraw to a vault |
+
 ## Linting
 
 ```bash
@@ -37,18 +66,3 @@ This opens an interactive prompt with the SDK loaded for experimentation.
 ```bash
 ruby example.rb
 ```
-
-## Integration Testing (Testnet)
-
-For real trading tests on testnet:
-
-```bash
-# Get testnet funds from: https://app.hyperliquid-testnet.xyz
-HYPERLIQUID_PRIVATE_KEY=0x... ruby test_integration.rb
-```
-
-The integration test executes real trades on testnet:
-1. Spot market roundtrip (buy/sell PURR/USDC)
-2. Spot limit order (place and cancel)
-3. Perp market roundtrip (long/close BTC)
-4. Perp limit order (place short, cancel)

data/docs/EXAMPLES.md

@@ -276,6 +276,70 @@ cloid_cancels = [
 sdk.exchange.bulk_cancel_by_cloid(cancels: cloid_cancels)
 ```
 
+### Modifying Orders
+
+```ruby
+# Modify an existing order by order ID
+oid = result.dig('response', 'data', 'statuses', 0, 'resting', 'oid')
+sdk.exchange.modify_order(
+  oid: oid,
+  coin: 'BTC',
+  is_buy: true,
+  size: '0.02',
+  limit_px: '96000'
+)
+
+# Modify an order by client order ID
+cloid = Hyperliquid::Cloid.from_int(123)
+sdk.exchange.modify_order(
+  oid: cloid,
+  coin: 'BTC',
+  is_buy: true,
+  size: '0.02',
+  limit_px: '96000'
+)
+
+# Modify multiple orders at once
+modifies = [
+  { oid: 12345, coin: 'BTC', is_buy: true, size: '0.01', limit_px: '95000' },
+  { oid: 12346, coin: 'ETH', is_buy: false, size: '0.5', limit_px: '3200' }
+]
+sdk.exchange.batch_modify(modifies: modifies)
+```
+
+### Position Management
+
+```ruby
+# Set cross leverage (default)
+sdk.exchange.update_leverage(coin: 'BTC', leverage: 5)
+
+# Set isolated leverage
+sdk.exchange.update_leverage(coin: 'BTC', leverage: 10, is_cross: false)
+
+# Add isolated margin to a position (positive amount)
+sdk.exchange.update_isolated_margin(coin: 'BTC', amount: 100.0)
+
+# Remove isolated margin from a position (negative amount)
+sdk.exchange.update_isolated_margin(coin: 'BTC', amount: -50.0)
+
+# Close an entire position at market price (auto-detects size and direction)
+sdk.exchange.market_close(coin: 'BTC')
+
+# Close a partial position with custom slippage
+sdk.exchange.market_close(coin: 'BTC', size: 0.01, slippage: 0.03)
+```
+
+### Schedule Cancel
+
+```ruby
+# Schedule auto-cancel of all orders at a specific time
+cancel_time = (Time.now.to_f * 1000).to_i + 60_000  # 60 seconds from now
+sdk.exchange.schedule_cancel(time: cancel_time)
+
+# Activate schedule cancel without specifying a time (server default)
+sdk.exchange.schedule_cancel
+```
+
 ### Vault Trading
 
 ```ruby
@@ -324,6 +388,97 @@ sdk.exchange.order(
 )
 ```
 
+### Transfers & Account Management
+
+```ruby
+# Transfer USDC to another address
+sdk.exchange.usd_send(
+  amount: '100',
+  destination: '0x...'
+)
+
+# Transfer a spot token to another address
+sdk.exchange.spot_send(
+  amount: '50',
+  destination: '0x...',
+  token: 'PURR'
+)
+
+# Move USDC between perp and spot accounts
+sdk.exchange.usd_class_transfer(amount: '100', to_perp: false)   # perp -> spot
+sdk.exchange.usd_class_transfer(amount: '100', to_perp: true)    # spot -> perp
+
+# Withdraw USDC via the bridge
+sdk.exchange.withdraw_from_bridge(
+  amount: '100',
+  destination: '0x...'
+)
+
+# Move assets between DEX instances
+sdk.exchange.send_asset(
+  destination: '0x...',
+  source_dex: 'dex1',
+  destination_dex: 'dex2',
+  token: 'USDC',
+  amount: '100'
+)
+```
+
+### Sub-Account Management
+
+```ruby
+# Create a sub-account
+result = sdk.exchange.create_sub_account(name: 'my-sub-account')
+sub_address = result.dig('response', 'data', 'subAccountUser')
+
+# Deposit USDC into a sub-account
+sdk.exchange.sub_account_transfer(
+  sub_account_user: sub_address,
+  is_deposit: true,
+  usd: 100
+)
+
+# Withdraw USDC from a sub-account
+sdk.exchange.sub_account_transfer(
+  sub_account_user: sub_address,
+  is_deposit: false,
+  usd: 50
+)
+
+# Transfer spot tokens to a sub-account
+sdk.exchange.sub_account_spot_transfer(
+  sub_account_user: sub_address,
+  is_deposit: true,
+  token: 'PURR',
+  amount: '10'
+)
+```
+
+### Vault Operations
+
+```ruby
+# Deposit USDC into a vault
+sdk.exchange.vault_transfer(
+  vault_address: '0x...',
+  is_deposit: true,
+  usd: 100
+)
+
+# Withdraw USDC from a vault
+sdk.exchange.vault_transfer(
+  vault_address: '0x...',
+  is_deposit: false,
+  usd: 50
+)
+```
+
+### Referral
+
+```ruby
+# Set a referral code
+sdk.exchange.set_referrer(code: 'MY_REFERRAL_CODE')
+```
+
 ### Client Order IDs (Cloid)
 
 ```ruby