solana-ruby 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 301f452c31d1989f2565adbf428c90081ca667eac36089e7b0817807a22d1a87
-  data.tar.gz: dfec2238bd6552db7b625f3016619837d57bd15735ef2c447b98acb3cad97a31
+  metadata.gz: '0009e34787d1786fde5b184a9e9d4ba090b52175abd8cc5d2efba47dbbc8eea9'
+  data.tar.gz: 3761ee4dcb2b182b8469c60814045581180770e555844dc74caf27ef27c3364a
 SHA512:
-  metadata.gz: 4a655cc6132c2c281e7aa798785a33b1cbb10754940d82d17f1ec33d34ce847d3bec11f4ac35a038973cc976e0e69c8b95b4fabaea0d6d007504e536dfe0c390
-  data.tar.gz: 3af5cefad5a04134b07cc0562a2ed3ed7720cb1d1289b89483480686f181ddc719ec72d9e3a5320d1b7ec46f4446e2e6d6acdd69e7c30e805056d60317a50bf4
+  metadata.gz: 77af58126eb32a211745baa0e1ce8d9a22249723bd2e77f4669d497e841ba7f55c74d0e5cb464f0ee75a195351a4ae1f73bf82677d3bcb19ad09d891088ab773
+  data.tar.gz: 70694ab44025b3fe3ad4310f5e49f1649fabb6254c766a369ae4da4f2c8b4bb15a8c6f0c8d2ecd1f9b9803e5c907d62949cc463b16634a8ac0ae7b2ee93a4f2c

data/lib/solana-ruby/client.rb

@@ -1,6 +1,7 @@
 require 'faye/websocket'
 require 'httpx'
 require 'json'
+require 'thread'
 
 require_relative 'utils'
 
@@ -81,19 +82,18 @@ module Solana
     # @param [Integer] slot_number The slot number of the block.
     # @param [Hash] options Optional parameters for the request.
     # @return [Integer] The estimated production time in seconds.
-    def get_block_time(slot_number, options = {}, &block)
-      request_http('getBlockTime', [slot_number, options], &block)
+    def get_block_time(slot_number, &block)
+      request_http('getBlockTime', [slot_number], &block)
     end
 
     ##
     # Retrieves a list of confirmed blocks between two slot numbers.
     #
     # @param [Integer] start_slot The start slot number.
-    # @param [Integer] end_slot The end slot number.
     # @param [Hash] options Optional parameters for the request.
     # @return [Array<Integer>] The list of confirmed blocks.
-    def get_blocks(start_slot, end_slot, options = {}, &block)
-      request_http('getBlocks', [start_slot, end_slot, options], &block)
+    def get_blocks(start_slot, options = {}, &block)
+      request_http('getBlocks', [start_slot, options], &block)
     end
 
     ##
@@ -110,10 +110,9 @@ module Solana
     ##
     # Retrieves the list of cluster nodes.
     #
-    # @param [Hash] options Optional parameters for the request.
     # @return [Array<Hash>] The list of cluster nodes.
-    def get_cluster_nodes(options = {}, &block)
-      request_http('getClusterNodes', [options], &block)
+    def get_cluster_nodes(&block)
+      request_http('getClusterNodes', &block)
     end
 
     ##
@@ -128,10 +127,9 @@ module Solana
     ##
     # Retrieves the epoch schedule.
     #
-    # @param [Hash] options Optional parameters for the request.
     # @return [Hash] The epoch schedule.
-    def get_epoch_schedule(options = {}, &block)
-      request_http('getEpochSchedule', [options], &block)
+    def get_epoch_schedule(&block)
+      request_http('getEpochSchedule', &block)
     end
 
     ##
@@ -147,46 +145,41 @@ module Solana
     ##
     # Retrieves the slot of the first available block.
     #
-    # @param [Hash] options Optional parameters for the request.
     # @return [Integer] The slot of the first available block.
-    def get_first_available_block(options = {}, &block)
-      request_http('getFirstAvailableBlock', [options], &block)
+    def get_first_available_block(&block)
+      request_http('getFirstAvailableBlock', &block)
     end
 
     ##
     # Retrieves the genesis hash.
     #
-    # @param [Hash] options Optional parameters for the request.
     # @return [String] The genesis hash.
-    def get_genesis_hash(options = {}, &block)
-      request_http('getGenesisHash', [options], &block)
+    def get_genesis_hash(&block)
+      request_http('getGenesisHash', &block)
     end
 
     ##
     # Checks the health of the node.
     #
-    # @param [Hash] options Optional parameters for the request.
     # @return [String] The health status of the node.
-    def get_health(options = {}, &block)
-      request_http('getHealth', [options], &block)
+    def get_health(&block)
+      request_http('getHealth', &block)
     end
 
     ##
     # Retrieves the highest snapshot slot.
     #
-    # @param [Hash] options Optional parameters for the request.
     # @return [Integer] The highest snapshot slot.
-    def get_highest_snapshot_slot(options = {}, &block)
-      request_http('getHighestSnapshotSlot', [options], &block)
+    def get_highest_snapshot_slot(&block)
+      request_http('getHighestSnapshotSlot', &block)
     end
 
     ##
     # Retrieves the identity of the node.
     #
-    # @param [Hash] options Optional parameters for the request.
     # @return [Hash] The identity information of the node.
-    def get_identity(options = {}, &block)
-      request_http('getIdentity', [options], &block)
+    def get_identity(&block)
+      request_http('getIdentity', &block)
     end
 
     ##
@@ -201,10 +194,9 @@ module Solana
     ##
     # Retrieves the current inflation rate.
     #
-    # @param [Hash] options Optional parameters for the request.
     # @return [Hash] The inflation rate.
-    def get_inflation_rate(options = {}, &block)
-      request_http('getInflationRate', [options], &block)
+    def get_inflation_rate(&block)
+      request_http('getInflationRate', &block)
     end
 
     ##
@@ -235,31 +227,30 @@ module Solana
       request_http('getLatestBlockhash', [options], &block)
     end
 
+    ## TODO
     ##
     # Retrieves the leader schedule.
     #
     # @param [Hash] options Optional parameters for the request.
     # @return [Hash] The leader schedule.
-    def get_leader_schedule(options = {}, &block)
-      request_http('getLeaderSchedule', [options], &block)
+    def get_leader_schedule(slot_number = nil, options = {}, &block)
+      request_http('getLeaderSchedule', [slot_number, options], &block)
     end
 
     ##
     # Retrieves the maximum retransmit slot.
     #
-    # @param [Hash] options Optional parameters for the request.
     # @return [Integer] The maximum retransmit slot.
-    def get_max_retransmit_slot(options = {}, &block)
-      request_http('getMaxRetransmitSlot', [options], &block)
+    def get_max_retransmit_slot(&block)
+      request_http('getMaxRetransmitSlot', &block)
     end
 
     ##
     # Retrieves the maximum shred insert slot.
     #
-    # @param [Hash] options Optional parameters for the request.
     # @return [Integer] The maximum shred insert slot.
-    def get_max_shred_insert_slot(options = {}, &block)
-      request_http('getMaxShredInsertSlot', [options], &block)
+    def get_max_shred_insert_slot(&block)
+      request_http('getMaxShredInsertSlot', &block)
     end
 
     ##
@@ -297,8 +288,8 @@ module Solana
     #
     # @param [Hash] options Optional parameters for the request.
     # @return [Array<Hash>] The recent performance samples.
-    def get_recent_performance_samples(options = {}, &block)
-      request_http('getRecentPerformanceSamples', [options], &block)
+    def get_recent_performance_samples(limit = 720, options = {}, &block)
+      request_http('getRecentPerformanceSamples', [limit, options], &block)
     end
 
     ##
@@ -306,8 +297,8 @@ module Solana
     #
     # @param [Hash] options Optional parameters for the request.
     # @return [Hash] The recent prioritization fees.
-    def get_recent_prioritization_fees(options = {}, &block)
-      request_http('getRecentPrioritizationFees', [options], &block)
+    def get_recent_prioritization_fees(addresses = [], &block)
+      request_http('getRecentPrioritizationFees', [addresses], &block)
     end
 
     ##
@@ -419,6 +410,7 @@ module Solana
       request_http('getTokenAccountsByOwner', [owner, opts, options], &block)
     end
 
+    ## TODO
     ##
     # Retrieves the largest accounts for a given token.
     #
@@ -490,8 +482,8 @@ module Solana
     #
     # @param [Hash] options Optional parameters for the request.
     # @return [Integer] The minimum ledger slot.
-    def minimum_ledger_slot(options = {}, &block)
-      request_http('minimumLedgerSlot', [options], &block)
+    def minimum_ledger_slot(&block)
+      request_http('minimumLedgerSlot', &block)
     end
 
     ##
@@ -509,9 +501,10 @@ module Solana
     # Sends a transaction.
     #
     # @param [Hash] transaction The transaction to send.
+    # @param [Hash] options Optional parameters for the request.
     # @return [Hash] The response from the send transaction request.
-    def send_transaction(transaction, &block)
-      request_http('sendTransaction', [transaction.to_json], &block)
+    def send_transaction(transaction, options = {}, &block)
+      request_http('sendTransaction', [transaction.to_json, options], &block)
     end
 
     ##
@@ -548,8 +541,8 @@ module Solana
     #
     # @param [Hash] options Optional parameters for the subscription.
     # @yield [Object] The response from the subscription.
-    def block_subscribe(options = {}, &block)
-      request_ws('blockSubscribe', [options], &block)
+    def block_subscribe(filter, options = {}, &block)
+      request_ws('blockSubscribe', [filter, options], &block)
     end
 
     ##
@@ -688,11 +681,16 @@ module Solana
 
     private
     ##
-    # Sends a JSON-RPC request to the Solana API.
+    # Sends a JSON-RPC request to the Solana API over HTTP.
+    #
+    # This method constructs a JSON-RPC request and sends it to the Solana API endpoint using HTTP.
+    # It then handles the response asynchronously.
     #
     # @param [String] method The RPC method to call.
     # @param [Array] params The parameters for the RPC method.
     # @yield [Object] The parsed response from the API.
+    # @return [Object, nil] The parsed response from the API if no block is given, otherwise nil.
+    # @raise [RuntimeError] If the request fails (non-success response).
     def request_http(method, params = nil, &block)
       body = {
         jsonrpc: '2.0',
@@ -711,12 +709,16 @@ module Solana
     ##
     # Handles the API response, checking for success and parsing the result.
     #
-    # @param [Faraday::Response] response The HTTP response object.
-    # @raise [RuntimeError] If the request fails (non-success response).
+    # This method processes the HTTP response from the Solana API, checking if the request was successful.
+    # If successful, it parses the JSON response and yields the result to the provided block.
+    #
+    # @param [HTTPX::Response] response The HTTP response object.
     # @yield [Object] The parsed result from the API response.
+    # @return [Object] The parsed result from the API response.
+    # @raise [RuntimeError] If the request fails (non-success response).
     def handle_response_http(response, &block)
       if response.status == 200
-        result = JSON.parse(response.body)['result']
+        result = JSON.parse(response.body)
         if block_given?
           yield result
         else
@@ -730,11 +732,16 @@ module Solana
     ##
     # Sends a JSON-RPC request to the Solana API over WebSocket.
     #
+    # This method constructs a JSON-RPC request and sends it to the Solana API endpoint using WebSocket.
+    # It then handles the response asynchronously, providing the result to the provided block or returning it via a queue.
+    #
     # @param [String] method The RPC method to call.
     # @param [Array] params The parameters for the RPC method.
     # @yield [Object] The parsed response from the API.
-
+    # @return [Object, nil] The parsed response from the API if no block is given, otherwise nil.
+    # @raise [RuntimeError] If the WebSocket connection fails or an error occurs during communication.
     def request_ws(method, params = nil, &block)
+      result_queue = Queue.new
       EM.run do
         ws = Faye::WebSocket::Client.new(@api_endpoint::WS)
 
@@ -751,7 +758,11 @@ module Solana
 
         ws.on :message do |event|
           response = JSON.parse(event.data)
-          yield response['result'] if block_given?
+          if block_given?
+            yield response['result']
+          else
+            result_queue.push(response['result'])
+          end
           ws.close
         end
 
@@ -762,10 +773,12 @@ module Solana
 
         ws.on :error do |event|
           puts "WebSocket error: #{event.message}"
+          result_queue.push(nil)
           ws = nil
           EM.stop
         end
       end
+      result_queue.pop unless block_given?
     end
   end
 end

data/lib/solana-ruby/version.rb

@@ -1,3 +1,3 @@
 module Solana
-    VERSION = '0.1.2'.freeze
+    VERSION = '0.1.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solana-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Fabrice Renard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-30 00:00:00.000000000 Z
+date: 2024-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpx