utxoracle 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 966c4c18a2b785a539acbfd09a9b491b24d5e83b6b606e5db05f4f3997c3f13c
-  data.tar.gz: 6089c1e572294e3b0a2a0c5f1e842f5b52449d78001522fe1f5c6c3db1c3382e
+  metadata.gz: 2ac6ef650a940eb64d180a28f6d556acca9310a42d199fa4bceb59e909cb6b2e
+  data.tar.gz: '0792d9c0e1867d62fcc507a0574c9338577b8468399d26b34124092525dddd8d'
 SHA512:
-  metadata.gz: 9cbde112559f59680e49d3fbef85dee93660b2ca03f3c8c73c45d07565ec6f90871e00de939ff530ce0a63f53e8fad3ef0c0b8e338e60d05aae9628fb72af971
-  data.tar.gz: 592eaf022a3bdfd81856cb9dfe1a6ee822daaf71d43bd824f7dd39e88d6b192cf17bb6d7d42f1a27368de5417ff8bbbbaa33c0a1e908e5b492427ae94a91a709
+  metadata.gz: 528c646c4201da999ca64ef7ea2ddd723a27e4663d7a253a0bc58472af5efc44d17ae28c4482b0bb271c7d87ed4269c165aa7355c6f0364b49cbdf1672b7e4e6
+  data.tar.gz: a34764d738c7fc67d09d57a9bf142642c2087233fe0fbb9110327ad2153b8d5c737924fab4cb120386f798b4ad4f819102d19f809a41b59b213797f7396c414d

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/run

@@ -9,7 +9,19 @@ password = ARGV[1]
 ip = ARGV[2]
 port = ARGV[3]
 date = ARGV[4]
+profile = ARGV[5]
 
-provider = Utxoracle::Node.new(user, password, ip, port)
-oracle = Utxoracle::Oracle.new(provider, true)
-oracle.price(date)
+
+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,5 +1,4 @@
 require 'time'
-require_relative 'rpc'
 
 module Utxoracle
   class Oracle
@@ -25,7 +24,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
 
@@ -261,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

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.0.3'
 end

data/lib/utxoracle.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'utxoracle/rpc'
 require_relative 'utxoracle/version'
 require_relative 'utxoracle/oracle'
 require_relative 'utxoracle/providers/mempool'

data/utxoracle.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_path           = 'lib'
 
   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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utxoracle
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Keith Gardner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-03 00:00:00.000000000 Z
+date: 2023-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         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,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.
@@ -144,11 +172,9 @@ files:
 - 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
@@ -170,7 +196,7 @@ 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: Offline price oracle for Bitcoin.

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