hyperliquid-rb 0.1.0

data/lib/hyperliquid/utils.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "bigdecimal"
+
+module Hyperliquid
+  module Utils
+    module_function
+
+    # Convert float to wire format string: 8 decimal precision, trailing zeros removed.
+    # Examples: 100 -> "100", 1670.1 -> "1670.1", 0.0147 -> "0.0147"
+    def float_to_wire(x)
+      rounded = format("%.8f", x)
+      raise SigningError, "float_to_wire causes rounding: #{x}" if (Float(rounded) - x).abs >= 1e-12
+
+      rounded = "0" if rounded == "-0"
+      # Normalize via BigDecimal to strip trailing zeros, format as fixed-point
+      normalized = BigDecimal(rounded).to_s("F")
+      # BigDecimal("100.00000000").to_s("F") => "100.0", we want "100"
+      normalized.sub(/\.0$/, "")
+    end
+
+    # Convert float to integer by multiplying by 10^power, validating precision.
+    def float_to_int(x, power)
+      with_decimals = x * (10**power)
+      rounded = with_decimals.round
+      raise SigningError, "float_to_int causes rounding: #{x}" if (rounded - with_decimals).abs >= 1e-3
+
+      rounded
+    end
+
+    # Convert float to int * 10^8 for action hashing.
+    def float_to_int_for_hashing(x)
+      float_to_int(x, 8)
+    end
+
+    # Convert USD float to int * 10^6.
+    def float_to_usd_int(x)
+      float_to_int(x, 6)
+    end
+
+    # Convert an OrderRequest hash to wire format for signing.
+    def order_request_to_order_wire(order, asset)
+      wire = {
+        "a" => asset,
+        "b" => order[:is_buy],
+        "p" => float_to_wire(order[:limit_px]),
+        "s" => float_to_wire(order[:sz]),
+        "r" => order[:reduce_only],
+        "t" => order_type_to_wire(order[:order_type])
+      }
+      wire["c"] = order[:cloid].to_raw if order[:cloid]
+      wire
+    end
+
+    # Convert order type to wire format.
+    def order_type_to_wire(order_type)
+      if order_type[:limit]
+        { "limit" => order_type[:limit] }
+      elsif order_type[:trigger]
+        t = order_type[:trigger]
+        {
+          "trigger" => {
+            "isMarket" => t[:isMarket],
+            "triggerPx" => float_to_wire(t[:triggerPx]),
+            "tpsl" => t[:tpsl]
+          }
+        }
+      else
+        raise SigningError, "Unknown order type: #{order_type}"
+      end
+    end
+
+    # Convert hex address string to 20-byte binary.
+    def address_to_bytes(address)
+      [address.delete_prefix("0x")].pack("H40")
+    end
+  end
+end

data/lib/hyperliquid/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Hyperliquid
+  VERSION = "0.1.0"
+end

data/lib/hyperliquid/websocket_manager.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+require "json"
+require "websocket-client-simple"
+
+module Hyperliquid
+  ActiveSubscription = Struct.new(:callback, :subscription_id)
+
+  class WebsocketManager
+    PING_INTERVAL = 50 # seconds
+
+    def initialize(base_url)
+      @subscription_id_counter = 0
+      @ws_ready = false
+      @queued_subscriptions = []
+      @active_subscriptions = Hash.new { |h, k| h[k] = [] }
+      @mutex = Mutex.new
+      @stop_event = false
+
+      ws_url = "ws#{base_url[4..]}/ws"
+      @ws_url = ws_url
+      @ws = nil
+    end
+
+    def start
+      manager = self
+      @ws = WebSocket::Client::Simple.connect(@ws_url)
+
+      @ws.on :message do |msg|
+        manager.send(:handle_message, msg.data)
+      end
+
+      @ws.on :open do
+        manager.send(:handle_open)
+      end
+
+      @ping_thread = Thread.new { send_ping }
+    end
+
+    def stop
+      @mutex.synchronize { @stop_event = true }
+      @ws&.close
+      @ping_thread&.join
+    end
+
+    def subscribe(subscription, callback, subscription_id: nil)
+      @mutex.synchronize do
+        if subscription_id.nil?
+          @subscription_id_counter += 1
+          subscription_id = @subscription_id_counter
+        end
+
+        if @ws_ready
+          identifier = self.class.subscription_to_identifier(subscription)
+          if %w[userEvents orderUpdates].include?(identifier) && !@active_subscriptions[identifier].empty?
+            raise NotImplementedError, "Cannot subscribe to #{identifier} multiple times"
+          end
+
+          @active_subscriptions[identifier] << ActiveSubscription.new(callback, subscription_id)
+          @ws.send(JSON.generate({ "method" => "subscribe", "subscription" => subscription }))
+        else
+          @queued_subscriptions << [subscription, ActiveSubscription.new(callback, subscription_id)]
+        end
+
+        subscription_id
+      end
+    end
+
+    def unsubscribe(subscription, subscription_id)
+      @mutex.synchronize do
+        raise NotImplementedError, "Can't unsubscribe before websocket connected" unless @ws_ready
+
+        identifier = self.class.subscription_to_identifier(subscription)
+        active = @active_subscriptions[identifier]
+        new_active = active.reject { |s| s.subscription_id == subscription_id }
+        @ws.send(JSON.generate({ "method" => "unsubscribe", "subscription" => subscription })) if new_active.empty?
+        @active_subscriptions[identifier] = new_active
+        active.length != new_active.length
+      end
+    end
+
+    # Maps a subscription request to its identifier string.
+    def self.subscription_to_identifier(subscription)
+      type = subscription["type"]
+      case type
+      when "allMids"
+        "allMids"
+      when "l2Book"
+        "l2Book:#{subscription["coin"].downcase}"
+      when "trades"
+        "trades:#{subscription["coin"].downcase}"
+      when "userEvents"
+        "userEvents"
+      when "userFills"
+        "userFills:#{subscription["user"].downcase}"
+      when "candle"
+        "candle:#{subscription["coin"].downcase},#{subscription["interval"]}"
+      when "orderUpdates"
+        "orderUpdates"
+      when "userFundings"
+        "userFundings:#{subscription["user"].downcase}"
+      when "userNonFundingLedgerUpdates"
+        "userNonFundingLedgerUpdates:#{subscription["user"].downcase}"
+      when "webData2"
+        "webData2:#{subscription["user"].downcase}"
+      when "bbo"
+        "bbo:#{subscription["coin"].downcase}"
+      when "activeAssetCtx"
+        "activeAssetCtx:#{subscription["coin"].downcase}"
+      when "activeAssetData"
+        "activeAssetData:#{subscription["coin"].downcase},#{subscription["user"].downcase}"
+      end
+    end
+
+    # Maps an incoming WS message to its identifier string.
+    def self.ws_msg_to_identifier(ws_msg)
+      channel = ws_msg["channel"]
+      case channel
+      when "pong"
+        "pong"
+      when "allMids"
+        "allMids"
+      when "l2Book"
+        "l2Book:#{ws_msg["data"]["coin"].downcase}"
+      when "trades"
+        trades = ws_msg["data"]
+        return nil if trades.empty?
+
+        "trades:#{trades[0]["coin"].downcase}"
+      when "user"
+        "userEvents"
+      when "userFills"
+        "userFills:#{ws_msg["data"]["user"].downcase}"
+      when "candle"
+        "candle:#{ws_msg["data"]["s"].downcase},#{ws_msg["data"]["i"]}"
+      when "orderUpdates"
+        "orderUpdates"
+      when "userFundings"
+        "userFundings:#{ws_msg["data"]["user"].downcase}"
+      when "userNonFundingLedgerUpdates"
+        "userNonFundingLedgerUpdates:#{ws_msg["data"]["user"].downcase}"
+      when "webData2"
+        "webData2:#{ws_msg["data"]["user"].downcase}"
+      when "bbo"
+        "bbo:#{ws_msg["data"]["coin"].downcase}"
+      when "activeAssetCtx", "activeSpotAssetCtx"
+        "activeAssetCtx:#{ws_msg["data"]["coin"].downcase}"
+      when "activeAssetData"
+        "activeAssetData:#{ws_msg["data"]["coin"].downcase},#{ws_msg["data"]["user"].downcase}"
+      end
+    end
+
+    private
+
+    def handle_message(data)
+      return if data == "Websocket connection established."
+
+      ws_msg = JSON.parse(data)
+      identifier = self.class.ws_msg_to_identifier(ws_msg)
+      return if identifier == "pong"
+      return if identifier.nil?
+
+      active = @mutex.synchronize { @active_subscriptions[identifier].dup }
+      if active.empty?
+        warn "Websocket message from an unexpected subscription: #{data} #{identifier}"
+      else
+        active.each { |sub| sub.callback.call(ws_msg) }
+      end
+    end
+
+    def handle_open
+      @mutex.synchronize do
+        @ws_ready = true
+        @queued_subscriptions.each do |subscription, active_sub|
+          subscribe(subscription, active_sub.callback, subscription_id: active_sub.subscription_id)
+        end
+        @queued_subscriptions.clear
+      end
+    end
+
+    def send_ping
+      loop do
+        sleep 1
+        elapsed = 0
+        loop do
+          break if @mutex.synchronize { @stop_event } || elapsed >= PING_INTERVAL
+
+          sleep 1
+          elapsed += 1
+        end
+        break if @mutex.synchronize { @stop_event }
+
+        @ws&.send(JSON.generate({ "method" => "ping" }))
+      end
+    end
+  end
+end

data/lib/hyperliquid.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "hyperliquid/version"
+require_relative "hyperliquid/error"
+require_relative "hyperliquid/constants"
+require_relative "hyperliquid/utils"
+require_relative "hyperliquid/cloid"
+require_relative "hyperliquid/transport"
+require_relative "hyperliquid/signer"
+require_relative "hyperliquid/websocket_manager"
+require_relative "hyperliquid/info"
+require_relative "hyperliquid/exchange"
+
+module Hyperliquid
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: hyperliquid-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Deltabadger
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.17
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.17
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: websocket-client-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Complete Ruby SDK for Hyperliquid — trading, market data, EIP-712 signing,
+  and WebSocket subscriptions.
+email:
+- hello@deltabadger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/hyperliquid.rb
+- lib/hyperliquid/cloid.rb
+- lib/hyperliquid/constants.rb
+- lib/hyperliquid/error.rb
+- lib/hyperliquid/exchange.rb
+- lib/hyperliquid/info.rb
+- lib/hyperliquid/signer.rb
+- lib/hyperliquid/transport.rb
+- lib/hyperliquid/utils.rb
+- lib/hyperliquid/version.rb
+- lib/hyperliquid/websocket_manager.rb
+homepage: https://github.com/deltabadger/hyperliquid-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/deltabadger/hyperliquid-rb
+  source_code_uri: https://github.com/deltabadger/hyperliquid-rb
+  changelog_uri: https://github.com/deltabadger/hyperliquid-rb/commits/main
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Ruby SDK for the Hyperliquid DEX API
+test_files: []