bitcoinrb 0.4.0 → 0.5.0

data/lib/bitcoin/rpc/bitcoin_core_client.rb

@@ -1,4 +1,4 @@
-require 'rest-client'
+require 'net/http'
 
 module Bitcoin
   module RPC
@@ -53,20 +53,30 @@ module Bitcoin
             :params => params,
             :id => 'jsonrpc'
         }
-        post(server_url, @config[:timeout], @config[:open_timeout], data.to_json, content_type: :json) do |respdata, request, result|
-          raise result.message if !result.kind_of?(Net::HTTPSuccess) && respdata.empty?
-          response = JSON.parse(respdata.gsub(/\\u([\da-fA-F]{4})/) { [$1].pack('H*').unpack('n*').pack('U*').encode('ISO-8859-1').force_encoding('UTF-8') })
-          raise response['error'].to_s if response['error']
-          response['result']
-        end
+        uri = URI.parse(server_url)
+        http = Net::HTTP.new(uri.hostname, uri.port)
+        http.use_ssl = uri.scheme === "https"
+        request = Net::HTTP::Post.new(uri.path.empty? ? '/' : uri.path)
+        request.basic_auth(uri.user, uri.password)
+        request.content_type = 'application/json'
+        request.body = data.to_json
+        response = http.request(request)
+        body = response.body
+        response = Bitcoin::Ext::JsonParser.new(body.gsub(/\\u([\da-fA-F]{4})/) { [$1].pack('H*').unpack('n*').pack('U*').encode('ISO-8859-1').force_encoding('UTF-8') }).parse
+        raise response['error'].to_s if response['error']
+        response['result']
       end
-
-      def post(url, timeout, open_timeout, payload, headers={}, &block)
-        RestClient::Request.execute(method: :post, url: url, timeout: timeout,
-                                    open_timeout: open_timeout, payload: payload, headers: headers, &block)
+      
+      # Call CLI command on Ruby-like method names.
+      # e.g. generate_to_address, send_to_address, get_wallet_info
+      def method_missing(name, *args)
+        if name.to_s.include?('_')
+          send(name.to_s.gsub('_', '').to_sym, args)
+        else
+          super
+        end
       end
 
     end
-
   end
 end

data/lib/bitcoin/rpc/request_handler.rb

@@ -42,7 +42,7 @@ module Bitcoin
               nextblockhash: node.chain.next_hash(block_hash).rhex
           }
         else
-          entry.header.to_payload.bth
+          entry.header.to_hex
         end
       end
 

data/lib/bitcoin/script/script.rb

@@ -6,6 +6,7 @@ module Bitcoin
   # bitcoin script
   class Script
     include Bitcoin::Opcodes
+    include Bitcoin::HexConverter
 
     attr_accessor :chunks
 
@@ -335,6 +336,7 @@ module Bitcoin
         when Integer
           opcode_to_name(c)
         when String
+          return c if c.empty?
           if c.pushdata?
             v = Opcodes.opcode_to_small_int(c.ord)
             if v
@@ -362,7 +364,7 @@ module Bitcoin
 
     # generate hash160 hash for payload
     def to_hash160
-      Bitcoin.hash160(to_payload.bth)
+      Bitcoin.hash160(to_hex)
     end
 
     # script size
@@ -499,7 +501,7 @@ module Bitcoin
     end
 
     def to_h
-      h = {asm: to_s, hex: to_payload.bth, type: type}
+      h = {asm: to_s, hex: to_hex, type: type}
       addrs = addresses
       unless addrs.empty?
         h[:req_sigs] = multisig? ? Bitcoin::Opcodes.opcode_to_small_int(chunks[0].bth.to_i(16)) :addrs.size
@@ -515,12 +517,6 @@ module Bitcoin
       (size > 0 && op_return?) || size > Bitcoin::MAX_SCRIPT_SIZE
     end
 
-    # convert payload to hex data.
-    # @return [String] script with hex format.
-    def to_hex
-      to_payload.bth
-    end
-
     private
 
     # generate p2pkh address. if script dose not p2pkh, return nil.
@@ -553,7 +549,7 @@ module Bitcoin
     def bech32_addr
       segwit_addr = Bech32::SegwitAddr.new
       segwit_addr.hrp = Bitcoin.chain_params.bech32_hrp
-      segwit_addr.script_pubkey = to_payload.bth
+      segwit_addr.script_pubkey = to_hex
       segwit_addr.addr
     end
 

data/lib/bitcoin/script/script_interpreter.rb

@@ -61,7 +61,6 @@ module Bitcoin
       # Additional validation for spend-to-script-hash transactions
       if flag?(SCRIPT_VERIFY_P2SH) && script_pubkey.p2sh?
         return set_error(SCRIPT_ERR_SIG_PUSHONLY) unless script_sig.push_only?
-        tmp = stack
         @stack = stack_copy
         raise 'stack cannot be empty.' if stack.empty?
         begin
@@ -76,7 +75,7 @@ module Bitcoin
         if flag?(SCRIPT_VERIFY_WITNESS) && redeem_script.witness_program?
           had_witness = true
           # The scriptSig must be _exactly_ a single push of the redeemScript. Otherwise we reintroduce malleability.
-          return set_error(SCRIPT_ERR_WITNESS_MALLEATED_P2SH) unless script_sig == (Bitcoin::Script.new << redeem_script.to_payload.bth)
+          return set_error(SCRIPT_ERR_WITNESS_MALLEATED_P2SH) unless script_sig == (Bitcoin::Script.new << redeem_script.to_hex)
 
           version, program = redeem_script.witness_data
           return false unless verify_witness_program(witness, version, program)
@@ -147,7 +146,7 @@ module Bitcoin
         op_count = 0
 
         script.chunks.each_with_index do |c, index|
-          need_exec = !flow_stack.include?(false)
+          need_exec = flow_stack.rindex(false).nil?
 
           return set_error(SCRIPT_ERR_PUSH_SIZE) if c.pushdata? && c.pushed_data.bytesize > MAX_SCRIPT_ELEMENT_SIZE
 

data/lib/bitcoin/secp256k1.rb

@@ -6,6 +6,7 @@ module Bitcoin
 
     autoload :Ruby, 'bitcoin/secp256k1/ruby'
     autoload :Native, 'bitcoin/secp256k1/native'
+    autoload :RFC6979, 'bitcoin/secp256k1/rfc6979'
 
   end
 

data/lib/bitcoin/secp256k1/rfc6979.rb

@@ -0,0 +1,43 @@
+module Bitcoin
+  module Secp256k1
+    module RFC6979
+
+      INITIAL_V = '0101010101010101010101010101010101010101010101010101010101010101'.htb
+      INITIAL_K = '0000000000000000000000000000000000000000000000000000000000000000'.htb
+      ZERO_B = '00'.htb
+      ONE_B = '01'.htb
+
+      module_function
+
+      # generate temporary key k to be used when ECDSA sign.
+      # https://tools.ietf.org/html/rfc6979#section-3.2
+      # @param [String] key_data a data contains private key and message.
+      # @param [String] extra_entropy extra entropy with binary format.
+      # @return [Integer] a nonce.
+      def generate_rfc6979_nonce(key_data, extra_entropy)
+        v = INITIAL_V # 3.2.b
+        k = INITIAL_K # 3.2.c
+        # 3.2.d
+        k = Bitcoin.hmac_sha256(k, v + ZERO_B + key_data + extra_entropy)
+        # 3.2.e
+        v = Bitcoin.hmac_sha256(k, v)
+        # 3.2.f
+        k = Bitcoin.hmac_sha256(k, v + ONE_B + key_data + extra_entropy)
+        # 3.2.g
+        v = Bitcoin.hmac_sha256(k, v)
+        # 3.2.h
+        t = ''
+        10000.times do
+          v = Bitcoin.hmac_sha256(k, v)
+          t = (t + v)
+          t_num = t.bth.to_i(16)
+          return t_num if 1 <= t_num && t_num < Bitcoin::Secp256k1::GROUP.order
+          k = Bitcoin.hmac_sha256(k, v + '00'.htb)
+          v = Bitcoin.hmac_sha256(k, v)
+        end
+        raise 'A valid nonce was not found.'
+      end
+
+    end
+  end
+end

data/lib/bitcoin/secp256k1/ruby.rb

@@ -12,8 +12,8 @@ module Bitcoin
         private_key = 1 + SecureRandom.random_number(GROUP.order - 1)
         public_key = GROUP.generator.multiply_by_scalar(private_key)
         privkey = ECDSA::Format::IntegerOctetString.encode(private_key, 32)
-        pubkey = ECDSA::Format::PointOctetString.encode(public_key, compression: compressed)
-        [privkey.bth, pubkey.bth]
+        pubkey = public_key.to_hex(compressed)
+        [privkey.bth, pubkey]
       end
 
       # generate bitcoin key object
@@ -24,7 +24,7 @@ module Bitcoin
 
       def generate_pubkey(privkey, compressed: true)
         public_key = ECDSA::Group::Secp256k1.generator.multiply_by_scalar(privkey.to_i(16))
-        ECDSA::Format::PointOctetString.encode(public_key, compression: compressed).bth
+        public_key.to_hex(compressed)
       end
 
       # sign data.
@@ -35,7 +35,7 @@ module Bitcoin
         privkey = privkey.htb
         private_key = ECDSA::Format::IntegerOctetString.decode(privkey)
         extra_entropy ||= ''
-        nonce = generate_rfc6979_nonce(data, privkey, extra_entropy)
+        nonce = RFC6979.generate_rfc6979_nonce(privkey + data, extra_entropy)
 
         # port form ecdsa gem.
         r_point = GROUP.new_point(nonce)
@@ -87,37 +87,6 @@ module Bitcoin
         end
       end
 
-      INITIAL_V = '0101010101010101010101010101010101010101010101010101010101010101'.htb
-      INITIAL_K = '0000000000000000000000000000000000000000000000000000000000000000'.htb
-      ZERO_B = '00'.htb
-      ONE_B = '01'.htb
-
-      # generate temporary key k to be used when ECDSA sign.
-      # https://tools.ietf.org/html/rfc6979#section-3.2
-      def generate_rfc6979_nonce(data, privkey, extra_entropy)
-        v = INITIAL_V # 3.2.b
-        k = INITIAL_K # 3.2.c
-        # 3.2.d
-        k = Bitcoin.hmac_sha256(k, v + ZERO_B + privkey + data + extra_entropy)
-        # 3.2.e
-        v = Bitcoin.hmac_sha256(k, v)
-        # 3.2.f
-        k = Bitcoin.hmac_sha256(k, v + ONE_B + privkey + data + extra_entropy)
-        # 3.2.g
-        v = Bitcoin.hmac_sha256(k, v)
-        # 3.2.h
-        t = ''
-        10000.times do
-          v = Bitcoin.hmac_sha256(k, v)
-          t = (t + v)
-          t_num = t.bth.to_i(16)
-          return t_num if 1 <= t_num && t_num < GROUP.order
-          k = Bitcoin.hmac_sha256(k, v + '00'.htb)
-          v = Bitcoin.hmac_sha256(k, v)
-        end
-        raise 'A valid nonce was not found.'
-      end
     end
-
   end
 end

data/lib/bitcoin/store.rb

@@ -6,6 +6,7 @@ module Bitcoin
     autoload :DB, 'bitcoin/store/db'
     autoload :SPVChain, 'bitcoin/store/spv_chain'
     autoload :ChainEntry, 'bitcoin/store/chain_entry'
+    autoload :UtxoDB, 'bitcoin/store/utxo_db'
 
   end
 end

data/lib/bitcoin/store/chain_entry.rb

@@ -3,6 +3,7 @@ module Bitcoin
 
     # wrap a block header object with extra data.
     class ChainEntry
+      include Bitcoin::HexConverter
 
       attr_reader :header
       attr_reader :height

data/lib/bitcoin/store/utxo_db.rb

@@ -0,0 +1,226 @@
+require 'leveldb-native'
+
+module Bitcoin
+  module Store
+    class UtxoDB
+
+      KEY_PREFIX = {
+        out_point: 'o',        # key: out_point(tx_hash and index), value: Utxo
+        script: 's',           # key: script_pubkey and out_point(tx_hash and index), value: Utxo
+        height: 'h',           # key: block_height and out_point, value: Utxo
+        tx_hash: 't',          # key: tx_hash of transaction, value: [block_height, tx_index]
+        block: 'b',            # key: block_height and tx_index, value: tx_hash
+        tx_payload: 'p',       # key: tx_hash, value: Tx
+      }
+
+      attr_reader :level_db, :logger
+
+      def initialize(path = "#{Bitcoin.base_dir}/db/utxo")
+        FileUtils.mkdir_p(path)
+        @level_db = ::LevelDBNative::DB.new(path)
+        @logger = Bitcoin::Logger.create(:debug)
+      end
+
+      def close
+        level_db.close
+      end
+
+      # Save payload of a transaction into db
+      #
+      # @param  [String] tx_hash
+      # @param  [String] tx_payload
+      def save_tx(tx_hash, tx_payload)
+        logger.info("UtxoDB#save_tx:#{[tx_hash, tx_payload]}")
+        level_db.batch do
+          # tx_hash -> [block_height, tx_index]
+          key = KEY_PREFIX[:tx_payload] + tx_hash
+          level_db.put(key, tx_payload)
+        end
+      end
+
+      # Save tx position (block height and index in the block) into db
+      # When node receives `header` message, node should call save_tx_position to store block height and its index.
+      #
+      # @param  [String] tx_hash
+      # @param  [Integer] block_height
+      # @param  [Integer] tx_index
+      def save_tx_position(tx_hash, block_height, tx_index)
+        logger.info("UtxoDB#save_tx_position:#{[tx_hash, block_height, tx_index]}")
+        level_db.batch do
+          # tx_hash -> [block_height, tx_index]
+          key = KEY_PREFIX[:tx_hash] + tx_hash
+          level_db.put(key, [block_height, tx_index].pack('N2').bth)
+
+          # block_hash and tx_index -> tx_hash
+          key = KEY_PREFIX[:block] + [block_height, tx_index].pack('N2').bth
+          level_db.put(key, tx_hash)
+        end
+      end
+
+      # Save utxo into db
+      #
+      # @param [Bitcoin::OutPoint] out_point
+      # @param [Double] value
+      # @param [Bitcoin::Script] script_pubkey
+      # @param [Integer] block_height
+      def save_utxo(out_point, value, script_pubkey, block_height=nil)
+        logger.info("UtxoDB#save_utxo:#{[out_point, value, script_pubkey, block_height]}")
+        level_db.batch do
+          utxo = Bitcoin::Wallet::Utxo.new(out_point.tx_hash, out_point.index, value, script_pubkey, block_height)
+          payload = utxo.to_payload
+
+          # out_point
+          key = KEY_PREFIX[:out_point] + out_point.to_hex
+          return if level_db.contains?(key)
+          level_db.put(key, payload)
+
+          # script_pubkey
+          if script_pubkey
+            key = KEY_PREFIX[:script] + script_pubkey.to_hex + out_point.to_hex
+            level_db.put(key, payload)
+          end
+
+          # height
+          unless block_height.nil?
+            key = KEY_PREFIX[:height] + [block_height].pack('N').bth + out_point.to_hex
+            level_db.put(key, payload)
+          end
+
+          utxo
+        end
+      end
+
+      # Get transaction stored via save_tx and save_tx_position
+      #
+      # @param  [string] tx_hash
+      # @return [block_height, tx_index, tx_payload]
+      def get_tx(tx_hash)
+        key = KEY_PREFIX[:tx_hash] + tx_hash
+        return [] unless level_db.contains?(key)
+        block_height, tx_index = level_db.get(key).htb.unpack('N2')
+        key = KEY_PREFIX[:tx_payload] + tx_hash
+        tx_payload = level_db.get(key)
+        [block_height, tx_index, tx_payload]
+      end
+
+      # Delete utxo from db
+      #
+      # @param  [Bitcoin::Outpoint] out_point
+      # @return [Bitcoin::Wallet::Utxo] 
+      def delete_utxo(out_point)
+        level_db.batch do
+          # [:out_point]
+          key = KEY_PREFIX[:out_point] + out_point.to_hex
+          return unless level_db.contains?(key)
+          utxo = Bitcoin::Wallet::Utxo.parse_from_payload(level_db.get(key))
+          level_db.delete(key)
+
+          # [:script]
+          if utxo.script_pubkey
+            key = KEY_PREFIX[:script] + utxo.script_pubkey.to_hex + out_point.to_hex
+            level_db.delete(key)
+          end
+
+          if utxo.block_height
+            # [:height]
+            key = KEY_PREFIX[:height] + [utxo.block_height].pack('N').bth + out_point.to_hex
+            level_db.delete(key)
+
+            # [:block]
+            key = KEY_PREFIX[:block] + [utxo.block_height, utxo.index].pack('N2').bth
+            level_db.delete(key)
+          end
+
+          # handles both [:tx_hash] and [:tx_payload]
+          if utxo.tx_hash
+            key = KEY_PREFIX[:tx_hash] + utxo.tx_hash
+            level_db.delete(key)
+
+            key = KEY_PREFIX[:tx_payload] + utxo.tx_hash
+            level_db.delete(key)
+          end
+
+          utxo
+        end
+      end
+
+      # Get utxo of the specified out point
+      #
+      # @param  [Bitcoin::Outpoint] out_point
+      # @return [Bitcoin::Wallet::Utxo]
+      def get_utxo(out_point)
+        level_db.batch do
+          key = KEY_PREFIX[:out_point] + out_point.to_hex
+          return unless level_db.contains?(key)
+          return Bitcoin::Wallet::Utxo.parse_from_payload(level_db.get(key))
+        end
+      end
+
+      # return [Bitcoin::Wallet::Utxo ...]
+      def list_unspent(current_block_height: 9999999, min: 0, max: 9999999, addresses: nil)
+        if addresses
+          list_unspent_by_addresses(current_block_height, min: min, max: max, addresses: addresses)
+        else
+          list_unspent_by_block_height(current_block_height, min: min, max: max)
+        end
+      end
+
+      # @param [Bitcoin::Wallet::Account]
+      # return [Bitcoin::Wallet::Utxo ...]
+      def list_unspent_in_account(account, current_block_height: 9999999, min: 0, max: 9999999)
+        return [] unless account
+
+        script_pubkeys = case account.purpose
+          when Bitcoin::Wallet::Account::PURPOSE_TYPE[:legacy]
+            account.watch_targets.map { |t| Bitcoin::Script.to_p2pkh(t).to_hex }
+          when Bitcoin::Wallet::Account::PURPOSE_TYPE[:nested_witness]
+            account.watch_targets.map { |t| Bitcoin::Script.to_p2wpkh(t).to_p2sh.to_hex }
+          when Bitcoin::Wallet::Account::PURPOSE_TYPE[:native_segwit]
+            account.watch_targets.map { |t| Bitcoin::Script.to_p2wpkh(t).to_hex }
+          end
+        list_unspent_by_script_pubkeys(current_block_height, min: min, max: max, script_pubkeys: script_pubkeys)
+      end
+
+      # @param [Bitcoin::Wallet::Account]
+      # return [Bitcoin::Wallet::Utxo ...]
+      def get_balance(account, current_block_height: 9999999, min: 0, max: 9999999)
+        list_unspent_in_account(account, current_block_height: current_block_height, min: min, max: max).sum { |u| u.value }
+      end
+
+      private
+
+      def utxos_between(from, to)
+        level_db.each(from: from, to: to).map { |k, v| Bitcoin::Wallet::Utxo.parse_from_payload(v) }
+      end
+
+      class ::Array
+        def with_height(min, max)
+          select { |u| u.block_height >= min && u.block_height <= max }
+        end
+      end
+
+      def list_unspent_by_block_height(current_block_height, min: 0, max: 9999999)
+        max_height = [current_block_height - min, 0].max
+        min_height = [current_block_height - max, 0].max
+        from = KEY_PREFIX[:height] + [min_height].pack('N').bth + '000000000000000000000000000000000000000000000000000000000000000000000000'
+        to = KEY_PREFIX[:height] + [max_height].pack('N').bth + 'ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff'
+        utxos_between(from, to)
+      end
+
+      def list_unspent_by_addresses(current_block_height, min: 0, max: 9999999, addresses: [])
+        script_pubkeys = addresses.map { |a| Bitcoin::Script.parse_from_addr(a).to_hex }
+        list_unspent_by_script_pubkeys(current_block_height, min: min, max: max, script_pubkeys: script_pubkeys)
+      end
+
+      def list_unspent_by_script_pubkeys(current_block_height, min: 0, max: 9999999, script_pubkeys: [])
+        max_height = current_block_height - min
+        min_height = current_block_height - max
+        script_pubkeys.map do |key|
+          from = KEY_PREFIX[:script] + key + '000000000000000000000000000000000000000000000000000000000000000000000000'
+          to = KEY_PREFIX[:script] + key + 'ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff'
+          utxos_between(from, to).with_height(min_height, max_height)
+        end.flatten
+      end
+    end
+  end
+end