cryptum 0.0.359 → 0.0.361

data/lib/cryptum/ui/order_plan_details.rb

@@ -0,0 +1,240 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Cryptum
+  module UI
+    # This plugin is used to Display Order Plan Details
+    # selected from the Order Plan Window Pane.
+    module OrderPlanDetails
+      # Supported Method Parameters::
+      # Cryptum::UI::OrderPlanDetails.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.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(
+         )
+        "
+      end
+    end
+  end
+end

data/lib/cryptum/ui/order_timer.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Cryptum
+  module UI
+    # This plugin is used to Refresh the Cryptum Status Section UI
+    module OrderTimer
+      # 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 = "- 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.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(
+         )
+        "
+      end
+    end
+  end
+end

data/lib/cryptum/ui/portfolio.rb

@@ -0,0 +1,221 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Cryptum
+  # This plugin is used to Refresh the Cryptum console UI
+  module UI
+    module Portfolio
+      # Supported Method Parameters::
+      # Cryptum::UI::Candle.refresh(
+      #   order_book: 'required - Order Book Data Structure',
+      #   event: 'required - Event from Coinbase Web Socket'
+      # )
+
+      public_class_method def self.refresh(opts = {})
+        option_choice = opts[:option_choice]
+        portfolio_win = opts[:portfolio_win]
+        event_history = opts[:event_history]
+        bot_conf = opts[:bot_conf]
+
+        ticker_price = event_history.order_book[:ticker_price].to_f
+        this_product = event_history.order_book[:this_product]
+        symbol_out = this_product[:id]
+        base_increment = this_product[:base_increment]
+
+        crypto_smallest_decimal = base_increment.to_s.split('.')[-1].length
+
+        autotrade_percent = format(
+          '%0.2f',
+          bot_conf[:autotrade_portfolio_percent].to_f
+        )
+
+        tpm = format(
+          '%0.2f',
+          bot_conf[:target_profit_margin_percent]
+        )
+
+        crypto_currency = option_choice.symbol.to_s.upcase.split('_').first.to_sym
+        portfolio = event_history.order_book[:portfolio]
+        this_account = portfolio.select do |account|
+          account[:currency] == crypto_currency.to_s
+        end
+        raise "ID for Crypto Currency, #{crypto_currency} Not Found" if this_account.empty?
+
+        balance = format("%0.#{crypto_smallest_decimal}f", this_account.first[:balance])
+        balance_out = Cryptum.beautify_large_number(
+          value: balance
+        )
+        avail_for_trade = format("%0.#{crypto_smallest_decimal}f", this_account.first[:available])
+        avail_for_trade_out = Cryptum.beautify_large_number(
+          value: avail_for_trade
+        )
+
+        fiat_portfolio = event_history.order_book[:fiat_portfolio]
+        fiat = option_choice.symbol.to_s.upcase.split('_').last.to_sym
+        total_holdings = format('%0.2f', fiat_portfolio.first[:total_holdings])
+        total_holdings_out = Cryptum.beautify_large_number(
+          value: total_holdings
+        )
+        fiat_balance = format('%0.2f', fiat_portfolio.first[:balance])
+        fiat_balance_out = Cryptum.beautify_large_number(
+          value: fiat_balance
+        )
+        fiat_avail_for_trade = format('%0.2f', fiat_portfolio.first[:available])
+        fiat_avail_for_trade_out = Cryptum.beautify_large_number(
+          value: fiat_avail_for_trade
+        )
+
+        fees = event_history.order_book[:fees]
+        maker_fee = format('%0.2f', fees[:maker_fee_rate].to_f * 100)
+        taker_fee = format('%0.2f', fees[:taker_fee_rate].to_f * 100)
+        volume_tier = format('%0.2f', fees[:usd_volume].to_f)
+        volume_tier_out = Cryptum.beautify_large_number(
+          value: volume_tier
+        )
+
+        current_crypto_fiat_value = format(
+          '%0.2f',
+          balance.to_f * ticker_price
+        )
+        current_crypto_fiat_value_out = Cryptum.beautify_large_number(
+          value: current_crypto_fiat_value
+        )
+
+        fiat_budget = fiat_avail_for_trade.to_f
+        current_fiat_invested_percent = format(
+          '%0.2f',
+          (1 - (fiat_budget / total_holdings.to_f)) * 100
+        )
+
+        crypto_invested_percent = format(
+          '%0.2f',
+          current_crypto_fiat_value.to_f.fdiv(total_holdings.to_f) * 100
+        )
+        # TODO: Everything Above this Line Needs to be Indicators ^
+
+        # UI
+        col_just3 = (Curses.cols - Cryptum::UI.col_third) - 1
+
+        # ROW 1
+        out_line_no = 0
+        Cryptum::UI.line(
+          ui_win: portfolio_win,
+          out_line_no: out_line_no
+        )
+
+        # ROW 2
+        out_line_no += 1
+        portfolio_win.setpos(out_line_no, Cryptum::UI.col_first)
+        portfolio_win.clrtoeol
+        Cryptum::UI.colorize(
+          ui_win: portfolio_win,
+          color: :white,
+          style: :bold,
+          string: "Portfolio | % Tied Up | % #{symbol_out}:"
+        )
+
+        portfolio_win.setpos(out_line_no, Cryptum::UI.col_third)
+        Cryptum::UI.colorize(
+          ui_win: portfolio_win,
+          color: :white,
+          string: "$#{total_holdings_out} | #{current_fiat_invested_percent}% | #{crypto_invested_percent}%".rjust(col_just3, '.')
+        )
+
+        # ROW 3
+        out_line_no += 1
+        portfolio_win.setpos(out_line_no, Cryptum::UI.col_first)
+        portfolio_win.clrtoeol
+        Cryptum::UI.colorize(
+          ui_win: portfolio_win,
+          color: :cyan,
+          string: 'TPM % | Autotrade %:'
+        )
+
+        portfolio_win.setpos(out_line_no, Cryptum::UI.col_third)
+        Cryptum::UI.colorize(
+          ui_win: portfolio_win,
+          color: :cyan,
+          string: "#{tpm}% | #{autotrade_percent}%".rjust(col_just3, '.')
+        )
+
+        # ROW 4
+        out_line_no += 1
+        portfolio_win.setpos(out_line_no, Cryptum::UI.col_first)
+        portfolio_win.clrtoeol
+        Cryptum::UI.colorize(
+          ui_win: portfolio_win,
+          color: :green,
+          style: :bold,
+          string: "#{fiat} Bal | Tradeable:"
+        )
+
+        portfolio_win.setpos(out_line_no, Cryptum::UI.col_third)
+        Cryptum::UI.colorize(
+          ui_win: portfolio_win,
+          color: :green,
+          string: "$#{fiat_balance_out} | $#{fiat_avail_for_trade_out}".rjust(
+            col_just3,
+            '.'
+          )
+        )
+
+        # ROW 5
+        out_line_no += 1
+        portfolio_win.setpos(out_line_no, Cryptum::UI.col_first)
+        portfolio_win.clrtoeol
+        Cryptum::UI.colorize(
+          ui_win: portfolio_win,
+          color: :yellow,
+          style: :bold,
+          string: 'Crypto Val | Bal | Tradeable:'
+        )
+
+        portfolio_win.setpos(out_line_no, Cryptum::UI.col_third)
+        Cryptum::UI.colorize(
+          ui_win: portfolio_win,
+          color: :yellow,
+          string: "$#{current_crypto_fiat_value_out} | *#{balance_out} | *#{avail_for_trade_out}".rjust(col_just3, '.')
+        )
+
+        # ROW 6
+        out_line_no += 1
+        portfolio_win.setpos(out_line_no, Cryptum::UI.col_first)
+        portfolio_win.clrtoeol
+        Cryptum::UI.colorize(
+          ui_win: portfolio_win,
+          color: :red,
+          style: :bold,
+          string: 'Maker & Taker Fees | My Volume:'
+        )
+
+        portfolio_win.setpos(out_line_no, Cryptum::UI.col_third)
+        Cryptum::UI.colorize(
+          ui_win: portfolio_win,
+          color: :red,
+          string: "#{maker_fee}% & #{taker_fee}% | $#{volume_tier_out}".rjust(col_just3, '.')
+        )
+
+        portfolio_win.refresh
+
+        event_history
+      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(
+           order_book: 'required - Order Book Data Structure',
+           event: 'required - Event from Coinbase Web Socket'
+         )
+        "
+      end
+    end
+  end
+end

data/lib/cryptum/ui/signal_engine.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Cryptum
+  # This plugin is used to Refresh the Cryptum console UI
+  module UI
+    module SignalEngine
+      # Supported Method Parameters::
+      # Cryptum::UI::Candle.refresh(
+      #   order_book: 'required - Order Book Data Structure',
+      #   event: 'required - Event from Coinbase Web Socket'
+      # )
+
+      public_class_method def self.refresh(opts = {})
+        signal_engine_win = opts[:signal_engine_win]
+        indicator_status = opts[:indicator_status]
+
+        color = :white
+        color = indicator_status.market_trend[:color] if indicator_status.market_trend
+
+        indicator_status.last_action_signal = indicator_status.action_signal
+
+        case color
+        when :green
+          signal_color = :green
+          action_signal = :sell
+        when :yellow
+          signal_color = :yellow
+          action_signal = :hold
+        when :red
+          signal_color = :cyan
+          action_signal = :buy
+        else
+          signal_color = :white
+          action_signal = :skip
+        end
+
+        action_signal_out = "SIGNAL >>> #{action_signal.to_s.upcase} <<< ENGINE"
+        # TODO: Everything Above this Line Needs to be Indicators ^
+
+        # UI
+        col_just1 = (Curses.cols - Cryptum::UI.col_first) - 1
+        col_just4 = Curses.cols - Cryptum::UI.col_fourth
+
+        # ROW 1
+        out_line_no = 0
+        Cryptum::UI.line(
+          ui_win: signal_engine_win,
+          out_line_no: out_line_no
+        )
+
+        # ROW 2
+        out_line_no += 1
+        signal_engine_win.setpos(out_line_no, Cryptum::UI.col_first)
+        signal_engine_win.clrtoeol
+
+        Cryptum::UI.colorize(
+          ui_win: signal_engine_win,
+          color: signal_color,
+          style: :reverse,
+          string: ''.ljust(col_just1, ' ')
+        )
+
+        signal_engine_win.setpos(
+          out_line_no,
+          Cryptum::UI.col_center(str: action_signal_out)
+        )
+
+        Cryptum::UI.colorize(
+          ui_win: signal_engine_win,
+          color: signal_color,
+          style: :reverse,
+          string: action_signal_out
+        )
+
+        signal_engine_win.setpos(out_line_no, Cryptum::UI.col_fourth)
+        Cryptum::UI.colorize(
+          ui_win: signal_engine_win,
+          color: signal_color,
+          style: :reverse,
+          string: ''.ljust(col_just4, ' ')
+        )
+
+        signal_engine_win.refresh
+
+        indicator_status.action_signal = action_signal
+
+        indicator_status
+      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(
+           order_book: 'required - Order Book Data Structure',
+           event: 'required - Event from Coinbase Web Socket'
+         )
+        "
+      end
+    end
+  end
+end