straight 0.2.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47b083622bc343959f9614caf0a90263c117e490
-  data.tar.gz: 7b6fd9a56ffae2d8e20d75c8f69c4bdcc5562978
+  metadata.gz: b6367d814a3c2ac159870bb0c8b6929f26c6c612
+  data.tar.gz: 525e7bce43d7e17a436103f36432fb637307b628
 SHA512:
-  metadata.gz: 2c750fa3761f2967e448b3b7c8256e60b1815abe215a22bfad1f3c953283a3e46268735084cd8debc2b73d176e3486f81fbe576ed5f1eb789794641454c4dac4
-  data.tar.gz: 9ca4bb9f861caf0d57d02ef2d415c5db3adba2fa1b4a3ff39e72272c6d311fd5a9f291d0471326efcbe82e33a565e596c2f9c2b724d9a38f0d53b7d7ed4a6730
+  metadata.gz: b5f817e6c86180289c7b6f3dbcad0d10e6d5f2e5de3ce7218c3f8d08fec9ac2851d7878ebd03b825bf0ddb88b096c9cfbfdbe31694c7a46be2458444bdcbdeac
+  data.tar.gz: f6f8afecb366765b9b80f2e471158bf38f614a640aeadddb155a1bdd129c24b0873d2f3ae936ce931458220ec6a6d74f822f805c69a4e276f4f9e9f82c95679d

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.2.1
+notifications:
+  slack: mycelium-gear:aqCsWhyRsg9iRfre4VaBUvVP

data/Gemfile

@@ -1,11 +1,11 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-# Used to generate bip32 addresses
-gem 'money-tree', "0.9.0"
+gem 'btcruby', '~> 1.0'
 
 # Used in exchange rate adapters
-gem 'satoshi-unit'
-gem 'httparty'
+gem 'satoshi-unit', '~> 0.1'
+gem 'httparty', '~> 0.13.5'
+gem 'faraday'
 
 group :development do
   gem "bundler", "~> 1.0"
@@ -15,4 +15,6 @@ end
 
 group :test do
   gem 'rspec'
+  gem 'webmock'
+  gem 'vcr'
 end

data/Gemfile.lock

@@ -1,8 +1,12 @@
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     addressable (2.3.6)
+    btcruby (1.0.3)
+      ffi (~> 1.9, >= 1.9.3)
     builder (3.2.2)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
@@ -20,7 +24,7 @@ GEM
       oauth2
     hashie (3.3.1)
     highline (1.6.21)
-    httparty (0.13.3)
+    httparty (0.13.5)
       json (~> 1.8)
       multi_xml (>= 0.5.2)
     jeweler (2.0.1)
@@ -35,8 +39,6 @@ GEM
     json (1.8.1)
     jwt (1.0.0)
     mini_portile (0.6.0)
-    money-tree (0.9.0)
-      ffi
     multi_json (1.10.1)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
@@ -64,17 +66,25 @@ GEM
     rspec-mocks (3.1.0)
       rspec-support (~> 3.1.0)
     rspec-support (3.1.0)
+    safe_yaml (1.0.4)
     satoshi-unit (0.1.7)
     thread_safe (0.3.4)
+    vcr (2.9.3)
+    webmock (1.21.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  btcruby (~> 1.0)
   bundler (~> 1.0)
+  faraday
   github_api (= 0.11.3)
-  httparty
+  httparty (~> 0.13.5)
   jeweler (~> 2.0.1)
-  money-tree (= 0.9.0)
   rspec
-  satoshi-unit
+  satoshi-unit (~> 0.1)
+  vcr
+  webmock

data/README.md

@@ -1,5 +1,8 @@
 Straight
 ========
+
+[![Build Status](https://travis-ci.org/MyceliumGear/straight.svg)](https://travis-ci.org/MyceliumGear/straight)
+
 > Receive bitcoin payments directly into your wallet
 
 > Website: http://straight.romansnitko.com

data/Rakefile

@@ -21,5 +21,14 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{An engine for the Straight payment gateway software. Requires no state to be saved (that is, no storage or DB). Its responsibilities only include processing data coming from an actual gateway.}
   gem.email = "roman.snitko@gmail.com"
   gem.authors = ["Roman Snitko"]
+  gem.files.exclude 'spec/**/*'
 end
 Jeweler::RubygemsDotOrgTasks.new
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/VERSION

@@ -1 +1 @@
-0.2.3
+1.0.0

data/lib/straight.rb

@@ -1,4 +1,4 @@
-require 'money-tree'
+require 'btcruby'
 require 'satoshi-unit'
 require 'json'
 require 'uri'
@@ -6,11 +6,18 @@ require 'open-uri'
 require 'yaml'
 require 'singleton'
 require 'httparty'
+require 'faraday'
+require_relative 'straight/faraday_monkeypatch'
+
+module Straight
+  StraightError = Class.new(StandardError)
+end
 
 require_relative 'straight/blockchain_adapter'
 require_relative 'straight/blockchain_adapters/blockchain_info_adapter'
 require_relative 'straight/blockchain_adapters/biteasy_adapter'
 require_relative 'straight/blockchain_adapters/mycelium_adapter'
+require_relative 'straight/blockchain_adapters/insight_adapter'
 
 require_relative 'straight/exchange_rate_adapter'
 require_relative 'straight/exchange_rate_adapters/bitpay_adapter'
@@ -22,6 +29,7 @@ require_relative 'straight/exchange_rate_adapters/btce_adapter'
 require_relative 'straight/exchange_rate_adapters/kraken_adapter'
 require_relative 'straight/exchange_rate_adapters/average_rate_adapter'
 
+require_relative 'straight/address_providers/bip32'
 
 require_relative 'straight/order'
 require_relative 'straight/gateway'

data/lib/straight/address_providers/base.rb

@@ -0,0 +1,28 @@
+module Straight
+  module AddressProvider
+    class Base
+
+      attr_reader :gateway
+
+      def initialize(gateway)
+        @gateway = gateway
+      end
+
+      # @param [Hash] args see GatewayModule::Includable#new_order
+      # @return [String] bitcoin address
+      # Returns a Base58-encoded Bitcoin address to which the payment transaction
+      # is expected to arrive. keychain_id is an integer > 0 (hopefully not too large and hopefully
+      # the one a user of this class is going to properly increment) that is used to generate a
+      # an BIP32 bitcoin address deterministically.
+      def new_address(keychain_id:, **args)
+        raise NotImplementedError
+      end
+
+      # If this method returns true, then address provider is expected to define
+      # #new_address_and_amount which returns ['address', Integer(amount in satoshi)]
+      def takes_fees?
+        false
+      end
+    end
+  end
+end

data/lib/straight/address_providers/bip32.rb

@@ -0,0 +1,22 @@
+require_relative 'base'
+
+module Straight
+  module AddressProvider
+    class Bip32 < Base
+      def new_address(keychain_id:, **args)
+        path =
+          if gateway.address_derivation_scheme.to_s.empty?
+            # First check the depth. If the depth is 4 use '/i' notation (Mycelium iOS wallet)
+            if gateway.keychain.depth > 3
+              keychain_id.to_s
+            else # Otherwise, use 'm/0/n' - both Electrum and Mycelium on Android
+              "m/0/#{keychain_id.to_s}"
+            end
+          else
+            gateway.address_derivation_scheme.to_s.downcase.sub('n', keychain_id.to_s)
+          end
+        gateway.keychain.derived_key(path).address.to_s
+      end
+    end
+  end
+end

data/lib/straight/blockchain_adapter.rb

@@ -10,7 +10,14 @@ module Straight
       # Raised when blockchain data cannot be retrived for any reason.
       # We're not really intereste in the precise reason, although it is
       # stored in the message.
-      class RequestError < Exception; end
+      class RequestError < StraightError; end
+
+      # Raised when an invalid address is used, for example a mainnet address
+      # is used on testnet and vice versa.
+      class BitcoinAddressInvalid < StraightError; end
+
+      # How much times try to connect to servers if ReadTimeout error appears
+      MAX_TRIES = 5
 
       def fetch_transaction(tid)
         raise "Please implement #fetch_transaction in #{self.to_s}"
@@ -34,5 +41,14 @@ module Straight
 
     end
 
+    # Look for the adapter without namespace if not found it in a specific module
+    # @return nil
+    def self.const_missing(name)
+      Kernel.const_get(name)
+    rescue NameError
+      puts "WARNING: No blockchain adapter with the name #{name.to_s} was found!"
+      nil
+    end
+
   end
 end

data/lib/straight/blockchain_adapters/biteasy_adapter.rb

@@ -19,34 +19,35 @@ module Straight
 
       # Returns the current balance of the address
       def fetch_balance_for(address)
-        JSON.parse(api_request("/addresses/#{address}"))['data']['balance']
+        api_request("/addresses/#{address}")['data']['balance']
       end
 
       # Returns transaction info for the tid
       def fetch_transaction(tid, address: nil)
-        straighten_transaction JSON.parse(api_request("/transactions/#{tid}"), address: address)
+        straighten_transaction api_request("/transactions/#{tid}"), address: address
       end
 
       # Returns all transactions for the address
       def fetch_transactions_for(address)
-        transactions = JSON.parse(api_request("/transactions?address=#{address}"))['data']['transactions']
+        transactions = api_request("/transactions?address=#{address}")['data']['transactions']
         transactions.map { |t| straighten_transaction(t, address: address) }
       end
 
       private
 
         def api_request(url)
-          begin
-            response = HTTParty.get("#{@base_url}/#{url}", timeout: 4, verify: false)
-            unless response.code == 200
-              raise RequestError, "Cannot access remote API, response code was #{response.code}"
-            end
-            response.body
-          rescue HTTParty::Error => e
-            raise RequestError, YAML::dump(e)
-          rescue JSON::ParserError => e
-            raise RequestError, YAML::dump(e)
+          conn = Faraday.new("#{@base_url}/#{url}", ssl: { verify: false }) do |faraday|
+            faraday.adapter Faraday.default_adapter
           end
+          result = conn.get
+          unless result.status == 200
+            raise RequestError, "Cannot access remote API, response code was #{result.code}"
+          end
+          JSON.parse(result.body)
+        rescue JSON::ParserError => e
+          raise RequestError, YAML::dump(e)
+        rescue => e
+          raise RequestError, YAML::dump(e)
         end
 
         # Converts transaction info received from the source into the

data/lib/straight/blockchain_adapters/blockchain_info_adapter.rb

@@ -20,18 +20,18 @@ module Straight
 
       # Returns transaction info for the tid
       def fetch_transaction(tid, address: nil)
-        straighten_transaction JSON.parse(api_request("/rawtx/#{tid}"), address: address)
+        straighten_transaction(api_request("/rawtx/#{tid}"), address: address)
       end
 
       # Returns all transactions for the address
       def fetch_transactions_for(address)
-        transactions = JSON.parse(api_request("/rawaddr/#{address}"))['txs']
+        transactions = api_request("/rawaddr/#{address}")['txs']
         transactions.map { |t| straighten_transaction(t, address: address) }
       end
 
       # Returns the current balance of the address
       def fetch_balance_for(address)
-        JSON.parse(api_request("/rawaddr/#{address}"))['final_balance']
+        api_request("/rawaddr/#{address}")['final_balance']
       end
 
       def latest_block(force_reload: false)
@@ -42,7 +42,7 @@ module Straight
            force_reload
           @latest_block = {
             cache_timestamp: Time.now,
-            block: JSON.parse(api_request("/latestblock"))
+            block: api_request("/latestblock")
           }
         else
           @latest_block
@@ -52,17 +52,18 @@ module Straight
       private
 
         def api_request(url)
-          begin
-            response = HTTParty.get("#{@base_url}/#{url}", timeout: 4, verify: false)
-            unless response.code == 200
-              raise RequestError, "Cannot access remote API, response code was #{response.code}"
-            end
-            response.body
-          rescue HTTParty::Error => e
-            raise RequestError, YAML::dump(e)
-          rescue JSON::ParserError => e
-            raise RequestError, YAML::dump(e)
+          conn = Faraday.new(url: "#{@base_url}/#{url}", ssl: { verify: false }) do |faraday|
+            faraday.adapter Faraday.default_adapter
           end
+          result = conn.get
+          unless result.status == 200
+            raise RequestError, "Cannot access remote API, response code was #{result.code}"
+          end
+          JSON.parse(result.body)
+        rescue JSON::ParserError => e
+          raise RequestError, YAML::dump(e)
+        rescue => e
+          raise RequestError, YAML::dump(e)
         end
 
         # Converts transaction info received from the source into the

data/lib/straight/blockchain_adapters/insight_adapter.rb

@@ -0,0 +1,76 @@
+module Straight
+  module Blockchain
+    
+    class InsightAdapter < Adapter
+
+      @@test_url = nil
+
+      def self.mainnet_adapter(main_url:, test_url: nil)
+        @@test_url = test_url
+        new(main_url)
+      end
+
+      def self.testnet_adapter
+        raise "Testnet not implemented" unless @@test_url
+        new(@@test_url)
+      end
+
+      def initialize(host_url)
+        @base_url = host_url
+      end
+
+      def fetch_transaction(tid, address: nil)
+        res = api_request("/tx/", tid)
+        straighten_transaction(res, address: address)
+      end
+
+      def fetch_transactions_for(address)
+        res = api_request("/addr/", address)
+        return [] if res["transactions"].empty?
+        [fetch_transaction(res["transactions"].first, address: address)]
+      end
+
+      def fetch_balance_for(address)
+        res = api_request("/addr/", address)
+        res["balanceSat"].to_i
+      end
+
+    private
+
+      def api_request(place, val)
+        req_url = @base_url + place + val
+        conn = Faraday.new(url: req_url, ssl: { verify: false }) do |faraday|
+          faraday.adapter Faraday.default_adapter
+        end
+        result = conn.get do |req|
+          req.headers['Content-Type'] = 'application/json'
+        end
+        JSON.parse(result.body)
+      rescue JSON::ParserError => e
+        raise BitcoinAddressInvalid, message: "address in question: #{val}" if e.message.include?("Invalid address")
+        raise RequestError, YAML::dump(e)
+      rescue => e
+        raise RequestError, YAML::dump(e)
+      end
+
+      def straighten_transaction(transaction, address: nil)
+        total_amount = 0
+        tid = transaction["txid"]
+        transaction["vout"].each do |o|
+          total_amount += Satoshi.new(o["value"]) if address.nil? || address == o["scriptPubKey"]["addresses"].first
+        end
+        confirmations = transaction["confirmations"] 
+        outs = transaction["vout"].map { |o| {amount: Satoshi.new(o["value"]).to_i, receiving_address: o["scriptPubKey"]["addresses"].first} }
+
+        {
+          tid:           tid,
+          total_amount:  total_amount,
+          confirmations: confirmations || 0,
+          outs:          outs || []
+        }
+      end
+
+    end
+
+  end
+end

data/lib/straight/blockchain_adapters/mycelium_adapter.rb

@@ -3,30 +3,46 @@ module Straight
 
     class MyceliumAdapter < Adapter
 
-      class NoBitcoindInstalled < Exception
-        def message
-          "You need to install bitcoind on your server and have a `bitcoin-cli` executable in PATH.\n" +
-          "Note that you don't have to download the blockchain and you can run bitcoind in offline mode."
-        end
-      end
-
-      require 'base64'
+      MAINNET_SERVERS     = %w{
+        https://mws2.mycelium.com/wapi/wapi
+        https://mws6.mycelium.com/wapi/wapi
+        https://mws7.mycelium.com/wapi/wapi
+      }
+      TESTNET_SERVERS     = %w{
+        https://node3.mycelium.com/wapitestnet/wapi
+      }
+      PINNED_CERTIFICATES = %w{
+        6afe0e9b6806fa4a49fc6818512014332953f30101dad7b91e76c14e073c3134
+      }.to_set
 
       def self.mainnet_adapter
-        instance = self.instance
-        instance._initialize("https://mws2.mycelium.com/wapi/wapi")
-        instance
+        new(testnet: false)
       end
-      
+
       def self.testnet_adapter
-        instance = self.instance
-        instance._initialize("https://node3.mycelium.com/wapitestnet/wapi")
-        instance
+        new(testnet: true)
       end
-      
-      def _initialize(base_url)
+
+      def initialize(testnet: false)
         @latest_block = { cache_timestamp: nil, block: nil }
-        @base_url = base_url
+        @testnet = testnet
+        @api_servers = @testnet ? TESTNET_SERVERS : MAINNET_SERVERS
+        set_base_url
+      end
+
+      def testnet?
+        @testnet
+      end
+
+      # Set url for API request.
+      # @param num [Integer] a number of server in array
+      def set_base_url(num = 0)
+        return nil if num >= @api_servers.size
+        @base_url = @api_servers[num]
+      end
+
+      def next_server
+        set_base_url(@api_servers.index(@base_url) + 1)
       end
 
       # Returns transaction info for the tid
@@ -38,8 +54,15 @@ module Straight
       # Supposed to returns all transactions for the address, but
       # currently actually returns the first one, since we only need one.
       def fetch_transactions_for(address)
-        tid = api_request('queryTransactionInventory', { addresses: [address], limit: 1 })["txIds"].first
-        tid ? [fetch_transaction(tid, address: address)] : []
+        # API may return nil instead of an empty array if address turns out to be invalid
+        # (for example when trying to supply a testnet address instead of mainnet while using
+        # mainnet adapter.
+        if api_response = api_request('queryTransactionInventory', { addresses: [address], limit: 1 })
+          tid = api_response["txIds"].first
+          tid ? [fetch_transaction(tid, address: address)] : []
+        else
+          raise BitcoinAddressInvalid, message: "address in question: #{address}"
+        end
       end
 
       # Returns the current balance of the address
@@ -69,54 +92,56 @@ module Straight
       private
 
         def api_request(method, params={})
+          ssl_opts =
+            if testnet?
+              {verify: false}
+            else
+              {verify_callback: lambda { |preverify_ok, store_context|
+                end_cert = store_context.chain[0] # pinned invalid certificate
+                PINNED_CERTIFICATES.include?(OpenSSL::Digest::SHA256.hexdigest(end_cert.to_der)) || preverify_ok
+              }}
+            end
           begin
-            body = JSON.parse(HTTParty.post(
-              "#{@base_url}/#{method}",
-              body: params.merge({version: 1}).to_json,
-              headers: { 'Content-Type' => 'application/json' },
-              timeout: 15,
-              verify: false
-            ).body)["r"]
-          rescue HTTParty::Error => e
-            raise RequestError, YAML::dump(e)
-          rescue JSON::ParserError => e
-            raise RequestError, YAML::dump(e)
+            conn = Faraday.new(url: "#{@base_url}/#{method}", ssl: ssl_opts) do |faraday|
+              faraday.request  :url_encoded             # form-encode POST params
+              faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+            end
+            result = conn.post do |req|
+              req.body = params.merge({version: 1}).to_json
+              req.headers['Content-Type'] = 'application/json'
+            end
+            JSON.parse(result.body || '')['r']
+          rescue => e
+            next_server ? retry : raise(RequestError, YAML::dump(e))
           end
         end
 
         # Converts transaction info received from the source into the
         # unified format expected by users of BlockchainAdapter instances.
         def straighten_transaction(transaction, address: nil)
-
           # Get the block number this transaction was included into
           block_height = transaction['height']
           tid          = transaction['txid']
 
-          # Converting from Base64 to hex
-          transaction = transaction['binary'].unpack("m0").first.unpack("H*").first
+          # Converting from Base64 to binary
+          transaction = transaction['binary'].unpack('m0')[0]
 
-          # Decoding with bitcoin-cli
-          begin
-            transaction = JSON.parse(`bitcoin-cli decoderawtransaction #{transaction}`)
-          rescue Errno::ENOENT => e
-            if e.message == 'No such file or directory - bitcoin-cli'
-              raise NoBitcoindInstalled
-            else
-              raise e
-            end
-          end
+          # Decoding
+          transaction = BTC::Transaction.new(data: transaction)
 
           outs         = []
           total_amount = 0
-          transaction['vout'].each do |out|
-            out['value'] = out['value']*10**8
-            total_amount += out['value'] if address.nil? || address == out['address']
-            outs << { amount: out['value'], receiving_address: out['address'] }
+
+          transaction.outputs.each do |out|
+            amount = out.value
+            receiving_address = out.script.standard_address
+            total_amount += amount if address.nil? || address == receiving_address.to_s
+            outs << {amount: amount, receiving_address: receiving_address}
           end
 
           {
             tid:           tid,
-            total_amount:  total_amount,
+            total_amount:  total_amount.to_i,
             confirmations: calculate_confirmations(block_height),
             outs:          outs
           }