solana-ruby-web3js 1.0.1.beta1

data/lib/solana_ruby/web_socket_client.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'websocket-client-simple'
+require 'securerandom'
+require 'json'
+require_relative 'web_socket_handlers'
+Dir[File.join(__dir__, 'web_socket_methods', '*.rb')].each { |file| require file }
+
+module SolanaRuby
+  class WebSocketClient
+    include WebSocketHandlers
+    include WebSocketMethods::AccountMethods
+    include WebSocketMethods::LogMethods
+    include WebSocketMethods::SignatureMethods
+    include WebSocketMethods::RootMethods
+    include WebSocketMethods::SlotMethods
+    attr_reader :subscriptions
+
+    def initialize(url, auto_reconnect: true, reconnect_delay: 5)
+      @url = url
+      @subscriptions = {}
+      @auto_reconnect = auto_reconnect
+      @reconnect_delay = reconnect_delay
+      @connected = false
+      @ws = nil
+      connect
+    end
+
+    def connect
+      return if @connected
+
+      # Close existing WebSocket if it exists
+      @ws&.close if @ws
+
+      @ws = WebSocket::Client::Simple.connect(@url)
+      setup_handlers(@ws, self)
+      @connected = true
+    rescue StandardError => e
+      puts "Failed to connect: #{e.message}"
+      attempt_reconnect
+    end
+
+    def reconnect
+      @connected = false
+      connect
+    end
+
+    def subscribe(method, params = nil, &block)
+      id = SecureRandom.uuid
+      @subscriptions[id] = block
+      message = {
+        jsonrpc: '2.0',
+        id: id,
+        method: method
+      }
+      message[:params] = params if params
+      sleep 2
+      @ws.send(message.to_json)
+      id
+    end
+
+    def unsubscribe(method, subscription_id)
+      message = {
+        jsonrpc: '2.0',
+        id: SecureRandom.uuid,
+        method: method,
+        params: [subscription_id]
+      }
+      @ws.send(message.to_json)
+    end
+
+    def handle_message(data)
+      if data['id'] && @subscriptions[data['id']]
+        @subscriptions[data['id']].call(data['result'])
+      elsif data['method'] && data['params']
+        @subscriptions.each do |id, block|
+          block.call(data['params']) if block
+        end
+      else
+        puts "Unhandled message: #{data}"
+      end
+    end
+
+    def attempt_reconnect
+      return unless @auto_reconnect
+
+      puts "Attempting to reconnect in #{@reconnect_delay} seconds..."
+      @connected = false
+      sleep @reconnect_delay
+      reconnect
+    end
+  end
+end

data/lib/solana_ruby/web_socket_handlers.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SolanaRuby
+  module WebSocketHandlers
+    def setup_handlers(ws, client)
+      ws.on :message do |msg|
+        begin
+          data = JSON.parse(msg.data)
+          if data['error']
+            puts "Error: #{data['error']['message']} with the code #{data['error']['code']}"
+          else
+            client.handle_message(data)
+          end
+        rescue JSON::ParserError => e
+          puts "Failed to parse message: #{e.message}"
+        end
+      end
+
+      ws.on :open do
+        puts 'Web Socket connection established.'
+      end
+
+      ws.on :close do |e|
+        puts "Web Socket connection closed: #{e.inspect}"
+        client.attempt_reconnect if client.instance_variable_get(:@auto_reconnect)
+      end
+
+      ws.on :error do |e|
+        puts "Error: #{e.inspect}"
+        client.attempt_reconnect if client.instance_variable_get(:@auto_reconnect)
+      end
+    end
+  end
+end

data/lib/solana_ruby/web_socket_methods/account_methods.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module SolanaRuby
+  module WebSocketMethods
+    # Acccount Related Web Socket Methods
+    module AccountMethods
+      FINALIZED_OPTIONS = { commitment: "finalized" }.freeze
+      ENCODING_OPTIONS = { encoding: "base64" }.freeze
+
+      def on_account_change(pubkey, options = FINALIZED_OPTIONS, &block)
+        params = [pubkey, options]
+
+        subscribe("accountSubscribe", params) do |account_info|
+          block.call(account_info)
+        end
+      end
+
+      # Unsubscribe from account change updates
+      def remove_account_change_listener(subscription_id)
+        unsubscribe("accountUnsubscribe", subscription_id)
+        @subscriptions.delete(subscription_id)
+      end
+
+      def on_program_account_change(program_id, options = ENCODING_OPTIONS.merge(FINALIZED_OPTIONS), filters = [],
+                                    &block)
+        params = [program_id, options]
+        params.last[:filters] = filters unless filters.empty?
+        subscribe("programSubscribe", params, &block)
+      end
+
+      # Unsubscribe from program account change updates
+      def remove_program_account_listener(subscription_id)
+        unsubscribe("programUnsubscribe", subscription_id)
+      end
+    end
+  end
+end

data/lib/solana_ruby/web_socket_methods/log_methods.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SolanaRuby
+  module WebSocketMethods
+    # Log Related Web Socket Methods
+    module LogMethods
+      def on_logs(params = ["all"], &block)
+        subscribe("logsSubscribe", params, &block)
+      end
+
+      def on_logs_for_account(public_key, &block)
+        params = [{ mentions: [public_key] }]
+        on_logs(params, &block)
+      end
+
+      def on_logs_for_program(program_id, &block)
+        params = [{ mentions: [program_id] }]
+        on_logs(params, &block)
+      end
+
+      # Unsubscribe from logs updates
+      def remove_logs_listener(subscription_id)
+        unsubscribe("logsUnsubscribe", subscription_id)
+      end
+    end
+  end
+end

data/lib/solana_ruby/web_socket_methods/root_methods.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SolanaRuby
+  module WebSocketMethods
+    # Root Related Web Socket Methods
+    module RootMethods
+      def on_root_change(&block)
+        subscribe("rootSubscribe", [], &block)
+      end
+
+      def remove_root_listener(subscription_id)
+        unsubscribe("rootUnsubscribe", subscription_id)
+      end
+    end
+  end
+end

data/lib/solana_ruby/web_socket_methods/signature_methods.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SolanaRuby
+  module WebSocketMethods
+    # Signature Related Web Socket Methods
+    module SignatureMethods
+      FINALIZED_OPTIONS = { commitment: "finalized" }.freeze
+      BASE_64_ENCODING_OPTIONS = { encoding: "base64" }.freeze
+
+      def on_signature(signature, options = FINALIZED_OPTIONS, &block)
+        params = [signature, options]
+        subscribe("signatureSubscribe", params, &block)
+      end
+
+      def on_signature_with_options(signature, options = BASE_64_ENCODING_OPTIONS.merge(FINALIZED_OPTIONS), &block)
+        on_signature(signature, options, &block)
+      end
+
+      # Unsubscribe from signature updates
+      def remove_signature_listener(subscription_id)
+        unsubscribe("signatureUnsubscribe", subscription_id)
+      end
+    end
+  end
+end

data/lib/solana_ruby/web_socket_methods/slot_methods.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SolanaRuby
+  module WebSocketMethods
+    # Slot Related Web Socket Methods
+    module SlotMethods
+      # Subscribe to slot change notifications.
+      # Options can include parameters such as commitment level, encoding, etc.
+      def on_slot_change(&block)
+        # Default to empty params if no options are provided.
+        subscribe("slotSubscribe", [], &block)
+      end
+
+      # Unsubscribe from slot change notifications.
+      def remove_slot_change_listener(subscription_id)
+        unsubscribe("slotUnsubscribe", subscription_id)
+      end
+    end
+  end
+end

data/lib/solana_ruby.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "solana_ruby/version"
+require_relative "solana_ruby/http_client"
+require_relative "solana_ruby/web_socket_client"
+# Dir["solana_ruby/*.rb"].each { |f| require_relative f.delete(".rb") }
+
+module SolanaRuby
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: solana-ruby-web3js
+version: !ruby/object:Gem::Version
+  version: 1.0.1.beta1
+platform: ruby
+authors:
+- BuildSquad
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: websocket-client-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: base58
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem allows to use JSON RPC API Methods from solana.
+email:
+- engineering@buildsquad.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/.DS_Store
+- lib/solana_ruby.rb
+- lib/solana_ruby/.DS_Store
+- lib/solana_ruby/base_client.rb
+- lib/solana_ruby/http_client.rb
+- lib/solana_ruby/http_methods/account_methods.rb
+- lib/solana_ruby/http_methods/basic_methods.rb
+- lib/solana_ruby/http_methods/block_methods.rb
+- lib/solana_ruby/http_methods/blockhash_methods.rb
+- lib/solana_ruby/http_methods/lookup_table_methods.rb
+- lib/solana_ruby/http_methods/signature_methods.rb
+- lib/solana_ruby/http_methods/slot_methods.rb
+- lib/solana_ruby/http_methods/token_methods.rb
+- lib/solana_ruby/http_methods/transaction_methods.rb
+- lib/solana_ruby/version.rb
+- lib/solana_ruby/web_socket_client.rb
+- lib/solana_ruby/web_socket_handlers.rb
+- lib/solana_ruby/web_socket_methods/account_methods.rb
+- lib/solana_ruby/web_socket_methods/log_methods.rb
+- lib/solana_ruby/web_socket_methods/root_methods.rb
+- lib/solana_ruby/web_socket_methods/signature_methods.rb
+- lib/solana_ruby/web_socket_methods/slot_methods.rb
+homepage: https://github.com/Build-Squad/solana-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Build-Squad/solana-ruby
+  source_code_uri: https://github.com/Build-Squad/solana-ruby
+  documentation_uri: https://www.rubydoc.info/gems/solana-ruby-web3js
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.20
+signing_key:
+specification_version: 4
+summary: Solana Ruby SDK
+test_files: []