solana_rpc_ruby 1.0.0 → 1.1.2

data/lib/solana_rpc_ruby/websocket_methods_wrapper.rb

@@ -0,0 +1,300 @@
+require 'json'
+require_relative 'request_body'
+require_relative 'helper_methods'
+
+module SolanaRpcRuby
+  ##
+  # WebsocketsMethodsWrapper class serves as a wrapper for solana JSON RPC API websocket methods.
+  # All informations about params:
+  # @see https://docs.solana.com/developing/clients/jsonrpc-api#subscription-websocket
+  class WebsocketsMethodsWrapper
+    include RequestBody
+    include HelperMethods
+
+    # Determines which cluster will be used to send requests.
+    # @return [SolanaRpcRuby::WebsocketClient]
+    attr_accessor :websocket_client
+
+    # Cluster where requests will be sent.
+    # @return [String]
+    attr_accessor :cluster
+
+    # Unique client-generated identifying integer.
+    # @return [Integer]
+    attr_accessor :id
+
+    # Initialize object with cluster address where requests will be sent.
+    #
+    # @param api_client [ApiClient]
+    # @param cluster [String] cluster where requests will be sent.
+    # @param id [Integer] unique client-generated identifying integer.
+    def initialize(
+      websocket_client: WebsocketClient, 
+      cluster: SolanaRpcRuby.ws_cluster,
+      id: rand(1...99_999)
+    )
+      @websocket_client = websocket_client.new(cluster: cluster)
+      @id = id
+    end
+
+    # @see https://docs.solana.com/developing/clients/jsonrpc-api#accountsubscribe
+    # Subscribe to an account to receive notifications when the lamports or data for a given account public key changes
+    #
+    # @param account_pubkey [String]
+    # @param commitment [String]
+    # @param encoding [String]
+    # @param &block [Proc]
+    #
+    # @return [Integer] Subscription id (needed to unsubscribe)
+    def account_subscribe(account_pubkey, commitment: nil, encoding: '', &block)
+      method = create_method_name(__method__) 
+
+      params = []
+      params_hash = {}
+      params_hash['commitment'] = commitment unless blank?(commitment)
+      params_hash['encoding'] = encoding unless blank?(encoding)
+
+      params << account_pubkey
+      params << params_hash if params_hash.any?
+      
+      subscribe(method, method_params: params, &block)
+    end
+
+    # @see https://docs.solana.com/developing/clients/jsonrpc-api#accountunsubscribe
+    # Unsubscribe from account change notifications
+    #
+    # @param subscription_id [Integer]
+    #
+    # @return [Bool] unsubscribe success message
+    def account_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
+    #
+    # @param filter [String]|[Hash]
+    # @option filter [Array] :mentions
+    # @param commitment [String]
+    # @param &block [Proc]
+    #
+    # @return [Integer] Subscription id (needed to unsubscribe)
+    def logs_subscribe(filter, commitment: nil, &block)
+      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
+
+    # @see https://docs.solana.com/developing/clients/jsonrpc-api#logsunsubscribe
+    # Unsubscribe from transaction logging
+    #
+    # @param subscription_id [Integer]
+    #
+    # @return [Bool] unsubscribe success message
+
+    def logs_unsubscribe(subscription_id)
+      method = create_method_name(__method__)
+      unsubscribe(method, subscription_id: subscription_id)
+    end
+
+    # @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]
+    # @param filters [Array]
+    # @param &block [Proc]
+    #
+    # @return [Integer] Subscription id (needed to unsubscribe)
+    def program_subscribe(
+      program_id_pubkey, 
+      commitment: nil, 
+      encoding: '', 
+      filters: [],
+      &block
+    )
+      method = create_method_name(__method__) 
+
+      params = []
+      params_hash = {}
+      params_hash['commitment'] = commitment unless blank?(commitment)
+      params_hash['encoding'] = encoding unless blank?(encoding)
+      params_hash['filters'] = filters unless blank?(filters)
+
+      params << program_id_pubkey
+      params << params_hash if params_hash.any?
+      
+      subscribe(method, method_params: params, &block)
+    end
+
+    # @see https://docs.solana.com/developing/clients/jsonrpc-api#programunsubscribe
+    # Unsubscribe from program-owned account change notifications
+    #
+    # @param subscription_id [Integer]
+    #
+    # @return [Bool] unsubscribe success message
+
+    def program_unsubscribe(subscription_id)
+      method = create_method_name(__method__)
+      unsubscribe(method, subscription_id: subscription_id)
+    end
+
+    # @see https://docs.solana.com/developing/clients/jsonrpc-api#signaturesubscribe
+    # Subscribe to a transaction signature to receive notification when the transaction is confirmed 
+    # On signatureNotification, the subscription is automatically cancelled
+    #
+    # @param transaction_signature [String]
+    # @param commitment [String]
+    # @param &block [Proc]
+    #
+    # @return [Integer] Subscription id (needed to unsubscribe)
+    def signature_subscribe(
+      transaction_signature, 
+      commitment: nil,
+      &block
+    )
+      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
+
+    # @see https://docs.solana.com/developing/clients/jsonrpc-api#signatureunsubscribe
+    # Unsubscribe from signature confirmation notification
+    #
+    # @param subscription_id [Integer]
+    #
+    # @return [Bool] unsubscribe success message
+    def signature_unsubscribe(subscription_id)
+      method = create_method_name(__method__)
+      unsubscribe(method, subscription_id: subscription_id)
+    end
+
+    # @see https://docs.solana.com/developing/clients/jsonrpc-api#slotsubscribe
+    # 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
+
+    # @see https://docs.solana.com/developing/clients/jsonrpc-api#slotunsubscribe
+    # Unsubscribe from slot notifications
+    #
+    # @param subscription_id [Integer]
+    #
+    # @return [Bool] unsubscribe success message
+    def slot_unsubscribe(subscription_id)
+      method = create_method_name(__method__)
+      unsubscribe(method, subscription_id: subscription_id)
+    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
+
+    # @see https://docs.solana.com/developing/clients/jsonrpc-api#slotsupdatesunsubscribe
+    # Unsubscribe from slot-update notifications
+    #
+    # @param subscription_id [Integer]
+    #
+    # @return [Bool] unsubscribe success message
+    def slots_updates_unsubscribe(subscription_id)
+      method = create_method_name(__method__)
+      unsubscribe(method, subscription_id: subscription_id)
+    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
+
+    # @see https://docs.solana.com/developing/clients/jsonrpc-api#rootunsubscribe
+    # Unsubscribe from root notifications
+    #
+    # @param subscription_id [Integer]
+    #
+    # @return [Bool] unsubscribe success message
+    def root_unsubscribe(subscription_id)
+      method = create_method_name(__method__)
+      unsubscribe(method, subscription_id: subscription_id)
+    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. 
+    # The format of this subscription may change in the future
+    # 
+    # 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
+
+    # @see https://docs.solana.com/developing/clients/jsonrpc-api#rootunsubscribe
+    # Unsubscribe from vote notifications
+    #
+    # @param subscription_id [Integer]
+    #
+    # @return [Bool] unsubscribe success message
+    def vote_unsubscribe(subscription_id)
+      method = create_method_name(__method__)
+      unsubscribe(method, subscription_id: subscription_id)
+    end
+
+    private
+
+    def subscribe(method, method_params: [], &block)
+      body = create_json_body(method, method_params: method_params)
+      @websocket_client.connect(body, &block)
+    end
+
+    def unsubscribe(method, subscription_id:)
+      body = create_json_body(method, method_params: [subscription_id])
+      @websocket_client.connect(body)
+    end
+  end
+end

data/lib/solana_rpc_ruby.rb

@@ -2,6 +2,8 @@ require_relative 'solana_rpc_ruby/api_client'
 require_relative 'solana_rpc_ruby/api_error'
 require_relative 'solana_rpc_ruby/methods_wrapper'
 require_relative 'solana_rpc_ruby/response'
+require_relative 'solana_rpc_ruby/websocket_client'
+require_relative 'solana_rpc_ruby/websocket_methods_wrapper'
 
 # Namespace for classes and modules that handle connection with solana JSON RPC API.
 module SolanaRpcRuby 
@@ -10,6 +12,10 @@ module SolanaRpcRuby
     # @return [String] cluster address.
     attr_accessor :cluster
 
+    # Default websocket cluster address that will be used if not passed.
+    # @return [String] websocket cluster address.
+    attr_accessor :ws_cluster
+
     # Default json rpc version that will be used.
     # @return [String] json rpc version.
     attr_accessor :json_rpc_version

data/solana_rpc_ruby.gemspec

@@ -28,14 +28,16 @@ Gem::Specification.new do |spec|
     'source_code_uri' => 'https://github.com/Block-Logic/solana-rpc-ruby'
   }
 
+  spec.add_dependency 'faye-websocket', '~> 0.11'
+
   spec.add_development_dependency 'rubocop', '~> 1.15'
   spec.add_development_dependency 'rubocop-performance', '~> 1.11'
   spec.add_development_dependency 'rubocop-rspec', '~> 2.3'
-  spec.add_development_dependency 'pry', '~> 0.13.1'
+  spec.add_development_dependency 'pry', '~> 0.14'
 
   spec.add_development_dependency 'codecov', '~> 0.4'
   spec.add_development_dependency 'dotenv', '~> 2.7'
-  spec.add_development_dependency 'rails', '~> 6.1.3'
+  spec.add_development_dependency 'rails', '~> 6.1'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.10'
   spec.add_development_dependency 'rspec-rails', '~> 4.0'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: solana_rpc_ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Block Logic Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-15 00:00:00.000000000 Z
+date: 2021-10-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.3
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.3
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -218,6 +232,8 @@ files:
 - lib/solana_rpc_ruby/request_body.rb
 - lib/solana_rpc_ruby/response.rb
 - lib/solana_rpc_ruby/version.rb
+- lib/solana_rpc_ruby/websocket_client.rb
+- lib/solana_rpc_ruby/websocket_methods_wrapper.rb
 - solana_rpc_ruby.gemspec
 homepage: https://github.com/Block-Logic/solana-rpc-ruby
 licenses:
@@ -240,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.2
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for solana JSON RPC API.