cryptum 0.0.358 → 0.0.360

data/lib/cryptum/event/pane.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Cryptum
+  # This plugin is used to Switch through Order Plan / Order History
+  # Window Panes when the TAB Key is Pressed.
+  module Event
+    module Pane
+      # Supported Method Parameters::
+      # Cryptum::Event::Pane.switch(
+      # )
+      public_class_method def self.switch(opts = {})
+        terminal_win = opts[:terminal_win]
+        event_history = opts[:event_history]
+
+        terminal_win.key_press_event.key_tab = false
+
+        if event_history.order_plan_win_active
+          event_history.order_plan_win_active = false
+          event_history.order_execute_win_active = true
+        else
+          event_history.order_plan_win_active = true
+          event_history.order_execute_win_active = false
+        end
+      rescue StandardError => e
+        raise e
+      end
+
+      # Supported Method Parameters::
+      # Cryptum::Event::Pane.toggle_details(
+      # )
+      public_class_method def self.toggle_details(opts = {})
+        terminal_win = opts[:terminal_win]
+        event_history = opts[:event_history]
+
+        terminal_win.key_press_event.key_enter = false
+
+        if event_history.order_plan_win_active
+          unless event_history.red_pill
+            if event_history.order_plan_details_win_active
+              event_history.order_plan_details_win_active = false
+            else
+              event_history.order_plan_details_win_active = true
+            end
+          end
+        elsif event_history.order_execute_win_active
+          if event_history.order_execute_details_win_active
+            event_history.order_execute_details_win_active = false
+          else
+            event_history.order_execute_details_win_active = true
+          end
+        end
+      rescue StandardError => e
+        raise e
+      end
+
+      # Display Usage for this Module
+      public_class_method def self.help
+        puts "USAGE:
+          #{self}.switch()
+          #{self}.toggle_details()
+        "
+      end
+    end
+  end
+end

data/lib/cryptum/event/parse.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+module Cryptum
+  # This plugin is used to parse Coinbase Pro Web Socket Events in the HTTP Response
+  module Event
+    module Parse
+      # Supported Method Parameters::
+      # Cryptum::Event::Pane.websocket_msg(
+      # )
+      public_class_method def self.websocket_msg(opts = {})
+        env = opts[:env]
+        terminal_win = opts[:terminal_win]
+        option_choice = opts[:option_choice]
+        event_history = opts[:event_history]
+        indicator_status = opts[:indicator_status]
+        bot_conf = opts[:bot_conf]
+
+        this_product = event_history.order_book[:this_product]
+        fiat = this_product[:quote_currency]
+        fiat_portfolio_file = "#{option_choice.session_root}/order_books/#{fiat}_PORTFOLIO.json"
+
+        # Determine if Summary UI needs updated data
+        event_history = Cryptum::Portfolio::Balance.refresh(
+          env: env,
+          option_choice: option_choice,
+          terminal_win: terminal_win,
+          event_history: event_history,
+          fiat_portfolio_file: fiat_portfolio_file
+        )
+
+        # If the Terminal Window has been Resized, Resize the UI
+        if Curses.cols != terminal_win.cols
+          terminal_win.cols = Curses.cols
+          terminal_win.ticker_ui_resize = true
+          terminal_win.market_trend_ui_resize = true
+        end
+
+        event_history = Cryptum::UI::Portfolio.refresh(
+          option_choice: option_choice,
+          portfolio_win: terminal_win.portfolio_section,
+          event_history: event_history,
+          key_press_event: terminal_win.key_press_event,
+          indicator_status: indicator_status,
+          bot_conf: bot_conf,
+          fiat_portfolio_file: fiat_portfolio_file
+        )
+
+        if event_history.event_type == :ticker ||
+           terminal_win.ticker_ui_resize
+
+          ticker_event = event_history.ticker_event = event_history.event if event_history.event_type == :ticker
+          ticker_event = event_history.ticker_event if terminal_win.ticker_ui_resize
+          event_history = Cryptum::UI::Ticker.refresh(
+            option_choice: option_choice,
+            start_time: event_history.start_time,
+            ticker_win: terminal_win.ticker_section,
+            key_press_event: terminal_win.key_press_event,
+            event_history: event_history,
+            event: ticker_event
+          )
+        end
+
+        Cryptum::UI::OrderTimer.refresh(
+          option_choice: option_choice,
+          event_history: event_history,
+          order_timer_win: terminal_win.order_timer_section,
+          indicator_status: indicator_status,
+          key_press_event: terminal_win.key_press_event
+        )
+
+        if event_history.event_type == :l2update ||
+           terminal_win.market_trend_ui_resize
+
+          market_trend_event = event_history.market_trend_event = event_history.event if event_history.event_type == :l2update
+          market_trend_event = event_history.market_trend_event if terminal_win.market_trend_ui_resize
+          event_history = Cryptum::UI::MarketTrend.refresh(
+            option_choice: option_choice,
+            market_trend_win: terminal_win.market_trend_section,
+            event_history: event_history,
+            key_press_event: terminal_win.key_press_event,
+            event: market_trend_event,
+            indicator_status: indicator_status,
+            bot_conf: bot_conf
+          )
+        end
+
+        indicator_status = Cryptum::UI::SignalEngine.refresh(
+          option_choice: option_choice,
+          signal_engine_win: terminal_win.signal_engine_section,
+          event_history: event_history,
+          key_press_event: terminal_win.key_press_event,
+          indicator_status: indicator_status,
+          bot_conf: bot_conf,
+          fiat_portfolio_file: fiat_portfolio_file
+        )
+
+        unless event_history.order_plan_details_win_active
+          event_history = Cryptum::UI::OrderPlan.refresh(
+            option_choice: option_choice,
+            order_plan_win: terminal_win.order_plan_section,
+            env: env,
+            event_history: event_history,
+            key_press_event: terminal_win.key_press_event,
+            indicator_status: indicator_status,
+            bot_conf: bot_conf,
+            fiat_portfolio_file: fiat_portfolio_file
+          )
+          recalc_op = event_history.recalculate_order_plan
+          order_plan = event_history.order_book[:order_plan]
+          terminal_win.key_press_event.key_w = true if (recalc_op || order_plan.empty?) &&
+                                                       !event_history.red_pill
+          event_history.recalculate_order_plan = false
+        end
+
+        if event_history.order_plan_details_win_active
+          event_history = Cryptum::UI::OrderPlanDetails.refresh(
+            option_choice: option_choice,
+            order_plan_details_win: terminal_win.order_plan_details_section,
+            event_history: event_history,
+            key_press_event: terminal_win.key_press_event
+          )
+        end
+
+        unless event_history.order_execute_details_win_active
+          event_history = Cryptum::UI::OrderExecution.refresh(
+            option_choice: option_choice,
+            order_execute_win: terminal_win.order_execute_section,
+            env: env,
+            event_history: event_history,
+            key_press_event: terminal_win.key_press_event,
+            indicator_status: indicator_status,
+            bot_conf: bot_conf,
+            fiat_portfolio_file: fiat_portfolio_file
+          )
+        end
+
+        if event_history.order_execute_details_win_active
+          event_history = Cryptum::UI::OrderExecuteDetails.refresh(
+            option_choice: option_choice,
+            order_execute_details_win: terminal_win.order_execute_details_section,
+            event_history: event_history,
+            key_press_event: terminal_win.key_press_event
+          )
+        end
+
+        # Refresh Command Section for Cryptum Session Usage
+        Cryptum::UI::Command.refresh(
+          command_win: terminal_win.command_section,
+          key_press_event: terminal_win.key_press_event
+        )
+
+        event_history
+      rescue Interrupt
+        # Exit Gracefully if CTRL+C is Pressed During Session
+        Cryptum.exit_gracefully(
+          which_self: self,
+          event_history: event_history,
+          option_choice: option_choice,
+          env: env
+        )
+      rescue StandardError => e
+        raise e
+      end
+
+      # Display Usage for this Module
+      public_class_method def self.help
+        puts "USAGE:
+          #{self}.websocket_msg(
+            env: env,
+            terminal_win: terminal_win,
+            option_choice: option_choice,
+            event_history: event_history,
+            indicator_status: indicator_status,
+            bot_conf: bot_conf,
+            ai_enabled: ai_enabled
+          )
+        "
+      end
+    end
+  end
+end

data/lib/cryptum/event/scroll.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+module Cryptum
+  # This plugin is used to Scroll through Order Plan
+  # Order Plan and Order History Window Panes
+  # to File When the "w" Key is Pressed
+  module Event
+    module Scroll
+      # Supported Method Parameters::
+      # Cryptum::Event::Scroll.up(
+      # )
+      public_class_method def self.up(opts = {})
+        terminal_win = opts[:terminal_win]
+        event_history = opts[:event_history]
+
+        terminal_win.key_press_event.key_ansi = false
+        terminal_win.key_press_event.key_esc = false
+        terminal_win.key_press_event.key_up_arrow = false
+
+        if event_history.order_plan_win_active
+          event_history.order_plan_row_to_select -= 1
+          event_history.order_plan_index_offset -= 1 if event_history.order_plan_row_to_select.negative?
+          event_history.order_plan_index_offset = 0 if event_history.order_plan_index_offset.negative?
+          event_history.order_plan_row_to_select = 0 if event_history.order_plan_row_to_select.negative?
+        end
+
+        if event_history.order_execute_win_active
+          event_history.order_execute_row_to_select -= 1
+          event_history.order_execute_index_offset -= 1 if event_history.order_execute_row_to_select.negative?
+          event_history.order_execute_index_offset = 0 if event_history.order_execute_index_offset.negative?
+          event_history.order_execute_row_to_select = 0 if event_history.order_execute_row_to_select.negative?
+        end
+      rescue StandardError => e
+        raise e
+      end
+
+      # Supported Method Parameters::
+      # Cryptum::Event::Scroll.down(
+      # )
+      public_class_method def self.down(opts = {})
+        terminal_win = opts[:terminal_win]
+        event_history = opts[:event_history]
+
+        terminal_win.key_press_event.key_ansi = false
+        terminal_win.key_press_event.key_esc = false
+        terminal_win.key_press_event.key_down_arrow = false
+
+        order_book = event_history.order_book
+
+        if event_history.order_plan_win_active
+          order_plan_length = order_book[:order_plan].length
+          last_row = order_plan_length - 1
+          event_history.order_plan_max_records_available_to_display = last_row if last_row < event_history.order_plan_max_rows_to_display
+
+          event_history.order_plan_row_to_select += 1
+          event_history.order_plan_index_offset += 1 if event_history.order_plan_row_to_select > event_history.order_plan_max_records_available_to_display
+          event_history.order_plan_row_to_select = event_history.order_plan_max_records_available_to_display if event_history.order_plan_row_to_select > event_history.order_plan_max_records_available_to_display
+        end
+
+        if event_history.order_execute_win_active
+          order_history_meta_length = order_book[:order_history_meta].length
+          last_row = order_history_meta_length - 1
+          event_history.order_execute_max_records_available_to_display = last_row if last_row < event_history.order_execute_max_rows_to_display
+
+          event_history.order_execute_row_to_select += 1
+          event_history.order_execute_index_offset += 1 if event_history.order_execute_row_to_select > event_history.order_execute_max_records_available_to_display
+          event_history.order_execute_row_to_select = event_history.order_execute_max_records_available_to_display if event_history.order_execute_row_to_select > event_history.order_execute_max_records_available_to_display
+        end
+      rescue StandardError => e
+        raise e
+      end
+
+      # Supported Method Parameters::
+      # Cryptum::Event::Scroll.page_up(
+      # )
+      public_class_method def self.page_up(opts = {})
+        terminal_win = opts[:terminal_win]
+        event_history = opts[:event_history]
+
+        terminal_win.key_press_event.key_ansi = false
+        terminal_win.key_press_event.key_esc = false
+        terminal_win.key_press_event.key_page_up = false
+
+        if event_history.order_plan_win_active
+          event_history.order_plan_row_to_select = 0
+          event_history.order_plan_index_offset -= event_history.order_plan_max_rows_to_display + 1
+          event_history.order_plan_index_offset = 0 if event_history.order_plan_index_offset.negative?
+          event_history.order_plan_row_to_select = 0 if event_history.order_plan_row_to_select.negative?
+        end
+
+        if event_history.order_execute_win_active
+          event_history.order_execute_row_to_select = 0
+          event_history.order_execute_index_offset -= event_history.order_execute_max_rows_to_display + 1
+          event_history.order_execute_index_offset = 0 if event_history.order_execute_index_offset.negative?
+          event_history.order_execute_row_to_select = 0 if event_history.order_execute_row_to_select.negative?
+        end
+      rescue StandardError => e
+        raise e
+      end
+
+      # Supported Method Parameters::
+      # Cryptum::Event::Scroll.page_down(
+      # )
+      public_class_method def self.page_down(opts = {})
+        terminal_win = opts[:terminal_win]
+        event_history = opts[:event_history]
+
+        terminal_win.key_press_event.key_ansi = false
+        terminal_win.key_press_event.key_esc = false
+        terminal_win.key_press_event.key_page_down = false
+
+        order_book = event_history.order_book
+
+        if event_history.order_plan_win_active
+          order_plan_length = order_book[:order_plan].length
+          event_history.order_plan_row_to_select = 0
+          event_history.order_plan_index_offset += event_history.order_plan_max_rows_to_display + 1 unless event_history.order_plan_index_offset > order_plan_length
+        end
+
+        if event_history.order_execute_win_active
+          order_history_meta_length = order_book[:order_history_meta].length
+          event_history.order_execute_row_to_select = 0
+          event_history.order_execute_index_offset += event_history.order_execute_max_rows_to_display + 1 unless event_history.order_execute_index_offset > order_history_meta_length
+        end
+      rescue StandardError => e
+        raise e
+      end
+
+      # Supported Method Parameters::
+      # Cryptum::Event::Scroll.top(
+      # )
+      public_class_method def self.top(opts = {})
+        terminal_win = opts[:terminal_win]
+        event_history = opts[:event_history]
+
+        terminal_win.key_press_event.key_ansi = false
+        terminal_win.key_press_event.key_esc = false
+        terminal_win.key_press_event.key_home = false
+
+        if event_history.order_plan_win_active
+          event_history.order_plan_row_to_select = 0
+          event_history.order_plan_index_offset = 0
+        end
+
+        if event_history.order_execute_win_active
+          event_history.order_execute_row_to_select = 0
+          event_history.order_execute_index_offset = 0
+        end
+      rescue StandardError => e
+        raise e
+      end
+
+      # Supported Method Parameters::
+      # Cryptum::Event::Scroll.bottom(
+      # )
+      public_class_method def self.bottom(opts = {})
+        terminal_win = opts[:terminal_win]
+        event_history = opts[:event_history]
+
+        terminal_win.key_press_event.key_ansi = false
+        terminal_win.key_press_event.key_esc = false
+        terminal_win.key_press_event.key_end = false
+
+        order_book = event_history.order_book
+
+        if event_history.order_plan_win_active
+          order_plan_length = order_book[:order_plan].length
+          last_row = order_plan_length - 1
+          event_history.order_plan_max_records_available_to_display = last_row if last_row < event_history.order_plan_max_rows_to_display
+
+          event_history.order_plan_row_to_select = event_history.order_plan_max_records_available_to_display
+          event_history.order_plan_index_offset = order_plan_length - event_history.order_plan_max_records_available_to_display
+        end
+
+        if event_history.order_execute_win_active
+          order_history_meta_length = order_book[:order_history_meta].length
+          last_row = order_history_meta_length - 1
+          event_history.order_execute_max_records_available_to_display = last_row if last_row < event_history.order_execute_max_rows_to_display
+
+          event_history.order_execute_row_to_select = event_history.order_execute_max_records_available_to_display
+          event_history.order_execute_index_offset = order_history_meta_length - event_history.order_execute_max_records_available_to_display
+        end
+      rescue StandardError => e
+        raise e
+      end
+
+      # Display Usage for this Module
+      public_class_method def self.help
+        puts "USAGE:
+          #{self}.up()
+          #{self}.down()
+          #{self}.page_up()
+          #{self}.page_down()
+          #{self}.top()
+          #{self}.bottom()
+        "
+      end
+    end
+  end
+end

data/lib/cryptum/event/sell.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module Cryptum
+  # This plugin is used to Submit a Limit Order
+  # to Sell Crypto Currency
+
+  module Event
+    module Sell
+      # Supported Method Parameters::
+      # Cryptum::Event::Sell.crypto(
+      # )
+      public_class_method def self.crypto(opts = {})
+        option_choice = opts[:option_choice]
+        env = opts[:env]
+        bot_conf = opts[:bot_conf]
+        stuck_in_pos_status = opts[:stuck_in_pos_status]
+        event_history = opts[:event_history]
+        order_type = opts[:order_type]
+        fiat_smallest_decimal = opts[:fiat_smallest_decimal]
+        crypto_smallest_decimal = opts[:crypto_smallest_decimal]
+        # base_min_size = opts[:base_min_size]
+        min_market_funds = this_product[:min_market_funds]
+        indicator_status = opts[:indicator_status]
+        quote_increment = opts[:quote_increment]
+
+        # Initialize some bot_conf variables
+        pie_in_sky_sell_percent = bot_conf[:pie_in_sky_sell_percent].to_f
+
+        crypto_currency = option_choice.symbol.to_s.upcase.split('_').first
+        portfolio = event_history.order_book[:portfolio]
+        symbol_portfolio = portfolio.select do |this_portfolio|
+          this_portfolio if this_portfolio[:currency] == crypto_currency
+        end
+
+        symbol_balance_available = format(
+          '%0.8f',
+          symbol_portfolio.first[:available].to_f
+        ).to_f
+
+        # 2. Calculate Price, Size, Fees
+        # Get the middle of last 3 ticker prices
+        # to avoid over purcase blips.
+        last_three_prices_arr = []
+        last_ticker_price = event_history.order_book[:ticker_price].to_f
+        second_to_last_ticker_price = event_history.order_book[:ticker_price_second_to_last].to_f
+        third_to_last_ticker_price = event_history.order_book[:ticker_price_third_to_last].to_f
+        last_three_prices_arr.push(last_ticker_price)
+        last_three_prices_arr.push(second_to_last_ticker_price)
+        last_three_prices_arr.push(third_to_last_ticker_price)
+        # limit_price = last_three_prices_arr.min
+        # limit_price = last_three_prices_arr.max
+
+        # Obtain our Target Price based on TPM configurations
+        target_symbol_price = stuck_in_pos_status[:target_symbol_price].to_f
+
+        case order_type
+        when :pie
+          pie_in_sky_sell_percent_cast_as_decimal = format(
+            '%0.2f',
+            pie_in_sky_sell_percent * 0.01
+          ).to_f
+
+          target_profit = target_symbol_price * pie_in_sky_sell_percent_cast_as_decimal
+          limit_price = target_symbol_price + target_profit
+
+        when :tpm
+          limit_price = target_symbol_price
+          # TODO: Ensure previous order price
+          # on last _open order_ if applicable
+          # is greater than this one.
+          order_type = :tpm
+        when :gtfo
+          # Attempt to get in front of falling price.
+          limit_price = last_three_prices_arr.sort[1]
+          gtfo_price = limit_price -= quote_increment.to_f
+          limit_price = gtfo_price if gtfo_price.positive?
+        else
+          raise "ERROR: Unknown order_type: #{order_type}"
+        end
+
+        price = format("%0.#{fiat_smallest_decimal}f", limit_price)
+
+        # Selling Available Crytpo Balance in its Entirety
+        # We Will Likely Want to Change this in the Future.
+        size = format(
+          "%0.#{crypto_smallest_decimal}f",
+          symbol_balance_available.floor(crypto_smallest_decimal)
+        )
+
+        size = symbol_balance_available if min_market_funds.to_i == 1
+
+        if size.to_f >= min_market_funds.to_f &&
+           price.to_f.positive?
+
+          # SUBMIT SELL ORDER
+          event_history.order_submitted = true
+          event_history.event_notes = "{ \"event_type\": \"#{event_history.event_type}\", \"cancel\": \"#{event_history.order_canceled}\", \"submitted\": \"#{event_history.order_submitted}\" }" if option_choice.proxy
+
+          event_history = Cryptum::API.submit_limit_order(
+            option_choice: option_choice,
+            env: env,
+            price: price,
+            size: size,
+            buy_or_sell: :sell,
+            order_type: order_type,
+            event_history: event_history,
+            indicator_status: indicator_status
+          )
+        end
+
+        event_history
+      rescue StandardError => e
+        raise e
+      end
+
+      # Display Usage for this Module
+      public_class_method def self.help
+        puts "USAGE:
+         order_book = #{self}.crypto()
+        "
+      end
+    end
+  end
+end

data/lib/cryptum/event.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Cryptum
+  # This plugin is used to parse Coinbase Pro Web Socket Events in the HTTP Response
+  module Event
+    require 'cryptum/event/bot_conf'
+    require 'cryptum/event/buy'
+    require 'cryptum/event/cancel'
+    require 'cryptum/event/exit'
+    require 'cryptum/event/gtfo'
+    require 'cryptum/event/history'
+    require 'cryptum/event/key_press'
+    require 'cryptum/event/order_book'
+    require 'cryptum/event/pane'
+    require 'cryptum/event/parse'
+    require 'cryptum/event/scroll'
+    require 'cryptum/event/sell'
+
+    # Display Usage for this Module
+
+    public_class_method def self.help
+      constants.sort
+    end
+  end
+end

data/lib/cryptum/log.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Cryptum
+  # This plugin is used to instantiate a Cryptum logger with a custom message format
+  module Log
+    # Supported Method Parameters::
+    # Cryptum::Log.create(
+    # )
+    public_class_method def self.create
+      logger = Logger.new($stdout)
+      logger.level = Logger::INFO
+      logger.datetime_format = '%Y-%m-%d %H:%M:%S'
+
+      logger.formatter = proc do |severity, _datetime, _progname, msg|
+        # TODO: Include datetime & progname vars
+        "[#{severity}] #{msg}\n"
+      end
+
+      logger
+    rescue StandardError => e
+      raise e
+    end
+
+    # Display Usage for this Module
+
+    public_class_method def self.help
+      puts "USAGE:
+        logger = #{self}.create()
+      "
+    end
+  end
+end