solana_rpc_ruby 1.1.1 → 1.2.0

data/lib/solana_rpc_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolanaRpcRuby
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/lib/solana_rpc_ruby/websocket_client.rb

@@ -27,7 +27,6 @@ module SolanaRpcRuby
       @client = websocket_client
       @cluster = cluster || SolanaRpcRuby.ws_cluster
       @retries = 0
-      @subscription_info = nil
 
       message = 'Websocket cluster is missing. Please provide default cluster in config or pass it to the client directly.'
       raise ArgumentError, message unless @cluster
@@ -59,11 +58,6 @@ module SolanaRpcRuby
           end
         end
 
-        # Uncomment to disconnect websocket.
-        # EM::Timer.new(2) do
-        #   ws.send(unsubscribe_body(body))
-        # end
-
         ws.on :open do |event|
           p [:open]
           p "Status: #{ws.status}"
@@ -79,7 +73,6 @@ module SolanaRpcRuby
           #   result = block_given? ? block.call(event.data) : event.data
           #   return result
           # end
-          @subscription_info = event.data unless @subscription_info
 
           if block_given?
             block.call(event.data)
@@ -114,16 +107,5 @@ module SolanaRpcRuby
       message = "#{e.class} #{e.message}\n Backtrace: \n #{e.backtrace}"
       fail ApiError.new(message: message)
     end
-
-    def unsubscribe_body(body)
-      method = JSON.parse(body)['method']
-      info = JSON.parse(@subscription_info)
-      
-      subscription_id = info['result']
-      id = info['id']
-      unsubscribe_method = method.gsub('Sub', 'Unsub')
-
-      create_json_body(unsubscribe_method, method_params: [subscription_id], id: id)
-    end
   end
 end

data/lib/solana_rpc_ruby/websocket_methods_wrapper.rb

@@ -29,7 +29,7 @@ module SolanaRpcRuby
     # @param cluster [String] cluster where requests will be sent.
     # @param id [Integer] unique client-generated identifying integer.
     def initialize(
-      websocket_client: WebsocketClient, 
+      websocket_client: WebsocketClient,
       cluster: SolanaRpcRuby.ws_cluster,
       id: rand(1...99_999)
     )
@@ -47,7 +47,7 @@ module SolanaRpcRuby
     #
     # @return [Integer] Subscription id (needed to unsubscribe)
     def account_subscribe(account_pubkey, commitment: nil, encoding: '', &block)
-      method = create_method_name(__method__) 
+      method = create_method_name(__method__)
 
       params = []
       params_hash = {}
@@ -56,7 +56,7 @@ module SolanaRpcRuby
 
       params << account_pubkey
       params << params_hash if params_hash.any?
-      
+
       subscribe(method, method_params: params, &block)
     end
 
@@ -71,6 +71,57 @@ module SolanaRpcRuby
       unsubscribe(method, subscription_id: subscription_id)
     end
 
+    # @see https://docs.solana.com/developing/clients/jsonrpc-api#blocksubscribe---unstable-disabled-by-default
+    # This subscription is unstable and only available if the validator was started with the --rpc-pubsub-enable-block-subscription flag. The format of this subscription may change in the future
+    #
+    # Subscribe to receive notification anytime a new block is Confirmed or Finalized.
+    #
+    # @param filter [String] # 'all' or public key as base-58 endcoded string
+    # @param commitment [String]
+    # @param encoding [String]
+    # @param transaction_details [String]
+    # @param show_rewards [Boolean]
+    # @param &block [Proc]
+    #
+    # @return [Integer] Subscription id (needed to unsubscribe)
+    def block_subscribe(
+      filter,
+      commitment: nil,
+      encoding: '',
+      transaction_details: '',
+      show_rewards: nil,
+      &block
+    )
+      method = create_method_name(__method__)
+
+      params = []
+      param_filter = nil
+      params_hash = {}
+
+      param_filter = filter == 'all' ? filter : { 'mentionsAccountOrProgram': filter}
+
+      params_hash['commitment'] = commitment unless blank?(commitment)
+      params_hash['encoding'] = encoding unless blank?(encoding)
+      params_hash['transactionDetails'] = transaction_details unless blank?(transaction_details)
+      params_hash['showRewards'] = show_rewards unless blank?(show_rewards)
+
+      params << param_filter
+      params << params_hash if params_hash.any?
+
+      subscribe(method, method_params: params, &block)
+    end
+
+    # @see https://docs.solana.com/developing/clients/jsonrpc-api#blockunsubscribe
+    # Unsubscribe from block notifications
+    #
+    # @param subscription_id [Integer]
+    #
+    # @return [Bool] unsubscribe success message
+    def block_unsubscribe(subscription_id)
+      method = create_method_name(__method__)
+      unsubscribe(method, subscription_id: subscription_id)
+    end
+
     # @see https://docs.solana.com/developing/clients/jsonrpc-api#logssubscribe
     # Subscribe to transaction logging
     #
@@ -81,15 +132,15 @@ module SolanaRpcRuby
     #
     # @return [Integer] Subscription id (needed to unsubscribe)
     def logs_subscribe(filter, commitment: nil, &block)
-      method = create_method_name(__method__) 
+      method = create_method_name(__method__)
 
       params = []
       params_hash = {}
       params_hash['commitment'] = commitment unless blank?(commitment)
-  
+
       params << filter
       params << params_hash
-      
+
       subscribe(method, method_params: params, &block)
     end
 
@@ -107,7 +158,7 @@ module SolanaRpcRuby
 
     # @see https://docs.solana.com/developing/clients/jsonrpc-api#programsubscribe
     # Subscribe to a program to receive notifications when the lamports or data for a given account owned by the program changes
-    # 
+    #
     # @param account_pubkey [String]
     # @param commitment [String]
     # @param encoding [String]
@@ -116,13 +167,13 @@ module SolanaRpcRuby
     #
     # @return [Integer] Subscription id (needed to unsubscribe)
     def program_subscribe(
-      program_id_pubkey, 
-      commitment: nil, 
-      encoding: '', 
+      program_id_pubkey,
+      commitment: nil,
+      encoding: '',
       filters: [],
       &block
     )
-      method = create_method_name(__method__) 
+      method = create_method_name(__method__)
 
       params = []
       params_hash = {}
@@ -132,7 +183,7 @@ module SolanaRpcRuby
 
       params << program_id_pubkey
       params << params_hash if params_hash.any?
-      
+
       subscribe(method, method_params: params, &block)
     end
 
@@ -149,7 +200,7 @@ module SolanaRpcRuby
     end
 
     # @see https://docs.solana.com/developing/clients/jsonrpc-api#signaturesubscribe
-    # Subscribe to a transaction signature to receive notification when the transaction is confirmed 
+    # Subscribe to a transaction signature to receive notification when the transaction is confirmed
     # On signatureNotification, the subscription is automatically cancelled
     #
     # @param transaction_signature [String]
@@ -158,19 +209,19 @@ module SolanaRpcRuby
     #
     # @return [Integer] Subscription id (needed to unsubscribe)
     def signature_subscribe(
-      transaction_signature, 
+      transaction_signature,
       commitment: nil,
       &block
     )
-      method = create_method_name(__method__) 
+      method = create_method_name(__method__)
 
       params = []
       params_hash = {}
       params_hash['commitment'] = commitment unless blank?(commitment)
-  
+
       params << transaction_signature
       params << params_hash
-      
+
       subscribe(method, method_params: params, &block)
     end
 
@@ -189,11 +240,11 @@ module SolanaRpcRuby
     # Subscribe to receive notification anytime a slot is processed by the validator
     #
     # @param &block [Proc]
-    # 
+    #
     # @return [Integer] Subscription id (needed to unsubscribe)
     def slot_subscribe(&block)
       method = create_method_name(__method__)
-      
+
       subscribe(method, &block)
     end
 
@@ -209,16 +260,16 @@ module SolanaRpcRuby
     end
 
     # @see https://docs.solana.com/developing/clients/jsonrpc-api#slotsupdatessubscribe---unstable
-    # 
+    #
     # This subscription is unstable; the format of this subscription may change in the future and it may not always be supported
     # Subscribe to receive a notification from the validator on a variety of updates on every slot
     #
     # @param &block [Proc]
-    # 
+    #
     # @return [Integer] Subscription id (needed to unsubscribe)
     def slots_updates_subscribe(&block)
       method = create_method_name(__method__)
-      
+
       subscribe(method, &block)
     end
 
@@ -234,15 +285,15 @@ module SolanaRpcRuby
     end
 
     # @see https://docs.solana.com/developing/clients/jsonrpc-api#rootsubscribe
-    # 
+    #
     # Subscribe to receive notification anytime a new root is set by the validator.
     #
     # @param &block [Proc]
-    # 
+    #
     # @return [Integer] Subscription id (needed to unsubscribe)
     def root_subscribe(&block)
       method = create_method_name(__method__)
-      
+
       subscribe(method, &block)
     end
 
@@ -258,19 +309,19 @@ module SolanaRpcRuby
     end
 
     # @see https://docs.solana.com/developing/clients/jsonrpc-api#votesubscribe---unstable-disabled-by-default
-    # 
-    # This subscription is unstable and only available if the validator was started with the --rpc-pubsub-enable-vote-subscription flag. 
+    #
+    # This subscription is unstable and only available if the validator was started with the --rpc-pubsub-enable-vote-subscription flag.
     # The format of this subscription may change in the future
-    # 
-    # Subscribe to receive notification anytime a new vote is observed in gossip. 
+    #
+    # Subscribe to receive notification anytime a new vote is observed in gossip.
     # These votes are pre-consensus therefore there is no guarantee these votes will enter the ledger.
     #
     # @param &block [Proc]
-    # 
+    #
     # @return [Integer] Subscription id (needed to unsubscribe)
     def vote_subscribe(&block)
       method = create_method_name(__method__)
-      
+
       subscribe(method, &block)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solana_rpc_ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Block Logic Team
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2022-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket
@@ -241,7 +241,7 @@ licenses:
 metadata:
   documentation_uri: https://www.rubydoc.info/github/Block-Logic/solana-rpc-ruby
   source_code_uri: https://github.com/Block-Logic/solana-rpc-ruby
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -256,8 +256,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
-signing_key:
+rubygems_version: 3.2.2
+signing_key: 
 specification_version: 4
 summary: Ruby wrapper for solana JSON RPC API.
 test_files: []