cryptum 0.0.381 → 0.0.383

data/lib/cryptum/ui/order/plan_details.rb

@@ -0,0 +1,243 @@
+# frozen_string_literal: true
+
+module Cryptum
+  module UI
+    # This plugin is used to Display Order Plan Details
+    # selected from the Order Plan Window Pane.
+    module Order
+      module PlanDetails
+        # Supported Method Parameters::
+        # Cryptum::UI::Order::PlanDetails.refresh(
+        # )
+
+        public_class_method def self.refresh(opts = {})
+          event_history = opts[:event_history]
+          order_plan_details_win = opts[:order_plan_details_win]
+
+          order = event_history.order_plan_selected_data
+          tpm = order[:tpm]
+          autotrade_percent = order[:autotrade_percent]
+          order_color = order[:color]
+
+          fiat_avail_out = Cryptum.beautify_large_number(
+            value: order[:fiat_available]
+          )
+          risk_alloc_out = Cryptum.beautify_large_number(
+            value: order[:risk_alloc]
+          )
+          slice_alloc_out = Cryptum.beautify_large_number(
+            value: order[:slice_alloc]
+          )
+          previous_slice_invest_out = Cryptum.beautify_large_number(
+            value: order[:previous_slice_invest]
+          )
+          invest_out = Cryptum.beautify_large_number(
+            value: order[:invest]
+          )
+          profit_out = Cryptum.beautify_large_number(
+            value: order[:profit]
+          )
+          tpm_out = format('%0.2f', tpm)
+          return_out = Cryptum.beautify_large_number(
+            value: order[:return]
+          )
+          autotrade_ln1_details = "1. Autotrade is set to #{autotrade_percent}% of $#{fiat_avail_out}, making $#{risk_alloc_out} available for this slice in"
+          autotrade_ln2_details = '   the order plan.'
+          if order[:last_slice]
+            slice_alloc_ln1_details = "2. Since $#{risk_alloc_out} is the remaining amount within the criteria defined in the Autotrade % above,"
+            slice_alloc_ln2_details = "   $#{invest_out} will be allocated for this slice."
+          else
+            slice_alloc_ln1_details = "2. With $#{risk_alloc_out} available and a slice allocation of #{order[:allocation_percent]}%, $#{slice_alloc_out} plus the previous"
+            slice_alloc_ln2_details = "   slice of $#{previous_slice_invest_out} results in $#{invest_out} being allocated for this slice."
+          end
+          profit_ln1_details = "3. With a slice allocation of $#{invest_out}, plus a TPM equal to #{tpm_out}%, $#{return_out} will be returned"
+          profit_ln2_details = "   once sold.  With $#{invest_out} invested, the gross profit equals $#{profit_out}, minus any Maker &"
+          profit_ln3_details = '   Taker (transaction) fees.'
+
+          # UI
+          col_just1 = (Curses.cols - Cryptum::UI.col_first) - 1
+
+          # ROW 1
+          out_line_no = 0
+          line_color = order_color
+          header_color = order_color
+          header_style = :bold
+          style = :bold
+          header_style = :reverse if event_history.order_plan_details_win_active
+
+          Cryptum::UI.line(
+            ui_win: order_plan_details_win,
+            out_line_no: out_line_no,
+            color: line_color
+          )
+
+          # ROW 2
+          out_line_no += 1
+          order_plan_details_win.setpos(out_line_no, Cryptum::UI.col_first)
+          order_plan_details_win.clrtoeol
+          Cryptum::UI.colorize(
+            ui_win: order_plan_details_win,
+            color: header_color,
+            style: header_style,
+            string: ''.ljust(col_just1, ' ')
+          )
+
+          header_str = "- ORDER SLICE ##{order[:plan_no]} DETAILS -"
+          order_plan_details_win.setpos(
+            out_line_no,
+            Cryptum::UI.col_center(str: header_str)
+          )
+
+          Cryptum::UI.colorize(
+            ui_win: order_plan_details_win,
+            color: order_color,
+            style: header_style,
+            string: header_str
+          )
+
+          # ROW 3
+          out_line_no += 1
+          order_plan_details_win.setpos(out_line_no, Cryptum::UI.col_first)
+          order_plan_details_win.clrtoeol
+
+          Cryptum::UI.colorize(
+            ui_win: order_plan_details_win,
+            color: order_color,
+            style: style,
+            string: autotrade_ln1_details.ljust(col_just1, ' ')
+          )
+
+          # ROW 4
+          out_line_no += 1
+          order_plan_details_win.setpos(out_line_no, Cryptum::UI.col_first)
+          order_plan_details_win.clrtoeol
+
+          Cryptum::UI.colorize(
+            ui_win: order_plan_details_win,
+            color: order_color,
+            style: style,
+            string: autotrade_ln2_details.ljust(col_just1, ' ')
+          )
+
+          # ROW 5
+          out_line_no += 1
+          order_plan_details_win.setpos(out_line_no, Cryptum::UI.col_first)
+          order_plan_details_win.clrtoeol
+
+          Cryptum::UI.colorize(
+            ui_win: order_plan_details_win,
+            color: order_color,
+            style: style,
+            string: slice_alloc_ln1_details.ljust(col_just1, ' ')
+          )
+
+          # ROW 6
+          out_line_no += 1
+          order_plan_details_win.setpos(out_line_no, Cryptum::UI.col_first)
+          order_plan_details_win.clrtoeol
+
+          Cryptum::UI.colorize(
+            ui_win: order_plan_details_win,
+            color: order_color,
+            style: style,
+            string: slice_alloc_ln2_details.ljust(col_just1, ' ')
+          )
+
+          # ROW 7
+          out_line_no += 1
+          order_plan_details_win.setpos(out_line_no, Cryptum::UI.col_first)
+          order_plan_details_win.clrtoeol
+
+          Cryptum::UI.colorize(
+            ui_win: order_plan_details_win,
+            color: order_color,
+            style: style,
+            string: profit_ln1_details.ljust(col_just1, ' ')
+          )
+
+          # ROW 8
+          out_line_no += 1
+          order_plan_details_win.setpos(out_line_no, Cryptum::UI.col_first)
+          order_plan_details_win.clrtoeol
+
+          Cryptum::UI.colorize(
+            ui_win: order_plan_details_win,
+            color: order_color,
+            style: style,
+            string: profit_ln2_details.ljust(col_just1, ' ')
+          )
+
+          # ROW 9
+          out_line_no += 1
+          order_plan_details_win.setpos(out_line_no, Cryptum::UI.col_first)
+          order_plan_details_win.clrtoeol
+
+          Cryptum::UI.colorize(
+            ui_win: order_plan_details_win,
+            color: order_color,
+            style: style,
+            string: profit_ln3_details.ljust(col_just1, ' ')
+          )
+
+          # Clear to OK ROW
+          ok_row = 9
+          out_line_no += 1
+          to_ok_row = ok_row - 1
+          (out_line_no..to_ok_row).each do |clr_line|
+            order_plan_details_win.setpos(clr_line, Cryptum::UI.col_first)
+            Cryptum::UI.colorize(
+              ui_win: order_plan_details_win,
+              color: order_color,
+              style: :normal,
+              string: ''.ljust(col_just1, ' ')
+            )
+          end
+
+          # OK ROW
+          out_line_no = ok_row
+          order_plan_details_win.setpos(out_line_no, Cryptum::UI.col_first)
+          order_plan_details_win.clrtoeol
+          Cryptum::UI.colorize(
+            ui_win: order_plan_details_win,
+            color: order_color,
+            string: ''.ljust(col_just1, ' ')
+          )
+
+          header_str = '- OK -'
+          order_plan_details_win.setpos(
+            out_line_no,
+            Cryptum::UI.col_center(str: header_str)
+          )
+
+          Cryptum::UI.colorize(
+            ui_win: order_plan_details_win,
+            color: order_color,
+            style: :reverse,
+            string: header_str
+          )
+
+          order_plan_details_win.refresh
+
+          event_history
+        rescue Interrupt
+          # Exit Gracefully if CTRL+C is Pressed During Session
+          Cryptum::UI::Exit.gracefully(
+            which_self: self,
+            event_history: event_history
+          )
+        rescue StandardError => e
+          raise e
+        end
+
+        # Display Usage for this Module
+
+        public_class_method def self.help
+          puts "USAGE:
+           #{self}.refresh(
+           )
+          "
+        end
+      end
+    end
+  end
+end

data/lib/cryptum/ui/order/timer.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Cryptum
+  module UI
+    # This plugin is used to Refresh the Cryptum Status Section UI
+    module Order
+      module Timer
+        # Supported Method Parameters::
+        # Cryptum::UI::Timer.refresh(
+        # )
+
+        public_class_method def self.refresh(opts = {})
+          option_choice = opts[:option_choice]
+          event_history = opts[:event_history]
+          order_timer_win = opts[:order_timer_win]
+          indicator_status = opts[:indicator_status]
+
+          last_trend_reset_time = event_history.order_book[:last_trend_reset]
+          last_order_exec_time = event_history.order_book[:last_order_exec]
+
+          # Market Trend Reset Timer
+          time_between_trend_reset = option_choice.market_trend_reset
+          trend_timer_begin = Time.parse(last_trend_reset_time)
+          trend_timer_end = trend_timer_begin + time_between_trend_reset
+          trend_time_remaining = trend_timer_end - Time.now
+
+          if trend_time_remaining.zero? || trend_time_remaining.negative?
+            event_history.order_book[:market_trend][:buy] = 0
+            event_history.order_book[:market_trend][:sell] = 0
+            event_history.order_book[:last_trend_reset] = Time.now.strftime(
+              '%Y-%m-%d %H:%M:%S.%N%z'
+            )
+
+            last_trend_reset_time = event_history.order_book[:last_trend_reset]
+            time_between_trend_reset = option_choice.market_trend_reset
+            trend_timer_begin = Time.parse(last_trend_reset_time)
+            trend_timer_end = trend_timer_begin + time_between_trend_reset
+            trend_time_remaining = trend_timer_end - Time.now
+          end
+
+          trend_countdown = Cryptum.beautify_large_number(
+            value: format('%0.2f', trend_time_remaining)
+          )
+
+          # Market Trend Reset Timer
+          time_between_order_exec = event_history.time_between_orders
+          time_between_order_exec_out = Cryptum.beautify_large_number(
+            value: format('%0.2f', time_between_order_exec)
+          )
+          order_begin_time = Time.parse(last_order_exec_time)
+          order_end_time = order_begin_time + time_between_order_exec
+          order_exec_time_remaining = order_end_time - Time.now
+          order_countdown = Cryptum.beautify_large_number(
+            value: format('%0.2f', order_exec_time_remaining)
+          )
+
+          buy_total = event_history.order_book[:market_trend][:buy].to_i
+          sell_total = event_history.order_book[:market_trend][:sell].to_i
+
+          color = :white
+          color = indicator_status.market_trend[:color] if indicator_status.market_trend
+          case color
+          when :green
+            # TODO: add condition to check if open sell orders exist.
+            # If so intent should be something like, "- SEE ORDER HISTORY -"
+            # Otherwise, intent should be something like, "- WAIT FOR MARKET TREND SHIFT -"
+            intent = "- #{Cryptum.down_arrow} SEE ORDER HISTORY #{Cryptum.down_arrow} -"
+          else
+            speed = 'FAST'
+            speed = 'SLOW' if buy_total >= sell_total
+
+            intent = "- #{speed} BUY: #{order_countdown} of #{time_between_order_exec_out} -"
+            intent = '- BUYING PAUSED -' if event_history.red_pill
+          end
+
+          # Have a Clock
+          clock = Time.now.strftime('%Y-%m-%d %H:%M:%S%z')
+
+          # UI
+          col_just4 = (Curses.cols - Cryptum::UI.col_fourth) - 1
+
+          # ROW 1
+          # COLUMN 1
+          out_line_no = 0
+          order_timer_win.setpos(out_line_no, Cryptum::UI.col_first)
+          order_timer_win.clrtoeol
+          Cryptum::UI.colorize(
+            ui_win: order_timer_win,
+            color: :white,
+            style: :bold,
+            string: "#{option_choice.market_trend_reset_label} M. Trend Rst: #{trend_countdown}"
+          )
+
+          # COLUMN 2
+          order_timer_win.setpos(
+            out_line_no,
+            Cryptum::UI.col_center(str: intent)
+          )
+          Cryptum::UI.colorize(
+            ui_win: order_timer_win,
+            color: :white,
+            style: :bold,
+            string: intent
+          )
+
+          # COLUMN 3
+          order_timer_win.setpos(out_line_no, Cryptum::UI.col_fourth)
+          Cryptum::UI.colorize(
+            ui_win: order_timer_win,
+            color: :white,
+            style: :bold,
+            string: clock.rjust(col_just4)
+          )
+
+          order_timer_win.refresh
+
+          order_countdown.to_f
+        rescue Interrupt
+          # Exit Gracefully if CTRL+C is Pressed During Session
+          Cryptum::UI::Exit.gracefully(
+            which_self: self,
+            event_history: event_history,
+            option_choice: option_choice
+          )
+        rescue StandardError => e
+          raise e
+        end
+
+        # Display Usage for this Module
+
+        public_class_method def self.help
+          puts "USAGE:
+           #{self}.refresh(
+           )
+          "
+        end
+      end
+    end
+  end
+end

data/lib/cryptum/ui/order.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Cryptum
+  # Cryptum::UI Module used for Presenting the
+  # Cryptum Curses Interface
+  module UI
+    module Order
+      require 'cryptum/ui/order/execute'
+      require 'cryptum/ui/order/execute_details'
+      require 'cryptum/ui/order/plan'
+      require 'cryptum/ui/order/plan_details'
+      require 'cryptum/ui/order/timer'
+
+      # Display a List of Every UI Module
+
+      public_class_method def self.help
+        constants.sort
+      end
+    end
+  end
+end

data/lib/cryptum/ui/portfolio.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'logger'
-
 module Cryptum
   # This plugin is used to Refresh the Cryptum console UI
   module UI
@@ -201,7 +199,11 @@ module Cryptum
         event_history
       rescue Interrupt
         # Exit Gracefully if CTRL+C is Pressed During Session
-        Cryptum.exit_gracefully(which_self: self)
+        Cryptum::UI::Exit.gracefully(
+          which_self: self,
+          event_history: event_history,
+          option_choice: option_choice
+        )
       rescue StandardError => e
         raise e
       end

data/lib/cryptum/ui/signal_engine.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'logger'
-
 module Cryptum
   # This plugin is used to Refresh the Cryptum console UI
   module UI
@@ -89,7 +87,7 @@ module Cryptum
         indicator_status
       rescue Interrupt
         # Exit Gracefully if CTRL+C is Pressed During Session
-        Cryptum.exit_gracefully(which_self: self)
+        Cryptum::UI::Exit.gracefully(which_self: self)
       rescue StandardError => e
         raise e
       end

data/lib/cryptum/ui/terminal_window.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'logger'
-
 module Cryptum
   module UI
     # This Class is Used by Cryptum::Event to
@@ -101,7 +99,7 @@ module Cryptum
       end
     rescue Interrupt
       # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum.exit_gracefully(which_self: self)
+      Cryptum::UI::Exit.gracefully(which_self: self)
     rescue StandardError => e
       # Produce a Stacktrace for anything else
       Curses.close_screen

data/lib/cryptum/ui/ticker.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'logger'
-
 module Cryptum
   # This plugin is used to Refresh the Cryptum console UI
   module UI
@@ -299,7 +297,10 @@ module Cryptum
         event_history
       rescue Interrupt
         # Exit Gracefully if CTRL+C is Pressed During Session
-        Cryptum.exit_gracefully(which_self: self)
+        Cryptum::UI::Exit.gracefully(
+          which_self: self,
+          event_history: event_history
+        )
       rescue StandardError => e
         raise e
       end

data/lib/cryptum/ui.rb

@@ -1,24 +1,19 @@
 # frozen_string_literal: true
 
-require 'curses'
-require 'time'
-
 module Cryptum
   # Cryptum::UI Module used for Presenting the
   # Cryptum Curses Interface
   module UI
+    require 'cryptum/ui/command'
+    require 'cryptum/ui/exit'
     require 'cryptum/ui/key_press_event'
-    require 'cryptum/ui/terminal_window'
-    require 'cryptum/ui/ticker'
-    require 'cryptum/ui/portfolio'
-    require 'cryptum/ui/order_plan'
-    require 'cryptum/ui/order_plan_details'
-    require 'cryptum/ui/order_timer'
     require 'cryptum/ui/market_trend'
+    require 'cryptum/ui/matrix'
+    require 'cryptum/ui/order'
+    require 'cryptum/ui/portfolio'
     require 'cryptum/ui/signal_engine'
-    require 'cryptum/ui/order_execution'
-    require 'cryptum/ui/order_execute_details'
-    require 'cryptum/ui/command'
+    require 'cryptum/ui/terminal_window'
+    require 'cryptum/ui/ticker'
 
     # Initialize the UI
     public_class_method def self.init
@@ -53,7 +48,7 @@ module Cryptum
       Cryptum::UI::TerminalWindow.new
     rescue Interrupt
       # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum.exit_gracefully(which_self: self)
+      Cryptum::UI::Exit.gracefully(which_self: self)
     rescue StandardError => e
       # Produce a Stacktrace for anything else
       Curses.close_screen
@@ -78,7 +73,7 @@ module Cryptum
       window
     rescue Interrupt
       # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum.exit_gracefully(which_self: self)
+      Cryptum::UI::Exit.gracefully(which_self: self)
     rescue StandardError => e
       # Produce a Stacktrace for anything else
       Curses.close_screen
@@ -104,7 +99,7 @@ module Cryptum
       )
     rescue Interrupt
       # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum.exit_gracefully(which_self: self)
+      Cryptum::UI::Exit.gracefully(which_self: self)
     rescue StandardError => e
       # Produce a Stacktrace for anything else
       Curses.close_screen
@@ -202,7 +197,7 @@ module Cryptum
       end
     rescue Interrupt
       # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum.exit_gracefully(which_self: self)
+      Cryptum::UI::Exit.gracefully(which_self: self)
     rescue StandardError => e
       # Produce a Stacktrace for anything else
       Curses.close_screen
@@ -217,7 +212,7 @@ module Cryptum
       (Curses.cols / 2) - str_divided_by_two
     rescue Interrupt
       # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum.exit_gracefully(which_self: self)
+      Cryptum::UI::Exit.gracefully(which_self: self)
     rescue StandardError => e
       # Produce a Stacktrace for anything else
       Curses.close_screen
@@ -228,7 +223,7 @@ module Cryptum
       0
     rescue Interrupt
       # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum.exit_gracefully(which_self: self)
+      Cryptum::UI::Exit.gracefully(which_self: self)
     rescue StandardError => e
       # Produce a Stacktrace for anything else
       Curses.close_screen
@@ -240,7 +235,7 @@ module Cryptum
       (Curses.cols / 8) + 5
     rescue Interrupt
       # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum.exit_gracefully(which_self: self)
+      Cryptum::UI::Exit.gracefully(which_self: self)
     rescue StandardError => e
       # Produce a Stacktrace for anything else
       Curses.close_screen
@@ -252,7 +247,7 @@ module Cryptum
       ((Curses.cols / 8) * 3) + 2
     rescue Interrupt
       # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum.exit_gracefully(which_self: self)
+      Cryptum::UI::Exit.gracefully(which_self: self)
     rescue StandardError => e
       # Produce a Stacktrace for anything else
       Curses.close_screen
@@ -264,7 +259,7 @@ module Cryptum
       ((Curses.cols / 4) * 3) - 3
     rescue Interrupt
       # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum.exit_gracefully(which_self: self)
+      Cryptum::UI::Exit.gracefully(which_self: self)
     rescue StandardError => e
       # Produce a Stacktrace for anything else
       Curses.close_screen
@@ -327,7 +322,7 @@ module Cryptum
       key_press_event
     rescue Interrupt
       # Exit Gracefully if CTRL+C is Pressed During Session
-      Cryptum.exit_gracefully(which_self: self)
+      Cryptum::UI::Exit.gracefully(which_self: self)
     rescue StandardError => e
       # Produce a Stacktrace for anything else
       Curses.close_screen

data/lib/cryptum/version.rb

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

data/lib/cryptum/web_sock/coinbase.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require 'faye/websocket'
-require 'websocket/extensions'
-require 'permessage_deflate'
-
 module Cryptum
   # This plugin is used to Establish a Web
   # Socket Connection with Coinbase
@@ -54,7 +50,7 @@ module Cryptum
         ws
       rescue Interrupt
         # Exit Gracefully if CTRL+C is Pressed During Session
-        Cryptum.exit_gracefully(which_self: self)
+        Cryptum::UI::Exit.gracefully(which_self: self)
       rescue StandardError => e
         raise e
       end
@@ -96,7 +92,6 @@ module Cryptum
 
       public_class_method def self.help
         puts "USAGE:
-          logger = #{self}.create()
         "
       end
     end

data/lib/cryptum/web_sock/event_machine.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'eventmachine'
-require 'json'
-
 module Cryptum
   # This plugin is used to Establish a Web
   # Socket Connection with Coinbase
@@ -196,7 +193,7 @@ module Cryptum
             end
 
             EM.add_periodic_timer(delay_ms_cast_as_decimal) do
-              order_countdown = Cryptum::UI::OrderTimer.refresh(
+              order_countdown = Cryptum::UI::Order::Timer.refresh(
                 option_choice: option_choice,
                 event_history: event_history,
                 order_timer_win: terminal_win.order_timer_section,
@@ -230,7 +227,7 @@ module Cryptum
               terminal_win.key_press_event.key_r = true
               # IMPORTANT:
               # Wait for Order Plan recalculation to occur
-              # once Cryptum::UI::OrderPlan is refreshed
+              # once Cryptum::UI::Order::Plan is refreshed
               # in Cryptum::Event _BEFORE_ writing the order
               # book to file.
             end
@@ -255,7 +252,7 @@ module Cryptum
         end
       rescue Interrupt
         # Exit Gracefully if CTRL+C is Pressed During Session
-        Cryptum.exit_gracefully(
+        Cryptum::UI::Exit.gracefully(
           which_self: self,
           event_history: event_history,
           option_choice: option_choice,
@@ -268,7 +265,6 @@ module Cryptum
       # Display Usage for this Module
       public_class_method def self.help
         puts "USAGE:
-          logger = #{self}.create()
         "
       end
     end