cryptum 0.0.358 → 0.0.360

data/lib/cryptum/matrix.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Cryptum
+  # This plugin is used for my own entertainment
+  module Matrix
+    # Supported Method Parameters::
+    # Cryptum::Matrix.generate(
+    #   cols: cols
+    # )
+
+    public_class_method def self.generate(opts = {})
+      # Need to divide by two for wide characters
+      cols = opts[:cols].to_i
+
+      matrix_arr = [
+        0x30a0.chr('UTF-8'),
+        0x30a1.chr('UTF-8'),
+        0x30a2.chr('UTF-8'),
+        0x30a3.chr('UTF-8'),
+        0x30a4.chr('UTF-8'),
+        0x30a5.chr('UTF-8'),
+        0x30a6.chr('UTF-8'),
+        0x30a7.chr('UTF-8'),
+        0x30a8.chr('UTF-8'),
+        0x30a9.chr('UTF-8'),
+        0x30aa.chr('UTF-8'),
+        0x30ab.chr('UTF-8'),
+        0x30ac.chr('UTF-8'),
+        0x30ad.chr('UTF-8'),
+        0x30ae.chr('UTF-8'),
+        0x30af.chr('UTF-8'),
+        0x30b0.chr('UTF-8'),
+        0x30b1.chr('UTF-8'),
+        0x30b2.chr('UTF-8'),
+        0x30b3.chr('UTF-8'),
+        0x30b4.chr('UTF-8'),
+        0x30b5.chr('UTF-8'),
+        0x30b6.chr('UTF-8'),
+        0x30b7.chr('UTF-8'),
+        0x30b8.chr('UTF-8'),
+        0x30b9.chr('UTF-8'),
+        0x30ba.chr('UTF-8'),
+        0x30bb.chr('UTF-8'),
+        0x30bc.chr('UTF-8'),
+        0x30bd.chr('UTF-8'),
+        0x30be.chr('UTF-8'),
+        0x30bf.chr('UTF-8'),
+        0x30c0.chr('UTF-8'),
+        0x30c1.chr('UTF-8'),
+        0x30c2.chr('UTF-8'),
+        0x30c3.chr('UTF-8'),
+        0x30c4.chr('UTF-8'),
+        0x30c5.chr('UTF-8'),
+        0x30c6.chr('UTF-8'),
+        0x30c7.chr('UTF-8'),
+        0x30c8.chr('UTF-8'),
+        0x30c9.chr('UTF-8'),
+        0x30ca.chr('UTF-8'),
+        0x30cb.chr('UTF-8'),
+        0x30cc.chr('UTF-8'),
+        0x30cd.chr('UTF-8'),
+        0x30ce.chr('UTF-8'),
+        0x30cf.chr('UTF-8'),
+        0x30d0.chr('UTF-8'),
+        0x30d1.chr('UTF-8'),
+        0x30d2.chr('UTF-8'),
+        0x30d3.chr('UTF-8'),
+        0x30d4.chr('UTF-8'),
+        0x30d5.chr('UTF-8'),
+        0x30d6.chr('UTF-8'),
+        0x30d7.chr('UTF-8'),
+        0x30d8.chr('UTF-8'),
+        0x30d9.chr('UTF-8'),
+        0x30da.chr('UTF-8'),
+        0x30db.chr('UTF-8'),
+        0x30dc.chr('UTF-8'),
+        0x30dd.chr('UTF-8'),
+        0x30de.chr('UTF-8'),
+        0x30df.chr('UTF-8'),
+        0x30e0.chr('UTF-8'),
+        0x30e1.chr('UTF-8'),
+        0x30e2.chr('UTF-8'),
+        0x30e3.chr('UTF-8'),
+        0x30e4.chr('UTF-8'),
+        0x30e5.chr('UTF-8'),
+        0x30e6.chr('UTF-8'),
+        0x30e7.chr('UTF-8'),
+        0x30e8.chr('UTF-8'),
+        0x30e9.chr('UTF-8'),
+        0x30ea.chr('UTF-8'),
+        0x30eb.chr('UTF-8'),
+        0x30ec.chr('UTF-8'),
+        0x30ed.chr('UTF-8'),
+        0x30ee.chr('UTF-8'),
+        0x30ef.chr('UTF-8'),
+        0x30f0.chr('UTF-8'),
+        0x30f1.chr('UTF-8'),
+        0x30f2.chr('UTF-8'),
+        0x30f3.chr('UTF-8'),
+        0x30f4.chr('UTF-8'),
+        0x30f5.chr('UTF-8'),
+        0x30f6.chr('UTF-8'),
+        0x30f7.chr('UTF-8'),
+        0x30f8.chr('UTF-8'),
+        0x30f9.chr('UTF-8'),
+        0x30fa.chr('UTF-8'),
+        0x30fb.chr('UTF-8'),
+        0x30fc.chr('UTF-8'),
+        0x30fd.chr('UTF-8'),
+        0x30fe.chr('UTF-8'),
+        '0 ',
+        '1 ',
+        '2 ',
+        '3 ',
+        '4 ',
+        '5 ',
+        '6 ',
+        '7 ',
+        '8 ',
+        '9 ',
+        'A ',
+        'c ',
+        'R ',
+        'y ',
+        'P ',
+        't ',
+        'U ',
+        'm ',
+        'x ',
+        'Z ',
+        ': ',
+        '{ ',
+        '[ ',
+        '} ',
+        '] ',
+        '| ',
+        '` ',
+        '~ ',
+        '! ',
+        '@ ',
+        '# ',
+        '$ ',
+        '% ',
+        '^ ',
+        '& ',
+        '* ',
+        '( ',
+        ') ',
+        '_ ',
+        '- ',
+        '= ',
+        '+ ',
+        '> ',
+        '< ',
+        '. ',
+        ', '
+      ]
+
+      last_index = matrix_arr.length - 1
+
+      matrix_row = ''
+      most_cols = cols - 1
+      most_cols.times.each do
+        matrix_row += "#{matrix_arr[Random.rand(0..last_index)]} "
+      end
+      matrix_row += matrix_arr[Random.rand(0..last_index)]
+    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

data/lib/cryptum/open_ai.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'rest-client'
+
+module Cryptum
+  # This plugin is used for interacting w/ OpenAI's REST API
+  # This is based on the following OpenAI API Specification:
+  # https://api.openai.com/v1
+  module OpenAI
+    # Supported Method Parameters::
+    # open_ai_rest_call(
+    #   env: 'required - env object containing OpenAI Bearer token',
+    #   option_choice = 'required - option_choice object in case proxy is configured',
+    #   http_method: 'optional HTTP method (defaults to GET)
+    #   rest_call: 'required rest call to make per the schema',
+    #   params: 'optional params passed in the URI or HTTP Headers',
+    #   http_body: 'optional HTTP body sent in HTTP methods that support it e.g. POST'
+    # )
+
+    private_class_method def self.open_ai_rest_call(opts = {})
+      env = opts[:env]
+      option_choice = opts[:option_choice]
+      http_method = if opts[:http_method].nil?
+                      :GET
+                    else
+                      opts[:http_method].to_s.upcase.scrub.strip.chomp.to_sym
+                    end
+      rest_call = opts[:rest_call].to_s.scrub
+      params = opts[:params]
+      http_body = opts[:http_body].to_s.scrub
+      base_open_ai_api_uri = 'https://api.openai.com/v1'
+      bearer_token = env[:open_ai_bearer_token]
+
+      if option_choice.proxy
+        rest_client = RestClient
+        rest_client.proxy = option_choice.proxy
+        rest_client_request = rest_client::Request
+      else
+        rest_client_request = RestClient::Request
+      end
+
+      case http_method
+      when :GET
+        response = rest_client_request.execute(
+          method: :GET,
+          url: "#{base_open_ai_api_uri}/#{rest_call}",
+          headers: {
+            content_type: 'application/json; charset=UTF-8',
+            authorization: "Bearer #{bearer_token}",
+            params: params
+          },
+          verify_ssl: false
+        )
+
+      when :POST
+        response = rest_client_request.execute(
+          method: :POST,
+          url: "#{base_open_ai_api_uri}/#{rest_call}",
+          headers: {
+            content_type: 'application/json; charset=UTF-8',
+            authorization: "Bearer #{bearer_token}"
+          },
+          payload: http_body,
+          verify_ssl: false
+        )
+
+      else
+        raise @@logger.error("Unsupported HTTP Method #{http_method} for #{self} Plugin")
+      end
+      response
+    rescue RestClient::ExceptionWithResponse => 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 "URL: #{api_endpoint}#{api_call}"
+        f.puts "PARAMS: #{params.inspect}"
+        f.puts "HTTP POST BODY: #{http_body.inspect}" if http_body != ''
+        f.puts "#{e}\n#{e.response}\n\n\n"
+      end
+    rescue StandardError => e
+      raise e
+    end
+
+    # Supported Method Parameters::
+    # models = PWN::Plugins::OpenAI.get_models(
+    #   env: 'required - env object containing OpenAI Bearer token',
+    #   option_choice = 'required - option_choice object in case proxy is configured',
+    # )
+
+    public_class_method def self.get_models(opts = {})
+      env = opts[:env]
+      option_choice = opts[:option_choice]
+
+      response = open_ai_rest_call(
+        env: env,
+        option_choice: option_choice,
+        http_method: :post,
+        rest_call: 'models'
+      )
+
+      JSON.parse(response, symbolize_names: true)
+    rescue StandardError => e
+      raise e
+    end
+
+    # Supported Method Parameters::
+    # response = PWN::Plugins::OpenAI.chat_gpt(
+    #   env: 'required - env object containing OpenAI Bearer token',
+    #   option_choice = 'required - option_choice object in case proxy is configured',
+    #   request: 'required - message to ChatGPT'
+    # )
+
+    public_class_method def self.chat_gpt(opts = {})
+      env = opts[:env]
+      option_choice = opts[:option_choice]
+      request = opts[:request]
+
+      http_body = {
+        model: 'text-davinci-003',
+        prompt: request,
+        temperature: 0,
+        max_tokens: 1024
+      }
+
+      response = open_ai_rest_call(
+        env: env,
+        option_choice: option_choice,
+        http_method: :post,
+        rest_call: 'completions',
+        http_body: http_body.to_json
+      )
+
+      JSON.parse(response, symbolize_names: true)
+    rescue StandardError => e
+      raise e
+    end
+
+    # Display Usage for this Module
+
+    public_class_method def self.help
+      puts "USAGE:
+        models = PWN::Plugins::OpenAI.get_models(
+          env: 'required - env object containing OpenAI Bearer token',
+          option_choice = 'required - option_choice object in case proxy is configured',
+        )
+
+        response = #{self}.chat_gpt(
+          env: 'required - env object containing OpenAI Bearer token',
+          option_choice = 'required - option_choice object in case proxy is configured',
+          request: 'required - message to ChatGPT'
+        )
+      "
+    end
+  end
+end

data/lib/cryptum/option/choice.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Cryptum
+  # This plugin is used to Cancel Open Limit Orders
+  module Option
+    # Keep Last Event History When Terminal Resize Occuers
+    class Choice
+      attr_accessor :autotrade,
+                    :driver_name,
+                    :list_products,
+                    :proxy,
+                    :reset_session_countdown,
+                    :session_root,
+                    :sandbox,
+                    :symbol,
+                    :market_trend_reset,
+                    :market_trend_reset_label
+
+    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

data/lib/cryptum/option.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'yaml'
+
+module Cryptum
+  # Cryptum::UI Module used for Presenting the
+  # Cryptum Curses Interface
+  module Option
+    require 'cryptum/option/choice'
+
+    # Options for cryptum Driver
+    public_class_method def self.parser(opts = {})
+      option_choice = Option::Choice.new
+      option_choice.driver_name = opts[:driver_name]
+
+      OptionParser.new do |options|
+        options.banner = "USAGE: #{option_choice.driver_name} [opts]"
+
+        options.on(
+          '-sSYMBOL',
+          '--symbol=SYMBOL',
+          '<Required - Crypto Symbol.(e.g. btc-usd, eth-usd, etc.)'
+        ) { |s| option_choice.symbol = s.to_s.gsub('-', '_').downcase.to_sym }
+
+        options.on(
+          '-A',
+          '--[no-]autotrade',
+          '<Optional - Automatically Buy and Sell Crypto>'
+        ) { |a| option_choice.autotrade = a }
+
+        options.on(
+          '-l',
+          '--[no-]list-products',
+          '<Optional - List Supported Crypto Currency Products and Exit>'
+        ) { |l| option_choice.list_products = l }
+
+        options.on(
+          '-pPROXY',
+          '--proxy=PROXY',
+          '<Optional - HTTP Proxy e.g. "http://127.0.0.1:8080">'
+        ) { |p| option_choice.proxy = p }
+
+        options.on(
+          '-R',
+          '--[no-]reset-session-countdown',
+          '<Optional - Reset Timers / Market Trend Stats at Session Init (Defaults to false)>'
+        ) { |t| option_choice.reset_session_countdown = t }
+
+        options.on(
+          '-rPATH',
+          '--session-root=PATH',
+          '<Optional - Directory with etc && order_books (Defaults to ~/cryptum)>'
+        ) { |r| option_choice.session_root = r }
+
+        options.on(
+          '-S',
+          '--[no-]sandbox',
+          '<Optional - Use Coinbase Sandbox Environment for Testing Ideas>'
+        ) { |n| option_choice.sandbox = n }
+
+        options.on(
+          '-tSECONDS',
+          '--time-between-market-trend-reset=SECONDS',
+          '<Optional - Seconds Between Market Trend Reset (Default 60 i.e. 1 hour)>'
+        ) { |t| option_choice.market_trend_reset = t.to_i }
+      end.parse!
+
+      input_validation(option_choice: option_choice)
+
+      option_choice
+    rescue OptionParser::InvalidOption => e
+      # Print Usage if unsupported flags are passed
+      puts "ERROR: #{e.message}\n\n"
+      puts `#{option_choice.driver_name} --help`
+      exit 1
+    rescue StandardError => e
+      raise e
+    end
+
+    # Validate Options for cryptum Driver
+    public_class_method def self.input_validation(opts = {})
+      option_choice = opts[:option_choice]
+
+      # Conditions to display cryptum usage
+      if option_choice.symbol.nil? && option_choice.list_products.nil?
+        usage = true
+        reason = :symbol
+      end
+
+      option_choice.session_root = "#{Dir.home}/cryptum" if option_choice.session_root.nil?
+
+      unless Dir.exist?(option_choice.session_root)
+        usage = true
+        reason = :session_root
+      end
+
+      option_choice.market_trend_reset = 86_400 if option_choice.market_trend_reset.to_i.zero?
+      unless option_choice.market_trend_reset.to_i >= 60 &&
+             option_choice.market_trend_reset <= 604_800
+        usage = true
+        reason = :market_trend_reset
+      end
+
+      case option_choice.market_trend_reset
+      when 604_800
+        option_choice.market_trend_reset_label = '1W'
+      when 86_400
+        option_choice.market_trend_reset_label = '1D'
+      when 14_400
+        option_choice.market_trend_reset_label = '4h'
+      when 10_800
+        option_choice.market_trend_reset_label = '3h'
+      when 7_200
+        option_choice.market_trend_reset_label = '2h'
+      when 3_600
+        option_choice.market_trend_reset_label = '1h'
+      when 2_700
+        option_choice.market_trend_reset_label = '45m'
+      when 1_800
+        option_choice.market_trend_reset_label = '30m'
+      when 900
+        option_choice.market_trend_reset_label = '15m'
+      when 300
+        option_choice.market_trend_reset_label = '5m'
+      when 180
+        option_choice.market_trend_reset_label = '3m'
+      when 60
+        option_choice.market_trend_reset_label = '1m'
+      else
+        usage = true
+        reason = :market_trend_reset
+      end
+
+      if usage
+        case reason
+        when :symbol
+          puts "ERROR: --symbol Flag is Required.\n\n"
+        when :session_root
+          puts "ERROR: #{option_choice.session_root} does not exist.\n\n"
+        when :market_trend_reset
+          puts "ERROR: #{option_choice.market_trend_reset} - Possible values are: 604_800 || 86_400 || 14_400 || 10_800 || 7_200 || 3_600 || 2_700 || 1_800 || 900 || 300 || 180 || 60\n\n"
+        end
+
+        puts `#{option_choice.driver_name} --help`
+        exit 1
+      end
+    rescue StandardError => e
+      raise e
+    end
+
+    # List Supported Cryptum Products and Exit
+    public_class_method def self.list_products_and_exit(opts = {})
+      option_choice = opts[:option_choice]
+      env = opts[:env]
+
+      puts "\n#{option_choice.driver_name} Supports the Following Products:"
+      products = Cryptum::API.get_products(
+        option_choice: option_choice,
+        env: env
+      )
+
+      products.map do |product|
+        puts product[:id].downcase
+      end
+
+      exit 0
+    rescue StandardError => e
+      raise e
+    end
+
+    # Initialize Cryptum Session Environment
+    public_class_method def self.get_env(opts = {})
+      option_choice = opts[:option_choice]
+
+      yaml_conf_file = "#{option_choice.session_root}/etc/coinbase_pro.yaml"
+      yaml_conf = YAML.load_file(
+        yaml_conf_file,
+        symbolize_names: true
+      )
+
+      env = yaml_conf[:prod]
+      env[:env] = :prod
+      env = yaml_conf[:sandbox] if option_choice.sandbox
+      env[:env] = :sandbox if option_choice.sandbox
+
+      open_ai_yaml_conf_file = "#{option_choice.session_root}/etc/open_ai.yaml"
+      if File.exist?(open_ai_yaml_conf_file)
+        open_ai_yaml_conf = YAML.load_file(
+          open_ai_yaml_conf_file,
+          symbolize_names: true
+        )
+        env[:open_ai_bearer_token] = open_ai_yaml_conf[:bearer_token]
+      end
+
+      env
+    rescue StandardError => e
+      raise e
+    end
+
+    # Display a List of Every UI Module
+    public_class_method def self.help
+      constants.sort
+    end
+  end
+end

data/lib/cryptum/order_book/generate.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'io/console'
+require 'json'
+require 'logger'
+require 'tty-spinner'
+
+module Cryptum
+  # This module is used to define the Order Book Data Structure
+  module OrderBook
+    module Generate
+      # Supported Method Parameters::
+      # Cryptum::OrderBook.generate(
+      #   symbol: 'required - target symbol (e.g. btc-usd)',
+      #   this_product: 'required - this_product',
+      # )
+
+      public_class_method def self.new_order_book(opts = {})
+        start_time = opts[:start_time]
+        option_choice = opts[:option_choice]
+        env = opts[:env]
+
+        session_root = option_choice.session_root
+        symbol = option_choice.symbol
+        order_book_file = "#{session_root}/order_books/#{symbol}.ORDER_BOOK.json"
+
+        # Only need to retrieve a product list once / session.
+        products = Cryptum::API.get_products(
+          option_choice: option_choice,
+          env: env
+        )
+        this_product_arr = products.select do |product|
+          product if product[:id] == option_choice.symbol.to_s.gsub('_', '-').upcase
+        end
+        this_product = this_product_arr.last
+
+        order_book = {
+          path: order_book_file,
+          symbol: symbol,
+          open_24h: 0.00,
+          high_24h: 0.00,
+          low_24h: 0.00,
+          volume_24h: 0.00,
+          ticker_price: 0.00,
+          ticker_price_second_to_last: 0.00,
+          ticker_price_third_to_last: 0.00,
+          sequence: -1,
+          this_product: this_product,
+          portfolio: [],
+          fiat_portfolio: [],
+          fees: [],
+          order_plan: [],
+          last_trend_reset: Time.now.strftime('%Y-%m-%d %H:%M:%S.%N%z'),
+          last_order_exec: Time.now.strftime('%Y-%m-%d %H:%M:%S.%N%z'),
+          market_trend: {
+            buy: 0,
+            buy_start: '--',
+            buy_end: '--',
+            sell: 0,
+            sell_start: '--',
+            sell_end: '--'
+          },
+          order_history: [],
+          order_history_meta: []
+        }
+
+        # Order History Retention ---------------------------------------#
+        # Instantiate Event History attr_accessible
+        # Object to Keep Track of Everything as Events
+        # are Parsed.
+        event_history = Cryptum::Event::History.new(
+          option_choice: option_choice,
+          start_time: start_time,
+          order_book: order_book
+        )
+
+        if File.exist?(order_book_file)
+          order_book = JSON.parse(
+            File.read(order_book_file),
+            symbolize_names: true
+          )
+        end
+
+        event_history.order_book = order_book
+        if option_choice.reset_session_countdown
+          event_history.order_book[:order_plan] = []
+          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'
+          )
+          event_history.order_book[:last_order_exec] = Time.now.strftime(
+            '%Y-%m-%d %H:%M:%S.%N%z'
+          )
+        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}.new_order_book(
+            symbol: 'required - target symbol (e.g. btc-usd)',
+            this_product: 'required - this_product'
+          )
+        "
+      end
+    end
+  end
+end

data/lib/cryptum/order_book/indicator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Cryptum
+  # This plugin is used to calculate Exponential Moving Average
+  # Price of a Symbol over time.
+
+  module OrderBook
+    class Indicator
+      attr_accessor :market_trend,
+                    :profit_margin,
+                    :action_signal,
+                    :last_action_signal
+    end
+  end
+end