utxoracle 0.0.3 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ac6ef650a940eb64d180a28f6d556acca9310a42d199fa4bceb59e909cb6b2e
-  data.tar.gz: '0792d9c0e1867d62fcc507a0574c9338577b8468399d26b34124092525dddd8d'
+  metadata.gz: 27cdbbaf670f00da5da626ef21a0edeea1f94a046f07a6b7eedf3a6082522f74
+  data.tar.gz: 41879792ecb2ca00f62c78316676c800a46dcfb50c735b12ce9ca19bc0e6e025
 SHA512:
-  metadata.gz: 528c646c4201da999ca64ef7ea2ddd723a27e4663d7a253a0bc58472af5efc44d17ae28c4482b0bb271c7d87ed4269c165aa7355c6f0364b49cbdf1672b7e4e6
-  data.tar.gz: a34764d738c7fc67d09d57a9bf142642c2087233fe0fbb9110327ad2153b8d5c737924fab4cb120386f798b4ad4f819102d19f809a41b59b213797f7396c414d
+  metadata.gz: 12d274a91721d318f7ba7cfac53fcfb9d3ae0925a62f5645071b409af44bd18dbaf25b6f3107e0c4e5b57c4c195200065b942eb7f436e9be417753f508d7bef1
+  data.tar.gz: af8065f8b177b0f57d938e94dba0605974d035d8289a9b6b3bd9de19654deaca0d47cb4d6f7820b7582ec22d6f246cabf927dea5244e0d86e3e49ef09e59fefd

data/.gitignore

@@ -55,6 +55,5 @@ build-iPhoneSimulator/
 # Used by RuboCop. Remote config files pulled in from inherit_from directive.
 # .rubocop-https?--*
 
-/Gemfile.lock
 .rspec_status
 .DS_Store

data/Gemfile.lock

@@ -0,0 +1,118 @@
+PATH
+  remote: .
+  specs:
+    utxoracle (0.1.1)
+      cleanrpc (~> 0.0.2)
+      typhoeus (~> 1.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.2)
+    cleanrpc (0.0.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.1)
+    docile (1.4.0)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    ffi (1.17.0)
+    ffi (1.17.0-aarch64-linux-gnu)
+    ffi (1.17.0-aarch64-linux-musl)
+    ffi (1.17.0-arm-linux-gnu)
+    ffi (1.17.0-arm-linux-musl)
+    ffi (1.17.0-arm64-darwin)
+    ffi (1.17.0-x86-linux-gnu)
+    ffi (1.17.0-x86-linux-musl)
+    ffi (1.17.0-x86_64-darwin)
+    ffi (1.17.0-x86_64-linux-gnu)
+    ffi (1.17.0-x86_64-linux-musl)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    method_source (1.1.0)
+    parallel (1.25.1)
+    parser (3.3.3.0)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.8.0)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.0)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-rspec (3.0.1)
+      rubocop (~> 1.61)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-console (0.9.1)
+      ansi
+      simplecov
+      terminal-table
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    stackprof (0.2.26)
+    strscan (3.1.0)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    typhoeus (1.4.1)
+      ethon (>= 0.9.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  ruby
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  pry
+  rake
+  rspec
+  rubocop
+  rubocop-rspec
+  simplecov
+  simplecov-console
+  stackprof
+  utxoracle!
+
+BUNDLED WITH
+   2.5.7

data/README.md

@@ -19,6 +19,7 @@ The purpose of releasing Utxoracle as a Gem is multi-fold:
 - [Usage](#usage)
   * [Requiring the gem](#requiring-the-gem)
   * [Fetching Price](#fetching-price)
+- [Performance](#performance)
 - [Development](#development)
 - [Contributing](#contributing)
 - [License](#license)
@@ -92,6 +93,53 @@ blocks_on_this_day: 165
 Price Estimate: $27,045
 ```
 
+## Performance
+
+Without optimization at the algorithmic/implementation level, UTXOracle.rb is able to compute prices for an entire month in ~10 minutes using native Ruby threads. 
+
+Results on 3Ghz 6-Core Intel i5
+
+For October 2023:
+```ruby
+$ ./bin/benchmark/run_range aUser aPassword 127.0.0.1 8332 2023-10-01 2023-11-01
+[1] pry(main)> ret.sort
+=> [[2023-10-01 00:00:00 -0400, 27364],
+ [2023-10-02 00:00:00 -0400, 28345],
+ [2023-10-03 00:00:00 -0400, 27696],
+ [2023-10-04 00:00:00 -0400, 27712],
+ [2023-10-05 00:00:00 -0400, 27725],
+ [2023-10-06 00:00:00 -0400, 28021],
+ [2023-10-07 00:00:00 -0400, 28311],
+ [2023-10-08 00:00:00 -0400, 28308],
+ [2023-10-09 00:00:00 -0400, 28000],
+ [2023-10-10 00:00:00 -0400, 27708],
+ [2023-10-11 00:00:00 -0400, 27373],
+ [2023-10-12 00:00:00 -0400, 27045],
+ [2023-10-13 00:00:00 -0400, 27058],
+ [2023-10-14 00:00:00 -0400, 27077],
+ [2023-10-15 00:00:00 -0400, 27093],
+ [2023-10-16 00:00:00 -0400, 28357],
+ [2023-10-17 00:00:00 -0400, 28664],
+ [2023-10-18 00:00:00 -0400, 28658],
+ [2023-10-19 00:00:00 -0400, 28690],
+ [2023-10-20 00:00:00 -0400, 29704],
+ [2023-10-21 00:00:00 -0400, 30034],
+ [2023-10-22 00:00:00 -0400, 30333],
+ [2023-10-23 00:00:00 -0400, 31069],
+ [2023-10-24 00:00:00 -0400, 34468],
+ [2023-10-25 00:00:00 -0400, 34858],
+ [2023-10-26 00:00:00 -0400, 34484],
+ [2023-10-27 00:00:00 -0400, 34114],
+ [2023-10-28 00:00:00 -0400, 34438],
+ [2023-10-29 00:00:00 -0400, 34841],
+ [2023-10-30 00:00:00 -0400, 34840],
+ [2023-10-31 00:00:00 -0400, 34829]]
+[2] pry(main)> time
+=> #<Benchmark::Tms:0x0000000110ddd310 @cstime=0.0, @cutime=0.0, @label="", @real=643.9174029999995, @stime=87.356026, @total=647.7391030000001, @utime=560.3830770000001>
+
+# 643 seconds, or 10.7 minutes.
+```
+
 
 ## Development
 
@@ -124,7 +172,7 @@ rake spec                     # Run RSpec code examples
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Carolina-Bitcoin-Project/UTXOracle.
+Bug reports and pull requests are welcome on GitHub at https://github.com/BrantaOps/UTXOracle.
 
 ## License
 

data/bin/benchmarks/run

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# This is a copy of bin/run but with timing code.
+# Usage:
+#
+# Basic wall clock measurement:
+# $ ./bin/benchmarks/run aUser aPassword 127.0.0.1 8332 2023-10-01
+#
+# With StackProf measurement:
+# ./bin/benchmarks/run aUser aPassword 127.0.0.1 8332 2023-10-01 true
+
+require 'bundler/setup'
+require 'utxoracle'
+require 'benchmark'
+
+user        = ARGV[0]
+password    = ARGV[1]
+ip          = ARGV[2]
+port        = ARGV[3]
+date        = ARGV[4]
+profile     = ARGV[5]
+
+if profile
+  require 'stackprof'
+  # See https://github.com/tmm1/stackprof#sampling: for :cpu, :wall, :object
+  StackProf.run(mode: :wall, out: 'tmp/stackprof-wall.dump', raw: true) do
+    provider = Utxoracle::Node.new(user, password, ip, port)
+    oracle = Utxoracle::Oracle.new(provider, log = false)
+    puts oracle.price(date)
+  end
+else
+  time = Benchmark.measure do
+    provider = Utxoracle::Node.new(user, password, ip, port)
+    oracle = Utxoracle::Oracle.new(provider, log = false)
+    puts oracle.price(date)
+  end
+  puts time
+end

data/bin/benchmarks/run_range

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# This is a copy of bin/run_range but with timing code.
+# Usage:
+#
+# ./bin/benchmarks/run_range aUser aPassword 127.0.0.1 8332 2023-10-01 2023-10-05
+#
+# Note: Too long of a range will crash the program.
+# Bitcoin Core has limits:
+# https://github.com/bitcoin/bitcoin/blob/c0ddd32bf629bb48426b0651def497ca1a78e6b1/src/httpserver.h#L12-L14
+# for threads, queue and timeout.
+#
+# With default settings, 20 days works fine.
+#
+# To run for a full month, I've found the following settings to work fine:
+#
+# rpcworkqueue=32
+# rpcthreads=16
+# rpctimeout=60
+# Database cache 1024 MiB
+
+require 'bundler/setup'
+require 'utxoracle'
+require 'benchmark'
+
+user        = ARGV[0]
+password    = ARGV[1]
+ip          = ARGV[2]
+port        = ARGV[3]
+start_date  = ARGV[4]
+end_date    = ARGV[5]
+
+time = Benchmark.measure do
+  provider = Utxoracle::Node.new(user, password, ip, port)
+  batch_oracle = Utxoracle::BatchOracle.new(provider)
+  batch_oracle.prices(start_date, end_date)
+end
+
+puts time.real

data/bin/run

@@ -4,24 +4,12 @@
 require 'bundler/setup'
 require 'utxoracle'
 
-user = ARGV[0]
-password = ARGV[1]
-ip = ARGV[2]
-port = ARGV[3]
-date = ARGV[4]
-profile = ARGV[5]
-
-
-if profile
-  require 'stackprof'
-  # See https://github.com/tmm1/stackprof#sampling: for :cpu, :wall, :object
-  StackProf.run(mode: :wall, out: 'tmp/stackprof-wall.dump', raw: true) do
-    provider = Utxoracle::Node.new(user, password, ip, port)
-    oracle = Utxoracle::Oracle.new(provider, log = true)
-    oracle.price(date)
-  end
-else
-  provider = Utxoracle::Node.new(user, password, ip, port)
-  oracle = Utxoracle::Oracle.new(provider, log = true)
-  oracle.price(date)
-end
+user      = ARGV[0]
+password  = ARGV[1]
+ip        = ARGV[2]
+port      = ARGV[3]
+date      = ARGV[4]
+
+provider = Utxoracle::Node.new(user, password, ip, port)
+oracle = Utxoracle::Oracle.new(provider, log = true)
+oracle.price(date)

data/bin/run_range

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'utxoracle'
+
+user        = ARGV[0]
+password    = ARGV[1]
+ip          = ARGV[2]
+port        = ARGV[3]
+start_date  = ARGV[4]
+end_date    = ARGV[5]
+
+provider = Utxoracle::Node.new(user, password, ip, port)
+batch_oracle = Utxoracle::BatchOracle.new(provider)
+batch_oracle.prices(start_date, end_date)

data/lib/utxoracle/batch_oracle.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Utxoracle
+  class BatchOracle
+    def initialize(provider, log = false)
+      @provider   = provider
+      @log        = log
+    end
+
+    def prices(start_date, end_date)
+      formatted_start_date  = Time.parse start_date.tr('\n', '')
+      formatted_end_date    = Time.parse end_date.tr('\n', '')
+      ret                   = {}
+
+      date = formatted_start_date
+      threads = []
+
+      while date < formatted_end_date
+        # Bind `date` to thread scope: https://ruby-doc.org/core-2.0.0/Thread.html#method-c-new
+        threads << Thread.new(date) do |t_date|
+          oracle = Utxoracle::Oracle.new(@provider, log = @log)
+          date_str = t_date.to_s[0..9]
+          ret[date_str] = oracle.price(date_str)
+        end
+
+        date += Utxoracle::Oracle::SECONDS_PER_DAY
+      end
+      threads.each(&:join)
+
+      puts ret
+      ret
+    end
+  end
+end

data/lib/utxoracle/oracle.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'time'
 
 module Utxoracle
   class Oracle
-    SECONDS_IN_A_DAY      = 60 * 60 * 24
+    SECONDS_PER_DAY       = 86_400
     FOUR_HOURS            = 14_400
     MAINNET_PORT          = 8332
     TESTNET_PORT          = 18_332
@@ -51,7 +53,7 @@ module Utxoracle
       latest_utc_midnight = Time.new(latest_year, latest_month, latest_day).utc
 
       latest_time_in_seconds = blockheader['time']
-      yesterday_seconds = latest_time_in_seconds - SECONDS_IN_A_DAY
+      yesterday_seconds = latest_time_in_seconds - SECONDS_PER_DAY
       latest_price_day = Time.at(yesterday_seconds).utc
       latest_price_date = latest_price_day.utc.strftime('%Y-%m-%d')
 
@@ -59,7 +61,7 @@ module Utxoracle
       price_day_date_utc = @requested_date
 
       seconds_since_price_day = latest_time_in_seconds - price_day_seconds
-      blocks_ago_estimate = (144 * seconds_since_price_day.to_f / SECONDS_IN_A_DAY.to_f).round
+      blocks_ago_estimate = (144 * seconds_since_price_day.to_f / SECONDS_PER_DAY.to_f).round
       price_day_block_estimate = (block_count - blocks_ago_estimate).to_i
 
       block_hash_b       = @provider.getblockhash(price_day_block_estimate)
@@ -67,7 +69,7 @@ module Utxoracle
       time_in_seconds = block_header['time']
 
       seconds_difference = time_in_seconds - price_day_seconds
-      block_jump_estimate = (144.0 * seconds_difference / SECONDS_IN_A_DAY).round
+      block_jump_estimate = (144.0 * seconds_difference / SECONDS_PER_DAY).round
 
       last_estimate = 0
       last_last_estimate = 0
@@ -81,7 +83,7 @@ module Utxoracle
 
         time_in_seconds = block_header['time']
         seconds_difference = time_in_seconds - price_day_seconds
-        block_jump_estimate = (144.0 * seconds_difference / SECONDS_IN_A_DAY).round
+        block_jump_estimate = (144.0 * seconds_difference / SECONDS_PER_DAY).round
       end
 
       if time_in_seconds > price_day_seconds

data/lib/utxoracle/provider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Utxoracle
   class Provider
     def init

data/lib/utxoracle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Utxoracle
-  VERSION = '0.0.3'
+  VERSION = '0.1.1'
 end

data/lib/utxoracle.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'utxoracle/version'
+require_relative 'utxoracle/batch_oracle'
 require_relative 'utxoracle/oracle'
 require_relative 'utxoracle/providers/mempool'
 require_relative 'utxoracle/providers/node'

data/utxoracle.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
 
   spec.summary                = 'Offline price oracle for Bitcoin.'
   spec.description            = 'Offline price oracle for Bitcoin. Offers programmable data providers (Bitcoin node, mempool, etc). Can be used from commandline, or integrated into existing ruby stacks.'
-  spec.homepage               = 'https://github.com/Carolina-Bitcoin-Project/UTXOracle'
+  spec.homepage               = 'https://github.com/BrantaOps/UTXOracle'
   spec.license                = 'MIT'
   spec.required_ruby_version  = '>= 3.1.0'
 
@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
   spec.bindir                 = 'bin'
   spec.require_path           = 'lib'
 
-  spec.add_dependency 'typhoeus', '~> 1.4.0'
   spec.add_dependency 'cleanrpc', '~> 0.0.2'
+  spec.add_dependency 'typhoeus', '~> 1.4.0'
 
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: utxoracle
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.1
 platform: ruby
 authors:
 - Keith Gardner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-06 00:00:00.000000000 Z
+date: 2024-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  name: cleanrpc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 0.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
-  name: cleanrpc
+  name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -161,12 +161,17 @@ files:
 - ".gitignore"
 - ".ruby-version"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- bin/benchmarks/run
+- bin/benchmarks/run_range
 - bin/console
 - bin/run
+- bin/run_range
 - lib/utxoracle.rb
+- lib/utxoracle/batch_oracle.rb
 - lib/utxoracle/oracle.rb
 - lib/utxoracle/provider.rb
 - lib/utxoracle/providers/mempool.rb
@@ -177,7 +182,7 @@ files:
 - spec/utxoracle/oracle_spec.rb
 - spec/utxoracle_spec.rb
 - utxoracle.gemspec
-homepage: https://github.com/Carolina-Bitcoin-Project/UTXOracle
+homepage: https://github.com/BrantaOps/UTXOracle
 licenses:
 - MIT
 metadata: {}
@@ -196,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Offline price oracle for Bitcoin.