cryptum 0.0.230

data/lib/cryptum/ui/ticker.rb

@@ -0,0 +1,317 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Cryptum
+  # This plugin is used to Refresh the Cryptum console UI
+  module UI
+    module Ticker
+      public_class_method def self.refresh(opts = {})
+        option_choice = opts[:option_choice]
+        start_time = opts[:start_time]
+        ticker_win = opts[:ticker_win]
+        key_press_event = opts[:key_press_event]
+        order_book = opts[:order_book]
+        event = opts[:event]
+
+        this_product = order_book[:this_product]
+        quote_increment = this_product[:quote_increment]
+        fiat_smallest_decimal = quote_increment.to_s.split('.')[-1].length
+
+        symbol_out = "#{this_product[:id]}.#{option_choice.market_trend_reset}s"
+        fiat = this_product[:quote_currency].to_sym
+        fiat_symbol = '?'
+        fiat_symbol = '$' if fiat == :USD
+        fiat_symbol = "\u20ac" if fiat == :EUR
+
+        last_ticker_price = order_book[:ticker_price].to_f
+        second_to_last_ticker_price = order_book[:ticker_price_second_to_last].to_f
+
+        sequence = event[:sequence].to_i
+        last_sequence = order_book[:sequence].to_i
+
+        raise "ERROR: Sequence Order Mismatch - #{last_sequence} #{sequence}" unless sequence >= last_sequence
+
+        order_book[:sequence] = sequence
+        open_24h = event[:open_24h].to_f
+        order_book[:open_24h] = open_24h
+
+        open_24h_out = "#{Cryptum.open_symbol} #{fiat_symbol}#{format("%0.#{fiat_smallest_decimal}f", open_24h)}"
+
+        beautify_ticker = Cryptum.beautify_large_number(
+          value: format("%0.#{fiat_smallest_decimal}f", event[:price].to_f)
+        )
+        ticker_fmt = "#{fiat_symbol}#{beautify_ticker}"
+        if last_ticker_price.zero?
+          ticker_price_color = :white
+          ticker_price_out = "#{Cryptum.flat_arrow} #{ticker_fmt}"
+        elsif last_ticker_price < event[:price].to_f
+          ticker_price_color = :green
+          ticker_price_out = "#{Cryptum.up_arrow} #{ticker_fmt}"
+        elsif last_ticker_price > event[:price].to_f
+          ticker_price_color = :red
+          ticker_price_out = "#{Cryptum.down_arrow} #{ticker_fmt}"
+        else
+          ticker_price_color = :yellow
+          ticker_price_out = "#{Cryptum.flat_arrow} #{ticker_fmt}"
+        end
+
+        order_book[:ticker_price_third_to_last] = format("%0.#{fiat_smallest_decimal}f", second_to_last_ticker_price)
+        order_book[:ticker_price_second_to_last] = format("%0.#{fiat_smallest_decimal}f", last_ticker_price)
+        order_book[:ticker_price] = format("%0.#{fiat_smallest_decimal}f", event[:price].to_f)
+
+        volume_24h = format('%0.7f', event[:volume_24h])
+        volume_24h_out = Cryptum.beautify_large_number(
+          value: volume_24h
+        )
+        order_book[:volume_24h] = volume_24h
+
+        volume_30d = format('%0.7f', event[:volume_30d])
+        volume_30d_out = Cryptum.beautify_large_number(
+          value: volume_30d
+        )
+
+        # TODO: Potential for RACE CONDITIONS - MIGRATE TO
+        # Cryptum::Event.parse
+        # Indicate if 24 Hour High is Reached During Sesssion
+        high_24h = format(
+          "%0.#{fiat_smallest_decimal}f",
+          event[:high_24h]
+        )
+        high_24h_out = Cryptum.beautify_large_number(
+          value: high_24h
+        )
+        order_book[:high_24h] = high_24h
+
+        low_24h = format(
+          "%0.#{fiat_smallest_decimal}f",
+          event[:low_24h]
+        )
+        low_24h_out = Cryptum.beautify_large_number(
+          value: low_24h
+        )
+        order_book[:low_24h] = low_24h
+        margin_percent_open_24h = (1 - (open_24h / order_book[:ticker_price].to_f)) * 100
+
+        beautify_margin_percent_open_24h = Cryptum.beautify_large_number(
+          value: format('%0.4f', margin_percent_open_24h)
+        )
+        if margin_percent_open_24h.positive?
+          margin_percent_open_24h_color = :green
+          margin_percent_open_24h_out = "#{Cryptum.up_arrow} #{beautify_margin_percent_open_24h}%"
+        elsif margin_percent_open_24h.negative?
+          # Space removed to account for negative number.
+          margin_percent_open_24h_color = :red
+          margin_percent_open_24h_out = "#{Cryptum.down_arrow}#{beautify_margin_percent_open_24h}%"
+        else
+          margin_percent_open_24h_color = :yellow
+          margin_percent_open_24h_out = "#{Cryptum.flat_arrow} #{beautify_margin_percent_open_24h}%"
+        end
+
+        current_time_out = Time.now.strftime('%Y-%m-%d %H:%M:%S%z')
+
+        order_history = order_book[:order_history]
+        open_sell_orders = order_history.select do |order|
+          order[:status] == 'open' &&
+          order[:side] == 'sell'
+        end
+
+        sorted_open_sell_orders = open_sell_orders.sort_by do |order|
+          order[:price].to_f
+        end
+
+        lowest_selling_price = '0.00'
+        highest_selling_price = '0.00'
+        lowest_selling_price = sorted_open_sell_orders.first[:price] unless sorted_open_sell_orders.empty?
+        highest_selling_price = sorted_open_sell_orders.last[:price] unless sorted_open_sell_orders.empty?
+        lowest_selling_price_out = Cryptum.beautify_large_number(
+          value: format(
+            "%0.#{fiat_smallest_decimal}f",
+            lowest_selling_price
+          )
+        )
+
+        highest_selling_price_out = Cryptum.beautify_large_number(
+          value: format(
+            "%0.#{fiat_smallest_decimal}f",
+            highest_selling_price
+          )
+        )
+        # TODO: Everything Above this Line Needs to be Indicators ^
+
+        # UI
+        col_just1 = 15
+        col_just2 = 14
+        col_just3 = 21
+        col_just3_alt = (Curses.cols - Cryptum::UI.col_third) - 1
+        col_just4 = (Curses.cols - Cryptum::UI.col_fourth) - 1
+
+        Cryptum::UI.detect_key_press_in_ui(
+          key_press_event: key_press_event,
+          ui_win: ticker_win
+        )
+
+        # ROW 1
+        out_line_no = 0
+        Cryptum::UI.line(
+          ui_win: ticker_win,
+          out_line_no: out_line_no
+        )
+
+        out_line_no += 1
+        ticker_win.setpos(out_line_no, Cryptum::UI.col_first)
+        ticker_win.clrtoeol
+        if Curses.can_change_color?
+          Cryptum::UI.colorize(
+            ui_win: ticker_win,
+            color: :rainbow,
+            style: :bold,
+            string: symbol_out.ljust(col_just1)
+          )
+        else
+          Cryptum::UI.colorize(
+            ui_win: ticker_win,
+            color: :yellow,
+            style: :bold,
+            string: symbol_out.ljust(col_just1)
+          )
+        end
+
+        ticker_win.setpos(out_line_no, Cryptum::UI.col_second)
+        Cryptum::UI.colorize(
+          ui_win: ticker_win,
+          color: margin_percent_open_24h_color,
+          style: :bold,
+          string: margin_percent_open_24h_out.ljust(col_just2)
+        )
+
+        ticker_win.setpos(out_line_no, Cryptum::UI.col_third)
+        Cryptum::UI.colorize(
+          ui_win: ticker_win,
+          color: :blue,
+          style: :bold,
+          string: open_24h_out.ljust(col_just3)
+        )
+
+        ticker_win.setpos(out_line_no, Cryptum::UI.col_fourth)
+        Cryptum::UI.colorize(
+          ui_win: ticker_win,
+          color: ticker_price_color,
+          style: :bold,
+          string: ticker_price_out.rjust(col_just4)
+        )
+
+        # ROW 2
+        out_line_no += 1
+        ticker_win.setpos(out_line_no, Cryptum::UI.col_first)
+        ticker_win.clrtoeol
+        Cryptum::UI.colorize(
+          ui_win: ticker_win,
+          color: :white,
+          style: :bold,
+          string: 'Highest | Lowest Sell Price:'
+        )
+
+        ticker_win.setpos(out_line_no, Cryptum::UI.col_third)
+        Cryptum::UI.colorize(
+          ui_win: ticker_win,
+          color: :white,
+          style: :bold,
+          string: "$#{highest_selling_price_out} | $#{lowest_selling_price_out}".rjust(
+            col_just3_alt,
+            '.'
+          )
+        )
+
+        # ROW 2
+        out_line_no += 1
+        ticker_win.setpos(out_line_no, Cryptum::UI.col_first)
+        ticker_win.clrtoeol
+        Cryptum::UI.colorize(
+          ui_win: ticker_win,
+          color: :green,
+          style: :bold,
+          string: '24 Hr High:'
+        )
+
+        ticker_win.setpos(out_line_no, Cryptum::UI.col_third)
+        Cryptum::UI.colorize(
+          ui_win: ticker_win,
+          color: :green,
+          string: "#{Cryptum.up_arrow} #{fiat_symbol}#{high_24h_out}".rjust(col_just3_alt, '.')
+        )
+
+        # ROW 3
+        out_line_no += 1
+        ticker_win.setpos(out_line_no, Cryptum::UI.col_first)
+        ticker_win.clrtoeol
+        Cryptum::UI.colorize(
+          ui_win: ticker_win,
+          color: :red,
+          string: '24 Hr Low:'
+        )
+
+        ticker_win.setpos(out_line_no, Cryptum::UI.col_third)
+        Cryptum::UI.colorize(
+          ui_win: ticker_win,
+          color: :red,
+          string: "#{Cryptum.down_arrow} #{fiat_symbol}#{low_24h_out}".rjust(col_just3_alt, '.')
+        )
+
+        # ROW 4
+        out_line_no += 1
+        ticker_win.setpos(out_line_no, Cryptum::UI.col_first)
+        ticker_win.clrtoeol
+        Cryptum::UI.colorize(
+          ui_win: ticker_win,
+          color: :blue,
+          style: :bold,
+          string: '24 Hr | 30 Day Market Volume:'
+        )
+
+        ticker_win.setpos(out_line_no, Cryptum::UI.col_third)
+        Cryptum::UI.colorize(
+          ui_win: ticker_win,
+          color: :blue,
+          string: "#{volume_24h_out} | #{volume_30d_out}".rjust(col_just3_alt, '.')
+        )
+
+        # ROW 5
+        out_line_no += 1
+        ticker_win.setpos(out_line_no, Cryptum::UI.col_first)
+        ticker_win.clrtoeol
+        Cryptum::UI.colorize(
+          ui_win: ticker_win,
+          color: :cyan,
+          style: :bold,
+          string: 'Start Time:'
+        )
+
+        ticker_win.setpos(out_line_no, Cryptum::UI.col_third)
+        Cryptum::UI.colorize(
+          ui_win: ticker_win,
+          color: :cyan,
+          string: start_time.rjust(col_just3_alt, '.')
+        )
+
+        ticker_win.refresh
+      rescue Interrupt
+        # Exit Gracefully if CTRL+C is Pressed During Session
+        Cryptum.exit_gracefully(which_self: self)
+      rescue StandardError => e
+        raise e
+      end
+
+      # Display Usage for this Module
+      public_class_method def self.help
+        puts "USAGE:
+          #{self}.refresh(
+            symbol: 'required - Symbol for this Session (e.g. btc-usd)',
+            order_book: 'required - Order Book Data Structure',
+            event: 'required - Event from Coinbase Web Socket'
+          )
+        "
+      end
+    end
+  end
+end

data/lib/cryptum/ui.rb

@@ -0,0 +1,306 @@
+# frozen_string_literal: true
+
+require 'curses'
+require 'time'
+
+module Cryptum
+  # Cryptum::UI Module used for Presenting the
+  # Cryptum Curses Interface
+  module UI
+    autoload :KeyPressEvent, 'cryptum/ui/key_press_event'
+    autoload :TerminalWindow, 'cryptum/ui/terminal_window'
+    autoload :Ticker, 'cryptum/ui/ticker'
+    autoload :Portfolio, 'cryptum/ui/portfolio'
+    autoload :OrderPlan, 'cryptum/ui/order_plan'
+    autoload :OrderTimer, 'cryptum/ui/order_timer'
+    autoload :MarketTrend, 'cryptum/ui/market_trend'
+    autoload :SignalEngine, 'cryptum/ui/signal_engine'
+    autoload :OrderExecution, 'cryptum/ui/order_execution'
+    autoload :Command, 'cryptum/ui/command'
+
+    # Initialize the UI
+    public_class_method def self.init
+      # Initialize curses Screen
+      Curses.init_screen
+
+      # Ensure the cursor is invisible
+      Curses.curs_set(0)
+
+      # Do not echo keystrokes back to the UI
+      Curses.noecho
+
+      # Used to immediately evaluate characters submitted
+      # without pressing ENTER (e.g. b, r, & w key events)
+      Curses.crmode
+      # Curses.nocrmode
+      # Curses.raw # NO
+      # Curses.noraw
+      # Disable Line Buffering
+      Curses.ESCDELAY = 0
+
+      # Start Color!
+      Curses.start_color
+
+      # This is important to ensure -1 maintains
+      # the original background color in the terminal
+      # when defining color pairs
+      Curses.use_default_colors
+
+      # This object is used to pass all of the UI sections
+      # around to various Cryptum modules
+      Cryptum::UI::TerminalWindow.new
+    rescue Interrupt
+      # Exit Gracefully if CTRL+C is Pressed During Session
+      Cryptum.exit_gracefully(which_self: self)
+    rescue StandardError => e
+      # Produce a Stacktrace for anything else
+      Curses.close_screen
+      raise e
+    end
+
+    # Create New Curses Window
+    public_class_method def self.window(opts = {})
+      height = opts[:height].to_i
+      width = opts[:width].to_i
+      top = opts[:top].to_i
+      left = opts[:left].to_i
+
+      window = Curses::Window.new(
+        height,
+        width,
+        top,
+        left
+      )
+      window.nodelay = true
+
+      window
+    rescue Interrupt
+      # Exit Gracefully if CTRL+C is Pressed During Session
+      Cryptum.exit_gracefully(which_self: self)
+    rescue StandardError => e
+      # Produce a Stacktrace for anything else
+      Curses.close_screen
+      raise e
+    end
+
+    # Draw a Box Around a Window
+    public_class_method def self.line(opts = {})
+      ui_win = opts[:ui_win]
+      out_line_no = opts[:out_line_no].to_i
+
+      ui_win.setpos(out_line_no, 0)
+      if Curses.can_change_color?
+        colorize(
+          ui_win: ui_win,
+          color: :custom,
+          red: 192,
+          green: 192,
+          blue: 192,
+          string: "\u2500" * Curses.cols
+        )
+      else
+        colorize(
+          ui_win: ui_win,
+          color: :white,
+          string: "\u2500" * Curses.cols
+        )
+      end
+    rescue Interrupt
+      # Exit Gracefully if CTRL+C is Pressed During Session
+      Cryptum.exit_gracefully(which_self: self)
+    rescue StandardError => e
+      # Produce a Stacktrace for anything else
+      Curses.close_screen
+      raise e
+    end
+
+    # Jump to First Column
+    public_class_method def self.colorize(opts = {})
+      ui_win = opts[:ui_win]
+      color = opts[:color].to_s.to_sym
+      red = opts[:red].to_i
+      green = opts[:green].to_i
+      blue = opts[:blue].to_i
+
+      style = opts[:style].to_s.to_sym
+      style = :normal if opts[:style].nil?
+
+      bg = opts[:bg].to_i
+      bg = -1 if opts[:bg].nil?
+
+      string = opts[:string]
+
+      case color
+      when :black
+        color_id = 0
+        color_fg = Curses::COLOR_BLACK
+        color_bg = bg
+      when :red
+        color_id = 1
+        color_fg = Curses::COLOR_RED
+        color_bg = bg
+      when :green
+        color_id = 2
+        color_fg = Curses::COLOR_GREEN
+        color_bg = bg
+      when :yellow
+        color_id = 3
+        color_fg = Curses::COLOR_YELLOW
+        color_bg = bg
+      when :blue
+        color_id = 4
+        color_fg = Curses::COLOR_BLUE
+        color_bg = bg
+      when :magenta
+        color_id = 5
+        color_fg = Curses::COLOR_MAGENTA
+        color_bg = bg
+      when :cyan
+        color_id = 6
+        color_fg = Curses::COLOR_CYAN
+        color_bg = bg
+      when :white
+        color_id = 7
+        color_fg = Curses::COLOR_WHITE
+        color_bg = bg
+      when :rainbow
+        color_id = 254
+        red = Random.rand(0..1000)
+        green = Random.rand(0..1000)
+        blue = Random.rand(0..1000)
+        Curses.init_color(color_id, red, green, blue)
+        color_fg = color_id
+        color_bg = bg
+      when :custom
+        color_id = 255
+        Curses.init_color(color_id, red, green, blue)
+        color_fg = color_id
+        color_bg = bg
+      else
+        raise "Color Not Implemented for this Method: #{color}"
+      end
+
+      case style
+      when :blink
+        font = Curses::A_BLINK
+      when :bold
+        font = Curses::A_BOLD
+      when :highlight
+        font = Curses::A_STANDOUT
+      when :normal
+        font = Curses::A_NORMAL
+      when :reverse
+        font = Curses::A_REVERSE
+      else
+        raise "Font Style Not Implemented for this Method: #{style}"
+      end
+
+      Curses.init_pair(color_id, color_fg, color_bg)
+      ui_win.attron(Curses.color_pair(color_id) | font) do
+        ui_win.addstr(string)
+      end
+    rescue Interrupt
+      # Exit Gracefully if CTRL+C is Pressed During Session
+      Cryptum.exit_gracefully(which_self: self)
+    rescue StandardError => e
+      # Produce a Stacktrace for anything else
+      Curses.close_screen
+      raise e
+    end
+
+    # Jump to First Column
+    public_class_method def self.col_center(opts = {})
+      str = opts[:str]
+
+      str_divided_by_two = str.length / 2
+      (Curses.cols / 2) - str_divided_by_two
+    rescue Interrupt
+      # Exit Gracefully if CTRL+C is Pressed During Session
+      Cryptum.exit_gracefully(which_self: self)
+    rescue StandardError => e
+      # Produce a Stacktrace for anything else
+      Curses.close_screen
+      raise e
+    end
+
+    public_class_method def self.col_first
+      0
+    rescue Interrupt
+      # Exit Gracefully if CTRL+C is Pressed During Session
+      Cryptum.exit_gracefully(which_self: self)
+    rescue StandardError => e
+      # Produce a Stacktrace for anything else
+      Curses.close_screen
+      raise e
+    end
+
+    # Jump to Second Column
+    public_class_method def self.col_second
+      (Curses.cols / 8) + 5
+    rescue Interrupt
+      # Exit Gracefully if CTRL+C is Pressed During Session
+      Cryptum.exit_gracefully(which_self: self)
+    rescue StandardError => e
+      # Produce a Stacktrace for anything else
+      Curses.close_screen
+      raise e
+    end
+
+    # Jump to Third Column
+    public_class_method def self.col_third
+      ((Curses.cols / 8) * 3) + 2
+    rescue Interrupt
+      # Exit Gracefully if CTRL+C is Pressed During Session
+      Cryptum.exit_gracefully(which_self: self)
+    rescue StandardError => e
+      # Produce a Stacktrace for anything else
+      Curses.close_screen
+      raise e
+    end
+
+    # Jump to Fourth Column
+    public_class_method def self.col_fourth
+      ((Curses.cols / 4) * 3) - 3
+    rescue Interrupt
+      # Exit Gracefully if CTRL+C is Pressed During Session
+      Cryptum.exit_gracefully(which_self: self)
+    rescue StandardError => e
+      # Produce a Stacktrace for anything else
+      Curses.close_screen
+      raise e
+    end
+
+    public_class_method def self.detect_key_press_in_ui(opts = {})
+      key_press_event = opts[:key_press_event]
+      ui_win = opts[:ui_win]
+
+      case ui_win.getch
+      when 'G'
+        key_press_event.key_g = true
+      when 'r'
+        key_press_event.key_r = true
+      when 'u'
+        key_press_event.key_u = true
+      when 'w'
+        key_press_event.key_w = true
+      when 'x'
+        key_press_event.key_x = true
+      end
+
+      key_press_event
+    rescue Interrupt
+      # Exit Gracefully if CTRL+C is Pressed During Session
+      Cryptum.exit_gracefully(which_self: self)
+    rescue StandardError => e
+      # Produce a Stacktrace for anything else
+      Curses.close_screen
+      raise e
+    end
+
+    # Display a List of Every UI Module
+
+    public_class_method def self.help
+      constants.sort
+    end
+  end
+end

data/lib/cryptum/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Cryptum
+  VERSION = '0.0.230'
+end