utxoracle 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 966c4c18a2b785a539acbfd09a9b491b24d5e83b6b606e5db05f4f3997c3f13c
-  data.tar.gz: 6089c1e572294e3b0a2a0c5f1e842f5b52449d78001522fe1f5c6c3db1c3382e
+  metadata.gz: 27c98fbe262713835893d7590648c0e566ac35cf837d5c1b6514961b54c99324
+  data.tar.gz: 8cf05e364850de7f330a4c833640d58c69b8a0c048aaec4fbaa8f4dbe54b529c
 SHA512:
-  metadata.gz: 9cbde112559f59680e49d3fbef85dee93660b2ca03f3c8c73c45d07565ec6f90871e00de939ff530ce0a63f53e8fad3ef0c0b8e338e60d05aae9628fb72af971
-  data.tar.gz: 592eaf022a3bdfd81856cb9dfe1a6ee822daaf71d43bd824f7dd39e88d6b192cf17bb6d7d42f1a27368de5417ff8bbbbaa33c0a1e908e5b492427ae94a91a709
+  metadata.gz: 932541e0474fbdbe9515629cfa7f4f4b35a1a04b4f993fc21542b063f46f1273bf66b77cc91c457301af2f81fe95bd782ec0c31bd16d8060b4509f870e1806a6
+  data.tar.gz: dcabd03dcf97198240167c5ad9449345340c85f49b39f31e80a77cab3ba4a5c68f02736a8d09c988246af34ea2a35238795a3a7b4b3cd4bcdad38ef4a36310e8

data/.gitignore

@@ -57,3 +57,4 @@ build-iPhoneSimulator/
 
 /Gemfile.lock
 .rspec_status
+.DS_Store

data/README.md

@@ -44,29 +44,58 @@ All examples below assume that the gem has been required.
 require 'utxoracle'
 ```
 
-
 ### Fetching price
 
 #### Using a specific bitcoin node
+
+`bitcoin.conf` would look like:
+```txt
+server=1
+rpcuser=aUser
+rpcpassword=aPassword
+```
 ```ruby
 provider = Utxoracle::Node.new("aUser", "aPassword", "127.0.0.1", 8332)
+oracle = Utxoracle::Oracle.new(provider, log = false)
+oracle.price("2023-10-30")
+34840
 ```
 
 #### Using mempool.space node
-```ruby
-provider = Utxoracle::Mempool.new
-```
 
-####
 ```ruby
-oracle = Utxoracle::Oracle.new(provider)
+# Mempool will throttle you without an enterprise license
+provider = Utxoracle::Mempool.new
+oracle = Utxoracle::Oracle.new(provider, log = false)
 oracle.price("2023-10-30")
 34840
 ```
 
+### Command line usage
+```bash
+$ ./bin/run aUser aPassword 127.0.0.1 8332 2023-10-10
+Reading all blocks on 2023-10-12 00:00:00 -0400...
+This will take a few minutes (~144 blocks)...
+Height  Time(utc)       Completion %
+811769  00:18:31        1.25
+811770  00:22:48        1.53
+811771  00:24:24        1.67
+811772  00:33:32        2.29
+811773  00:38:14        2.64
+811774  01:06:40        4.58
+811775  01:09:07        4.79
+...
+811931  23:41:09        98.68
+811932  23:44:01        98.89
+811933  23:48:40        99.17
+blocks_on_this_day: 165
+Price Estimate: $27,045
+```
+
+
 ## Development
 
-After checking out the repo, run `bundle i` to install dependencies.
+After checking out the repo, run `bundle install` to install dependencies.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 

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,12 +4,12 @@
 require 'bundler/setup'
 require 'utxoracle'
 
-user = ARGV[0]
-password = ARGV[1]
-ip = ARGV[2]
-port = ARGV[3]
-date = ARGV[4]
+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, true)
+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,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'time'
-require_relative 'rpc'
 
 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
@@ -25,7 +26,7 @@ module Utxoracle
       end
 
       if price_estimate = @cache[requested_date]
-        puts "price_estimate is #{price_estimate}" if @log
+        puts "Price Estimate: $#{price_estimate.to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse}" if @log
         return price_estimate
       end
 
@@ -52,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')
 
@@ -60,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)
@@ -68,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
@@ -82,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
@@ -261,7 +262,7 @@ module Utxoracle
       w2 = a2 / (a1 + a2)
       price_estimate = (w1 * btc_in_usd_best + w2 * btc_in_usd_2nd).to_i
 
-      puts "price_estimate is #{price_estimate}" if @log
+      puts "Price Estimate: $#{price_estimate.to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse}" if @log
 
       price_estimate
     end

data/lib/utxoracle/provider.rb

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

data/lib/utxoracle/providers/node.rb

@@ -1,10 +1,10 @@
 require_relative '../provider'
-require_relative '../rpc'
+require 'cleanrpc'
 
 module Utxoracle
   class Node < Provider
     def initialize(rpcuser, rpcpassword, ip, port)
-      @rpc = Rpc.new("http://#{rpcuser}:#{rpcpassword}@#{ip}:#{port}")
+      @rpc = Cleanrpc::Rpc.new("http://#{rpcuser}:#{rpcpassword}@#{ip}:#{port}")
     end
 
     def getblockcount

data/lib/utxoracle/version.rb

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

data/lib/utxoracle.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'utxoracle/rpc'
 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

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.bindir                 = 'bin'
   spec.require_path           = 'lib'
 
+  spec.add_dependency 'cleanrpc', '~> 0.0.2'
   spec.add_dependency 'typhoeus', '~> 1.4.0'
 
   spec.add_development_dependency 'pry'
@@ -30,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'simplecov-console'
+  spec.add_development_dependency 'stackprof'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: utxoracle
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Keith Gardner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-03 00:00:00.000000000 Z
+date: 2023-11-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: cleanrpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: stackprof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 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.
@@ -136,19 +164,21 @@ files:
 - 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
 - lib/utxoracle/providers/node.rb
 - lib/utxoracle/request.rb
-- lib/utxoracle/rpc.rb
 - lib/utxoracle/version.rb
 - spec/spec_helper.rb
 - spec/utxoracle/oracle_spec.rb
-- spec/utxoracle/rpc_spec.rb
 - spec/utxoracle_spec.rb
 - utxoracle.gemspec
 homepage: https://github.com/Carolina-Bitcoin-Project/UTXOracle

data/lib/utxoracle/rpc.rb

@@ -1,30 +0,0 @@
-require 'net/http'
-require 'uri'
-require 'json'
-
-module Utxoracle
-  class Rpc
-    def initialize(service_url)
-      @uri = URI.parse(service_url)
-    end
-
-    def method_missing(name, *args)
-      post_body = { 'method' => name, 'params' => args, 'id' => 'jsonrpc' }.to_json
-      resp = JSON.parse(http_post_request(post_body))
-      raise JSONRPCError, resp['error'] if resp['error']
-
-      resp['result']
-    end
-
-    def http_post_request(post_body)
-      http    = Net::HTTP.new(@uri.host, @uri.port)
-      request = Net::HTTP::Post.new(@uri.request_uri)
-      request.basic_auth @uri.user, @uri.password
-      request.content_type = 'application/json'
-      request.body = post_body
-      http.request(request).body
-    end
-
-    class JSONRPCError < RuntimeError; end
-  end
-end

data/spec/utxoracle/rpc_spec.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe Utxoracle::Rpc do
-  let(:rpc) do
-    described_class.new('http://foo:bar@127.0.0.1:8332')
-  end
-
-  describe '.new' do
-    it 'creates an instance of Rpc with given uri' do
-      expect(rpc.class).to eq(Utxoracle::Rpc)
-    end
-  end
-
-  it 'exposes http request interface' do
-    allow(rpc).to receive(:http_post_request).and_return(true)
-    expect(rpc.http_post_request('')).to eq true
-  end
-
-  it 'forwards methods over http' do
-    allow(rpc).to receive(:http_post_request).and_return(
-      "{\"result\":814521,\"error\":null,\"id\":\"jsonrpc\"}\n"
-    )
-    expect(rpc.getblockcount).to eq 814_521
-  end
-
-  it 'returns error from http endpoint when indicated' do
-    expect(rpc).to receive(:http_post_request).and_return(
-      "{\"result\":814521,\"error\":\"test error\",\"id\":\"jsonrpc\"}\n"
-    )
-    expect { rpc.test_rpc_call }.to raise_error(Utxoracle::Rpc::JSONRPCError)
-  end
-end