txcatcher 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 909ad770012c2bacccbb1e9f7438bf97e4c92d15
-  data.tar.gz: ec40ed49c4f006e30f4ff07be84fce1d2f05523f
+  metadata.gz: 57275484854984cda01f4f29c6660d19db19ff71
+  data.tar.gz: 6bb6d1e3de974824ffcfd8e918545b112b4bd0d5
 SHA512:
-  metadata.gz: f12b5d7ef16ba43904ec6cebc3ab77a3f1c8fad8588a67b5ad17d1f5076260dee01f21d20928a5f6ae287955ab6c5a83233a05402d8350bd79523e0700095b02
-  data.tar.gz: 3f737f4a9d32f9ae4c8f9011a3a03856cd55cf9dd4af3e517e0ded3d0dfd656d938bcf8a59008b6a32b9cfc37379ef90e1e0f78317be7f7e8d2b8ca438a3b061
+  metadata.gz: e81da207158daf3c4b8cf61636deecd85088c2edb7bd191b52007f47639fe00cbc89c923019fc92566a69ac675a56d792e90247338c33b5a787208ddf46b9b2c
+  data.tar.gz: dbf857e7c92d76e34e4adfbe3c792115084159d6c2be8b90af2bec9d69b0b417ac1ccc520a208185e36f3de69c8ddfcc91f7e44965c5636ced454742487b28b9

data/Gemfile.lock

@@ -30,7 +30,7 @@ GEM
       hashie (>= 3.4)
       mime-types (>= 1.16, < 3.0)
       oauth2 (~> 1.0)
-    goliath (1.0.5)
+    goliath (1.0.6)
       async-rack
       einhorn
       em-synchrony (>= 1.0.0)
@@ -42,8 +42,8 @@ GEM
       rack (>= 1.2.2)
       rack-contrib
       rack-respond_to
-    hashie (3.5.6)
-    highline (1.7.8)
+    hashie (3.5.7)
+    highline (1.7.10)
     http_parser.rb (0.6.0)
     jeweler (2.3.7)
       builder
@@ -59,12 +59,12 @@ GEM
     jwt (1.5.6)
     log4r (1.1.10)
     mime-types (2.99.3)
-    mini_portile2 (2.2.0)
-    multi_json (1.12.1)
+    mini_portile2 (2.3.0)
+    multi_json (1.13.1)
     multi_xml (0.6.0)
     multipart-post (2.0.0)
-    nokogiri (1.8.0)
-      mini_portile2 (~> 2.2.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
     oauth2 (1.4.0)
       faraday (>= 0.8, < 0.13)
       jwt (~> 1.0)
@@ -74,28 +74,28 @@ GEM
     psych (2.2.4)
     rack (1.6.8)
     rack-accept-media-types (0.9)
-    rack-contrib (1.5.0)
+    rack-contrib (1.8.0)
       rack (~> 1.4)
     rack-respond_to (0.9.8)
       rack-accept-media-types (>= 0.6)
-    rake (12.0.0)
-    rdoc (5.1.0)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
+    rake (12.3.0)
+    rdoc (6.0.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
     satoshi-unit (0.2.2)
     semver2 (3.4.2)
-    sequel (4.49.0)
+    sequel (5.4.0)
     sqlite3 (1.3.13)
     thread_safe (0.3.6)
 
@@ -113,4 +113,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   1.15.4
+   1.16.0

data/README.md

@@ -71,7 +71,7 @@ Installation
 
   Install txcatcher: `gem install txcatcher`
 
-Configuring & Runing
+Configuring & Running
 --------------------
 You're going to need a simple config file. By default, txcatcher looks in `~/.txcatcher` dir,
 so create the dir and the file there: `mkdir ~/.txcatcher && touch ~/.txcatcher/config.yml`
@@ -79,7 +79,7 @@ Example config file can be found in [templates/config.yml](templates/config.yml)
 to copy the contents and edit it.
 
 Once your bitcoin/litecoind finished syncing, you can start txcatcher with a simple command: `txcatcher`.
-You can srart multiple instances of txcatcher, when, for example, you want instances of it
+You can start multiple instances of txcatcher, when, for example, you want instances of it
 tracking both litecoin and bitcoin transactions:
 
     txcatcher -c ~/.txcatcher/litecoin_config.yml

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.6

data/db/migrations/004_add_timestamps_to_transactions.rb

@@ -0,0 +1,7 @@
+Sequel.migration do
+  change do
+    alter_table :transactions do
+      add_column :created_at, DateTime
+    end
+  end
+end

data/db/migrations/005_add_protected_flag_to_transactions.rb

@@ -0,0 +1,9 @@
+Sequel.migration do
+  change do
+    alter_table :transactions do
+      # This flag means someone has checked it once through the API and we might not want to remove
+      # it from the DB (upon scheduled cleanup) because it's of a potential interest.
+      add_column :protected, FalseClass, default: false
+    end
+  end
+end

data/lib/txcatcher/catcher.rb

@@ -93,7 +93,7 @@ module TxCatcher
         block_hash   = TxCatcher.rpc_node.getblock(block_hex)
         transactions = block_hash["tx"]
         height       = TxCatcher.current_block_height = block_hash["height"].to_i
-        $stdout.puts "Block #{height} mined, transactions received:\n  #{transactions.join("  \n")}"
+        $stdout.puts "*** Block #{height} mined, transactions received:\n  #{transactions.join("  \n")}"
         @queue["hashblock"] << ( Proc.new {
           Transaction.where(txid: transactions).update(block_height: height)
         })

data/lib/txcatcher/cleaner.rb

@@ -17,7 +17,11 @@ module TxCatcher
         Thread.new do
           loop do
             @@cleaning_counter = { transactions: 0, deposits: 0, addresses: 0 }
-            db_tx_count = TxCatcher::Transaction.last.id - TxCatcher::Transaction.first.id + 1
+            db_tx_count = if Config.protected_transactions
+              TxCatcher::Transaction.where(Sequel.~(protected: true)).count
+            else
+              TxCatcher::Transaction.count
+            end
             $stdout.print "Cleaning transactions in DB..."
             $stdout.print "#{db_tx_count} now, needs to be below #{Config.max_db_transactions_stored}\n"
             if db_tx_count > Config.max_db_transactions_stored
@@ -42,7 +46,9 @@ module TxCatcher
       end
 
       def clean_transactions(n)
-        transactions = Transaction.order("created_at ASC").limit(n).each do |t|
+        transactions = Transaction.order("created_at ASC")
+        transactions.where(Sequel.~(protected: true)) if Config.protected_transactions
+        transactions.limit(n).each do |t|
           clean_deposits(t)
           t.delete
           @@cleaning_counter[:transactions] += 1

data/lib/txcatcher/models/transaction.rb

@@ -19,6 +19,10 @@ module TxCatcher
       end
     end
 
+    def before_create
+      self.created_at = Time.now
+    end
+
     def after_create
       self.deposits.each do |d|
         d.transaction = self
@@ -38,6 +42,35 @@ module TxCatcher
       end
     end
 
+    # Queries rpc node to check whether the transaction has been included in any of the blocks,
+    # but only if current block_height is nil.
+    def update_block_height!(limit=100)
+
+      # This calculates the approximate number of blocks to check.
+      # So, for example, if transaction is less than 10 minutes old,
+      # there's probably no reason to try and check more than 2-3 blocks back.
+      # However, to make absolute sure, we always bump up this number for 10 blocks.
+      # Over larger periods of time, the avg block per minute value should even out, so
+      # it's probably going to be fine either way.
+      created_minutes_ago = ((self.created_at - Time.now).to_i/60)
+      blocks_to_check = (created_minutes_ago / 10).abs + 10
+      return self.block_height if self.block_height
+      blocks_to_check = limit if blocks_to_check > limit
+
+      i = 0
+      while i <= blocks_to_check
+        block_hash = TxCatcher.rpc_node.getblockhash(TxCatcher.current_block_height - i)
+        block      = TxCatcher.rpc_node.getblock(block_hash)
+        i += 1
+        $stdout.puts "--- checking block #{TxCatcher.current_block_height - i} for tx #{self.txid}"
+        if block["tx"] && block["tx"].include?(self.txid)
+          $stdout.puts "tx #{self.txid} block height updated to #{block["height"]}"
+          self.update(block_height: block["height"])
+          return block["height"].to_i
+        end
+      end
+    end
+
     private
 
       def parse_transaction

data/lib/txcatcher/server.rb

@@ -32,7 +32,9 @@ module TxCatcher
       if address
         transactions_ids = address.deposits.map { |d| d.transaction.txid }
         deposits = address.deposits.map do |d|
+          t.update(protected: true) unless t.protected
           t = d.transaction
+          t.update_block_height!
           {
             txid:          t.txid,
             amount:        d.amount_in_btc,
@@ -52,11 +54,15 @@ module TxCatcher
       path.pop
       addr = path.last
 
-      model        = Address.where(address: addr).eager(deposits: :transactions).first
+      model = Address.where(address: addr).eager(deposits: :transactions).first
+      return [200, {}, "{}"] unless model
+
       transactions = model.deposits.map { |d| d.transaction }
       utxos = transactions.map do |t|
         outs = t.tx_hash["vout"].select { |out| out["scriptPubKey"]["addresses"] == [addr] }
         outs.map! do |out|
+          t.update(protected: true) unless t.protected
+          t.update_block_height!
           out["confirmations"] = t.confirmations || 0
           out["txid"]          = t.txid
           out

data/spec/catcher_spec.rb

@@ -41,17 +41,22 @@ RSpec.describe TxCatcher::Catcher do
 
   end
 
-  it "upon receiving a new block updates transactions block height" do
-    transaction = TxCatcher::Transaction.create(hex: @hextx)
-    expect(TxCatcher.rpc_node).to receive(:getblock).and_return({ "height" => TxCatcher.current_block_height + 1, "tx" => [transaction.txid]})
-    @block_sock.send_string('hashblock', ZMQ::SNDMORE)
-    @block_sock.send_string("hello")
+  describe "upon receiving a new block" do
+
+    it "updates transactions block height" do
+      transaction = TxCatcher::Transaction.create(hex: @hextx)
+      allow(TxCatcher.rpc_node).to receive(:getblock).and_return({ "height" => TxCatcher.current_block_height + 1, "tx" => [transaction.txid]})
+      @block_sock.send_string('hashblock', ZMQ::SNDMORE)
+      @block_sock.send_string("hello")
+      #transaction.update_block_height!
+
+      i = 0
+      until transaction.reload.confirmations == 1
+        sleep 1 and i += 1
+      end
+      expect(transaction.block_height).to eq(TxCatcher.current_block_height)
 
-    i = 0
-    until transaction.reload.confirmations == 1
-      sleep 1 and i += 1
     end
-    expect(transaction.block_height).to eq(TxCatcher.current_block_height)
 
   end
 

data/spec/cleaner_spec.rb

@@ -42,13 +42,23 @@ RSpec.describe TxCatcher::Cleaner do
     expect(TxCatcher::Address.count).to     eq(10)
   end
 
+  it "protects checked transactions" do
+    protected_txs = create_transactions(3, { protected: true })
+    regular_txs   = create_transactions(15)
+    clean_transactions
+    expect(TxCatcher::Transaction.count).to eq(12)
+    expect(TxCatcher::Deposit.count).to     eq(12)
+    expect(TxCatcher::Address.count).to     eq(12)
+  end
+
 
-  def create_transactions(n)
-    (1..n).to_a.each do |i|
+  def create_transactions(n, attrs={})
+    (1..n).to_a.map do |i|
       d  = TxCatcher::Deposit.new(address_string: "addr#{i}", amount: 0)
-      tx = TxCatcher::Transaction.new
+      tx = TxCatcher::Transaction.new(attrs)
       tx.deposits << d
       tx.save
+      tx
     end
   end
 

data/spec/config/config.yml.sample

@@ -20,3 +20,4 @@ rpcnode:
 # zeromq: bitcoind
 max_db_transactions_stored: 10
 db_clean_period_seconds: 300
+protected_transactions: true

data/spec/models/transaction_spec.rb

@@ -26,4 +26,11 @@ RSpec.describe TxCatcher::Transaction do
     expect(TxCatcher::Transaction.where(txid: transaction.txid).count).to eq(1)
   end
 
+  it "updates block height by making manual requests to RPC and searching if tx is included in one of the previous blocks" do
+    expect(TxCatcher.rpc_node).to receive(:getblockhash).and_return("blockhash123")
+    expect(TxCatcher.rpc_node).to receive(:getblock).and_return({ "height" => "123", "tx" => [@transaction.txid], "hash" => "blockhash123"})
+    @transaction.update_block_height!
+    expect(@transaction.block_height).to eq(123)
+  end
+
 end

data/spec/spec_helper.rb

@@ -31,6 +31,8 @@ end
 
 RSpec.configure do |config|
 
+  config.default_formatter = 'doc'
+
   config.before(:all) do
   end
 

data/txcatcher.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: txcatcher 0.1.5 ruby lib
+# stub: txcatcher 0.1.6 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "txcatcher"
-  s.version = "0.1.5"
+  s.version = "0.1.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: txcatcher
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Roman Snitko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-25 00:00:00.000000000 Z
+date: 2018-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: goliath
@@ -120,6 +120,8 @@ files:
 - db/migrations/001_create_transactions.rb
 - db/migrations/002_create_addresses.rb
 - db/migrations/003_create_deposits.rb
+- db/migrations/004_add_timestamps_to_transactions.rb
+- db/migrations/005_add_protected_flag_to_transactions.rb
 - db/schema.rb
 - lib/tasks/db.rake
 - lib/txcatcher.rb
@@ -136,10 +138,8 @@ files:
 - spec/catcher_spec.rb
 - spec/cleaner_spec.rb
 - spec/config/config.yml.sample
-- spec/config/txcatcher_test.db
 - spec/fixtures/transaction.txt
 - spec/fixtures/transaction_decoded_no_outputs.txt
-- spec/models/address_spec.rb
 - spec/models/transaction_spec.rb
 - spec/spec_helper.rb
 - templates/config.yml

data/spec/models/address_spec.rb

@@ -1,5 +0,0 @@
-require_relative '../spec_helper'
-require_relative '../../lib/txcatcher/models/address'
-
-RSpec.describe TxCatcher::Address do
-end