txcatcher 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ad836b6bfc449c217c567752f17d24aa2b3656b
-  data.tar.gz: db3033df9af8f9923c8aa21e2e41f8a8effab623
+  metadata.gz: 909ad770012c2bacccbb1e9f7438bf97e4c92d15
+  data.tar.gz: ec40ed49c4f006e30f4ff07be84fce1d2f05523f
 SHA512:
-  metadata.gz: 2f2e45bf54b63f1262909a3f051a9d270edc9b88ae47b4abafda15a4e2af37423aa77a051d0b9cc2a5c50afd01aa45ca43a65ba3c7f827cdb3aa65cc745af080
-  data.tar.gz: 9f86649d0540f376adb8d09bf820e84680335bbeb2fb0ea3880566f3fdfe1528b685c2ee4ffcda52f2b5bfa971bff17ccb3cd89817504dbe1a5fa9120ffba1da
+  metadata.gz: f12b5d7ef16ba43904ec6cebc3ab77a3f1c8fad8588a67b5ad17d1f5076260dee01f21d20928a5f6ae287955ab6c5a83233a05402d8350bd79523e0700095b02
+  data.tar.gz: 3f737f4a9d32f9ae4c8f9011a3a03856cd55cf9dd4af3e517e0ded3d0dfd656d938bcf8a59008b6a32b9cfc37379ef90e1e0f78317be7f7e8d2b8ca438a3b061

data/README.md

@@ -1,11 +1,116 @@
-= txcatcher
+TxCatcher
+========
 
-Dependencies
+*TxCatcher* is a lightweight alternative to Bitpay's Insight (bitcoin and litecoin compatible)
+The purpose of this software is to receive all incoming unconfirmed transactions,
+store them in the DB along with addresses (outputs) and provide a simple API to check whether
+a certain address received a deposit.
+
+However, it doesn't rely on having full blockchain with either bitcoind or litecoind.
+You can have pruning enabled (in fact, it's recommended) and the txcatcher's DB
+is regularly cleaned, so it doesn't grow.
+
+The point is to detect new transactions to an address and store them for at least a while,
+but then get rid of them. It's ideal for lightweight payment processing.
+
+API requests:
+-------------
+request: `/addr/2N8Xdi8FiWAT3Vuo2mzcCETnrBjeAtBiqiA`
+response (JSON):
+
+    {
+      "address":"2N8Xdi8FiWAT3Vuo2mzcCETnrBjeAtBiqiA","received":2000000
+      "deposits":[
+        {
+          "txid":"4e6e1e491108b8302da8885b7e57b8809385d206346b3d287b6300408efe551c",
+          "amount":0.01,
+          "satoshis":1000000,
+          "confirmations":0,
+          "block_height":null
+        }
+    }
+
+request: `/addr/2N8Xdi8FiWAT3Vuo2mzcCETnrBjeAtBiqiA/utxo`
+response (JSON):
+
+    [{
+      "value":0.01,
+      "n":0,
+      "scriptPubKey":{"asm":"OP_HASH160 a7a458022e92dd04935c849ab2ea3b07373b7e4b OP_EQUAL","hex":"a914a7a458022e92dd04935c849ab2ea3b07373b7e4b87","reqSigs":1,"type":"scripthash","addresses":["2N8Xdi8FiWAT3Vuo2mzcCETnrBjeAtBiqiA"]},
+      "confirmations":5,
+      "txid":"4e6e1e491108b8302da8885b7e57b8809385d206346b3d287b6300408efe551c"
+    }]
+
+You can also broadcast transactions by sending requests to `/tx/send` passing transaction in `rawtx` param.
+
+
+Is that all?
+-----------
+For now - yes. It allows you to do basic stuff like checking what an address has received.
+
+TODO:
+  * websockets for instant update notifications
+  * better configuration through command line args
+
+
+What it does under the hood
+---------------------------
+* it uses bitcoind or litecoind with ZeroMQ to receive new transactions from the mempool
+* it receives newly mined blocks so that we can tell how many confirmations a transaction to a certain
+  address has.
+* regularly cleans the DB
+
+Installation
 ------------
 
-In order for bitcoin-core and litecoin-core to stream new transactions
-and blocks, we need ZeroMQ. Ubuntu/Debian installation instructions are here:
+  Install dependencies:
+  *  zeromq
+  *  rvm, ruby & rubygems
+  *  sqlite3 or postgresql
+  *  bitcoind or litecoind or both
+
+  Install txcatcher: `gem install txcatcher`
+
+Configuring & Runing
+--------------------
+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`
+Example config file can be found in [templates/config.yml](templates/config.yml), you might want
+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
+tracking both litecoin and bitcoin transactions:
+
+    txcatcher -c ~/.txcatcher/litecoin_config.yml
+    txcatcher -c ~/.txcatcher/bitcoin_config.yml
+    
+Upstart script
+-------------
+If running on Ubuntu, you may also want to create an upstart script, so here's an example (`/etc/init/txcatcher_btc.conf`):
+
+    start on started bitcoind
+    stop on shutdown
+    setuid deploy
+    respawn
+    respawn limit 10 90
+
+    env HOME="/home/deploy"
+    env RVM_WRAPPERS_PATH="/usr/local/rvm/gems/ruby-2.3.4/wrappers"
+    env TXCATCHER_CONFIG="/home/deploy/.txcatcher/config.yml"
 
-    http://zeromq.org/distro:debian
+    exec ${RVM_WRAPPERS_PATH}/txcatcher -c ${TXCATCHER_CONFIG}
+  
+ For this to work, you need a number of prerequisites:
+ * create a `deploy` user, make sure rvm works with this user (rvm multi-user installation)
+ * DO NOT daemonize the process in config.yml, set `daemonize: false` in `/home/deploy/.txcatcher/config.yml`
+ * Generate rvm wrapper for txcatcher: https://rvm.io/deployment/init-d
+ * Make sure your bitcoind or litecoind are also started with an upstart script: https://github.com/bitcoin/bitcoin/blob/0.13/contrib/init/bitcoind.conf
+ 
+You can then start and stop txcatcher with `start txcatcher_btc` and `stop txcatcher_btc`.
 
-you can safely use a package weirdly located at download.opensuse.org.
+Running unit tests
+------------------
+Before running unit tests, make sure you have bitcoind running in mainnet mode,
+with RPC enabled and blockchain synced. Copy the `spec/config/config.yml.sample` file
+and change the RPC username/password to match your bitcoind settings.

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.1.5

data/lib/txcatcher/models/transaction.rb

@@ -1,6 +1,8 @@
 module TxCatcher
 
   class Transaction < Sequel::Model
+
+    plugin      :validation_helpers
     one_to_many :deposits
 
     def before_validation
@@ -17,7 +19,7 @@ module TxCatcher
       end
     end
 
-    def after_save
+    def after_create
       self.deposits.each do |d|
         d.transaction = self
         d.save
@@ -47,6 +49,8 @@ module TxCatcher
       end
 
       def validate
+        super
+        validates_unique :txid
         errors.add(:base, "No outputs for this transactions") if self.deposits.empty?
       end
 

data/lib/txcatcher/server.rb

@@ -28,19 +28,20 @@ module TxCatcher
       path = path.split("/").delete_if { |i| i.empty? }
       addr = path.last
 
-      model = Address.where(address: addr).eager(deposits: :transactions).first
-      if model
-        transactions_ids = model.deposits.map { |d| d.transaction.txid }
-        deposits = model.deposits.map do |d|
+      address = Address.where(address: addr).eager(deposits: :transactions).first
+      if address
+        transactions_ids = address.deposits.map { |d| d.transaction.txid }
+        deposits = address.deposits.map do |d|
           t = d.transaction
           {
             txid:          t.txid,
             amount:        d.amount_in_btc,
             satoshis:      d.amount,
-            confirmations: 0
+            confirmations: t.confirmations,
+            block_height:  t.block_height
           }
         end
-        [200, {}, { address: model.address, received: model.received, deposits: deposits }.to_json]
+        [200, {}, { address: address.address, received: address.received, deposits: deposits }.to_json]
       else
         [200, {}, { address: addr, received: 0, deposits: [] }.to_json]
       end

data/spec/config/{config.yml → config.yml.sample}

@@ -12,8 +12,8 @@ db:
 
 rpcnode:
   name: bitcoind
-  user: roman
-  password: 12990duxcibciwebf
+  user: user
+  password: password
   host: 127.0.0.1
   port: 8332
 

data/spec/models/transaction_spec.rb

@@ -17,10 +17,13 @@ RSpec.describe TxCatcher::Transaction do
   end
 
   it "doesn't create duplicate deposits if valid? called manually before save" do
+    TxCatcher::Transaction.select_all.delete
     transaction = TxCatcher::Transaction.new(hex: @hextx)
     transaction.valid?
     transaction.save
     expect(transaction.deposits.size).to eq(2)
+    transaction.update(block_height: 1)
+    expect(TxCatcher::Transaction.where(txid: transaction.txid).count).to eq(1)
   end
 
 end

data/templates/config.yml

@@ -1,6 +1,6 @@
 db:
   adapter: sqlite
-  db_path: txcatcher_test.db
+  db_path: txcatcher.db
 
   # No need to set these options for sqlite,
   # but other DBs may require them.
@@ -12,8 +12,8 @@ db:
 
 rpcnode:
   name: bitcoind
-  user: roman
-  password: 12990duxcibciwebf
+  user: user
+  password: password
   host: 127.0.0.1
   port: 8332
 
@@ -21,3 +21,4 @@ zeromq: bitcoind
 max_db_transactions_stored: 100000
 db_clean_period_seconds: 300
 server_port: 9498
+daemonize: false

data/txcatcher.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: txcatcher 0.1.4 ruby lib
+# stub: txcatcher 0.1.5 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "txcatcher"
-  s.version = "0.1.4"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Roman Snitko"]
-  s.date = "2017-09-24"
+  s.date = "2017-09-25"
   s.description = "Ccurrently, the only job of this gem is to collect all new Bitcoin/Litecoin transactions, store them in a DB, index addresses."
   s.email = "roman.snitko@gmail.com"
   s.executables = ["goliath.log", "goliath_stdout.log", "txcatcher"]
@@ -49,7 +49,7 @@ Gem::Specification.new do |s|
     "lib/txcatcher/utils/hash_string_to_sym_keys.rb",
     "spec/catcher_spec.rb",
     "spec/cleaner_spec.rb",
-    "spec/config/config.yml",
+    "spec/config/config.yml.sample",
     "spec/config/txcatcher_test.db",
     "spec/fixtures/transaction.txt",
     "spec/fixtures/transaction_decoded_no_outputs.txt",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: txcatcher
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Roman Snitko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-24 00:00:00.000000000 Z
+date: 2017-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: goliath
@@ -135,7 +135,7 @@ files:
 - lib/txcatcher/utils/hash_string_to_sym_keys.rb
 - spec/catcher_spec.rb
 - spec/cleaner_spec.rb
-- spec/config/config.yml
+- spec/config/config.yml.sample
 - spec/config/txcatcher_test.db
 - spec/fixtures/transaction.txt
 - spec/fixtures/transaction_decoded_no_outputs.txt