cryptum 0.0.359 → 0.0.361

data/lib/cryptum/order_book/market_trend.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module Cryptum
+  # This plugin is used to indicate if the order trend
+
+  module OrderBook
+    module MarketTrend
+      # Supported Method Parameters::
+      # Cryptum::OrderBook::OrderTrend.status(
+      # )
+
+      public_class_method def self.status(opts = {})
+        event_history = opts[:event_history]
+        event = opts[:event]
+        indicator_status = opts[:indicator_status]
+
+        # Compatible w/ l2update websocket channel
+        # buy_or_sell = event[:changes].first[0].to_s.to_sym
+        # case buy_or_sell
+        # when :buy
+        #   event_history.order_book[:market_trend][:buy] += 1
+        # when :sell
+        #   event_history.order_book[:market_trend][:sell] += 1
+        # else
+        #   raise "UNKNOWN Value in event[:changes] => #{buy_or_sell}"
+        # end
+
+        # Compatible w/ l2update_batch websocket channel
+        buy_count = event[:changes].select { |change| change.first == 'buy' }.length
+        sell_count = event[:changes].select { |change| change.first == 'sell' }.length
+        event_history.order_book[:market_trend][:buy] += buy_count
+        event_history.order_book[:market_trend][:sell] += sell_count
+
+        indicator_hash = {}
+        buy_total = event_history.order_book[:market_trend][:buy].to_i
+        indicator_hash[:buy] = buy_total
+
+        sell_total = event_history.order_book[:market_trend][:sell].to_i
+        indicator_hash[:sell] = sell_total
+
+        # order_difference = 0
+        if buy_total > sell_total
+          order_difference = buy_total - sell_total
+          motivation = 'BUYING THE DIP'
+          indicator_hash[:color] = :red
+          if event_history.bullish_trend
+            motivation = 'FOMO' if event_history.bullish_trend
+            indicator_hash[:color] = :green
+          end
+          trend = "BUYS #{Cryptum.up_arrow} BY #{order_difference.to_i}"
+          indicator_hash[:status] = "B#{Cryptum.up_arrow}"
+        elsif buy_total < sell_total
+          order_difference = sell_total - buy_total
+          motivation = 'REKT'
+          indicator_hash[:color] = :red
+          if event_history.bullish_trend
+            motivation = 'TAKING PROFITS' if event_history.bullish_trend
+            indicator_hash[:color] = :green
+          end
+          trend = "SELLS #{Cryptum.up_arrow} BY #{order_difference.to_i}"
+          indicator_hash[:status] = "S#{Cryptum.up_arrow}"
+        else
+          # This Condition is Met When candle_buy_tot == candle_sell_tot
+          motivation = 'FLAT'
+          indicator_hash[:color] = :yellow
+          trend = 'BUYS == SELLS'
+          indicator_hash[:status] = "F#{Cryptum.up_arrow}"
+        end
+        indicator_hash[:ui] = "Market is #{motivation} | #{trend}"
+
+        indicator_status.market_trend = indicator_hash
+      rescue StandardError => e
+        raise e
+      end
+
+      # public_class_method def self.reset(opts = {})
+      #   # IT IS ABSOLUTELY CRITICAL THIS METHOD IS AS FAST AS POSSIBLE
+      #   # TO AVOID TICKER PRICE SYNCING ISSUES.
+      #   event_history = opts[:event_history]
+
+      #   # order_history = event_history.order_book[:order_history]
+      #   # order_history_meta = event_history.order_book[:order_history_meta]
+
+      #   # Only retain past 24 hours of
+      #   # order history meta for bought, sold, and expired
+      #   # keep open limit sell orders indefintely
+      #   # before_twenty_four_hrs_ago = Time.now - 86_400
+      #   # order_history_meta.delete_if do |ohm|
+      #   #   order_history.find do |oh|
+      #   #     next unless oh[:done_at]
+
+      #   #     Time.parse(oh[:done_at]) < before_twenty_four_hrs_ago && (
+      #   #       oh[:id] == ohm[:buy_order_id] ||
+      #   #       oh[:id] == ohm[:sell_order_id]
+      #   #     ) && (
+      #   #       ohm[:color].to_sym == :white ||
+      #   #       ohm[:color].to_sym == :green ||
+      #   #       ohm[:color].to_sym == :cyan ||
+      #   #       ohm[:color].to_sym == :red
+      #   #     )
+      #   #   end
+      #   # end
+
+      #   # Only keep order history meta for those
+      #   # hashes that exist in the last order history
+      #   # response
+      #   # order_history_meta.keep_if do |ohm|
+      #   #   order_history.find do |oh|
+      #   #     (oh[:id] == ohm[:buy_order_id] || oh[:id] == ohm[:sell_order_id]) && (
+      #   #       ohm[:color].to_sym == :white ||
+      #   #       ohm[:color].to_sym == :green ||
+      #   #       ohm[:color].to_sym == :yellow
+      #   #     )
+      #   #   end
+      #   # end
+      #   # event_history.order_book[:order_history_meta] = order_history_meta
+
+      #   # Reset Market Trend Counter
+      #   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'
+      #   )
+      # rescue StandardError => e
+      #   raise e
+      # end
+
+      # Display Usage for this Module
+
+      public_class_method def self.help
+        puts "USAGE:
+         order_trend_indicator_hash = #{self}.status
+        "
+      end
+    end
+  end
+end

data/lib/cryptum/order_book/profit_margin.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Cryptum
+  # This plugin is used to indicate if the
+  # Projected Profit Margin is greater than
+  # the Target Profit Margin Outlined in the
+  # Respective Bot Conf
+
+  module OrderBook
+    module ProfitMargin
+      # Supported Method Parameters::
+      # Cryptum::OrderBook::ProfitMargin.status(
+      # )
+
+      public_class_method def self.status(opts = {})
+        indicator_hash = {}
+        target_profit_margin_percent = opts[:target_profit_margin_percent]
+        total_invested = opts[:total_invested]
+        total_projected_return = opts[:total_projected_return]
+        indicator_status = opts[:indicator_status]
+        invested = opts[:invested]
+
+        ave_profit_margin_percent = 100 - ((total_invested / total_projected_return) * 100)
+
+        if ave_profit_margin_percent > target_profit_margin_percent
+          indicator_hash[:color] = :green
+          pm_op = '>'
+        elsif ave_profit_margin_percent < target_profit_margin_percent
+          indicator_hash[:color] = :red
+          pm_op = '<'
+        else
+          indicator_hash[:color] = :yellow
+          pm_op = '=='
+        end
+
+        profit_margin_status_out = "Profit Margin #{pm_op} TPM"
+        indicator_hash[:invested] = invested
+        indicator_hash[:status] = profit_margin_status_out
+
+        indicator_status.profit_margin = indicator_hash
+      rescue StandardError => e
+        raise e
+      end
+
+      # Display Usage for this Module
+
+      public_class_method def self.help
+        puts "USAGE:
+         weighted_ave_indicator_hash = #{self}.status(
+         )
+        "
+      end
+    end
+  end
+end

data/lib/cryptum/order_book.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'logger'
+
+module Cryptum
+  # This module is used to define the Order Book Data Structure
+  module OrderBook
+    require 'cryptum/order_book/generate'
+    require 'cryptum/order_book/indicator'
+    require 'cryptum/order_book/market_trend'
+    require 'cryptum/order_book/profit_margin'
+
+    # Display Usage for this Module
+    public_class_method def self.help
+      constants.sort
+    end
+  end
+end

data/lib/cryptum/portfolio/balance.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Cryptum
+  # This plugin is used to instantiate a Cryptum logger with a custom message format
+  module Portfolio
+    module Balance
+      # Supported Method Parameters::
+      # Cryptum::Event::Update.summary(
+      # )
+      public_class_method def self.refresh(opts = {})
+        option_choice = opts[:option_choice]
+        env = opts[:env]
+        terminal_win = opts[:terminal_win]
+        event_history = opts[:event_history]
+        fiat_portfolio_file = opts[:fiat_portfolio_file]
+
+        this_product = event_history.order_book[:this_product]
+        crypto = this_product[:base_currency]
+        fiat = this_product[:quote_currency]
+
+        if event_history.first_event ||
+           event_history.reconnected ||
+           event_history.event_type == :received ||
+           event_history.event_type == :open ||
+           event_history.event_type == :done ||
+           event_history.event_type == :match ||
+           event_history.event_type == :change ||
+           event_history.event_type == :activate ||
+           terminal_win.key_press_event.key_u
+
+          etype = event_history.event_type
+          manual_refresh = terminal_win.key_press_event.key_u
+          etype = :manual_refresh if manual_refresh
+          etype = :first_event if event_history.first_event
+          etype = :reconnected if event_history.reconnected
+          event_history.event_type = etype
+
+          # Prevent Multiple Order Events from Occuring --- #
+          ocancel = event_history.order_canceled
+          osubmit = event_history.order_submitted
+
+          # POTENTIAL STOP IN ORDERS WHEN
+          # event_history.order_canceled = true
+          # Verify it's not due to EMA being red.
+          # ocancel = false if (etype == :open || etype == :done) &&
+          #                    osubmit == false &&
+          #                    !manual_refresh
+
+          ocancel = false if etype == :done &&
+                             osubmit == true &&
+                             !manual_refresh
+
+          event_history.order_canceled = ocancel
+
+          osubmit = false if etype == :done &&
+                             !manual_refresh
+
+          event_history.order_submitted = osubmit
+          # ---------------------------------------------- #
+
+          enotes = event_history.event_notes
+          enotes = "{ \"event_type\": \"#{etype}\", \"cancel\": \"#{ocancel}\", \"submitted\": \"#{osubmit}\" }" if option_choice.proxy
+          event_history.event_notes = enotes
+
+          portfolio = Cryptum::API.get_portfolio(
+            option_choice: option_choice,
+            env: env,
+            crypto: crypto,
+            fiat: fiat,
+            fiat_portfolio_file: fiat_portfolio_file,
+            event_notes: event_history.event_notes
+          )
+          event_history.order_book[:portfolio] = portfolio unless portfolio.empty?
+
+          order_history = Cryptum::API.get_order_history(
+            option_choice: option_choice,
+            env: env
+          )
+          event_history.order_book[:order_history] = order_history unless order_history.empty?
+
+          fees = Cryptum::API.get_fees(
+            option_choice: option_choice,
+            env: env
+          )
+          event_history.order_book[:fees] = fees unless fees.empty?
+
+          terminal_win.key_press_event.key_u = false if manual_refresh
+          # First Event to Refresh No Longer Needed
+          event_history.first_event = false
+          # Reconnected Event to Refresh No Longer Needed
+          event_history.reconnected = false
+        end
+
+        # Always reload fiat portfolio as it's shared
+        # by all sessions (unless it's empty)
+        fpf = ''
+        fpf = File.read(fiat_portfolio_file) unless File.empty?(
+          fiat_portfolio_file
+        )
+
+        unless fpf.empty?
+          event_history.order_book[:fiat_portfolio] = JSON.parse(
+            fpf,
+            symbolize_names: true
+          )
+        end
+
+        event_history
+      rescue StandardError => e
+        raise e
+      end
+
+      # Display Usage for this Module
+      public_class_method def self.help
+        puts "USAGE:
+         event_history.order_book = #{self}.crypto()
+        "
+      end
+    end
+  end
+end

data/lib/cryptum/portfolio.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Cryptum
+  # This plugin is used to instantiate a Cryptum logger with a custom message format
+  module Portfolio
+    require 'cryptum/portfolio/balance'
+
+    # Display Usage for this Module
+    public_class_method def self.help
+      constants.sort
+    end
+  end
+end

data/lib/cryptum/ui/command.rb

@@ -0,0 +1,314 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Cryptum
+  module UI
+    # This plugin is used to Refresh the Cryptum Command Section UI
+    module Command
+      # Supported Method Parameters::
+      # Cryptum::UI::Command.refresh(
+      #   action_command_status: 'required - Instatiated Cryptum::OrderBook::Probabilities Object'
+      # )
+      public_class_method def self.refresh(opts = {})
+        command_win = opts[:command_win]
+        key_press_event = opts[:key_press_event]
+
+        key_press_event = Cryptum::UI.detect_key_press_in_ui(
+          key_press_event: key_press_event,
+          ui_win: command_win
+        )
+
+        if key_press_event.key_c
+          key_c_color = :cyan
+          key_c_style = :reverse
+        else
+          key_c_color = :white
+          key_c_style = :bold
+        end
+
+        if key_press_event.key_g
+          key_g_color = :cyan
+          key_g_style = :reverse
+        else
+          key_g_color = :white
+          key_g_style = :bold
+        end
+
+        if key_press_event.key_r
+          key_r_color = :cyan
+          key_r_style = :reverse
+        else
+          key_r_color = :white
+          key_r_style = :bold
+        end
+
+        if key_press_event.key_u
+          key_u_color = :cyan
+          key_u_style = :reverse
+        else
+          key_u_color = :white
+          key_u_style = :bold
+        end
+
+        if key_press_event.key_w
+          key_w_color = :cyan
+          key_w_style = :reverse
+        else
+          key_w_color = :white
+          key_w_style = :bold
+        end
+
+        if key_press_event.key_x
+          key_x_color = :cyan
+          key_x_style = :reverse
+        else
+          key_x_color = :white
+          key_x_style = :bold
+        end
+
+        command_str_r2_arr = [
+          "* v#{Cryptum::VERSION} >>> ",
+          '[',
+          'C',
+          ']ancel Open Orders',
+          ' | ',
+          '[',
+          'G',
+          ']TFO',
+          ' | ',
+          '[',
+          'r',
+          ']eload bot conf'
+        ]
+
+        command_str_r3_arr = [
+          '[',
+          'u',
+          ']pdate summary',
+          ' | ',
+          '[',
+          'w',
+          ']rite order book',
+          ' | ',
+          'e[',
+          'x',
+          ']it'
+        ]
+        # ROW 1
+        out_line_no = 0
+        command_win.clrtoeol
+        command_win.setpos(
+          out_line_no,
+          Cryptum::UI.col_center(str: command_str_r2_arr.join)
+        )
+
+        # * v#{Cryptum::VERSION} >>>
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: :yellow,
+          style: :bold,
+          string: command_str_r2_arr.first
+        )
+
+        # [C]ancel Open Orders
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: key_c_color,
+          style: key_c_style,
+          string: command_str_r2_arr[1]
+        )
+
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: :yellow,
+          style: key_c_style,
+          string: command_str_r2_arr[2]
+        )
+
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: key_c_color,
+          style: key_c_style,
+          string: command_str_r2_arr[3]
+        )
+
+        # |
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: :white,
+          string: command_str_r2_arr[4]
+        )
+
+        # [G]TFO
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: key_g_color,
+          style: key_g_style,
+          string: command_str_r2_arr[5]
+        )
+
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: :yellow,
+          style: key_g_style,
+          string: command_str_r2_arr[6]
+        )
+
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: key_g_color,
+          style: key_g_style,
+          string: command_str_r2_arr[7]
+        )
+
+        # |
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: :white,
+          string: command_str_r2_arr[8]
+        )
+
+        # [r]eload bot conf
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: key_r_color,
+          style: key_r_style,
+          string: command_str_r2_arr[9]
+        )
+
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: :yellow,
+          style: key_r_style,
+          string: command_str_r2_arr[10]
+        )
+
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: key_r_color,
+          style: key_r_style,
+          string: command_str_r2_arr.last
+        )
+
+        # ROW 3
+        out_line_no += 1
+        command_win.setpos(
+          out_line_no,
+          Cryptum::UI.col_center(str: command_str_r3_arr.join)
+        )
+        command_win.clrtoeol
+
+        # [u]date summary
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: key_u_color,
+          style: key_u_style,
+          string: command_str_r3_arr.first
+        )
+
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: :yellow,
+          style: key_u_style,
+          string: command_str_r3_arr[1]
+        )
+
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: key_u_color,
+          style: key_u_style,
+          string: command_str_r3_arr[2]
+        )
+
+        # |
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: :white,
+          string: command_str_r3_arr[3]
+        )
+
+        # [w]rite order book
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: key_w_color,
+          style: key_w_style,
+          string: command_str_r3_arr[4]
+        )
+
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: :yellow,
+          style: key_w_style,
+          string: command_str_r3_arr[5]
+        )
+
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: key_w_color,
+          style: key_w_style,
+          string: command_str_r3_arr[6]
+        )
+
+        # |
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: :white,
+          string: command_str_r3_arr[7]
+        )
+
+        # e[x]it
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: key_x_color,
+          style: key_x_style,
+          string: command_str_r3_arr[8]
+        )
+
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: :yellow,
+          style: key_x_style,
+          string: command_str_r3_arr[9]
+        )
+
+        Cryptum::UI.colorize(
+          ui_win: command_win,
+          color: key_x_color,
+          style: key_x_style,
+          string: command_str_r3_arr.last
+        )
+
+        # ROW 4
+        out_line_no += 1
+        Cryptum::UI.line(
+          ui_win: command_win,
+          out_line_no: out_line_no
+        )
+
+        command_win.refresh
+
+        sleep 0.15 if key_press_event.key_g ||
+                      key_press_event.key_r ||
+                      key_press_event.key_u ||
+                      key_press_event.key_w ||
+                      key_press_event.key_x
+      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(
+           command_status: 'required - Instatiated Cryptum::OrderBook::Probabilities Object'
+         )
+        "
+      end
+    end
+  end
+end

data/lib/cryptum/ui/key_press_event.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Cryptum
+  module UI
+    # This Class is Used to Detect Key Press Events
+    class KeyPressEvent
+      attr_accessor :key_c,
+                    :key_g,
+                    :key_r,
+                    :key_u,
+                    :key_w,
+                    :key_x,
+                    :key_ansi,
+                    :key_down_arrow,
+                    :key_end,
+                    :key_enter,
+                    :key_esc,
+                    :key_home,
+                    :key_page_down,
+                    :key_page_up,
+                    :key_tab,
+                    :key_up_arrow
+
+    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
+  end
+end