cryptum 0.0.359 → 0.0.361

data/lib/cryptum/web_sock/event_machine.rb

@@ -0,0 +1,276 @@
+# frozen_string_literal: true
+
+require 'eventmachine'
+require 'json'
+
+module Cryptum
+  # This plugin is used to Establish a Web
+  # Socket Connection with Coinbase
+  module WebSock
+    # This module is the primary module to handle
+    # Web Socket Events from Coinbase
+    module EventMachine
+      # Supported Method Parameters::
+      # Cryptum::WS.run(
+      # )
+      public_class_method def self.run(opts = {})
+        env = opts[:env]
+        option_choice = opts[:option_choice]
+        terminal_win = opts[:terminal_win]
+        event_history = opts[:event_history]
+        indicator_status = opts[:indicator_status]
+        bot_conf = opts[:bot_conf]
+
+        max_conn_attempts = 30
+        conn_attempt = 0
+
+        begin
+          conn_attempt += 1
+          event_history.reconnected = true if conn_attempt > 1
+
+          EM.run do
+            # Iterate as fast as possible
+            # This ensures candle timing is accurate
+            # and everything is fast as possible
+            # Defaults to 100ms, 5ms is the lowest possible
+            delay_ms = 5
+            delay_ms_cast_as_decimal = delay_ms * 0.001
+            EM.set_quantum(delay_ms)
+
+            ws = Cryptum::WebSock::Coinbase.connect(
+              option_choice: option_choice,
+              env: env
+            )
+
+            ws.on :open do |_event|
+              ws.send(
+                Cryptum::WebSock::Coinbase.subscribe_message(
+                  option_choice: option_choice,
+                  env: env
+                )
+              )
+            end
+
+            ws.on :message do |event|
+              # TODO: The Speed of the UI is dictated by the
+              # Frequency of WebSocket Messages Coming Through.
+              # Explore another way to decouple required events
+              # (such as keypresses) from only being triggered
+              # when messages come through.
+
+              event_history.event = JSON.parse(
+                event.data,
+                symbolize_names: true
+              )
+              event_history.event_type = event_history.event[:type].to_s.to_sym
+
+              event_history = Cryptum::Event::Parse.websocket_msg(
+                env: env,
+                terminal_win: terminal_win,
+                option_choice: option_choice,
+                event_history: event_history,
+                indicator_status: indicator_status,
+                bot_conf: bot_conf
+              )
+
+              # Detect Key Press Events
+              Cryptum::Event::KeyPress.detect(terminal_win: terminal_win)
+
+              # Cancel ALL Open Orders when
+              # C is pressed
+              if terminal_win.key_press_event.key_c
+                Cryptum::Event::Cancel.open_orders(
+                  terminal_win: terminal_win,
+                  option_choice: option_choice,
+                  env: env
+                )
+              end
+
+              # Get the F* Out (GTFO) when
+              # G is pressed
+              if terminal_win.key_press_event.key_g
+                event_history = Cryptum::Event::GTFO.now(
+                  terminal_win: terminal_win,
+                  option_choice: option_choice,
+                  env: env,
+                  event_history: event_history,
+                  bot_conf: bot_conf
+                )
+              end
+
+              # Reload Bot Conf when r is Pressed
+              if terminal_win.key_press_event.key_r
+                bot_conf = Cryptum::Event::BotConf.reload(
+                  terminal_win: terminal_win,
+                  event_history: event_history,
+                  option_choice: option_choice
+                )
+              end
+
+              # Only Write Order Book to File when
+              # W is Pressed
+              if terminal_win.key_press_event.key_w
+                Cryptum::Event::OrderBook.write(
+                  terminal_win: terminal_win,
+                  event_history: event_history
+                )
+              end
+
+              # Exit if x is Pressed
+              if terminal_win.key_press_event.key_x
+                Cryptum::Event::Exit.gracefully(
+                  terminal_win: terminal_win,
+                  event_history: event_history,
+                  option_choice: option_choice,
+                  env: env
+                )
+              end
+
+              # TAB through Order Plan / Order Execution Window Panes
+              if terminal_win.key_press_event.key_tab
+                Cryptum::Event::Pane.switch(
+                  terminal_win: terminal_win,
+                  event_history: event_history
+                )
+              end
+
+              # Scroll Up Order Plan / Order Execution Window Panes
+              if terminal_win.key_press_event.key_up_arrow
+                Cryptum::Event::Scroll.up(
+                  terminal_win: terminal_win,
+                  event_history: event_history
+                )
+              end
+
+              # Scroll Down Order Plan / Order Execution Window Panes
+              if terminal_win.key_press_event.key_down_arrow
+                Cryptum::Event::Scroll.down(
+                  terminal_win: terminal_win,
+                  event_history: event_history
+                )
+              end
+
+              # Scroll Up Order Plan / Order Execution Window Panes Faster
+              if terminal_win.key_press_event.key_page_up
+                Cryptum::Event::Scroll.page_up(
+                  terminal_win: terminal_win,
+                  event_history: event_history
+                )
+              end
+
+              # Scroll Down Order Plan / Order Execution Window Panes Faster
+              if terminal_win.key_press_event.key_page_down
+                Cryptum::Event::Scroll.page_down(
+                  terminal_win: terminal_win,
+                  event_history: event_history
+                )
+              end
+
+              # Scroll to Top of Order Plan / Order Execution Window Panes
+              if terminal_win.key_press_event.key_home
+                Cryptum::Event::Scroll.top(
+                  terminal_win: terminal_win,
+                  event_history: event_history
+                )
+              end
+
+              # Scroll to Bottom of Order Plan / Order Execution Window Panes
+              if terminal_win.key_press_event.key_end
+                Cryptum::Event::Scroll.bottom(
+                  terminal_win: terminal_win,
+                  event_history: event_history
+                )
+              end
+
+              # Open / Close Order Plan / Order Execution Details Window
+              if terminal_win.key_press_event.key_enter
+                Cryptum::Event::Pane.toggle_details(
+                  terminal_win: terminal_win,
+                  event_history: event_history
+                )
+              end
+            end
+
+            ws.on :close do
+              raise Errno::ECONNRESET
+            end
+
+            EM.add_periodic_timer(delay_ms_cast_as_decimal) do
+              order_countdown = 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 (order_countdown.zero? || order_countdown.negative?) &&
+                 !event_history.red_pill
+
+                # Ready to Submit a BUY order
+                event_history.order_ready = true
+
+                # Reload Bot Conf (i.e. Risk Allocation),
+                # Recalculate Order Plan, and Write to File
+                terminal_win.key_press_event.key_r = true
+              end
+            end
+
+            EM.add_periodic_timer(option_choice.market_trend_reset) do
+              # NOTE: To ensure the integrity of event_history is maintained,
+              # changes to its contenta _MUST_ stay in thos block.
+              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'
+              )
+
+              # Reload Bot Conf (i.e. Risk Allocation)
+              # Recalculate Order Plan, and Write to File
+              terminal_win.key_press_event.key_r = true
+              # IMPORTANT:
+              # Wait for Order Plan recalculation to occur
+              # once Cryptum::UI::OrderPlan is refreshed
+              # in Cryptum::Event _BEFORE_ writing the order
+              # book to file.
+            end
+          end
+        rescue Faye::WebSocket::API::ErrorEvent,
+               Errno::ECONNREFUSED,
+               Errno::ECONNRESET,
+               LoadError => e
+
+          File.open('/tmp/cryptum-errors.txt', 'a') do |f|
+            f.puts Time.now.strftime('%Y-%m-%d %H:%M:%S.%N %z')
+            f.puts "Module: #{self}"
+            f.puts "#{e}\n\n\n"
+          end
+
+          raise e if conn_attempt > max_conn_attempts
+
+          sleep 1
+          retry
+        ensure
+          $stdout.flush
+        end
+      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:
+          logger = #{self}.create()
+        "
+      end
+    end
+  end
+end

data/lib/cryptum/web_sock.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Cryptum
+  # This plugin is used to Establish a Web
+  # Socket Connection with Coinbase
+  module WebSock
+    require 'cryptum/web_sock/coinbase'
+    require 'cryptum/web_sock/event_machine'
+
+    # Display Usage for this Module
+
+    public_class_method def self.help
+      constants.sort
+    end
+  end
+end

data/lib/cryptum.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'rbtrace'
+require 'yaml'
+require 'json'
+require 'fileutils'
+require 'tty-spinner'
+# Root-Level Namespace for cryptum
+module Cryptum
+  $stdout.sync = true
+  $stdout.flush
+
+  require 'cryptum/api'
+  require 'cryptum/bot_conf'
+  require 'cryptum/event'
+  require 'cryptum/log'
+  require 'cryptum/matrix'
+  require 'cryptum/open_ai'
+  require 'cryptum/option'
+  require 'cryptum/order_book'
+  require 'cryptum/portfolio'
+  require 'cryptum/ui'
+  require 'cryptum/version'
+  require 'cryptum/web_sock'
+
+  public_class_method def self.bin
+    File.join root, 'bin'
+  end
+
+  public_class_method def self.etc
+    File.join root, 'etc'
+  end
+
+  public_class_method def self.lib
+    File.join root, 'lib'
+  end
+
+  public_class_method def self.order_book
+    File.join root, 'order_book'
+  end
+
+  public_class_method def self.root
+    File.dirname __dir__
+  end
+
+  public_class_method def self.open_symbol
+    "\u00f8"
+  end
+
+  public_class_method def self.up_arrow
+    "\u2191"
+  end
+
+  public_class_method def self.down_arrow
+    "\u2193"
+  end
+
+  public_class_method def self.flat_arrow
+    '_'
+  end
+
+  # Add Commas to Large Numbers to Make it Easier to Read
+  public_class_method def self.beautify_large_number(opts = {})
+    value = opts[:value].to_s
+
+    split_str_num = value.split('.')
+    whole_num = split_str_num.first
+    fraction = 0
+    fraction = split_str_num.last if split_str_num.length > 1
+
+    is_negative = false
+    is_negative = true if whole_num.chars.first == '-'
+    whole_num = whole_num[1..] if is_negative
+    beautify_whole = whole_num.reverse.scan(/.{1,3}/).join(',').reverse
+    beautify_num = "#{beautify_whole}.#{fraction}" unless is_negative
+    beautify_num = "-#{beautify_whole}.#{fraction}" if is_negative
+
+    beautify_num
+  rescue Interrupt
+    # Exit Gracefully if CTRL+C is Pressed During Session
+    Cryptum.exit_gracefully(which_self: self)
+  rescue StandardError => e
+    # Produce a Stacktrace for anything else
+    Curses.close_screen
+    raise e
+  end
+
+  public_class_method def self.exit_gracefully(opts = {})
+    which_self = opts[:which_self]
+    event_history = opts[:event_history]
+    # option_choice = opts[:option_choice]
+    # env = opts[:env]
+
+    # Clear out candle data to ensure
+    # Cryptum Statistics Only Apply to
+    # Live Sessions
+    if event_history
+      File.write(
+        order_book_file,
+        JSON.pretty_generate(event_history.order_book)
+      )
+    end
+
+    Curses.close_screen
+    puts "Interrupt detected in #{which_self}...goodbye."
+
+    exit 0
+  rescue NameError
+    puts "\nInterrupt detected in #{which_self}...goodbye."
+
+    exit 0
+  rescue StandardError => e
+    # Produce a Stacktrace for anything else
+    raise e
+  end
+
+  public_class_method def self.help
+    constants.sort
+  end
+end

data/reinstall_cryptum_gemset.sh

@@ -0,0 +1,29 @@
+#!/bin/bash --login
+# USE THIS SCRIPT WHEN UPGRADING VERSIONS IN Gemfile
+if [[ $CRYPTUM_ROOT == '' ]]; then
+  if [[ ! -d '/opt/cryptum' ]]; then
+    cryptum_root=$(pwd)
+  else
+    cryptum_root='/opt/cryptum'
+  fi
+else
+  cryptum_root="${CRYPTUM_ROOT}"
+fi
+
+if [[ -f '/etc/profile.d/rvm.sh' ]]; then
+  source /etc/profile.d/rvm.sh
+fi
+
+ruby_version=`cat ${cryptum_root}/.ruby-version`
+ruby_gemset=`cat ${cryptum_root}/.ruby-gemset`
+rvm use ruby-$ruby_version@global
+rvm gemset --force delete $ruby_gemset
+if [[ -f "${cryptum_root}/Gemfile.lock" ]]; then
+  rvmsudo rm $cryptum_root/Gemfile.lock
+fi
+
+rvm use ruby-$ruby_version@$ruby_gemset --create
+export rvmsudo_secure_path=1
+rvmsudo gem install bundler
+rvmsudo bundle install
+rvm --default ruby-$ruby_version@$ruby_gemset

data/spec/lib/cryptum/api_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::API do
+  it 'should display information for existing help method' do
+    help_response = Cryptum::API
+    expect(help_response).to respond_to :help
+  end
+end

data/spec/lib/cryptum/event_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::Event do
+  it 'should display information for existing help method' do
+    help_response = Cryptum::Event
+    expect(help_response).to respond_to :help
+  end
+end

data/spec/lib/cryptum/log_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::Log do
+  it 'should display information for existing help method' do
+    help_response = Cryptum::Log
+    expect(help_response).to respond_to :help
+  end
+end

data/spec/lib/cryptum/option_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::Option do
+  it 'should return data for help method' do
+    help_response = Cryptum::Option.help
+    expect(help_response).not_to be_nil
+  end
+end

data/spec/lib/cryptum/order_book/generate_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::OrderBook::Generate do
+  it 'should display information for existing help method' do
+    help_response = Cryptum::OrderBook::Generate
+    expect(help_response).to respond_to :help
+  end
+end

data/spec/lib/cryptum/order_book/market_trend_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::OrderBook::MarketTrend do
+  it 'should display information for existing help method' do
+    help_response = Cryptum::OrderBook::MarketTrend
+    expect(help_response).to respond_to :help
+  end
+end

data/spec/lib/cryptum/order_book_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::OrderBook do
+  it 'should display information for existing help method' do
+    help_response = Cryptum::OrderBook
+    expect(help_response).to respond_to :help
+  end
+end

data/spec/lib/cryptum/ui/command_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::UI::Command do
+  it 'should display information for existing help method' do
+    help_response = Cryptum::UI::Command
+    expect(help_response).to respond_to :help
+  end
+end

data/spec/lib/cryptum/ui/ticker_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::UI::Ticker do
+  it 'should display information for existing help method' do
+    help_response = Cryptum::UI::Ticker
+    expect(help_response).to respond_to :help
+  end
+end

data/spec/lib/cryptum/ui_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::UI do
+  it 'should return data for help method' do
+    help_response = Cryptum::UI.help
+    expect(help_response).not_to be_nil
+  end
+end

data/spec/lib/cryptum/web_sock_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::WebSock do
+  it 'should display information for existing help method' do
+    help_response = Cryptum::WebSock
+    expect(help_response).to respond_to :help
+  end
+end

data/spec/lib/cryptum_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum do
+  it 'should return data for help method' do
+    help_response = Cryptum.help
+    expect(help_response).not_to be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'cryptum'

data/upgrade_Gemfile_gems.sh

@@ -0,0 +1,20 @@
+#!/bin/bash --login
+cat Gemfile | awk '{print $2}' | grep -E "^'.+$" | grep -v -e rubygems.org | while read gem; do 
+  this_gem=`echo $gem | sed "s/'//g" | sed 's/\,//g'`
+  latest_version=`gem search -r $this_gem | grep -E "^${this_gem}\s.+$" | awk '{print $2}' | sed 's/(//g' | sed 's/)//g' | sed 's/,//g'`
+  echo "${this_gem} => $latest_version"
+  os=`uname -s`
+  if [[ $os == 'Linux' ]]; then
+    if [[ $this_gem == 'bundler' ]]; then
+      sed -i "s/^gem '${this_gem}'.*$/gem '${this_gem}', '>=${latest_version}'/g" Gemfile
+    else
+      sed -i "s/^gem '${this_gem}'.*$/gem '${this_gem}', '${latest_version}'/g" Gemfile
+    fi
+  elif [[ $os == 'Darwin' ]]; then
+    if [[ $this_gem == 'bundler' ]]; then
+      sed -i '' "s/^gem '${this_gem}'.*$/gem '${this_gem}', '>=${latest_version}'/g" Gemfile
+    else
+      sed -i '' "s/^gem '${this_gem}'.*$/gem '${this_gem}', '${latest_version}'/g" Gemfile
+    fi
+  fi
+done

data/upgrade_cryptum.sh

@@ -0,0 +1,13 @@
+#!/bin/bash --login
+if [[ $CRYPTUM_ROOT == '' ]]; then
+  if [[ ! -d '/opt/cryptum' ]]; then
+    cryptum_root=$(pwd)
+  else
+    cryptum_root='/opt/cryptum'
+  fi
+else
+  cryptum_root="${CRYPTUM_ROOT}"
+fi
+
+export rvmsudo_secure_path=1
+rvmsudo /bin/bash --login -c "cd ${cryptum_root} && ./build_cryptum_gem.sh"

data/upgrade_gem.sh

@@ -0,0 +1,4 @@
+#!/bin/bash --login
+printf "Updating RubyGems (i.e. gem command)..."
+gem update --system
+echo "complete."

data/upgrade_ruby.sh

@@ -0,0 +1,45 @@
+#!/bin/bash --login
+# USE THIS SCRIPT WHEN UPGRADING RUBY
+if [[ $CRYPTUM_ROOT == '' ]]; then
+  if [[ ! -d '/opt/cryptum' ]]; then
+    cryptum_root=$(pwd)
+  else
+    cryptum_root='/opt/cryptum'
+  fi
+else
+  cryptum_root="${CRYPTUM_ROOT}"
+fi
+
+function usage() {
+  echo $"Usage: $0 <new ruby version e.g. 2.4.4> <optional bool running from build_cryptum_gem.sh>"
+  exit 1
+}
+
+if [[ -f '/etc/profile.d/rvm.sh' ]]; then
+  source /etc/profile.d/rvm.sh
+fi
+
+new_ruby_version=$1
+if [[ $2 != '' ]]; then
+  old_ruby_version=$2
+else
+  old_ruby_version=`cat ${cryptum_root}/.ruby-version`
+fi
+
+ruby_gemset=`cat ${cryptum_root}/.ruby-gemset`
+
+if [[ $# < 1 ]]; then
+  usage
+fi
+
+# Upgrade RVM
+export rvmsudo_secure_path=1
+rvmsudo rvm get head
+rvm reload
+
+# Install New Version of RubyGems & Ruby
+cd $cryptum_root && ./upgrade_gem.sh
+rvmsudo rvm install ruby-$new_ruby_version
+echo $new_ruby_version > $cryptum_root/.ruby-version
+
+cd $cryptum_root && rvm use $new_ruby_version@$ruby_gemset && ./build_cryptum_gem.sh