utxoracle 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e06742e7448c182f3f2399e200c50e0563f3d8672433d942028cbc7c1827f60b
-  data.tar.gz: 33f2c9d1d7e496664c84a682e3b0d09a0971f152f7f351b59d7cdeb0baa48bba
+  metadata.gz: 2ac6ef650a940eb64d180a28f6d556acca9310a42d199fa4bceb59e909cb6b2e
+  data.tar.gz: '0792d9c0e1867d62fcc507a0574c9338577b8468399d26b34124092525dddd8d'
 SHA512:
-  metadata.gz: b64d8799da84d9ee041e61548adcf889067bd0bcef7b5331d59e43aca4bec7a4075d6bdd0773939132d9b8dec4b428e60a05be9bf9b720ecfec74b40b805e74f
-  data.tar.gz: caeb20a9d134903c29cccfd3bd03697a1bcf5b56452762ea383850b9423a4bc056d7ac77e4d18ed6f455d7765e21935421172ccd2ab3ca733298545792a03628
+  metadata.gz: 528c646c4201da999ca64ef7ea2ddd723a27e4663d7a253a0bc58472af5efc44d17ae28c4482b0bb271c7d87ed4269c165aa7355c6f0364b49cbdf1672b7e4e6
+  data.tar.gz: a34764d738c7fc67d09d57a9bf142642c2087233fe0fbb9110327ad2153b8d5c737924fab4cb120386f798b4ad4f819102d19f809a41b59b213797f7396c414d

data/.gitignore

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

data/README.md

@@ -1,7 +1,17 @@
-# UTXOracle.rb
-Ruby implementation of https://utxo.live/oracle/.
+[![Gem Version](https://badge.fury.io/rb/utxoracle.svg)](https://badge.fury.io/rb/utxoracle)
+
+# Utxoracle
+Offline price oracle for Bitcoin written in Ruby.
+
+In September 2023 [SteveSimple](https://twitter.com/SteveSimple) & [DanielLHinton](https://twitter.com/DanielLHinton) [dropped](https://twitter.com/SteveSimple/status/1704864674431332503) https://utxo.live/oracle/, the first method to derive historical USD price of bitcoin based purely on UTXO set.
+
+Needless to say, a lot of bitcoiners found this VERY cool. We're in a unique phase of history; transitioning from the Dollar Network to a Bitcoin Standard. Pulling out these patterns sparks joy.
+
+The purpose of releasing Utxoracle as a Gem is multi-fold:
+1. Make the tool available as a [Gem](https://rubygems.org/gems/utxoracle) to the Ruby community.
+2. Provide a flexible API, where folks can extend this for other use cases (currencies, language, etc).
+3. Provide a _modular_ provider model, so folks can pull data from mempool.space or other RPCs.
 
-(Original implementation by [SteveSimple](https://twitter.com/SteveSimple) & [DanielLHinton](https://twitter.com/DanielLHinton) who discovered and built the first offline bitcoin price oracle.)
 
 ## Table of contents
 
@@ -34,29 +44,58 @@ All examples below assume that the gem has been required.
 require 'utxoracle'
 ```
 
-
 ### Fetching price
 
-#### Using a raw bitcoin node
+#### Using a specific bitcoin node
+
+`bitcoin.conf` would look like:
+```txt
+server=1
+rpcuser=aUser
+rpcpassword=aPassword
+```
 ```ruby
-provider = Utxoracle::RawBitcoinNode.new("aUser", "aPassword", "127.0.0.1", 8332)
+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::MempoolDotSpace.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/Rakefile

@@ -1,4 +1,4 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rubocop/rake_task'
 require 'rspec/core/rake_task'
 

data/bin/run

@@ -0,0 +1,27 @@
+#!/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]
+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

data/lib/utxoracle/oracle.rb

@@ -1,6 +1,4 @@
 require 'time'
-require_relative 'rpc'
-require_relative 'providers/raw_bitcoin_node'
 
 module Utxoracle
   class Oracle
@@ -19,12 +17,14 @@ module Utxoracle
 
     def price(requested_date)
       unless validate_date(requested_date)
-        puts "Invalid date.\nEarliest available: 2020-07-26.\nLatest available #{Date.today}.\nFormat: YYYY-MM-DD."
-        return
+        if @log
+          puts "Invalid date.\nEarliest available: 2020-07-26.\nLatest available #{Date.today}.\nFormat: YYYY-MM-DD."
+        end
+        return -1
       end
 
       if price_estimate = @cache[requested_date]
-        puts "price_estimate is #{price_estimate}"
+        puts "Price Estimate: $#{price_estimate.to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse}" if @log
         return price_estimate
       end
 
@@ -124,7 +124,7 @@ module Utxoracle
 
       puts("Reading all blocks on #{price_day_date_utc}...") if @log
       puts('This will take a few minutes (~144 blocks)...') if @log
-      puts("Height\tTime(utc)\t Completion %") if @log
+      puts("Height\tTime(utc)\tCompletion %") if @log
 
       block_height = price_day_block_estimate
       block_hash_b = @provider.getblockhash(block_height)
@@ -143,8 +143,8 @@ module Utxoracle
       while target == day
         blocks_on_this_day += 1
 
-        progress_estimate = 100.0 * (hour + minute / 60) / 24.0
-        puts("#{block_height}\t#{time.strftime('%H:%M:%S')}\t#{progress_estimate}") if @log
+        progress_estimate = 100.0 * (hour + minute / 60.0) / 24.0
+        puts("#{block_height}\t#{time.strftime('%H:%M:%S')}\t#{progress_estimate.round(2)}") if @log
 
         for tx in block_b['tx']
           outputs = tx['vout']
@@ -260,7 +260,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
@@ -347,6 +347,8 @@ module Utxoracle
                     (Date.parse(date) < Date.today)
 
       valid_format && valid_range
+    rescue Date::Error
+      false
     end
   end
 end

data/lib/utxoracle/providers/{mempool_dot_space.rb → mempool.rb}

@@ -5,7 +5,7 @@ require_relative '../request'
 # and throttles the number of requests the oracle takes to compute.
 # Running this requires an Enterprise license.
 module Utxoracle
-  class MempoolDotSpace < Provider
+  class Mempool < Provider
     def initialize; end
 
     def getblockcount

data/lib/utxoracle/providers/{raw_bitcoin_node.rb → node.rb}

@@ -1,10 +1,10 @@
 require_relative '../provider'
-require_relative '../rpc'
+require 'cleanrpc'
 
 module Utxoracle
-  class RawBitcoinNode < Provider
+  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.1'
+  VERSION = '0.0.3'
 end

data/lib/utxoracle.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'utxoracle/rpc'
 require_relative 'utxoracle/version'
 require_relative 'utxoracle/oracle'
-require_relative 'utxoracle/providers/mempool_dot_space'
-require_relative 'utxoracle/providers/raw_bitcoin_node'
+require_relative 'utxoracle/providers/mempool'
+require_relative 'utxoracle/providers/node'
 
 module Utxoracle
 end

data/spec/utxoracle/oracle_spec.rb

@@ -2,20 +2,38 @@
 
 require 'spec_helper'
 
-# RSpec.describe Utxoracle::Oracle do
-#   let(:oracle) do
-#     described_class.new('aUser', 'aPassword', '127.0.0.1', '8332')
-#   end
-#
-#   describe '.new' do
-#     it 'initialized an Rpc instance' do
-#       expect(Utxoracle::Rpc).to receive(:new)
-#       described_class.new('aUser', 'aPassword', '127.0.0.1', '8332')
-#       expect(oracle.class).to eq Utxoracle::Oracle
-#     end
-#   end
-#
-#   # TODO: - test cache
-#   # TODO - test provider interface
-#   # TODO - test `price` return type
-# end
+RSpec.describe Utxoracle::Oracle do
+  describe '.new' do
+    it 'requires provider and takes optional log config' do
+      provider = Utxoracle::Mempool
+      Utxoracle::Oracle.new(provider, log = true)
+    end
+  end
+
+  describe 'date validation' do
+    it 'returns -1 for garbage date inputs' do
+      provider = Utxoracle::Mempool
+      oracle = Utxoracle::Oracle.new(provider)
+      price = oracle.price('garbage')
+      expect(price).to be(-1)
+    end
+
+    it 'returns -1 for dates before 2020-07-26' do
+      provider = Utxoracle::Mempool
+      oracle = Utxoracle::Oracle.new(provider)
+      price = oracle.price('2015-01-01')
+      expect(price).to be(-1)
+    end
+
+    it 'returns -1 for dates in the future' do
+      provider = Utxoracle::Mempool
+      oracle = Utxoracle::Oracle.new(provider)
+      price = oracle.price('3000-01-01')
+      expect(price).to be(-1)
+    end
+  end
+
+  # TODO: - test cache
+  # TODO - test provider interface
+  # TODO - test `price` return type
+end

data/utxoracle.gemspec

@@ -11,17 +11,18 @@ Gem::Specification.new do |spec|
   spec.platform               = Gem::Platform::RUBY
   spec.authors                = ['Keith Gardner']
 
-  spec.summary                = 'Interface for UTXOracle.'
-  spec.description            = 'Object oriented design for interacting with UTXOracle.'
+  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.license                = 'MIT'
   spec.required_ruby_version  = '>= 3.1.0'
 
   spec.files                  = `git ls-files`.split("\n")
-  spec.bindir                 = 'exe'
+  spec.bindir                 = 'bin'
   spec.require_path           = 'lib'
 
-  spec.add_dependency 'typhoeus'
+  spec.add_dependency 'typhoeus', '~> 1.4.0'
+  spec.add_dependency 'cleanrpc', '~> 0.0.2'
 
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'
@@ -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,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: utxoracle
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Keith Gardner
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2023-11-01 00:00:00.000000000 Z
+date: 2023-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
+- !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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -122,32 +136,45 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Object oriented design for interacting with UTXOracle.
+- !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.
 email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
-- ".rspec_status"
 - ".ruby-version"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/console
+- bin/run
 - lib/utxoracle.rb
 - lib/utxoracle/oracle.rb
 - lib/utxoracle/provider.rb
-- lib/utxoracle/providers/mempool_dot_space.rb
-- lib/utxoracle/providers/raw_bitcoin_node.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
@@ -169,8 +196,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
-summary: Interface for UTXOracle.
+summary: Offline price oracle for Bitcoin.
 test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rspec_status

@@ -1,8 +0,0 @@
-example_id                             | status | run_time        |
--------------------------------------- | ------ | --------------- |
-./spec/utxoracle/oracle_spec.rb[1:1:1] | failed | 0.00966 seconds |
-./spec/utxoracle/rpc_spec.rb[1:1:1]    | passed | 0.00025 seconds |
-./spec/utxoracle/rpc_spec.rb[1:2]      | passed | 0.01109 seconds |
-./spec/utxoracle/rpc_spec.rb[1:3]      | passed | 0.00028 seconds |
-./spec/utxoracle/rpc_spec.rb[1:4]      | passed | 0.00214 seconds |
-./spec/utxoracle_spec.rb[1:1]          | passed | 0.00127 seconds |

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,29 +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