hyperliquid 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14a1a12bfa26b33260f7f2b0eacd8aeeb6762fc5d7d678f44cd63d6b492dcdd2
-  data.tar.gz: b0d4516d805842818e5d71b904a1f707014446802ad8efe60a7b6a6ed6a27853
+  metadata.gz: 9a6d420027ac68a2d2959293fd9735798e80ad39f484dd2f43f1f808d5964944
+  data.tar.gz: 89c4e1688d7a5ac9d4cba3a214de798ec333161a0d6053abeac5d6d4da4916f3
 SHA512:
-  metadata.gz: 2e0419a6fc7501f2c3a3b4085d35fc495a88840a295a2017a60934f5e906f51b98bdd0be178d2474eb9be0414a6b435fed19e258235e30043ca1808af8e7144a
-  data.tar.gz: 3de78e11757c22db4a7d59880fd14e0d28a3e31721054bb22d5368adf48a0e1fa2a9ca7c67fa75ffce2d88115a9973fa5fdc92f285b62836f657c4518c7fe585
+  metadata.gz: 7ca76a9847766153f734661dd91f9d62bb1c87e2c43aacb4dd63e20904a1f3ddff505b4e8f92eb80b0bf6624e584560c121a901e2a1865617062b0e1cc1963c4
+  data.tar.gz: 43d32462a0350f7f733f50cd1190b6acfde8647b141665998bf5e1fb6f6b3fc24c348ba04dbb6ca35d3aef8e8bce0770445ab44991e65d566c58a9ce01c928c3

data/.ruby-version

@@ -1 +1 @@
-3.4.9
+3.4.10

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 ## [Ruby Hyperliquid SDK Changelog]
 
+## [1.9.0] - 2026-08-31
+
+### New Exchange actions
+
+- `Exchange#activate_outcome_deployer(is_deactivate:)` activates or deactivates a HIP-4 outcome deployer.
+
+### New Info methods
+
+- `Info#outcome_templates` retrieves HIP-4 prediction-market deployer templates.
+- `Info#usdc_routing` retrieves the active USDC deposit and withdrawal routing configuration.
+
+### Extended API support
+
+- Added fast-cancel support to `Exchange#cancel`, `Exchange#cancel_by_cloid`, and `l2Book` WebSocket subscriptions.
+- Added always-place support to individual `Exchange#modify_order` and `Exchange#batch_modify` entries.
+- Added optional sub-account routing to `Exchange#usd_class_transfer`.
+- Added optional trigger and stop-price details to `Exchange#twap_order`.
+- Added optional destination routing to `Exchange#reserve_request_weight`.
+- Added optional DEX selection to `Info#margin_table`.
+
+### Tooling
+
+- Added weekly Dependabot checks for Bundler and GitHub Actions dependencies.
+- Updated the repository Ruby version to 3.4.10.
+
 ## [1.8.0] - 2026-06-16
 
 ### New WebSocket endpoints

data/CLAUDE.md

@@ -27,11 +27,11 @@ Integration scripts live in `scripts/` as standalone files (`test_NN_<name>.rb`)
 
 ```bash
 HYPERLIQUID_PRIVATE_KEY=0x... ruby scripts/test_all.rb              # all 20
-HYPERLIQUID_PRIVATE_KEY=0x... ruby scripts/test_automated.rb        # CI-friendly subset (13)
+HYPERLIQUID_PRIVATE_KEY=0x... ruby scripts/test_automated.rb        # CI-friendly subset (14)
 HYPERLIQUID_PRIVATE_KEY=0x... ruby scripts/test_08_usd_class_transfer.rb  # single
 ```
 
-`test_automated.rb` is the unattended runner — same as `test_all.rb` but excludes scripts that require manual testnet preconditions (e.g. `test_09_sub_account_lifecycle` needs $100k traded volume; `test_12_staking` needs HYPE balance; `test_20_explorer_ws` is new and not yet in automated). Some included tests (e.g. `test_08`, `test_11`) are also coded to skip-with-warning when known testnet preconditions aren't met, so the suite stays green on a stable wallet.
+`test_automated.rb` is the unattended runner — same as `test_all.rb` but excludes scripts that require manual testnet preconditions (e.g. `test_09_sub_account_lifecycle` needs $100k traded volume; `test_12_staking` needs HYPE balance). Some included tests (e.g. `test_08`, `test_11`) are also coded to skip-with-warning when known testnet preconditions aren't met, so the suite stays green on a stable wallet.
 
 `test_integration.rb` at the project root is a thin convenience wrapper.
 
@@ -93,7 +93,7 @@ Predicate methods follow Ruby style (`vip?`, `connected?`, `testnet?`) — not `
 
 ### CI
 
-GitHub Actions (`.github/workflows/main.yml`): runs `bundle exec rake` (tests + lint) on the Ruby matrix defined in that workflow, for pushes to `main` and on all PRs. The release workflow creates GitHub releases from `CHANGELOG.md` on version tags.
+GitHub Actions (`.github/workflows/main.yml`): runs `bundle exec rake` (tests + lint) on the Ruby matrix defined in that workflow, for pushes to `main` and on all PRs. The release workflow creates GitHub releases from `CHANGELOG.md` on version tags. Dependabot checks Bundler and GitHub Actions dependencies weekly with a 14-day default cooldown; Bundler major updates use a 30-day cooldown.
 
 ## Release Flow
 

data/lib/hyperliquid/exchange.rb

@@ -144,13 +144,17 @@ module Hyperliquid
     # @param coin [String] Asset symbol
     # @param oid [Integer] Order ID
     # @param vault_address [String, nil] Vault address for vault trading (optional)
+    # @param fast [Boolean, nil] Whether to use fast cancel (optional)
     # @return [Hash] Cancel response
-    def cancel(coin:, oid:, vault_address: nil)
+    def cancel(coin:, oid:, vault_address: nil, fast: nil)
       nonce = timestamp_ms
 
+      cancel_entry = { a: asset_index(coin), o: oid }
+      cancel_entry[:f] = true if fast
+
       action = {
         type: 'cancel',
-        cancels: [{ a: asset_index(coin), o: oid }]
+        cancels: [cancel_entry]
       }
 
       signature = @signer.sign_l1_action(
@@ -165,14 +169,18 @@ module Hyperliquid
     # @param coin [String] Asset symbol
     # @param cloid [Cloid, String] Client order ID
     # @param vault_address [String, nil] Vault address for vault trading (optional)
+    # @param fast [Boolean, nil] Whether to use fast cancel (optional)
     # @return [Hash] Cancel response
-    def cancel_by_cloid(coin:, cloid:, vault_address: nil)
+    def cancel_by_cloid(coin:, cloid:, vault_address: nil, fast: nil)
       nonce = timestamp_ms
       cloid_raw = normalize_cloid(cloid)
 
+      cancel_entry = { asset: asset_index(coin), cloid: cloid_raw }
+      cancel_entry[:f] = true if fast
+
       action = {
         type: 'cancelByCloid',
-        cancels: [{ asset: asset_index(coin), cloid: cloid_raw }]
+        cancels: [cancel_entry]
       }
 
       signature = @signer.sign_l1_action(
@@ -233,15 +241,17 @@ module Hyperliquid
     # @param reduce_only [Boolean] Reduce-only flag (default: false)
     # @param cloid [Cloid, String, nil] Client order ID for the modified order (optional)
     # @param vault_address [String, nil] Vault address for vault trading (optional)
+    # @param always_place [Boolean, nil] Always place the order even if cancel fails (optional)
     # @return [Hash] Modify response
     def modify_order(oid:, coin:, is_buy:, size:, limit_px:,
                      order_type: { limit: { tif: 'Gtc' } },
-                     reduce_only: false, cloid: nil, vault_address: nil)
+                     reduce_only: false, cloid: nil, vault_address: nil, always_place: nil)
       batch_modify(
         modifies: [{
           oid: oid, coin: coin, is_buy: is_buy, size: size,
           limit_px: limit_px, order_type: order_type,
-          reduce_only: reduce_only, cloid: cloid
+          reduce_only: reduce_only, cloid: cloid,
+          always_place: always_place
         }],
         vault_address: vault_address
       )
@@ -249,7 +259,7 @@ module Hyperliquid
 
     # Modify multiple orders at once
     # @param modifies [Array<Hash>] Array of modify hashes with keys:
-    #   :oid, :coin, :is_buy, :size, :limit_px, :order_type, :reduce_only, :cloid
+    #   :oid, :coin, :is_buy, :size, :limit_px, :order_type, :reduce_only, :cloid, :always_place
     # @param vault_address [String, nil] Vault address for vault trading (optional)
     # @return [Hash] Batch modify response
     def batch_modify(modifies:, vault_address: nil)
@@ -265,7 +275,9 @@ module Hyperliquid
           reduce_only: m[:reduce_only] || false,
           cloid: m[:cloid]
         )
-        { oid: normalize_oid(m[:oid]), order: order_wire }
+        entry = { oid: normalize_oid(m[:oid]), order: order_wire }
+        entry[:a] = true if m[:always_place]
+        entry
       end
 
       action = {
@@ -420,19 +432,25 @@ module Hyperliquid
     # Move USDC between perp and spot accounts
     # @param amount [String, Numeric] Amount to transfer
     # @param to_perp [Boolean] True to move to perp, false to move to spot
+    # @param sub_account [String, nil] Optional sub-account address (0x-prefixed hex).
+    #   When provided, the transfer targets the sub-account rather than the
+    #   master account; the suffix ` subaccount:<address>` is appended to the
+    #   signed amount string (mirrors TS SDK v0.33.1's amount union shape).
     # @return [Hash] Transfer response
-    def usd_class_transfer(amount:, to_perp:)
+    def usd_class_transfer(amount:, to_perp:, sub_account: nil)
       nonce = timestamp_ms
+      amount_str = amount.to_s
+      amount_str = "#{amount_str} subaccount:#{sub_account}" if sub_account
       action = {
         type: 'usdClassTransfer',
         signatureChainId: '0x66eee',
         hyperliquidChain: Signing::EIP712.hyperliquid_chain(testnet: @testnet),
-        amount: amount.to_s,
+        amount: amount_str,
         toPerp: to_perp,
         nonce: nonce
       }
       signature = @signer.sign_user_signed_action(
-        { amount: amount.to_s, toPerp: to_perp, nonce: nonce },
+        { amount: amount_str, toPerp: to_perp, nonce: nonce },
         'HyperliquidTransaction:UsdClassTransfer',
         Signing::EIP712::USD_CLASS_TRANSFER_TYPES
       )
@@ -1211,8 +1229,9 @@ module Hyperliquid
     # @param minutes [Integer] TWAP duration in minutes (5..1440)
     # @param randomize [Boolean] Randomize order timing
     # @param vault_address [String, nil] Vault address if acting on behalf of a vault
+    # @param details [Hash, nil] Optional trigger/stop price config: { t: { p:, a: } | nil, s: <UnsignedDecimal> | nil }
     # @return [Hash] Exchange response — on success `response.data.status.running.twapId`
-    def twap_order(coin:, is_buy:, size:, reduce_only:, minutes:, randomize:, vault_address: nil)
+    def twap_order(coin:, is_buy:, size:, reduce_only:, minutes:, randomize:, vault_address: nil, details: nil)
       nonce = timestamp_ms
       action = {
         type: 'twapOrder',
@@ -1225,6 +1244,7 @@ module Hyperliquid
           t: randomize
         }
       }
+      action[:details] = details unless details.nil?
       signature = @signer.sign_l1_action(
         action, nonce,
         vault_address: vault_address,
@@ -1251,10 +1271,12 @@ module Hyperliquid
 
     # Reserve additional rate-limited actions for a fee (`reserveRequestWeight` L1 action).
     # @param weight [Integer] Amount of request weight to reserve
+    # @param destination [String, nil] Address of an existing user to reserve the weight for; nil omits the field
     # @return [Hash] Exchange response
-    def reserve_request_weight(weight:)
+    def reserve_request_weight(weight:, destination: nil)
       nonce = timestamp_ms
       action = { type: 'reserveRequestWeight', weight: weight }
+      action[:destination] = destination unless destination.nil?
       signature = @signer.sign_l1_action(
         action, nonce,
         expires_after: @expires_after
@@ -1338,6 +1360,20 @@ module Hyperliquid
       post_action(action, signature, nonce, nil)
     end
 
+    # Activate or deactivate the signer as an outcome deployer
+    # (`activateOutcomeDeployer` L1 action, HIP-4).
+    # @param is_deactivate [Boolean] True to deactivate, false to activate
+    # @return [Hash] Exchange response
+    def activate_outcome_deployer(is_deactivate:)
+      nonce = timestamp_ms
+      action = { type: 'activateOutcomeDeployer', isDeactivate: is_deactivate }
+      signature = @signer.sign_l1_action(
+        action, nonce,
+        expires_after: @expires_after
+      )
+      post_action(action, signature, nonce, nil)
+    end
+
     # Finalize the link between a HyperCore spot token and an ERC-20 contract on
     # HyperEVM (`finalizeEvmContract` L1 action). `input` selects the verification method
     # and is passed through verbatim — accepts a Hash `{ create: { nonce: <int> } }` for an

data/lib/hyperliquid/info.rb

@@ -375,9 +375,12 @@ module Hyperliquid
 
     # Retrieve the margin requirements table for a given id
     # @param id [Integer] Margin table id
+    # @param dex [String, nil] DEX name (empty string for main dex); nil omits the field
     # @return [Hash] Keys: description (String), marginTiers (Array of { lowerBound, maxLeverage })
-    def margin_table(id)
-      @client.post(Constants::INFO_ENDPOINT, { type: 'marginTable', id: id })
+    def margin_table(id, dex: nil)
+      body = { type: 'marginTable', id: id }
+      body[:dex] = dex unless dex.nil?
+      @client.post(Constants::INFO_ENDPOINT, body)
     end
 
     # Retrieve the vaults a user is leading
@@ -522,6 +525,20 @@ module Hyperliquid
       @client.post(Constants::INFO_ENDPOINT, { type: 'settledOutcome', outcome: outcome.to_i })
     end
 
+    # Retrieve outcome templates for HIP-4 prediction market deployers
+    # @return [Array<Hash>] Array of templates, each with id, role (standaloneOutcome
+    #   with sideNames), name, description (both with {keyword} placeholders), and
+    #   keywords (array of [name, type] where type is "dateTime", "date", "string", or "hlPerp")
+    def outcome_templates
+      @client.post(Constants::INFO_ENDPOINT, { type: 'outcomeTemplates' })
+    end
+
+    # Retrieve USDC transfer routing configuration
+    # @return [Hash] Hash with depositRoute and withdrawalRoute, each "bridge" or "cctp"
+    def usdc_routing
+      @client.post(Constants::INFO_ENDPOINT, { type: 'usdcRouting' })
+    end
+
     # Retrieve a user's funding history
     # @param user [String]
     # @param start_time [Integer]

data/lib/hyperliquid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hyperliquid
-  VERSION = '1.8.0'
+  VERSION = '1.9.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyperliquid
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - carter2099