bitcoinrb 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bad0d642595251361c1e4f281ebe2bb7c08093cd
-  data.tar.gz: 8a6ce86fdb345abb9fe19b2fb37d80402a92958e
+  metadata.gz: 8f25b7f5ff1de3882b880e49e858f3b49bf8c13a
+  data.tar.gz: 2a04f3a090503ffdc15d337b351c839d68b33929
 SHA512:
-  metadata.gz: f57859bf2c0080092422681fcc9e7f66c6a4605ae4b00dcef291b4f13126264da9bf6c23424aec2450be5f5819364d74e9765159d77b6d9b74de30ddeeb000fd
-  data.tar.gz: e7682dfea261c6456dc5f9e5c969836d338d5045a445b2141a63d97c9117cfea537b62683fe87dd7baae82e94c98dd5109b617db51933aa3656434c264ec1164
+  metadata.gz: abbfff02611cb216dc843414bc7e8e9f4e9799a72314ebc3f165f6b100fa2e2d77843975b77bca8ccce3d23d7fb749eb12c62f881ac7f3635840bb68eedb9791
+  data.tar.gz: a0a3fd06f7120bdff5c04375e1ab4214d3e962256d96f4c5f9a48811eeb5227ad602bd7ff2283c117219d3bb4d880dd529a9b0fde1567cc2ef03d2a9b2106cfd

data/.travis.yml

@@ -2,3 +2,7 @@ language: ruby
 rvm:
   - 2.3.0
   - 2.4.1
+addons:
+  apt:
+    packages:
+      - libleveldb-dev

data/README.md

@@ -1,8 +1,35 @@
-# Bitcoinrb
+# Bitcoinrb [![Build Status](https://travis-ci.org/haw-itn/bitcoinrb.svg?branch=master)](https://travis-ci.org/haw-itn/bitcoinrb) [![Gem Version](https://badge.fury.io/rb/bitcoinrb.svg)](https://badge.fury.io/rb/bitcoinrb) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE) <img src="http://segwit.co/static/public/images/logo.png" width="100">
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bitcoinrb`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
+Bitcoinrb is a Ruby implementation of Bitcoin Protocol.
+
+NOTE: Bitcoinrb work in progress, and there is a possibility of incompatible change. 
+
+## Features
+
+Bitcoinrb supports following feature:
+
+* Bitcoin script interpreter
+* De/serialization of Bitcoin protocol network messages
+* De/serialization of blocks and transactions
+* Key generation and verification for ECDSA, including [BIP-32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) and [BIP-39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) supports.
+* Segwit support (parsing segwit payload, Bech32 address, sign for segwit tx, etc..)
+* [WIP] SPV node
+* [WIP] 0ff-chain protocol
+
+## Requirements
+
+bitcoinrb requires a `leveldb` library.
+
+### install LevelDB
+
+* for Ubuntu
+
+    $ sudo apt-get install libleveldb-dev
+
++ for Mac
+
+    $ brew install leveldb
 
 ## Installation
 
@@ -20,16 +47,11 @@ Or install it yourself as:
 
     $ gem install bitcoinrb
 
+
 ## Usage
 
 TODO: Write usage instructions here
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bitcoinrb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/bitcoinrb.gemspec

@@ -4,6 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'bitcoin/version'
 
 Gem::Specification.new do |spec|
+
   spec.name          = "bitcoinrb"
   spec.version       = Bitcoin::VERSION
   spec.authors       = ["azuchi"]
@@ -22,12 +23,15 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'ecdsa'
   spec.add_runtime_dependency 'eventmachine'
   spec.add_runtime_dependency 'murmurhash3'
-  spec.add_runtime_dependency 'bech32', '~> 1.0.1'
+  spec.add_runtime_dependency 'bech32', '~> 1.0.3'
   spec.add_runtime_dependency 'daemon-spawn'
   spec.add_runtime_dependency 'thor'
   spec.add_runtime_dependency 'ffi'
-  spec.add_runtime_dependency 'parallel'
   spec.add_runtime_dependency 'leb128', '~> 1.0.0'
+  spec.add_runtime_dependency 'leveldb-ruby'
+  spec.add_runtime_dependency 'eventmachine_httpserver'
+  spec.add_runtime_dependency 'rest-client'
+  spec.add_runtime_dependency 'iniparse'
 
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'

data/exe/bitcoinrb-cli

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'bitcoin/node/spv/cli'
+require 'bitcoin'
 
-Bitcoin::Nodes::SPV::CLI.start(ARGV)
+Bitcoin::Node::CLI.start(ARGV)

data/lib/bitcoin/block_header.rb

@@ -3,7 +3,6 @@ module Bitcoin
   # Block Header
   class BlockHeader
 
-    attr_accessor :hash
     attr_accessor :version
     attr_accessor :prev_hash
     attr_accessor :merkle_root
@@ -18,7 +17,6 @@ module Bitcoin
       @time = time
       @bits = bits
       @nonce = nonce
-      @hash = calc_hash
     end
 
     def self.parse_from_payload(payload)
@@ -38,6 +36,11 @@ module Bitcoin
       (mantissa * 2 ** (8 * (exponent - 3)))
     end
 
+    # block hash
+    def hash
+      calc_hash
+    end
+
     # evaluate block header
     def valid?
       valid_pow? && valid_timestamp?
@@ -62,6 +65,10 @@ module Bitcoin
       (2**256) / (target + 1)
     end
 
+    def ==(other)
+      other && other.to_payload == to_payload
+    end
+
     private
 
     def calc_hash

data/lib/bitcoin/chainparams/regtest.yml

@@ -4,7 +4,7 @@ magic_head: "fabfb5da"
 message_magic: "Bitcoin Signed Message:\n"
 address_version: "6f"
 p2sh_version: "c4"
-bech32_hrp: 'tb'
+bech32_hrp: 'bcrt'
 privkey_version: "ef"
 extended_privkey_version: "04358394"
 extended_pubkey_version: "043587cf"

data/lib/bitcoin/constants.rb

@@ -167,4 +167,7 @@ module Bitcoin
 
   # Maximum amount of time that a block timestamp is allowed to exceed the current network-adjusted time before the block will be accepted.
   MAX_FUTURE_BLOCK_TIME = 2 * 60 * 60
+
+  # Size of set to pick median time from.
+  MEDIAN_TIME_SPAN = 11
 end

data/lib/bitcoin/key.rb

@@ -8,9 +8,16 @@ module Bitcoin
     attr_accessor :compressed
     attr_reader :secp256k1_module
 
+    MIN_PRIV_KEy_MOD_ORDER = 0x01
+    # Order of secp256k1's generator minus 1.
+    MAX_PRIV_KEY_MOD_ORDER = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364140
+
     def initialize(priv_key: nil, pubkey: nil, compressed: true)
       @secp256k1_module =  Bitcoin.secp_impl
       @priv_key = priv_key
+      if @priv_key
+        raise ArgumentError, 'private key is not on curve' unless validate_private_key_range(@priv_key)
+      end
       if pubkey
         @pubkey = pubkey
       else
@@ -28,12 +35,23 @@ module Bitcoin
     # import private key from wif format
     # https://en.bitcoin.it/wiki/Wallet_import_format
     def self.from_wif(wif)
-      compressed = wif.size == 52
       hex = Base58.decode(wif)
-      version, key, flag, checksum = hex.unpack("a2a64a#{compressed ? 2 : 0}a8")
+      raise ArgumentError, 'data is too short' if hex.htb.bytesize < 4
+      version = hex[0..1]
+      data = hex[2...-8].htb
+      checksum = hex[-8..-1]
       raise ArgumentError, 'invalid version' unless version == Bitcoin.chain_params.privkey_version
-      raise ArgumentError, 'invalid checksum' unless Bitcoin.calc_checksum(version + key + flag) == checksum
-      new(priv_key: key, compressed: compressed)
+      raise ArgumentError, 'invalid checksum' unless Bitcoin.calc_checksum(version + data.bth) == checksum
+      key_len = data.bytesize
+      if key_len == 33 && data[-1].unpack('C').first == 1
+        compressed = true
+        data = data[0..-2]
+      elsif key_len == 32
+        compressed = false
+      else
+        raise ArgumentError, 'Wrong number of bytes for a private key, not 32 or 33'
+      end
+      new(priv_key: data.bth, compressed: compressed)
     end
 
     # export private key with wif format
@@ -47,7 +65,12 @@ module Bitcoin
 
     # sign +data+ with private key
     def sign(data)
-      secp256k1_module.sign_data(data, priv_key)
+      sig = nil
+      until sig
+        signature = secp256k1_module.sign_data(data, priv_key)
+        sig = signature if Key.low_signature?(signature)
+      end
+      sig
     end
 
     # verify signature using public key
@@ -116,6 +139,42 @@ module Bitcoin
           compare_big_endian(val_s, max_mod_half_order) <= 0
     end
 
+
+    # check +sig+ is correct der encoding.
+    # This function is consensus-critical since BIP66.
+    def self.valid_signature_encoding?(sig)
+      return false if sig.bytesize < 9 || sig.bytesize > 73 # Minimum and maximum size check
+
+      s = sig.unpack('C*')
+
+      return false if s[0] != 0x30 || s[1] != s.size - 3 # A signature is of type 0x30 (compound). Make sure the length covers the entire signature.
+
+      len_r = s[3]
+      return false if 5 + len_r >= s.size # Make sure the length of the S element is still inside the signature.
+
+      len_s = s[5 + len_r]
+      return false unless len_r + len_s + 7 == s.size #Verify that the length of the signature matches the sum of the length of the elements.
+
+      return false unless s[2] == 0x02 # Check whether the R element is an integer.
+
+      return false if len_r == 0 # Zero-length integers are not allowed for R.
+
+      return false unless s[4] & 0x80 == 0 # Negative numbers are not allowed for R.
+
+      # Null bytes at the start of R are not allowed, unless R would otherwise be interpreted as a negative number.
+      return false if len_r > 1 && (s[4] == 0x00) && (s[5] & 0x80 == 0)
+
+      return false unless s[len_r + 4] == 0x02 # Check whether the S element is an integer.
+
+      return false if len_s == 0 # Zero-length integers are not allowed for S.
+      return false unless (s[len_r + 6] & 0x80) == 0 # Negative numbers are not allowed for S.
+
+      # Null bytes at the start of S are not allowed, unless S would otherwise be interpreted as a negative number.
+      return false if len_s > 1 && (s[len_r + 6] == 0x00) && (s[len_r + 7] & 0x80 == 0)
+
+      true
+    end
+
     private
 
     def self.compare_big_endian(c1, c2)
@@ -144,6 +203,12 @@ module Bitcoin
       pubkey.bth
     end
 
+    # check private key range.
+    def validate_private_key_range(private_key)
+      value = private_key.to_i(16)
+      MIN_PRIV_KEy_MOD_ORDER <= value && value <= MAX_PRIV_KEY_MOD_ORDER
+    end
+
   end
 
 end

data/lib/bitcoin/logger.rb

@@ -5,14 +5,38 @@ module Bitcoin
   # Simple Logger module
   module Logger
 
+    Format = "%s, [%s#%d #%d] %5s -- %s: %s\n".freeze
+
+    module_function
+
     # Create a logger with given +name+.log in $HOME/.bitcoinrb/log.
-    def self.create(name, level = ::Logger::INFO)
+    def create(name, level = ::Logger::INFO)
       dir = "#{Bitcoin.base_dir}/log"
       FileUtils.mkdir_p(dir)
       logger = ::Logger.new(dir + "/#{name}.log", 10)
       logger.level = level
+      logger.formatter =  proc do |severity, datetime, progname, msg|
+        Format % [severity[0..0], format_datetime(datetime), $$,
+                  Thread.current.object_id, severity, progname, msg2str(msg)]
+      end
       logger
     end
 
+    def self.msg2str(msg)
+      case msg
+        when ::String
+          msg
+        when ::Exception
+          "#{ msg.message } (#{ msg.class })\n" <<
+              (msg.backtrace || []).join("\n")
+        else
+          msg.inspect
+      end
+    end
+
+    def format_datetime(time)
+      time.strftime(@datetime_format || "%Y-%m-%dT%H:%M:%S.%6N ".freeze)
+    end
+
   end
 end

data/lib/bitcoin/message/addr.rb

@@ -31,44 +31,5 @@ module Bitcoin
 
     end
 
-    class NetworkAddr
-
-      # unix time.
-      # Nodes advertising their own IP address set this to the current time.
-      # Nodes advertising IP addresses they’ve connected to set this to the last time they connected to that node.
-      # Other nodes just relaying the IP address should not change the time. Nodes can use the time field to avoid relaying old addr messages.
-      attr_accessor :time
-
-      # The services the node advertised in its version message.
-      attr_accessor :services
-
-      attr_accessor :ip
-
-      attr_accessor :port
-
-      def initialize
-        @time = Time.now.to_i
-        @services = Bitcoin::Message::SERVICE_FLAGS[:network]
-      end
-
-      def self.parse_from_payload(payload)
-        buf = payload.is_a?(String) ? StringIO.new(payload) : payload
-        addr = new
-        addr.time = buf.read(4).unpack('V').first
-        addr.services = buf.read(8).unpack('Q').first
-        ip = IPAddr::new_ntoh(buf.read(16))
-        addr.ip = ip.ipv4_mapped? ? ip.native : ip.to_s
-        addr.port = buf.read(2).unpack('n').first
-        addr
-      end
-
-      def to_payload
-        ip_addr = IPAddr.new (ip)
-        ip_addr = ip_addr.ipv4_mapped if ip_addr.ipv4?
-        [time, services].pack('VQ') << ip_addr.hton << [port].pack('n')
-      end
-
-    end
-
   end
 end

data/lib/bitcoin/message/headers.rb

@@ -7,6 +7,7 @@ module Bitcoin
 
       COMMAND = 'headers'
 
+      # Array[Bitcoin::BlockHeader]
       attr_accessor :headers
 
       def initialize(headers = [])

data/lib/bitcoin/message/inventory.rb

@@ -35,6 +35,10 @@ module Bitcoin
         [identifier].pack('V') << hash.htb.reverse
       end
 
+      def block?
+        [MSG_BLOCK, MSG_WITNESS_BLOCK, MSG_FILTERED_WITNESS_BLOCK].include?(identifier)
+      end
+
       private
 
       def valid_identifier?(identifier)

data/lib/bitcoin/message/network_addr.rb

@@ -0,0 +1,44 @@
+module Bitcoin
+  module Message
+
+    class NetworkAddr
+
+      # unix time.
+      # Nodes advertising their own IP address set this to the current time.
+      # Nodes advertising IP addresses they’ve connected to set this to the last time they connected to that node.
+      # Other nodes just relaying the IP address should not change the time. Nodes can use the time field to avoid relaying old addr messages.
+      attr_accessor :time
+
+      # The services the node advertised in its version message.
+      attr_accessor :services
+
+      attr_accessor :ip
+
+      attr_accessor :port
+
+      def initialize
+        @time = Time.now.to_i
+        @services = Bitcoin::Message::SERVICE_FLAGS[:network]
+      end
+
+      def self.parse_from_payload(payload)
+        buf = payload.is_a?(String) ? StringIO.new(payload) : payload
+        addr = new
+        addr.time = buf.read(4).unpack('V').first
+        addr.services = buf.read(8).unpack('Q').first
+        ip = IPAddr::new_ntoh(buf.read(16))
+        addr.ip = ip.ipv4_mapped? ? ip.native : ip.to_s
+        addr.port = buf.read(2).unpack('n').first
+        addr
+      end
+
+      def to_payload
+        ip_addr = IPAddr.new (ip)
+        ip_addr = ip_addr.ipv4_mapped if ip_addr.ipv4?
+        [time, services].pack('VQ') << ip_addr.hton << [port].pack('n')
+      end
+
+    end
+
+  end
+end

data/lib/bitcoin/message/version.rb

@@ -1,4 +1,5 @@
 # encoding: ascii-8bit
+require 'ipaddr'
 module Bitcoin
   module Message
 
@@ -60,9 +61,13 @@ module Bitcoin
       end
 
       def pack_addr(addr)
-        host, port = addr.split(':')
-        sockaddr = Socket.pack_sockaddr_in(port.to_i, host)
-        [[1].pack('Q'), "\x00" * 10, "\xFF\xFF", sockaddr[4...8], sockaddr[2...4]].join
+        separator = addr.rindex(':')
+        ip = addr[0...separator]
+        port = addr[separator + 1..-1].to_i
+        ip_addr = IPAddr.new(ip)
+        ip_addr = ip_addr.ipv4_mapped if ip_addr.ipv4?
+        [1].pack('Q') << ip_addr.hton << [port].pack('n')
+        # [[1].pack('Q'), "\x00" * 10, "\xFF\xFF", sockaddr[4...8], sockaddr[2...4]].join
       end
 
       def unpack_addr(addr)

data/lib/bitcoin/message.rb

@@ -8,6 +8,7 @@ module Bitcoin
     autoload :Version, 'bitcoin/message/version'
     autoload :VerAck, 'bitcoin/message/ver_ack'
     autoload :Addr, 'bitcoin/message/addr'
+    autoload :NetworkAddr, 'bitcoin/message/network_addr'
     autoload :Block, 'bitcoin/message/block'
     autoload :FilterLoad, 'bitcoin/message/filter_load'
     autoload :FilterAdd, 'bitcoin/message/filter_add'
@@ -47,5 +48,16 @@ module Bitcoin
 
     DEFAULT_STOP_HASH = "00"*32
 
+    # the protocol version.
+    VERSION = {
+        headers: 31800,
+        pong: 60001,
+        bloom: 70011,
+        send_headers: 70012,
+        fee_filter: 70013,
+        compact: 70014,
+        compact_witness: 70015
+    }
+
   end
 end

data/lib/bitcoin/mnemonic.rb

@@ -24,7 +24,7 @@ module Bitcoin
     def to_entropy(words)
       word_master = load_words
       mnemonic = words.map do |w|
-        index = word_master.index(w)
+        index = word_master.index(w.downcase)
         raise IndexError, 'word not found in words list.' unless index
         index.to_s(2).rjust(11, '0')
       end.join
@@ -52,7 +52,7 @@ module Bitcoin
     # @param [String] passphrase a passphrase which protects mnemonic. the default value is an empty string.
     # @return [String] seed
     def to_seed(mnemonic, passphrase: '')
-      OpenSSL::PKCS5.pbkdf2_hmac(mnemonic.join(' '),
+      OpenSSL::PKCS5.pbkdf2_hmac(mnemonic.join(' ').downcase,
                                  'mnemonic' + passphrase, 2048, 64, OpenSSL::Digest::SHA512.new).bth
     end
 

data/lib/bitcoin/network/connection.rb

@@ -20,7 +20,7 @@ module Bitcoin
 
       def initialize(peer)
         @peer = peer
-        @logger = Bitcoin::Logger.create(:debug)
+        @logger = peer.logger
         @sendheaders = false
         @attr_accessor = 0
         @message = ''
@@ -28,6 +28,7 @@ module Bitcoin
 
       def post_init
         logger.info "connected. #{addr}"
+        peer.conn_time = Time.now.to_i
         begin_handshake
       end
 
@@ -51,6 +52,18 @@ module Bitcoin
         EM.stop
       end
 
+      def handle_error(e)
+        peer.handle_error(e)
+      end
+
+      private
+
+      # start handshake
+      def begin_handshake
+        logger.info "begin handshake with #{addr}"
+        send_message(peer.local_version)
+      end
+
     end
 
   end