bitcoin-ruby 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b4f48a8cb6fda24adfe21240efb4da2f74d9528d
-  data.tar.gz: fe92c36e2756b66f9f676e7082ef8a7aac56fd44
+SHA256:
+  metadata.gz: 69dc67ff7d6860767e626c22efabed33b86541022b4b490916b061a9b395b210
+  data.tar.gz: 5aa94333b2635f7f3d7e6e6f7fdf4476938edc448924cafdc3c8553b1f572933
 SHA512:
-  metadata.gz: ead4745327db1385e88ef610de2518d692281f0750c767e8a08216328aaa198218e67420c4f96ee35df5393aa70b19dfc58aba2612fb840555ff3bcfcdabbf9a
-  data.tar.gz: 8bc95d49dcda8806d2e850e4060510518bf92c210f75a894f46646e4ec10368a957581cbadd859a814a4cdaa3f5ada1d120c5b2d96a93f0ccbd30d8060597bef
+  metadata.gz: 33c7835ce224e0c6566baa10253b42c7e71ec46ce977c760a6eeef6b89c160e5aa1cd2a3a7b0ba06269e0d8de7acb8989b271a32b30e6b972ecf59488cf8dd2c
+  data.tar.gz: 77518c65ef050ac247ddb677da8c0725eacc49bd146c24a9805217efbef3124f7edf199535c924749c374b5b55443ab1cb94e4fab48e9046bfd21a2dc1b276e7

data/.gitignore

@@ -14,3 +14,11 @@ spec/bitcoin/fixtures/fake_chain
 .rbx/
 /vendor
 .ruby-version
+
+# rspec
+spec-rspec/examples.txt
+
+# emacs
+*~
+\#*\#
+.\#*

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,46 @@
+AllCops:
+  Exclude:
+    - 'Gemfile'
+
+Metrics/AbcSize:
+  Max: 100
+
+Metrics/BlockLength:
+  Max: 50
+  Exclude:
+    - 'spec/**/*'
+    - 'db/migrations/**/*'
+    - 'tasks/**/*'
+
+Metrics/ClassLength:
+  Max: 500
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 80
+
+Metrics/ModuleLength:
+  Max: 500
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Naming/UncommunicativeMethodParamName:
+  Enabled: False
+
+Style/FrozenStringLiteralComment:
+  Enabled: False
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/UnpackFirst:
+  Enabled: false

data/.travis.yml

@@ -3,4 +3,8 @@ rvm:
   - 2.2.9
   - 2.3.6
   - 2.4.3
-  - 2.5.0
+  - 2.5.1
+script:
+  - bundle exec rake build_libsecp256k1
+  - bundle exec rake rspec
+  - bundle exec rake coin_spec[dogecoin]

data/Gemfile

@@ -1,15 +1,17 @@
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in bitcoin-ruby.gemspec
 gemspec
 
-group :development do
-  gem 'eventmachine'
-  gem 'ffi'
-  gem 'scrypt'
-  gem 'minitest'
+group :test do
+  gem 'rake', '~> 12.3.1'
+  gem 'bacon', '~> 1.2.0'
+  gem 'rspec', '~> 3.7.0'
+  gem 'rubocop', '~> 0.58.2'
+  gem 'simplecov', '~> 0.16.1'
+  gem 'minitest', '~> 5.11.3'
+end
 
-  gem "rake", ">= 0.8.0"
-  gem 'bacon', '>= 1.2.0'
-  #gem 'simplecov', require: false
+group :development do
+  gem 'pry', '~> 0.11.3'
+  gem 'pry-byebug', '~> 3.6.0'
 end

data/Gemfile.lock

@@ -1,33 +1,85 @@
 PATH
   remote: .
   specs:
-    bitcoin-ruby (0.0.18)
+    bitcoin-ruby (0.0.19)
+      eventmachine
+      ffi
+      scrypt
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     bacon (1.2.0)
-    eventmachine (1.2.3)
-    ffi (1.9.18)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    eventmachine (1.2.7)
+    ffi (1.9.25)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
-    minitest (5.10.2)
-    rake (12.0.0)
+    jaro_winkler (1.5.1)
+    json (2.1.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (12.3.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.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.58.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
     scrypt (3.0.5)
       ffi-compiler (>= 1.0, < 2.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bacon (>= 1.2.0)
+  bacon (~> 1.2.0)
   bitcoin-ruby!
-  eventmachine
-  ffi
-  minitest
-  rake (>= 0.8.0)
-  scrypt
+  minitest (~> 5.11.3)
+  pry (~> 0.11.3)
+  pry-byebug (~> 3.6.0)
+  rake (~> 12.3.1)
+  rspec (~> 3.7.0)
+  rubocop (~> 0.58.2)
+  simplecov (~> 0.16.1)
 
 BUNDLED WITH
-   1.14.6
+   1.17.3

data/README.rdoc

@@ -29,7 +29,7 @@ Note that some aspects of the library (such as networking, storage, etc.) need
 additional dependencies which are not specified in the gemspec. The core requirements are
 intentionally kept to a minimum, so nobody has to install unneeded dependencies.
 
-* +bacon+ to run the specs
+* +rspec+ to run the specs
 * +scrypt+ to use a much faster scrypt hash implementation for Litecoin
 
 If you would like to install using Bundler, put it in your Gemfile and run bundle install
@@ -169,16 +169,29 @@ The specs are also a good place to see how something works.
 
 == Specs
 
-The specs can be run with
+Specs require libsecp256k1 in order to be fully run. Therefore, the first step
+in running the specs is to build this library if you haven't already:
 
- rake bacon
+  rake build_libsecp256k1
+
+The majority of specs can be run with
+
+ rake rspec
 
 or, if you want to run a single spec
 
- ruby spec/bitcoin/bitcoin_spec.rb
+ bundle exec rspec spec/bitcoin/bitcoin_spec.rb
 
 If you make changes to the code or add functionality, please also add specs.
 
+To run specs for changes that monkey patch significant functionality, you
+should run the specs individually. For example, to run the Dogecoin specs:
+
+  rake coin_spec[dogecoin]
+
+If support is added for any new coins a corresponding coin spec should also be
+added to test specific functionality of that coin.
+
 == Development
 
 Any help or feedback is greatly appreciated! From getting knee-deep into elliptic-curve acrobatics,

data/Rakefile

@@ -1,98 +1,66 @@
-begin
-  require 'bundler/gem_tasks'
-rescue LoadError
-end
-
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-PROJECT_SPECS = ( FileList['spec/bitcoin/bitcoin_spec.rb'] +
-                  FileList['spec/bitcoin/protocol/*_spec.rb'] +
-                  FileList['spec/bitcoin/script/*_spec.rb'] +
-                  FileList['spec/bitcoin/trezor/*_spec.rb'] +
-                  FileList['spec/bitcoin/*_spec.rb'] ).uniq
+# libsecp256k1 repository URL
+LIBSECP256K1_REPO = 'https://github.com/bitcoin-core/secp256k1/'.freeze
+# Folder into which libsecp256k1 repository is cloned
+LIBSECP256K1_PATH = 'secp256k1'.freeze
 
 RUBY = 'ruby' unless defined?(RUBY)
 
-task :default => :bacon
-#
-# test runner
+# Attempts to configure the path to libsecp256k1.
 #
-desc 'Run all bacon specs with pretty output'
-task :bacon do
-  require 'open3'
-  require 'scanf'
-  require 'matrix'
-
-  specs = PROJECT_SPECS
-  unless ENV["SECP256K1_LIB_PATH"]
-    # skip when missing secp256k1 shared lib
-    specs.delete_if{|i| ['secp256k1_spec.rb', 'bip143_spec.rb'].include?(File.basename(i))}
+# @return [Bool] true if the library was found and configured, false otherwise.
+def configure_libsecp256k1
+  return true if ENV["SECP256K1_LIB_PATH"]
+
+  if File.exist?('secp256k1.so')
+    ENV['SECP256K1_LIB_PATH'] = File.join(Dir.pwd, 'secp256k1.so')
+    return true
   end
 
-  # E.g. SPEC=specs/bitcoin/script/ to run script-related specs only.
-  if spec_mask = ENV["SPEC"]
-    specs.delete_if{|s| !s[spec_mask] }
+  false
+end
+
+task :default => :rspec
+
+RSpec::Core::RakeTask.new(:rspec) do |t|
+  t.rspec_opts = '--exclude spec/unit/integrations/*'
+end
+
+RSpec::Core::RakeTask.new(:coin_spec, :coin) do |t, args|
+  t.rspec_opts = "--pattern spec/unit/integrations/#{args[:coin]}_spec.rb"
+end
+
+desc 'Compiles the libsecp256k1 library'
+task :build_libsecp256k1, [:force] do |_, args|
+  # Commit hash for libsecp256k1 from May 31, 2018.
+  COMMIT_HASH = '1e6f1f5ad5e7f1e3ef79313ec02023902bf8175c'.freeze
+
+  force = args[:force]
+
+  if Dir.exists?(LIBSECP256K1_PATH) && !force
+    puts "ERROR: Folder #{LIBSECP256K1_PATH} already exists, run with " \
+         "[force:true] to force cloning and building anyways."
+    exit 1
   end
 
-  some_failed = false
-  specs_size = specs.size
-  len = specs.map{|s| s.size }.sort.last
-  total_tests = total_assertions = total_failures = total_errors = 0
-  totals = Vector[0, 0, 0, 0]
-
-  red, yellow, green = "\e[31m%s\e[0m", "\e[33m%s\e[0m", "\e[32m%s\e[0m"
-  left_format = "%4d/%d: %-#{len + 11}s"
-  spec_format = "%d specifications (%d requirements), %d failures, %d errors"
-
-  specs.each_with_index do |spec, idx|
-    print(left_format % [idx + 1, specs_size, spec])
-
-    Open3.popen3(RUBY, spec) do |sin, sout, serr|
-      out = sout.read.strip
-      err = serr.read.strip
-
-      # this is conventional, see spec/innate/state/fiber.rb for usage
-      if out =~ /^Bacon::Error: (needed .*)/
-        puts(yellow % ("%6s %s" % ['', $1]))
-      else
-        total = nil
-
-        out.each_line do |line|
-          scanned = line.scanf(spec_format)
-
-          next unless scanned.size == 4
-
-          total = Vector[*scanned]
-          break
-        end
-
-        if total
-          totals += total
-          tests, assertions, failures, errors = total_array = total.to_a
-
-          if tests > 0 && failures + errors == 0
-            puts((green % "%6d passed") % tests)
-          else
-            some_failed = true
-            puts(red % "       failed")
-            puts out unless out.empty?
-            puts err unless err.empty?
-          end
-        else
-          some_failed = true
-          puts(red % "       failed")
-          puts out unless out.empty?
-          puts err unless err.empty?
-        end
-      end
-    end
+  sh "rm -rf #{LIBSECP256K1_PATH}"
+  sh "git clone #{LIBSECP256K1_REPO}"
+  Dir.chdir(LIBSECP256K1_PATH) do
+    sh "git checkout #{COMMIT_HASH}"
+    sh './autogen.sh'
+    sh './configure --enable-module-recovery --with-pic'
+    sh 'make libsecp256k1.la'
   end
 
-  total_color = some_failed ? red : green
-  puts(total_color % (spec_format % totals.to_a))
-  exit 1 if some_failed
+  libfile = 'libsecp256k1.so.0.0.0'
+  # Handle macOS libraries being different from Linux libraries
+  libfile = 'libsecp256k1.0.dylib' unless RUBY_PLATFORM.match(/darwin/).nil?
+  sh "cp #{LIBSECP256K1_PATH}/.libs/#{libfile} secp256k1.so"
+  sh "rm -rf #{LIBSECP256K1_PATH}"
 end
 
-
 desc 'Generate RDoc documentation'
 task :rdoc do
   `rm -rf rdoc`
@@ -101,12 +69,19 @@ end
 
 desc 'Generate test coverage report'
 task :coverage do
+  if !configure_libsecp256k1
+    puts 'ERROR: Skipping code coverage tests since required library '\
+         'libsecp256k1 was not found. Run `rake build_libsecp256k1` to build.'
+    exit 1
+  end
+
   begin
     require 'simplecov'
   rescue LoadError
     puts "Simplecov not found. Run `gem install simplecov` to install it."
     exit
   end
-  sh "bacon", *PROJECT_SPECS
+
+  Rake::Task['rspec'].invoke
   system('open coverage/index.html') if RUBY_PLATFORM.include? 'darwin'
 end

data/bitcoin-ruby.gemspec

@@ -19,6 +19,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.required_rubygems_version = ">= 1.3.6"
-  #s.add_development_dependency "bacon"
+  s.required_rubygems_version = ">= 2.6.13"
+
+  s.add_runtime_dependency 'ffi'
+  s.add_runtime_dependency 'scrypt' # required by Litecoin
+  s.add_runtime_dependency 'eventmachine' # required for connection code
 end

data/lib/bitcoin.rb

@@ -7,6 +7,20 @@ require 'openssl'
 require 'securerandom'
 
 module Bitcoin
+  # Determine the integer class to use. In older versions of ruby (< 2.4.0) the
+  # integer class is called Fixnum. In newer version (>= 2.4.0) Fixnum was
+  # deprecated in favor of a unification of Fixnum and BigInteger named Integer.
+  # Since this project strivers for backwards-compatability, we determine the
+  # appropriate class to use at initialization.
+  # 
+  # This avoids annoying deprecation warnings on newer versions for ourselves
+  # and library consumers.
+  Integer =
+    if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.4.0')
+      Integer
+    else
+      Fixnum
+    end
 
   autoload :Bech32,     'bitcoin/bech32'
   autoload :Connection, 'bitcoin/connection'
@@ -14,7 +28,6 @@ module Bitcoin
   autoload :P,          'bitcoin/protocol'
   autoload :Script,     'bitcoin/script'
   autoload :VERSION,    'bitcoin/version'
-  autoload :Logger,     'bitcoin/logger'
   autoload :Key,        'bitcoin/key'
   autoload :ExtKey,     'bitcoin/ext_key'
   autoload :ExtPubkey,  'bitcoin/ext_key'
@@ -34,6 +47,7 @@ module Bitcoin
   module Util
 
     def address_version; Bitcoin.network[:address_version]; end
+    def version_bytes; address_version.size / 2; end
     def p2sh_version; Bitcoin.network[:p2sh_version]; end
 
     # hash160 is a 20 bytes (160bits) rmd610-sha256 hexdigest.
@@ -52,7 +66,7 @@ module Bitcoin
     def base58_checksum?(base58)
       hex = decode_base58(base58) rescue nil
       return false unless hex
-      checksum( hex[0...42] ) == hex[-8..-1]
+      checksum(hex[0...(version_bytes + 20) * 2]) == hex[-8..-1]
     end
     alias :address_checksum? :base58_checksum?
 
@@ -68,6 +82,11 @@ module Bitcoin
       true
     rescue OpenSSL::PKey::EC::Point::Error
       false
+    rescue OpenSSL::BNError
+      # Occasionally, a malformed value will fail hex decoding completely and
+      # instead of raising an `OpenSSL::PKey::EC::Point::Error` will raise this
+      # error. We capture this failure mode here as well.
+      false
     end
 
     # get hash160 for given +address+. returns nil if address is invalid.
@@ -77,7 +96,9 @@ module Bitcoin
         _, witness_program_hex = decode_segwit_address(address)
         witness_program_hex
       when :hash160, :p2sh
-        decode_base58(address)[2...42]
+        start_idx = version_bytes * 2
+        stop_idx = start_idx + 40 # 20 bytes (2 chars per byte)
+        decode_base58(address)[start_idx...stop_idx]
       end
     end
 
@@ -98,14 +119,16 @@ module Bitcoin
       end
 
       hex = decode_base58(address) rescue nil
-      if hex && hex.bytesize == 50 && address_checksum?(address)
+
+      target_size = (version_bytes + 20 + 4) * 2 # version_bytes + 20 bytes hash + 4 bytes checksum
+      if hex && hex.bytesize == target_size && address_checksum?(address)
         # Litecoin updates the P2SH version byte, and this method should recognize both.
         p2sh_versions = [p2sh_version]
         if Bitcoin.network[:legacy_p2sh_versions]
           p2sh_versions += Bitcoin.network[:legacy_p2sh_versions]
         end
 
-        case hex[0...2]
+        case hex[0...(version_bytes * 2)]
         when address_version
           return :hash160
         when *p2sh_versions
@@ -255,7 +278,7 @@ module Bitcoin
 
     def decode_target(target_bits)
       case target_bits
-      when Fixnum
+      when Bitcoin::Integer
         [ decode_compact_bits(target_bits).to_i(16), target_bits ]
       when String
         [ target_bits.to_i(16), encode_compact_bits(target_bits) ]
@@ -561,11 +584,11 @@ module Bitcoin
   end
 
   def self.network_name
-    @network
+    @network ||= nil
   end
 
   def self.network_project
-    @network_project
+    @network_project ||= nil
   end
 
   def self.network=(name)
@@ -653,7 +676,6 @@ module Bitcoin
       ],
       genesis_hash: "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f",
       proof_of_work_limit: 0x1d00ffff,
-      alert_pubkeys: ["04fc9702847840aaf195de8442ebecedf5b095cdbb9bc716bda9110971b28a49e0ead8564ff0db22209e0374782c093bb899692d524e9d6a6956e7c5ecbcd68284"],
       known_nodes: [
         'relay.eligius.st',
         'mining.bitcoin.cz',
@@ -692,7 +714,6 @@ module Bitcoin
       dns_seeds: [ ],
       genesis_hash: "00000007199508e34a9ff81e6ec0c477a4cccff2a4767a8eee39c11db367b008",
       proof_of_work_limit: 0x1d07fff8,
-      alert_pubkeys: ["04302390343f91cc401d56d68b123028bf52e5fca1939df127f63c6467cdf9c8e2c14b61104cf817d0b780da337893ecc4aaff1309e536162dabbdb45200ca2b0a"],
       known_nodes: [],
       checkpoints: {},
     })
@@ -757,7 +778,6 @@ module Bitcoin
       ],
       genesis_hash: "12a765e31ffd4059bada1e25190f6e98c99d9714d334efa41a195a7e7e04bfe2",
       proof_of_work_limit: 0x1e0fffff,
-      alert_pubkeys: ["040184710fa689ad5023690c80f3a49c8f13f8d45b8c857fbcbc8bc4a8e4d3eb4b10f4d4604fa08dce601aaf0f470216fe1b51850b4acf21b179c45070ac7b03a9"],
       known_nodes: [],
       checkpoints: {
              1 => "80ca095ed10b02e53d769eb6eaf92cd04e9e0759e5be4a8477b42911ba49c78f",
@@ -797,7 +817,6 @@ module Bitcoin
         "dnsseed-testnet.thrasher.io",
       ],
       genesis_hash: "4966625a4b2851d9fdee139e56211a0d88575f59ed816ff5e6a63deb4e3e29a0",
-      alert_pubkeys: ["04302390343f91cc401d56d68b123028bf52e5fca1939df127f63c6467cdf9c8e2c14b61104cf817d0b780da337893ecc4aaff1309e536162dabbdb45200ca2b0a"],
       known_nodes: [],
       checkpoints: {
         546 => "bf434a4c665307f52a041ee40faa7bf56284c5f3b5d11bf6182aba537961f86c",
@@ -836,7 +855,6 @@ module Bitcoin
       ],
       genesis_hash: "1a91e3dace36e2be3bf030a65679fe821aa1d6ef92e7c9902eb318182c355691",
       proof_of_work_limit: 0x1e0fffff,
-      alert_pubkeys: [],
       known_nodes: [
         "daemons.chain.so",
         "bootstrap.chain.so",
@@ -894,7 +912,6 @@ module Bitcoin
       ],
       genesis_hash: "bb0a78264637406b6360aad926284d544d7049f45189db5664f3c4d07350559e",
       proof_of_work_limit: 0x1e0fffff,
-      alert_pubkeys: [],
       known_nodes: [
         "localhost",
         "testnets.chain.so",