cryptum 0.0.368 → 0.0.370

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6b1a1f3adfd5488b1f51f2d288255b663cfd9bf6c516e77cec6e2d49c77da69
-  data.tar.gz: 14df82d2294151953337624cbce1bfffa6ad0af7ebc120625013d5c6c323713d
+  metadata.gz: 53bdb2d2da6bf7e78c5623af1b88d27bb8c7942e19911b00306f0b6bfef912eb
+  data.tar.gz: 9882b53b7be9185eb84ba21a8a52ac8a8773b098830786556a94ecfe92abbf4b
 SHA512:
-  metadata.gz: 12ad2d6e7401156dd5b02c9c928ea743ca608249c9dc631bda47910a786c9864abbbdeba762ad693865b50f16a3c316fc41902af3105147822d9906d2822cdac
-  data.tar.gz: 19173b3f98cbe0a063248aa0a7a3f8906dd85893e3fde9372e6529f53de5dc4ffe6ad89fc5c1aa1a9576a89c7c8ffb3e12f8667656f031c05bbde4c79cb4b997
+  metadata.gz: 51b81e6d2e78d0cc9d9151d7b0186ff13fe6e55ba4b5c29d176fee5818fb13d5a06baa281ef255306669d18c3e320c389667615f66a41965a939a8e57cf96c22
+  data.tar.gz: 1d764d72578d39ab049c462499f1885a26b3aa1f07aa5d02ba06688306b3a3faa65378e6dc26523588820823b17377f8b6bb319ec7b68ee9ed86c2dee94ff71e

data/Gemfile

@@ -12,7 +12,7 @@ gemspec
 # to build appropriately.  Defer to ./reinstall_coinbot_gemset.sh
 # to review these custom flags
 gem 'addressable', '2.8.1'
-gem 'bundler', '>=2.4.7'
+gem 'bundler', '>=2.4.9'
 gem 'bundler-audit', '0.9.1'
 gem 'curses', '1.4.4'
 gem 'eventmachine', '1.2.7'
@@ -26,9 +26,9 @@ gem 'rdoc', '6.5.0'
 gem 'require_all', '3.0.0'
 gem 'rest-client', '2.1.0'
 gem 'rspec', '3.12.0'
-gem 'rubocop', '1.46.0'
+gem 'rubocop', '1.48.1'
 gem 'rubocop-rake', '0.6.0'
-gem 'rubocop-rspec', '2.18.1'
+gem 'rubocop-rspec', '2.19.0'
 gem 'ruby-prof', '1.6.1'
 gem 'rvm', '1.11.3.9'
 gem 'sinatra', '3.0.5'

data/README.md

@@ -57,14 +57,54 @@ $ vi ~/cryptum/etc/open_ai.yaml
 
 
 ### **Usage** ###
-
 ```
 $ rvm use ruby-<VERSION>@cryptum
 $ cryptum --help
+USAGE: cryptum [opts]
+    -s, --symbol=SYMBOL              <Required - Crypto Symbol.(e.g. btc-usd, eth-usd, etc.)
+    -A, --[no-]autotrade             <Optional - Automatically Buy and Sell Crypto>
+    -l, --[no-]list-products         <Optional - List Supported Crypto Currency Products and Exit>
+    -p, --proxy=PROXY                <Optional - HTTP Proxy e.g. "http://127.0.0.1:8080">
+    -R                               <Optional - Reset Timers / Market Trend Stats at Session Init (Defaults to false)>
+        --[no-]reset-session-countdown
+    -r, --session-root=PATH          <Optional - Directory with etc && order_books (Defaults to ~/cryptum)>
+    -S, --[no-]sandbox               <Optional - Use Coinbase Sandbox Environment for Testing Ideas>
+    -tSECONDS,                       <Optional - Seconds Between Market Trend Reset (Default 60 i.e. 1 hour)>
+        --time-between-market-trend-reset
+
+$ cryptum --symbol btc-usd \
+          --autotrade \
+          --session-root ~/cryptum \
+          --time-between-market-trend-reset 86_400
+```
+
+By default, cryptum resets the market trend (i.e. number of buys vs number of sells) every day (i.e. 86400 seconds).  As Maker & Taker fees drop in value, it may be useful to change the market trend reset value to something lower:
+```
 $ cryptum --symbol btc-usd \
           --autotrade \
-          --session-root ~/cryptum
+          --session-root ~/cryptum \
+          --time-between-market-trend-reset 14_400
+```
+
+Possible values for market trend reset are:
 ```
+604_800 => 1 week
+86_400  => 1 day
+14_400  => 4 hours
+10_800  => 3 hours
+7_200   => 2 hours
+3_600   => 1 hour
+2_700   => 45 minutes
+1_800   => 30 minutes
+900     => 15 minutes
+300     => 5 minutes
+180     => 3 minutes
+60      => 1 minute
+```
+
+If you choose a lower value than the default, the target profit margin's (i.e. TPM) will also be reduced (assuming the TPM is still higher than Maker + Taker fees).  This may be desireable - although TPM is reduced, trading volume should increase resulting in better Maker & Taker fee tiers (i.e. lower cost / trade).
+
+Another option (particularly useful with smaller balances) is bumping the market trend reset to 604800 (i.e. 1 week) which will immediately increase the TPM %'s.  The downside to this approach is trading volume is reduced, resulting in higher maker & taker fee tiers (i.e. higher cost / trade).
 
 From an error monitoring perspective, they can be monitored via:
 ```

data/cryptum.gemspec

@@ -21,6 +21,25 @@ Gem::Specification.new do |spec|
 
   spec.files = `git ls-files -z`.split("\x0")
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec_tests = spec.files.grep(%r{^spec/})
+  cryptum_modules = spec.files.grep(%r{^lib/})
+
+  missing_rspec = false
+  cryptum_modules.each do |cryptum_path|
+    spec_test_for_mod = "#{File.dirname(cryptum_path)}/#{File.basename(cryptum_path).split('.').first}_spec.rb"
+
+    next unless spec_tests.grep(/#{spec_test_for_mod}/).empty?
+
+    missing_rspec = true
+    cryptum_mod_dir = File.dirname(cryptum_path)
+    spec_test = "spec/#{cryptum_mod_dir}/#{spec_test_for_mod}"
+    error_msg = "ERROR: RSpec: #{spec_test} missing for Cryptum Module: #{cryptum_path}"
+    # Display error message in red (octal encoded ansi sequence)
+    puts "\001\e[1m\002\001\e[31m\002#{error_msg}\001\e[0m\002"
+  end
+
+  raise if missing_rspec
+
   spec.require_paths = ['lib']
 
   dev_dependency_arr = %i[

data/lib/cryptum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cryptum
-  VERSION = '0.0.368'
+  VERSION = '0.0.370'
 end

data/spec/lib/cryptum/bot_conf_spec.rb

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

data/spec/lib/cryptum/event/bot_conf_spec.rb

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

data/spec/lib/cryptum/event/buy_spec.rb

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

data/spec/lib/cryptum/event/cancel_spec.rb

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

data/spec/lib/cryptum/event/exit_spec.rb

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

data/spec/lib/cryptum/event/gtfo_spec.rb

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

data/spec/lib/cryptum/event/history_spec.rb

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

data/spec/lib/cryptum/event/key_press_spec.rb

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

data/spec/lib/cryptum/event/order_book_spec.rb

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

data/spec/lib/cryptum/event/pane_spec.rb

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

data/spec/lib/cryptum/event/parse_spec.rb

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

data/spec/lib/cryptum/event/scroll_spec.rb

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

data/spec/lib/cryptum/event/sell_spec.rb

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

data/spec/lib/cryptum/matrix_spec.rb

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

data/spec/lib/cryptum/open_ai_spec.rb

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

data/spec/lib/cryptum/option/choice_spec.rb

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

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

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

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

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

data/spec/lib/cryptum/portfolio/balance_spec.rb

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

data/spec/lib/cryptum/portfolio_spec.rb

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

data/spec/lib/cryptum/version_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Cryptum::VERSION do
+  it 'is defined' do
+    expect(Cryptum::VERSION).not_to be_nil
+  end
+
+  it 'is a string' do
+    expect(Cryptum::VERSION).to be_a(String)
+  end
+
+  it 'matches the expected pattern' do
+    expect(Cryptum::VERSION).to match(/\d+\.\d+\.\d+/)
+  end
+end

data/spec/lib/cryptum/web_sock/coinbase_spec.rb

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

data/spec/lib/cryptum/web_sock/event_machine_spec.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cryptum
 version: !ruby/object:Gem::Version
-  version: 0.0.368
+  version: 0.0.370
 platform: ruby
 authors:
 - 0day Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-24 00:00:00.000000000 Z
+date: 2023-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.7
+        version: 2.4.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.7
+        version: 2.4.9
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -226,14 +226,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.46.0
+        version: 1.48.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.46.0
+        version: 1.48.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -254,14 +254,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.18.1
+        version: 2.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.18.1
+        version: 2.19.0
 - !ruby/object:Gem::Dependency
   name: ruby-prof
   requirement: !ruby/object:Gem::Requirement
@@ -454,15 +454,48 @@ files:
 - order_books/.gitkeep
 - reinstall_cryptum_gemset.sh
 - spec/lib/cryptum/api_spec.rb
+- spec/lib/cryptum/bot_conf_spec.rb
+- spec/lib/cryptum/event/bot_conf_spec.rb
+- spec/lib/cryptum/event/buy_spec.rb
+- spec/lib/cryptum/event/cancel_spec.rb
+- spec/lib/cryptum/event/exit_spec.rb
+- spec/lib/cryptum/event/gtfo_spec.rb
+- spec/lib/cryptum/event/history_spec.rb
+- spec/lib/cryptum/event/key_press_spec.rb
+- spec/lib/cryptum/event/order_book_spec.rb
+- spec/lib/cryptum/event/pane_spec.rb
+- spec/lib/cryptum/event/parse_spec.rb
+- spec/lib/cryptum/event/scroll_spec.rb
+- spec/lib/cryptum/event/sell_spec.rb
 - spec/lib/cryptum/event_spec.rb
 - spec/lib/cryptum/log_spec.rb
+- spec/lib/cryptum/matrix_spec.rb
+- spec/lib/cryptum/open_ai_spec.rb
+- spec/lib/cryptum/option/choice_spec.rb
 - spec/lib/cryptum/option_spec.rb
 - spec/lib/cryptum/order_book/generate_spec.rb
+- spec/lib/cryptum/order_book/indicator_spec.rb
 - spec/lib/cryptum/order_book/market_trend_spec.rb
+- spec/lib/cryptum/order_book/profit_margin_spec.rb
 - spec/lib/cryptum/order_book_spec.rb
+- spec/lib/cryptum/portfolio/balance_spec.rb
+- spec/lib/cryptum/portfolio_spec.rb
 - spec/lib/cryptum/ui/command_spec.rb
+- spec/lib/cryptum/ui/key_press_event_spec.rb
+- spec/lib/cryptum/ui/market_trend_spec.rb
+- spec/lib/cryptum/ui/order_execute_details_spec.rb
+- spec/lib/cryptum/ui/order_execution_spec.rb
+- spec/lib/cryptum/ui/order_plan_details_spec.rb
+- spec/lib/cryptum/ui/order_plan_spec.rb
+- spec/lib/cryptum/ui/order_timer_spec.rb
+- spec/lib/cryptum/ui/portfolio_spec.rb
+- spec/lib/cryptum/ui/signal_engine_spec.rb
+- spec/lib/cryptum/ui/terminal_window_spec.rb
 - spec/lib/cryptum/ui/ticker_spec.rb
 - spec/lib/cryptum/ui_spec.rb
+- spec/lib/cryptum/version_spec.rb
+- spec/lib/cryptum/web_sock/coinbase_spec.rb
+- spec/lib/cryptum/web_sock/event_machine_spec.rb
 - spec/lib/cryptum/web_sock_spec.rb
 - spec/lib/cryptum_spec.rb
 - spec/spec_helper.rb
@@ -490,7 +523,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.9
 signing_key:
 specification_version: 4
 summary: Coinbase Pro High-Frequency Trading Bot