hyperliquid 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a800dda349fdca23a3e13c4b49020a3c17d506934f7f80b9859d760a95fb1a23
-  data.tar.gz: 518ae3c035ba3018ccb27d80552dd2f08b7b64d126b58f9828ce2db7d84052f6
+  metadata.gz: ce12eae948710ac0527586206ef346535631855e2e99e5d858bbcbfab0440826
+  data.tar.gz: 58cfa00339c797844b38a1744392a4589c97a9d7c61b3d6782411a1f4a2adc05
 SHA512:
-  metadata.gz: 64ecd6d0060040e6f98143535c05ed0d4a3035e72fa9e0eba0faf4865b14496172463eecd1d57f664c9e5c9df35f0517cfd53b40d3bd34d1325625e1526c64e4
-  data.tar.gz: 1700985bc702806ea068c180327ae6ee5fc2ac0d8d5c801e85a61dc044a30c298a3130c840d44b9a132dddbc55c00262ff2137635a03b2139279b0ed0522890a
+  metadata.gz: 146b89a2874c1410b470cf2e9c795af60915dc4b5b9aaaad40228823230e8c738292a7c480e873f5732a896cdd4aa502622c8df47fa21321b51894efd5948a16
+  data.tar.gz: 870019afb083c7a5864361335fc5294d941d47e4318f38f5acd548ee63bfde3f364928f8f71690bca76db5aa68255478bc205a91c79f5737bdbdb78ce77f073e

data/README.md

@@ -2,7 +2,7 @@
 
 A Ruby SDK for interacting with the Hyperliquid decentralized exchange API.
 
-This is v0.1.0 - a read-only implementation focusing on the Info API endpoints for market data, user information, and order book data.
+This is v0.1.0 - an alpha-stage read-only implementation focusing on the Info API endpoints for market data, user information, and order book data.
 
 ## Installation
 
@@ -93,11 +93,33 @@ status = sdk.info.order_status(user_address, order_id)
 # Custom timeout (default: 30 seconds)
 sdk = Hyperliquid.new(timeout: 60)
 
+# Enable retry logic for handling transient failures (default: disabled)
+sdk = Hyperliquid.new(retry_enabled: true)
+
+# Combine multiple configuration options
+sdk = Hyperliquid.new(testnet: true, timeout: 60, retry_enabled: true)
+
 # Check which environment you're using
 sdk.testnet?  # => false
 sdk.base_url  # => "https://api.hyperliquid.xyz"
 ```
 
+#### Retry Configuration
+
+By default, retry logic is **disabled** for predictable API behavior. When enabled, the SDK will automatically retry requests that fail due to:
+
+- Network connectivity issues (connection failed, timeouts)
+- Server errors (5xx status codes)
+- Rate limiting (429 status codes)
+
+**Retry Settings:**
+- Maximum retries: 2
+- Base interval: 0.5 seconds
+- Backoff factor: 2x (exponential backoff)
+- Randomness: ±50% to prevent thundering herd
+
+**Note:** Retries are disabled by default to avoid unexpected delays in time-sensitive trading applications. Enable only when you want automatic handling of transient failures.
+
 ### Error Handling
 
 The SDK provides comprehensive error handling:
@@ -141,6 +163,7 @@ Creates a new SDK instance.
 **Parameters:**
 - `testnet` (Boolean) - Use testnet instead of mainnet (default: false)  
 - `timeout` (Integer) - Request timeout in seconds (default: 30)
+- `retry_enabled` (Boolean) - Enable automatic retry logic for transient failures (default: false)
 
 ### Info API Methods
 
@@ -197,4 +220,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/carter
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/hyperliquid/client.rb

@@ -7,14 +7,13 @@ require 'json'
 module Hyperliquid
   # HTTP client for making requests to Hyperliquid API
   class Client
-    # TODO:
-    # Unused for now. To be added to build_connection
+    # Default retry configuration for API requests
     DEFAULT_RETRY_OPTIONS = {
       max: 2,
       interval: 0.5,
       interval_randomness: 0.5,
       backoff_factor: 2,
-      retry_statuses: [502, 503, 504],
+      retry_statuses: [429, 502, 503, 504],
       exceptions: [
         Faraday::ConnectionFailed,
         Faraday::TimeoutError
@@ -24,7 +23,9 @@ module Hyperliquid
     # Initialize a new HTTP client
     # @param base_url [String] The base URL for the API
     # @param timeout [Integer] Request timeout in seconds (default: Constants::DEFAULT_TIMEOUT)
-    def initialize(base_url:, timeout: Constants::DEFAULT_TIMEOUT)
+    # @param retry_enabled [Boolean] Whether to enable retry logic (default: false)
+    def initialize(base_url:, timeout: Constants::DEFAULT_TIMEOUT, retry_enabled: false)
+      @retry_enabled = retry_enabled
       @connection = build_connection(base_url, timeout)
     end
 
@@ -47,6 +48,10 @@ module Hyperliquid
       end
 
       handle_response(response)
+    rescue Faraday::RetriableResponse => e
+      # After retries are exhausted, Faraday throws a RetriableResponse
+      # Catch and handle that here to bubble up the actual network error
+      handle_response(e.response)
     rescue Faraday::ConnectionFailed => e
       raise NetworkError, "Connection failed: #{e.message}"
     rescue Faraday::TimeoutError => e
@@ -59,9 +64,7 @@ module Hyperliquid
       Faraday.new(url: base_url) do |conn|
         conn.options.timeout = timeout
         conn.options.read_timeout = Constants::DEFAULT_READ_TIMEOUT
-
-        # TODO:
-        # conn.request :retry, DEFAULT_RETRY_OPTIONS
+        conn.request :retry, DEFAULT_RETRY_OPTIONS if @retry_enabled
       end
     end
 

data/lib/hyperliquid/version.rb

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

data/lib/hyperliquid.rb

@@ -12,9 +12,10 @@ module Hyperliquid
   # Create a new SDK instance
   # @param testnet [Boolean] Whether to use testnet (default: false for mainnet)
   # @param timeout [Integer] Request timeout in seconds (default: 30)
+  # @param retry_enabled [Boolean] Whether to enable retry logic (default: false)
   # @return [Hyperliquid::SDK] A new SDK instance
-  def self.new(testnet: false, timeout: Constants::DEFAULT_TIMEOUT)
-    SDK.new(testnet: testnet, timeout: timeout)
+  def self.new(testnet: false, timeout: Constants::DEFAULT_TIMEOUT, retry_enabled: false)
+    SDK.new(testnet: testnet, timeout: timeout, retry_enabled: retry_enabled)
   end
 
   # Main SDK class
@@ -24,9 +25,10 @@ module Hyperliquid
     # Initialize the SDK
     # @param testnet [Boolean] Whether to use testnet (default: false for mainnet)
     # @param timeout [Integer] Request timeout in seconds
-    def initialize(testnet: false, timeout: Constants::DEFAULT_TIMEOUT)
+    # @param retry_enabled [Boolean] Whether to enable retry logic (default: false)
+    def initialize(testnet: false, timeout: Constants::DEFAULT_TIMEOUT, retry_enabled: false)
       base_url = testnet ? Constants::TESTNET_API_URL : Constants::MAINNET_API_URL
-      client = Client.new(base_url: base_url, timeout: timeout)
+      client = Client.new(base_url: base_url, timeout: timeout, retry_enabled: retry_enabled)
 
       @info = Info.new(client)
       @testnet = testnet

metadata

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