vchain_client 1.0.1 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa130280366a0e4e56548c9a15435e04db999452
-  data.tar.gz: 4d18e892a688984d0687191cf2ea6420214613a8
+  metadata.gz: 22d66dc123ee989151f30fd3788b468c62026c78
+  data.tar.gz: 685b5f411fb7c965f493facc83d72ab886f9045d
 SHA512:
-  metadata.gz: ed11a5f60b243789441434726c5724e24964cefaf5c4b0d36059723170396cbdc94bbf6f315a4d18016cb0a317ad52c4c631af382a8a213248aa97e2b350f269
-  data.tar.gz: 414e34150172826ceab35559cb32d7fad5c1fe99256a526aa4e7613a6490caeb98c0e84475c3681cc685a2805898ce3c4711bf4711e3f53bae44efd9574aeb82
+  metadata.gz: 82145e5468d9b71fe0b9c95cc1b836ae06a9b53caecb5ed1e18a64e0be4562fd55a2246b22dc49a8485add020d45f763141e6c14dedf64e8301a1457d86b5fc8
+  data.tar.gz: d2ae23783d5ed7ae0b6519edffca250e63663c8d8b4cbde5b246f4d062eb31601ed0f34ef29616755e644a43769b4afb31babe90adb2cf2eaa79d5dffdb85215

data/lib/vchain_client/bitcoind_blockchain_adapter.rb

@@ -2,6 +2,8 @@ module VChainClient
 
   class BitcoindBlockchainAdapter < VChainClient::BlockchainAdapter
 
+    @log = nil
+
     @server = nil
     @port = nil
     @rpc_username = nil
@@ -12,22 +14,76 @@ module VChainClient
       @port = port
       @rpc_username = rpc_username
       @rpc_password = rpc_password
+
+      @log = Log4r::Logger["vchain_client"]
     end 
 
+    def getName()
+      return "BitcoindBlockchainAdapter"
+    end
+
     def getTx(txid)
-      raw_tx = self.getRawTx(txid)
+
+      if @log.debug?
+        @log.debug("[Bitcoind.getTx] input:")
+        @log.debug("-> txid: #{txid}")
+        @log.debug("-> server: #{@server}")
+        @log.debug("-> port: #{@port}")
+      end
+
+      raw_tx = nil
+
+      begin
+        
+        raw_tx = self.getRawTx(txid)
+
+      rescue => e
+        if @log.error?
+          @log.error("[Bitcoind.getTx] getRawTx raised exception:")
+          @log.error("#{e.class}, #{e.message}")
+          @log.error("-> txid: #{txid}")
+          @log.error("-> server: #{@server}")
+          @log.error("-> port: #{@port}")
+          @log.error("--> txid: #{txid}")
+        end
+
+        raise e
+      end
 
       if raw_tx != nil
+
         if raw_tx.key?("confirmations")
+
           if raw_tx["confirmations"] > 5
+
             if raw_tx.key?("blockhash")
+
               if raw_tx.key?("blocktime")
 
-                op_return = self.getOpReturn(raw_tx)
+                op_return = nil
+
+                begin 
+                  
+                  op_return = self.getOpReturn(raw_tx)
+
+                rescue => e
+                  if @log.error?
+                    @log.error("[Bitcoind.getTx] getOpReturn raised exception:")
+                    @log.error("#{e.class}, #{e.message}")
+                    @log.error("-> txid: #{txid}")
+                    @log.error("--> raw_tx:")
+                    @log.error(raw_tx)
+                  end
+
+                  raise e
+                end
 
                 if op_return != nil
+                  
                   prefix = op_return[0..2]
+
                   if prefix == "VCH"
+
                     op_return = op_return[3..op_return.length]
 
                     return {
@@ -36,19 +92,95 @@ module VChainClient
                       "block_timestamp" => raw_tx["blocktime"],
                       "op_return"       => op_return
                     }
+                  
+                  else
+                    if @log.error?
+                      @log.error("[Bitcoind.getTx] wrong prefix '#{prefix}'")
+                      @log.error("-> txid: #{txid}")
+                      @log.error("-> server: #{@server}")
+                      @log.error("-> port: #{@port}")
+                      @log.error("-> raw_tx:")
+                      @log.error(raw_tx)
+                    end
+                  end
+
+                else
+                  if @log.error?
+                    @log.error("[Bitcoind.getTx] failed to get OP_RETURN")
+                    @log.error("-> txid: #{txid}")
+                    @log.error("-> server: #{@server}")
+                    @log.error("-> port: #{@port}")
+                    @log.error("-> raw_tx:")
+                    @log.error(raw_tx)
                   end
                 end
 
+              else
+                if @log.error?
+                  @log.error("[Bitcoind.getTx] no 'block_hash' field in response")
+                  @log.error("-> txid: #{txid}")
+                  @log.error("-> server: #{@server}")
+                  @log.error("-> port: #{@port}")
+                  @log.error("-> raw_tx:")
+                  @log.error(raw_tx)
+                end
+              end
+
+            else
+              if @log.error?
+                @log.error("[Bitcoind.getTx] no 'block_hash' field in response")
+                @log.error("-> txid: #{txid}")
+                @log.error("-> server: #{@server}")
+                @log.error("-> port: #{@port}")
+                @log.error("-> raw_tx:")
+                @log.error(raw_tx)
               end
             end
+
+          else
+            if @log.error?
+              @log.error("[Bitcoind.getTx] less than 6 confirmations")
+              @log.error("-> txid: #{txid}")
+              @log.error("-> server: #{@server}")
+              @log.error("-> port: #{@port}")
+              @log.error("-> raw_tx:")
+              @log.error(raw_tx)
+            end
+          end
+
+        else
+          if @log.error?
+            @log.error("[Bitcoind.getTx] no 'confirmations' field")
+            @log.error("-> txid: #{txid}")
+            @log.error("-> server: #{@server}")
+            @log.error("-> port: #{@port}")
+            @log.error("-> raw_tx:")
+            @log.error(raw_tx)
           end
         end
+
+      else
+        if @log.error?
+          @log.error("[Bitcoind.getTx] empty raw_tx")
+          @log.error("-> txid: #{txid}")
+          @log.error("-> server: #{@server}")
+          @log.error("-> port: #{@port}")
+          @log.error("--> txid: #{txid}")
+        end
       end
 
       return nil
     end
 
     def getRawTx(txid)
+
+      if @log.debug?
+        @log.debug("[Bitcoind.getRawTx] input:")
+        @log.debug("-> txid: #{txid}")
+        @log.debug("-> server: #{@server}")
+        @log.debug("-> port: #{@port}")
+      end
+
       request = {
         "id"     => Random.rand(0...999999),
         "method" => "getrawtransaction",
@@ -62,14 +194,38 @@ module VChainClient
         req = RestClient.post(url, request.to_json)
 
         if req.code != 200
+          if @log.error?
+            @log.error("[Bitcoind.getRawTx] RestClient.post return code "+ req.code)
+            @log.error("-> txid: #{txid}")
+            @log.error("-> server: #{@server}")
+            @log.error("-> port: #{@port}")
+            @log.error("-> request:")
+            @log.error(request)
+          end
+
           return nil
         end
 
+        if @log.debug?
+          @log.debug("[Bitcoind.getRawTx] response:")
+          @log.debug(req.body)
+        end
+
         raw_tx = JSON.parse req.body
 
         return raw_tx["result"]
 
       rescue => e
+        if @log.error?
+          @log.error("[Bitcoind.getRawTx] RestClient.post raised exception:")
+          @log.error("#{e.class}, #{e.message}")
+          @log.error("-> txid: #{txid}")
+          @log.error("-> server: #{@server}")
+          @log.error("-> port: #{@port}")
+          @log.error("-> request:")
+          @log.error(request)
+        end
+
         raise e
       end
 
@@ -77,12 +233,22 @@ module VChainClient
     end
 
     def getOpReturn(raw_tx)
+      
+      if @log.debug?
+        @log.debug("[Bitcoind.getOpReturn] input:")
+        @log.debug("-> raw_tx:")
+        @log.debug(raw_tx)
+      end
+
       if raw_tx != nil
+
         tx_unpacked = {}
         tx_unpacked["vout"] = []
 
         if raw_tx.key?("vout")
+
           if raw_tx["vout"].length > 0
+
             raw_tx["vout"].each_with_index { |vout,index|
               vout_t = {}
 
@@ -120,11 +286,17 @@ module VChainClient
                   return scriptPubKeyBinary[4..scriptPubKeyBinary[2].ord()+1+256*scriptPubKeyBinary[3].ord()+1]
                 end
               end
-
             }
 
           end
         end
+
+      else
+        if @log.error?
+          @log.error("[Bitcoind.getOpReturn] raw_tx is nil")
+          @log.error("-> raw_tx:")
+          @log.error(raw_tx)
+        end
       end
 
       return nil

data/lib/vchain_client/blockchain_adapter.rb

@@ -6,6 +6,10 @@ module VChainClient
   		return nil
   	end
 
+  	def getName()
+  		return "abstract"
+  	end
+
   end
 
 end

data/lib/vchain_client/blockchain_adapter_factory.rb

@@ -10,7 +10,8 @@ module VChainClient
   			return VChainClient::BlockcypherBlockchainAdapter.new(config["api_token"])
   		end
 
-  		return nil
+      raise "No such adapter '#{type}'"
+
   	end
 
   end

data/lib/vchain_client/blockchain_connection.rb

@@ -2,23 +2,62 @@ module VChainClient
 
   class BlockchainConnection
 
+    @log = nil
+
     @config = nil
 
     def initialize(config)
       @config = config
+
+      @log = Log4r::Logger["vchain_client"]
     end 
 
   	def getTx(txid)
 
+      if @log.debug?
+        @log.debug("[BlockchainConnection.getTx] input:")
+        @log.debug("-> txid: #{txid}")
+      end
+
   		adapters = []
 
+      if !@config.key?("blockchain_adapters")
+        raise "There are no blockchain_adapters in config"
+      end
+
   		config_adapters = @config["blockchain_adapters"]
 
+      if config_adapters.length <= 0
+        raise "There are no blockchain_adapters in config"
+      end
+
   		config_adapters.each { |adapter_config|
-  			adapter = VChainClient::BlockchainAdapterFactory.getAdapter(adapter_config["type"], adapter_config)
+
+        begin
+  			 
+          adapter = VChainClient::BlockchainAdapterFactory.getAdapter(adapter_config["type"], adapter_config)
+
+        rescue => e
+          if @log.error?
+            @log.error("[BlockchainConnection.getTx] BlockchainAdapterFactory.getAdapter raised exception:")
+            @log.error("#{e.class}, #{e.message}")
+            @log.error("-> txid: #{txid}")
+            @log.error("--> type: "+ adapter_config["type"])
+          end
+
+          raise e
+        end
 
   			if adapter != nil
-  				adapters.push(adapter)
+  				
+          adapters.push(adapter)
+
+        else 
+          if @log.error?
+            @log.error("[BlockchainConnection.getTx] failed to init BlockchainAdapter")
+            @log.error("-> txid: #{txid}")
+            @log.error("--> type: "+ adapter_config["type"])
+          end
   			end
   		}
 
@@ -31,18 +70,65 @@ module VChainClient
 
         adapters.each { |adapter|
 
-  				tx = adapter.getTx(txid)
+          tx = nil
+
+          begin
+
+  				  tx = adapter.getTx(txid)
+
+          rescue => e
+            if @log.error?
+              @log.error("[BlockchainConnection.getTx] adapter.getTx raised exception:")
+              @log.error("#{e.class}, #{e.message}")
+              @log.error("-> txid: #{txid}")
+              @log.error("--> txid: #{txid}")
+              @log.error("--> adapter: "+ adapter.getName())
+            end
+
+            raise e
+          end
 
   				if tx == nil
+            if @log.error?
+              @log.error("[BlockchainConnection.getTx] failed to get tx")
+              @log.error("-> txid: #{txid}")
+              @log.error("--> txid: #{txid}")
+              @log.error("--> adapter: "+ adapter.getName())
+            end
+
   					return nil
   				end
+
   				if !tx.key?("block_hash")
+            if @log.error?
+              @log.error("[BlockchainConnection.getTx] no 'block_hash' field")
+              @log.error("-> txid: #{txid}")
+              @log.error("--> txid: #{txid}")
+              @log.error("--> adapter: "+ adapter.getName())
+            end
+
   					return nil
   				end
+
   				if !tx.key?("block_timestamp")
+            if @log.error?
+              @log.error("[BlockchainConnection.getTx] no 'block_timestamp' field")
+              @log.error("-> txid: #{txid}")
+              @log.error("--> txid: #{txid}")
+              @log.error("--> adapter: "+ adapter.getName())
+            end
+
   					return nil
   				end
+
   				if tx["block_hash"] == nil || tx["block_hash"] == ""
+            if @log.error?
+              @log.error("[BlockchainConnection.getTx] 'block_hash' field is empty")
+              @log.error("-> txid: #{txid}")
+              @log.error("--> txid: #{txid}")
+              @log.error("--> adapter: "+ adapter.getName())
+            end
+
   					return nil
   				end
 
@@ -52,15 +138,46 @@ module VChainClient
 				  op_return = tx["op_return"]
 
 				  if prev_size != nil && prev_size != size
+            if @log.error?
+              @log.error("[BlockchainConnection.getTx] size mismatch")
+              @log.error("-> txid: #{txid}")
+              @log.error("--> txid: #{txid}")
+              @log.error("--> adapter: "+ adapter.getName())
+            end
+
             return nil
 				  end
+
           if prev_block_hash != nil && prev_block_hash != block_hash
+            if @log.error?
+              @log.error("[BlockchainConnection.getTx] block_hash mismatch")
+              @log.error("-> txid: #{txid}")
+              @log.error("--> txid: #{txid}")
+              @log.error("--> adapter: "+ adapter.getName())
+            end
+
             return nil
           end
+
           if prev_block_timestamp != nil && prev_block_timestamp != block_timestamp
+            if @log.error?
+              @log.error("[BlockchainConnection.getTx] block_timestamp mismatch")
+              @log.error("-> txid: #{txid}")
+              @log.error("--> txid: #{txid}")
+              @log.error("--> adapter: "+ adapter.getName())
+            end
+
             return nil
           end
+
           if prev_op_return != nil && prev_op_return != op_return
+            if @log.error?
+              @log.error("[BlockchainConnection.getTx] op_return mismatch")
+              @log.error("-> txid: #{txid}")
+              @log.error("--> txid: #{txid}")
+              @log.error("--> adapter: "+ adapter.getName())
+            end
+
             return nil
           end
 
@@ -75,6 +192,9 @@ module VChainClient
           "block_timestamp" => prev_block_timestamp,
           "op_return"       => prev_op_return
 				}
+
+      else
+        raise "There are no initialized blockchain_adapters"
   		end
 
   		return nil

data/lib/vchain_client/blockcypher_blockchain_adapter.rb

@@ -2,36 +2,134 @@ module VChainClient
 
   class BlockcypherBlockchainAdapter < VChainClient::BlockchainAdapter
 
+    @log = nil
+
     @api_token = nil
 
     def initialize(api_token)
     	@api_token = api_token
+
+      @log = Log4r::Logger["vchain_client"]
     end 
 
+    def getName()
+      return "BlockcypherBlockchainAdapter"
+    end
+
   	def getTx(txid)
       url = "https://api.blockcypher.com/v1/btc/main/txs/"
   		url += txid
   		url += "?token="+ @api_token
   		url += "&rand="+ Random.rand(0...999999).to_s
 
-      req = RestClient.get(url)
+      if @log.debug?
+        @log.debug("[Blockcypher.getTx] input:")
+        @log.debug("-> txid: #{txid}")
+
+        @log.debug("[Blockcypher.getTx] will call '#{url}'")
+      end
+
+      req = nil
+
+      begin
+        
+        req = RestClient.get(url)
+
+      rescue => e
+        if @log.error?
+          @log.error("[Blockcypher.getTx] RestClient.get raised exception:")
+          @log.error("#{e.class}, #{e.message}")
+          @log.error("-> txid: #{txid}")
+          @log.error("--> url: #{url}")
+        end
+
+        raise e
+      end
+
+      if req == nil
+        if @log.error?
+          @log.error("[Blockcypher.getTx] failed to call REST")
+          @log.error("-> txid: #{txid}")
+          @log.error("--> url: #{url}")
+        end
+
+        return nil
+      end
 
       if req.code != 200
+        if @log.error?
+          @log.error("[Blockcypher.getTx] REST call returned "+ req.code.to_s)
+          @log.error("-> txid: #{txid}")
+          @log.error("--> url: #{url}")
+        end
+
         return nil
       end
 
+      if @log.debug?
+        @log.debug("[Blockcypher.getTx] REST call response:")
+        @log.debug(req.body)
+      end
+
       res = JSON.parse req.body
 
       if res != nil
+
         if res.key?("confirmations")
+
         	if res["confirmations"] > 5
+
         		if res.key?("block_hash")
+
         			if res.key?("confirmed")
-        				block_timestamp = DateTime.parse(res["confirmed"]).to_i
 
-        				op_return = self.getOpReturn(res)
+                block_timestamp = nil
+
+                begin
+
+        				  block_timestamp = DateTime.parse(res["confirmed"]).to_i
+
+                rescue => e
+                  if @log.error?
+                    @log.error("[Blockcypher.getTx] DateTime.parse('confirmed').to_i raised exception:")
+                    @log.error("#{e.class}, #{e.message}")
+                    @log.error("-> txid: #{txid}")
+                    @log.error("--> url: #{url}")
+                  end
+
+                  raise e
+                end
+
+                if block_timestamp == nil
+                  if @log.error?
+                    @log.error("[Blockcypher.getTx] failed to convert 'confirmed' field to timestamp")
+                    @log.error("-> txid: #{txid}")
+                    @log.error("--> url: #{url}")
+                  end
+
+                  return nil
+                end
+
+                op_return = nil
+
+                begin
+
+        				  op_return = self.getOpReturn(res)
+
+                rescue => e
+                  if @log.error?
+                    @log.error("[Blockcypher.getTx] getOpReturn raised exception:")
+                    @log.error("#{e.class}, #{e.message}")
+                    @log.error("-> txid: #{txid}")
+                    @log.error("--> res:")
+                    @log.error(res)
+                  end
+
+                  raise e
+                end
 
         				if op_return != nil
+
         					prefix = op_return[0..2]
 
         					if prefix == "VCH"
@@ -43,11 +141,62 @@ module VChainClient
   										"block_timestamp" => block_timestamp,
   										"op_return"       => op_return
         						}
+
+                  else
+                    if @log.error?
+                      @log.error("[Blockcypher.getTx] wrong prefix '#{prefix}'")
+                      @log.error("-> txid: #{txid}")
+                      @log.error("--> res:")
+                      @log.error(res)
+                    end
         					end
+
+                else
+                  if @log.error?
+                    @log.error("[Blockcypher.getTx] failed to get OP_RETURN")
+                    @log.error("-> txid: #{txid}")
+                    @log.error("--> res:")
+                    @log.error(res)
+                  end
         				end
+
+              else
+                if @log.error?
+                  @log.error("[Blockcypher.getTx] no 'confirmed' field in response")
+                  @log.error("-> txid: #{txid}")
+                  @log.error("--> url: #{url}")
+                end
         			end
+
+            else
+              if @log.error?
+                @log.error("[Blockcypher.getTx] no 'block_hash' field in response")
+                @log.error("-> txid: #{txid}")
+                @log.error("--> url: #{url}")
+              end
         		end
+
+          else
+            if @log.error?
+              @log.error("[Blockcypher.getTx] less than 6 confirmations")
+              @log.error("-> txid: #{txid}")
+              @log.error("--> url: #{url}")
+            end
         	end
+
+        else
+          if @log.error?
+            @log.error("[Blockcypher.getTx] no 'confirmations' field")
+            @log.error("-> txid: #{txid}")
+            @log.error("--> url: #{url}")
+          end
+        end
+
+      else
+        if @log.error?
+          @log.error("[Blockcypher.getTx] REST call - empty response")
+          @log.error("-> txid: #{txid}")
+          @log.error("--> url: #{url}")
         end
       end