cryptum 0.0.379 → 0.0.381

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 267109002234d04e788a39303868e372163535eb908e5934bd19e6765f552ed4
-  data.tar.gz: e5c9e401567e65691048b8c8131c39447202ce5ab5dfacfcd07d9fd5e0a4be7a
+  metadata.gz: 866bb0c564c84fd84b9795396ffabf73483cea8c71171e3de935545c9a5a7736
+  data.tar.gz: 060b3793c66b3a31d7747d5677de5f7b346d14ac00714357188239080a19bd5d
 SHA512:
-  metadata.gz: 067a56f54d073b4d05d52d15cc06be7f5c91b58ccc6c5d0cb9a8f6da7ff1c57b9296772aedabc532a11dd30f2ef02489dd97b7fbb8038193fcfa805a3f58cc8e
-  data.tar.gz: adda615b995b857cbe39ad49eeeb04307c3478c310a93e7fee25ae2d5f164bf9748db6cc0036e864eb9ea2c553b0a5741079f2007d09599170fb82ce07a31d30
+  metadata.gz: 07c342bb8da387ff8fad07303102860758b5be1334d6558732255a2f743a607bb5a881968f1da1506bda887819d82cd6d5a473b19380f9641dac3b7d43c2ae81
+  data.tar.gz: 928cd958349f76561e312529f3787d708924031ca6e73cec4c3314d59b639479d3c1997d70c6227e27360c66ceee038a5260ab61c3b4104f98fea7f764a50b1d

data/.rubocop.yml

@@ -5,6 +5,8 @@ Layout:
   Max: 3000
 Layout/LineLength:
   Max: 256
+Lint/UselessRescue:
+  Enabled: false
 Metrics/AbcSize:
   Max: 512
 Metrics/BlockLength:

data/.rubocop_todo.yml

@@ -1,20 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-03-29 14:29:26 UTC using RuboCop version 1.48.1.
+# on 2023-03-30 22:47:49 UTC using RuboCop version 1.48.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 4
-Lint/UselessAssignment:
-  Exclude:
-    - 'lib/cryptum/api.rb'
-
-# Offense count: 58
-Lint/UselessRescue:
-  Enabled: false
-
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
@@ -29,13 +20,7 @@ Style/ConditionalAssignment:
     - 'lib/cryptum/event/pane.rb'
     - 'lib/cryptum/ui/order_execute_details.rb'
 
-# Offense count: 23
+# Offense count: 24
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Enabled: false
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantAssignment:
-  Exclude:
-    - 'lib/cryptum/api.rb'

data/bin/cryptum

@@ -8,14 +8,14 @@ begin
   start_time = Time.now.strftime('%Y-%m-%d %H:%M:%S%z')
   # Initialize Driver Name & Parse cryptum Flags
   driver_name = File.basename($PROGRAM_NAME)
-  option_choice = Cryptum::Option.parser(driver_name: driver_name)
+  option_choice = Cryptum::Option::Parser.get(driver_name: driver_name)
 
   # Initialize the Respective Environment / API Authentication Artifacts
-  env = Cryptum::Option.get_env(option_choice: option_choice)
+  env = Cryptum::Option::Environment.get(option_choice: option_choice)
 
   # Dump out supported products if --list-products flag is passed and exit
   if option_choice.list_products
-    Cryptum::Option.list_products_and_exit(
+    Cryptum::API::Products.list_and_exit(
       option_choice: option_choice,
       env: env
     )

data/bin/cryptum-forecast

@@ -113,12 +113,12 @@ begin
   autotrade_cycle_tot = 1 unless option_choice.cycles_complete.to_i.positive?
 
   # Initialize the Respective Environment / API Authentication Artifacts
-  env = Cryptum::Option.get_env(option_choice: option_choice)
+  env = Cryptum::Option::Environment.get(option_choice: option_choice)
 
   # Read in Bot Conf Values
   bot_conf = Cryptum::BotConf.read(option_choice: option_choice)
 
-  products = Cryptum::API.get_products(
+  products = Cryptum::API::Products.get(
     option_choice: option_choice,
     env: env
   )
@@ -127,7 +127,7 @@ begin
   fiat = products.last[:quote_currency]
   fiat_portfolio_file = "#{option_choice.session_root}/order_books/#{fiat}_PORTFOLIO.json"
 
-  # portfolio = Cryptum::API.get_portfolio(
+  # portfolio = Cryptum::API::Portfolio.get(
   #   option_choice: option_choice,
   #   env: env,
   #   crypto: crypto,
@@ -149,7 +149,7 @@ begin
   gross_tpm = bot_conf[:target_profit_margin_percent].to_f / 100
   gross_tpm = option_choice.tpm.to_f if option_choice.tpm.to_f.positive?
 
-  fees = Cryptum::API.get_fees(
+  fees = Cryptum::API::Fees.get(
     option_choice: option_choice,
     env: env
   )

data/lib/cryptum/api/exchange_rates.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Cryptum
+  # This module is used to Interact with the APIs
+  module API
+    # Module specifically related to orders history retrieval.
+    module ExchangeRates
+      # Obtain latest order history
+      public_class_method def self.get(opts = {})
+        option_choice = opts[:option_choice]
+        env = opts[:env]
+
+        api_endpoint = 'https://api.coinbase.com/v2'
+        exchange_rates_api_call = '/exchange-rates'
+
+        # We don't always get fees back from Coinbase...
+        # This is a hack to ensure we do.
+        Cryptum::API::Rest.call(
+          option_choice: option_choice,
+          env: env,
+          http_method: :GET,
+          api_endpoint: api_endpoint,
+          api_call: exchange_rates_api_call
+        )
+      rescue StandardError => e
+        raise e
+      end
+
+      # Display Usage for this Module
+      public_class_method def self.help
+        puts "USAGE:
+          fees = #{self}.get(
+            env: 'required - Coinbase::Option::Environment.get Object',
+            option_choice: 'required - Coinbase::Option::Choice Object'
+          )
+        "
+      end
+    end
+  end
+end

data/lib/cryptum/api/fees.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Cryptum
+  # This module is used to Interact with the APIs
+  module API
+    # Module specifically related to orders history retrieval.
+    module Fees
+      # Obtain latest order history
+      public_class_method def self.get(opts = {})
+        option_choice = opts[:option_choice]
+        env = opts[:env]
+
+        fees_api_call = '/fees'
+
+        Cryptum::API::Rest.call(
+          option_choice: option_choice,
+          env: env,
+          http_method: :GET,
+          api_call: fees_api_call
+        )
+      rescue StandardError => e
+        raise e
+      end
+
+      # Display Usage for this Module
+      public_class_method def self.help
+        puts "USAGE:
+          fees = #{self}.get(
+            env: 'required - Coinbase::Option::Environment.get Object',
+            option_choice: 'required - Coinbase::Option::Choice Object'
+          )
+        "
+      end
+    end
+  end
+end

data/lib/cryptum/api/order_history.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Cryptum
+  # This module is used to Interact with the APIs
+  module API
+    # Module specifically related to orders history retrieval.
+    module OrderHistory
+      # Obtain latest order history
+      public_class_method def self.get(opts = {})
+        option_choice = opts[:option_choice]
+        env = opts[:env]
+
+        product_id = option_choice.symbol.to_s.gsub('_', '-').upcase
+
+        orders_api_call = '/orders'
+        params = {}
+        params[:product_id] = product_id
+        params[:status] = 'all'
+
+        order_history = Cryptum::API::Rest.call(
+          option_choice: option_choice,
+          env: env,
+          http_method: :GET,
+          api_call: orders_api_call,
+          params: params
+        )
+
+        # Cast UTC Timestamps as local times
+        order_history.each do |order|
+          order[:created_at] = Time.parse(
+            order[:created_at]
+          ).localtime.to_s
+
+          next unless order[:done_at]
+
+          order[:done_at] = Time.parse(
+            order[:done_at]
+          ).localtime.to_s
+        end
+
+        order_history
+      rescue StandardError => e
+        raise e
+      end
+
+      # Display Usage for this Module
+      public_class_method def self.help
+        puts "USAGE:
+          order_history = #{self}.get_order_history(
+            env: 'required - Coinbase::Option::Environment.get Object'
+          )
+        "
+      end
+    end
+  end
+end

data/lib/cryptum/api/orders.rb

@@ -0,0 +1,253 @@
+# frozen_string_literal: true
+
+require 'addressable'
+require 'base64'
+require 'json'
+require 'openssl'
+require 'rest-client'
+
+module Cryptum
+  # This plugin is used to interact withbtje Coinbase REST API
+  module API
+    module Orders
+      public_class_method def self.submit_limit_order(opts = {})
+        option_choice = opts[:option_choice]
+        env = opts[:env]
+        price = opts[:price]
+        size = opts[:size]
+        buy_or_sell = opts[:buy_or_sell]
+        event_history = opts[:event_history]
+        bot_conf = opts[:bot_conf]
+        buy_order_id = opts[:buy_order_id]
+
+        tpm = bot_conf[:target_profit_margin_percent].to_f
+        tpm_cast_as_decimal = tpm / 100
+
+        product_id = option_choice.symbol.to_s.gsub('_', '-').upcase
+
+        this_product = event_history.order_book[:this_product]
+        base_increment = this_product[:base_increment]
+        quote_increment = this_product[:quote_increment]
+        # crypto_smallest_decimal = base_increment.to_s.split('.')[-1].length
+        fiat_smallest_decimal = quote_increment.to_s.split('.')[-1].length
+
+        order_hash = {}
+
+        order_hash[:type] = 'limit'
+        order_hash[:time_in_force] = 'GTC'
+
+        if buy_or_sell == :buy
+          order_hash[:time_in_force] = 'GTT'
+          order_hash[:cancel_after] = 'min'
+        end
+
+        order_hash[:size] = size
+        order_hash[:price] = price
+        order_hash[:side] = buy_or_sell
+        order_hash[:product_id] = product_id
+
+        http_body = order_hash.to_json
+
+        limit_order_resp = Cryptum::API::Rest.call(
+          option_choice: option_choice,
+          env: env,
+          http_method: :POST,
+          api_call: '/orders',
+          http_body: http_body,
+          base_increment: base_increment
+        )
+
+        # Populate Order ID on the Buy
+        # to know what to do on the Sell
+        case buy_or_sell
+        when :buy
+          this_order = event_history.order_book[:order_plan].shift
+          this_order[:buy_order_id] = limit_order_resp[:id]
+          this_order[:price] = price
+          targ_price = price.to_f + (price.to_f * tpm_cast_as_decimal)
+          this_order[:tpm] = format(
+            '%0.2f',
+            tpm
+          )
+          this_order[:target_price] = format(
+            "%0.#{fiat_smallest_decimal}f",
+            targ_price
+          )
+
+          this_order[:size] = size
+
+          this_order[:color] = :cyan
+          event_history.order_book[:order_history_meta].push(this_order)
+        when :sell
+          sell_order_id = limit_order_resp[:id]
+          event_history.order_book[:order_history_meta].each do |meta|
+            if meta[:buy_order_id] == buy_order_id
+              meta[:sell_order_id] = sell_order_id
+              meta[:color] = :yellow
+            end
+          end
+        end
+
+        event_history
+      rescue StandardError => e
+        raise e
+      end
+
+      # public_class_method def self.cancel_open_order(opts = {})
+      #   env = opts[:env]
+      #   option_choice = opts[:option_choice]
+      #   order_id = opts[:order_id]
+      #   order_type = opts[:order_type]
+      #   product_id = option_choice.symbol.to_s.gsub('_', '-').upcase
+      #   order_hash = {}
+      #   order_hash[:product_id] = product_id
+      #   params = order_hash
+      #   Cryptum::API::Rest.call(
+      #     env: env,
+      #     http_method: :DELETE,
+      #     api_call: "/orders/#{order_id}",
+      #     option_choice: option_choice,
+      #     params: params,
+      #     order_type: order_type
+      #   )
+      # rescue StandardError => e
+      #   raise e
+      # end
+
+      public_class_method def self.cancel_all_open_orders(opts = {})
+        env = opts[:env]
+        option_choice = opts[:option_choice]
+        event_notes = opts[:event_notes]
+
+        product_id = option_choice.symbol.to_s.gsub('_', '-').upcase
+
+        order_hash = {}
+        order_hash[:product_id] = product_id
+
+        # http_body = order_hash.to_json
+        params = order_hash
+
+        canceled_order_id_arr = []
+        loop do
+          canceled_order_id_arr = Cryptum::API::Rest.call(
+            env: env,
+            http_method: :DELETE,
+            api_call: '/orders',
+            option_choice: option_choice,
+            params: params,
+            event_notes: event_notes
+          )
+
+          break if canceled_order_id_arr.empty?
+        end
+        canceled_order_id_arr
+      rescue StandardError => e
+        raise e
+      end
+
+      public_class_method def self.gtfo(opts = {})
+        option_choice = opts[:option_choice]
+        env = opts[:env]
+        event_history = opts[:event_history]
+
+        # Cancel all open orders
+        cancel_all_open_orders(
+          env: env,
+          option_choice: option_choice
+        )
+
+        product_id = option_choice.symbol.to_s.gsub('_', '-').upcase
+
+        this_product = event_history.order_book[:this_product]
+        base_increment = this_product[:base_increment]
+        quote_increment = this_product[:quote_increment]
+        crypto_smallest_decimal = base_increment.to_s.split('.')[-1].length
+        fiat_smallest_decimal = quote_increment.to_s.split('.')[-1].length
+
+        # TODO: Calculate / Price / Size
+        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.sort[1]
+        price = format(
+          "%0.#{fiat_smallest_decimal}f",
+          limit_price
+        )
+
+        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
+        balance = format(
+          "%0.#{crypto_smallest_decimal}f",
+          this_account.first[:balance]
+        )
+
+        current_crypto_fiat_value = format(
+          '%0.2f',
+          balance.to_f * price.to_f
+        )
+
+        order_hash = {}
+
+        order_hash[:type] = 'limit'
+        order_hash[:time_in_force] = 'GTT'
+        order_hash[:cancel_after] = 'min'
+
+        order_hash[:size] = balance
+        order_hash[:price] = price
+        order_hash[:side] = :sell
+        order_hash[:product_id] = product_id
+
+        http_body = order_hash.to_json
+
+        limit_order_resp = Cryptum::API::Rest.call(
+          option_choice: option_choice,
+          env: env,
+          http_method: :POST,
+          api_call: '/orders',
+          http_body: http_body,
+          base_increment: base_increment
+        )
+
+        # Populate Order ID on the Buy
+        # to know what to do on the Sell
+        this_order = {}
+        this_order[:plan_no] = '0.0'
+        this_order[:fiat_available] = '0.00'
+        this_order[:risk_alloc] = current_crypto_fiat_value
+        this_order[:allocation_decimal] = '1.0'
+        this_order[:allocation_percent] = '100.0'
+        this_order[:invest] = current_crypto_fiat_value
+        this_order[:return] = current_crypto_fiat_value
+        this_order[:profit] = '0.0'
+        this_order[:buy_order_id] = 'N/A'
+        this_order[:price] = price
+        this_order[:tpm] = '0.00'
+        this_order[:target_price] = current_crypto_fiat_value
+        this_order[:size] = balance
+        this_order[:color] = :magenta
+        this_order[:sell_order_id] = limit_order_resp[:id]
+
+        event_history.order_book[:order_history_meta].push(this_order)
+
+        event_history
+      rescue StandardError => e
+        raise e
+      end
+
+      public_class_method def self.help
+        puts "USAGE:
+         profiles = #{self}.get_profiles(
+           env: 'required - Coinbase::Option::Environment.get Object'
+         )
+        "
+      end
+    end
+  end
+end

data/lib/cryptum/api/portfolio.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Cryptum
+  # This module is used to Interact with the APIs
+  module API
+    # Module specifically related to orders history retrieval.
+    module Portfolio
+      # Obtain latest order history
+      public_class_method def self.get(opts = {})
+        option_choice = opts[:option_choice]
+        env = opts[:env]
+        crypto = opts[:crypto]
+        fiat = opts[:fiat]
+        fiat_portfolio_file = opts[:fiat_portfolio_file]
+        event_notes = opts[:event_notes]
+
+        # Retrieve Exchange Rates
+        exchange_rates_resp = Cryptum::API::ExchangeRates.get(
+          option_choice: option_choice,
+          env: env
+        )
+        exchange_rates = exchange_rates_resp[:data][:rates]
+
+        portfolio_complete_arr = Cryptum::API::Rest.call(
+          option_choice: option_choice,
+          env: env,
+          http_method: :GET,
+          api_call: '/accounts',
+          event_notes: event_notes
+        )
+        portfolio_complete_arr ||= []
+
+        all_products = portfolio_complete_arr.select do |products|
+          products if products[:balance].to_f.positive?
+        end
+
+        total_holdings = 0.00
+        all_products.each do |product|
+          currency = product[:currency].to_sym
+          this_exchange_rate = exchange_rates[currency].to_f
+          total_holdings += product[:balance].to_f / this_exchange_rate
+        end
+
+        crypto_portfolio = portfolio_complete_arr.select do |product|
+          product if product[:currency] == crypto
+        end
+
+        fiat_portfolio = portfolio_complete_arr.select do |product|
+          product if product[:currency] == fiat
+        end
+        fiat_portfolio.last[:total_holdings] = format(
+          '%0.8f',
+          total_holdings
+        )
+
+        File.write(
+          fiat_portfolio_file,
+          JSON.pretty_generate(fiat_portfolio)
+        )
+
+        crypto_portfolio
+      rescue StandardError => e
+        raise e
+      end
+
+      # Display Usage for this Module
+      public_class_method def self.help
+        puts "USAGE:
+          fees = #{self}.get(
+            env: 'required - Coinbase::Option::Environment.get Object',
+            option_choice: 'required - Coinbase::Option::Choice Object'
+          )
+        "
+      end
+    end
+  end
+end

data/lib/cryptum/api/products.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Cryptum
+  # This module is used to Interact with the APIs
+  module API
+    # Module specifically related to orders history retrieval.
+    module Products
+      # Obtain latest order history
+      public_class_method def self.get(opts = {})
+        option_choice = opts[:option_choice]
+        env = opts[:env]
+
+        products = Cryptum::API::Rest.call(
+          option_choice: option_choice,
+          env: env,
+          http_method: :GET,
+          api_call: '/products'
+        )
+
+        if products.length.positive?
+          supported_products_filter = products.select do |product|
+            product[:id].match?(/USD$/) &&
+              product[:status] == 'online' &&
+              product[:fx_stablecoin] == false
+          end
+          sorted_products = supported_products_filter.sort_by { |hash| hash[:id] }
+        end
+
+        sorted_products
+      rescue StandardError => e
+        raise e
+      end
+
+      # List Supported Cryptum Products and Exit
+      public_class_method def self.list_and_exit(opts = {})
+        option_choice = opts[:option_choice]
+        env = opts[:env]
+
+        puts "\n#{option_choice.driver_name} Supports the Following Products:"
+        products = get(
+          option_choice: option_choice,
+          env: env
+        )
+
+        products.map do |product|
+          puts product[:id].downcase
+        end
+
+        exit 0
+      rescue StandardError => e
+        raise e
+      end
+
+      # Display Usage for this Module
+      public_class_method def self.help
+        puts "USAGE:
+          fees = #{self}.get(
+            env: 'required - Coinbase::Option::Environment.get Object',
+            option_choice: 'required - Coinbase::Option::Choice Object'
+          )
+        "
+      end
+    end
+  end
+end