bitcoinrb 0.3.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df5d412165565c3dde3e626417f6a08e08d8698f66712c080b967f5d1e4e1688
-  data.tar.gz: 305d2ffba9338edfb26364da1d76ed166c1d2bbb253a2f3337db346a565247ea
+  metadata.gz: af836e45167490d93d1d9b5d8f29f4e473a78dc314b98cd789bb47e347a42037
+  data.tar.gz: 020fe745057f3b987c8bd8828be9f7f657d3085a7d8ee37cf0218b0761202325
 SHA512:
-  metadata.gz: 171bd45d707d1d49398d1f272ee7559bc88b5df66a8a4c15afbc107eb9c631eb243c3fad3ec3073d455c8e6c49048ddcd0bedbe96cb4c06b6af7daaad9d31c20
-  data.tar.gz: ef995e0e5db4d6b7352de9f7efa7d97bd2a6c0de39c811e352595c89a6b79966ab50304b7e0059bc7c2afff1826a37c99748233f79956d1dca80a745d6aec888
+  metadata.gz: 0db2c744f372a2e71c337cb8970bb8cad81f37aa81824504d5fe6ee46819516ca6869c3cab0af1474aa0906905496af3e8f97eacc6cdaf9b7eced0a6cd247ff2
+  data.tar.gz: dab1256db8085c43ec5ab5d784d465cbdb3d74e663d4f052fd76161decacd9fb5fe22b3c2f99cc20381dda8ea203d63866db45e6e8c8ed6d8b4a2d4c27acfe89

data/.github/workflows/ruby.yml

@@ -0,0 +1,37 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install leveldb
+      run: sudo apt-get install libleveldb-dev
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake spec

data/.rspec_parallel

@@ -0,0 +1,2 @@
+--format ParallelTests::RSpec::RuntimeLogger --out tmp/parallel_runtime_rspec.log
+--format ParallelTests::RSpec::SummaryLogger --out tmp/spec_summary.log

data/.ruby-version

@@ -1 +1 @@
-2.6.3
+ruby-3.0.0

data/README.md

@@ -1,4 +1,4 @@
-# Bitcoinrb [![Build Status](https://travis-ci.org/chaintope/bitcoinrb.svg?branch=master)](https://travis-ci.org/chaintope/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">
+# Bitcoinrb [![Build Status](https://github.com/chaintope/bitcoinrb/actions/workflows/ruby.yml/badge.svg?branch=master)](https://github.com/chaintope/bitcoinrb/actions/workflows/ruby.yml) [![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">
 
 
 Bitcoinrb is a Ruby implementation of Bitcoin Protocol.
@@ -9,14 +9,17 @@ NOTE: Bitcoinrb work in progress, and there is a possibility of incompatible cha
 
 Bitcoinrb supports following feature:
 
-* Bitcoin script interpreter(including [BIP-65](https://github.com/bitcoin/bips/blob/master/bip-0065.mediawiki), [BIP-68](https://github.com/bitcoin/bips/blob/master/bip-0068.mediawiki), [BIP-112](https://github.com/bitcoin/bips/blob/master/bip-0112.mediawiki))
-* De/serialization of Bitcoin protocol network messages
-* De/serialization of blocks and transactions
+* [Bitcoin script interpreter](https://github.com/chaintope/bitcoinrb/wiki/Script)(including [BIP-65](https://github.com/bitcoin/bips/blob/master/bip-0065.mediawiki), [BIP-68](https://github.com/bitcoin/bips/blob/master/bip-0068.mediawiki), [BIP-112](https://github.com/bitcoin/bips/blob/master/bip-0112.mediawiki))
+* [De/serialization of Bitcoin protocol network messages](https://github.com/chaintope/bitcoinrb/wiki/P2P-Message)
+* De/serialization of blocks and [transactions](https://github.com/chaintope/bitcoinrb/wiki/Transaction)
 * 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.
 * ECDSA signature(RFC6979 -Deterministic ECDSA, LOW-S, LOW-R support)
 * Segwit support (parsing segwit payload, Bech32 address, sign for segwit tx, [BIP-141](https://github.com/bitcoin/bips/blob/master/bip-0141.mediawiki), [BIP-143](https://github.com/bitcoin/bips/blob/master/bip-0143.mediawiki), [BIP-144](https://github.com/bitcoin/bips/blob/master/bip-0144.mediawiki))
 * [BIP-173](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki) Bech32 address support
 * [BIP-174](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki) PSBT(Partially Signed Bitcoin Transaction) support
+* [BIP-85](https://github.com/bitcoin/bips/blob/master/bip-0085.mediawiki) Deterministic Entropy From BIP32 Keychains support by `Bitcoin::BIP85Entropy` class.
+* Schnorr signature([BIP-340](https://github.com/bitcoin/bips/blob/master/bip-0340.mediawiki))  
+* Taproot consensus([BIP-341](https://github.com/bitcoin/bips/blob/master/bip-0341.mediawiki) and [BIP-342](https://github.com/bitcoin/bips/blob/master/bip-0342.mediawiki))  
 * [WIP] SPV node
 * [WIP] 0ff-chain protocol
 
@@ -38,8 +41,8 @@ If you use node features, please install level DB as follows.
 
 and put `leveldb-native` in your Gemfile and run bundle install.
 
-```
-gem leveldb-native
+```ruby
+gem 'leveldb-native'
 ```
 
 ## Installation
@@ -92,6 +95,14 @@ Bitcoin.chain_params = :regtest
 
 This parameter is described in https://github.com/chaintope/bitcoinrb/blob/master/lib/bitcoin/chainparams/regtest.yml.
 
+* default signet
+
+```ruby
+Bitcoin.chain_params = :signet
+```
+
+This parameter is described in https://github.com/chaintope/bitcoinrb/blob/master/lib/bitcoin/chainparams/signet.yml.
+
 ## 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

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["azuchi"]
   spec.email         = ["azuchi@chaintope.com"]
 
-  spec.summary       = %q{[WIP]The implementation of Bitcoin Protocol for Ruby.}
-  spec.description   = %q{[WIP]The implementation of Bitcoin Protocol for Ruby.}
+  spec.summary       = %q{The implementation of Bitcoin Protocol for Ruby.}
+  spec.description   = %q{The implementation of Bitcoin Protocol for Ruby.}
   spec.homepage      = 'https://github.com/chaintope/bitcoinrb'
   spec.license       = "MIT"
 
@@ -23,25 +23,26 @@ 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.3'
+  spec.add_runtime_dependency 'bech32', '~> 1.1.0'
   spec.add_runtime_dependency 'daemon-spawn'
   spec.add_runtime_dependency 'thor'
   spec.add_runtime_dependency 'ffi'
   spec.add_runtime_dependency 'leb128', '~> 1.0.0'
   spec.add_runtime_dependency 'eventmachine_httpserver'
-  spec.add_runtime_dependency 'rest-client'
   spec.add_runtime_dependency 'iniparse'
   spec.add_runtime_dependency 'siphash'
   spec.add_runtime_dependency 'protobuf', '3.8.5'
-  spec.add_runtime_dependency 'scrypt'
-  spec.add_runtime_dependency 'activesupport', '~> 5.2.3'
+  spec.add_runtime_dependency 'json_pure', '>= 2.3.1'
+  spec.add_runtime_dependency 'bip-schnorr', '>= 0.4.0'
+  spec.add_runtime_dependency 'base32', '>= 0.3.4'
 
   # for options
   spec.add_development_dependency 'leveldb-native'
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'timecop'
-
+  spec.add_development_dependency 'webmock', '>= 3.11.1'
+  spec.add_development_dependency 'parallel', '>= 1.20.1'
 end

data/exe/bitcoinrbd

@@ -12,6 +12,11 @@ class BitcoinDaemon < DaemonSpawn::Base
     node.run
   end
 
+  def stop
+    puts "Stopping Bitcoinrb daemon : #{Time.now}"
+    node.shutdown
+  end
+
 end
 
 class Bitcoinrbd < Thor

data/lib/bitcoin.rb

@@ -3,7 +3,7 @@
 
 require 'bitcoin/version'
 require 'eventmachine'
-require 'ecdsa'
+require 'schnorr'
 require 'securerandom'
 require 'json'
 require 'bech32'
@@ -14,6 +14,7 @@ require_relative 'openassets'
 
 module Bitcoin
 
+  autoload :Ext, 'bitcoin/ext'
   autoload :Util, 'bitcoin/util'
   autoload :ChainParams, 'bitcoin/chain_params'
   autoload :Message, 'bitcoin/message'
@@ -54,8 +55,16 @@ module Bitcoin
   autoload :KeyPath, 'bitcoin/key_path'
   autoload :Descriptor, 'bitcoin/descriptor'
   autoload :SLIP39, 'bitcoin/slip39'
+  autoload :Aezeed, 'bitcoin/aezeed'
+  autoload :PaymentCode, 'bitcoin/payment_code'
+  autoload :BIP85Entropy, 'bitcoin/bip85_entropy'
+  autoload :Errors, 'bitcoin/errors'
+  autoload :SigHashGenerator, 'bitcoin/sighash_generator'
+  autoload :MessageSign, 'bitcoin/message_sign'
+  autoload :Taproot, 'bitcoin/taproot'
 
   require_relative 'bitcoin/constants'
+  require_relative 'bitcoin/ext/ecdsa'
 
   extend Util
 
@@ -63,7 +72,7 @@ module Bitcoin
 
   # set bitcoin network chain params
   def self.chain_params=(name)
-    raise "chain params for #{name} is not defined." unless %i(mainnet testnet regtest).include?(name.to_sym)
+    raise "chain params for #{name} is not defined." unless %i(mainnet testnet regtest signet).include?(name.to_sym)
     @current_chain = nil
     @chain_param = name.to_sym
   end
@@ -78,6 +87,8 @@ module Bitcoin
       @current_chain = Bitcoin::ChainParams.testnet
     when :regtest
       @current_chain = Bitcoin::ChainParams.regtest
+    when :signet
+      @current_chain = Bitcoin::ChainParams.signet
     end
     @current_chain
   end
@@ -104,7 +115,7 @@ module Bitcoin
   class ::String
     # binary convert to hex string
     def bth
-      unpack('H*').first
+      unpack1('H*')
     end
 
     # hex string convert to binary
@@ -124,14 +135,7 @@ module Bitcoin
 
     # get opcode
     def opcode
-      case encoding
-      when Encoding::ASCII_8BIT
-        each_byte.next
-      when Encoding::US_ASCII
-        ord
-      else
-        to_i
-      end
+      force_encoding(Encoding::ASCII_8BIT).ord
     end
 
     def opcode?
@@ -161,6 +165,27 @@ module Bitcoin
       self[offset..-1]
     end
 
+    def valid_pushdata_length?
+      buf = StringIO.new(self)
+      opcode = buf.read(1).ord
+      offset = 1
+      return false if buf.eof?
+      len = case opcode
+            when Bitcoin::Opcodes::OP_PUSHDATA1
+              offset += 1
+              buf.read(1).unpack1('C')
+            when Bitcoin::Opcodes::OP_PUSHDATA2
+              offset += 2
+              buf.read(2).unpack1('v')
+            when Bitcoin::Opcodes::OP_PUSHDATA4
+              offset += 4
+              buf.read(4).unpack1('V')
+            else
+              opcode
+            end
+      self.bytesize == len + offset
+    end
+
     # whether value is hex or not hex
     # @return [Boolean] return true if data is hex
     def valid_hex?
@@ -188,7 +213,7 @@ module Bitcoin
         if value.is_a?(Array)
           result.update(key => value.map{|v|v.to_h})
         else
-          result.update(key => value)
+          result.update(key => value.class.to_s.start_with?("Bitcoin::") ? value.to_h : value)
         end
       end
     end
@@ -215,11 +240,4 @@ module Bitcoin
     end
   end
 
-  class ::ECDSA::Signature
-    # convert signature to der string.
-    def to_der
-      ECDSA::Format::SignatureDerString.encode(self)
-    end
-  end
-
 end

data/lib/bitcoin/bip85_entropy.rb

@@ -0,0 +1,111 @@
+module Bitcoin
+
+  # Deterministic Entropy From BIP32 Keychains
+  # https://github.com/bitcoin/bips/blob/master/bip-0085.mediawiki
+  class BIP85Entropy
+
+    BIP85_PATH = 83696968 + HARDENED_THRESHOLD
+
+    include Bitcoin::KeyPath
+
+    attr_reader :root_key #hex format
+
+    # Import root key.
+    # @param [String] base58 master bip32 root key.
+    # @return [Bitcoin::BIP85Entropy]
+    def self.from_base58(base58)
+      key = Bitcoin::ExtKey.from_base58(base58)
+      self.new(key)
+    end
+
+    # derive entropy
+    # @param [String] path derive path.
+    # @return [Tuple(String, Object)] a tuple of entropy with hex format and results depending the application.
+    def derive(path)
+      raise ArgumentError, "Invalid BIP85 path format." unless path.start_with?("m/83696968'")
+      derived_key = root_key
+      parse_key_path(path).each{|num| derived_key = derived_key.derive(num)}
+      derived_key = derived_key.priv
+      entropy = Bitcoin.hmac_sha512("bip-entropy-from-k", derived_key.htb).bth
+      app_no = path.split('/')[2]
+      case app_no
+      when "39'"
+        bip39_entropy(path, entropy)
+      when "2'"
+        hd_seed_entropy(entropy)
+      when "32'"
+        xprv_entropy(entropy)
+      else
+        [entropy, entropy]
+      end
+    end
+
+    private
+
+    def initialize(root_key)
+      @root_key = root_key
+    end
+
+    # derive BIP39 entropy.
+    def bip39_entropy(path, entropy)
+      params = path.split('/')
+      word_len = params[4]
+      language = code_to_language(params[3])
+      entropy = case word_len
+                when "12'"
+                  entropy[0...32]
+                when "18'"
+                  entropy[0...48]
+                when "24'"
+                  entropy[0...64]
+                else
+                  raise ArgumentError, "Word length #{word_len} does not supported."
+                end
+      mnemonic = Bitcoin::Mnemonic.new(language)
+      [entropy, mnemonic.to_mnemonic(entropy)]
+    end
+
+    # derive HD-Seed WIF entropy.
+    def hd_seed_entropy(entropy)
+      result = entropy[0...64]
+      [result, Bitcoin::Key.new(priv_key: result).to_wif]
+    end
+
+    # derive xprv entropy
+    def xprv_entropy(entropy)
+      chaincode = entropy[0...64]
+      private_key = Bitcoin::Key.new(priv_key: entropy[64..-1])
+      ext_key = Bitcoin::ExtKey.new
+      ext_key.key = private_key
+      ext_key.chain_code = chaincode.htb
+      ext_key.depth = 0
+      ext_key.number = 0
+      ext_key.parent_fingerprint = Bitcoin::ExtKey::MASTER_FINGERPRINT
+      [entropy, ext_key.to_base58]
+    end
+
+    # convert language code to language string.
+    def code_to_language(code)
+      case code
+      when "0'"
+        "english"
+      when "1'"
+        "japanese"
+      when "3'"
+        "spanish"
+      when "4'"
+        "chinese_simplified"
+      when "5'"
+        "chinese_traditional"
+      when "6'"
+        "french"
+      when "7'"
+        "italian"
+      else
+        raise ArgumentError, "bitcoinrb does not support language: #{code}"
+      end
+    end
+
+  end
+
+end

data/lib/bitcoin/block_filter.rb

@@ -43,6 +43,20 @@ module Bitcoin
       BlockFilter.new(filter_type, filter, block.block_hash)
     end
 
+    # Decode Block Filter from encoded filter
+    # @param [Integer] filter_type filter type.
+    # @param [String] block_hash block hash with hex format. not little endian.
+    # @param [String] encoded encoded_filter with hex format.
+    # @return [Bitcoin::BlockFilter] block filter object.
+    def self.decode(filter_type, block_hash, encoded)
+      filter = case filter_type
+               when TYPE[:basic]
+                GCSFilter.new(block_hash.htb[0...16], BASIC_FILTER_P, BASIC_FILTER_M, encoded_filter: encoded)
+              else
+                raise "unknown filter type: #{filter_type}."
+               end
+      BlockFilter.new(filter_type, filter, block_hash)
+    end
 
     # calculate filter hash.
     # @return [String] this filter hash with hex format.

data/lib/bitcoin/block_header.rb

@@ -3,6 +3,8 @@ module Bitcoin
   # Block Header
   class BlockHeader
 
+    include Bitcoin::HexConverter
+
     attr_accessor :version
     attr_accessor :prev_hash
     attr_accessor :merkle_root

data/lib/bitcoin/chain_params.rb

@@ -36,9 +36,6 @@ module Bitcoin
 
     attr_accessor :dust_relay_fee
 
-    # fork coin id.
-    attr_accessor :fork_id
-
     # mainnet genesis
     def self.mainnet
       init('mainnet')
@@ -54,6 +51,11 @@ module Bitcoin
       init('regtest')
     end
 
+    # signet genesis
+    def self.signet
+      init('signet')
+    end
+
     def mainnet?
       network == 'mainnet'
     end
@@ -66,6 +68,10 @@ module Bitcoin
       network == 'regtest'
     end
 
+    def signet?
+      network == 'signet'
+    end
+
     def genesis_block
       header = Bitcoin::BlockHeader.new(
           genesis['version'], genesis['prev_hash'].rhex, genesis['merkle_root'].rhex,
@@ -73,11 +79,6 @@ module Bitcoin
       Bitcoin::Block.new(header)
     end
 
-    # whether fork coin.
-    def fork_chain?
-      !fork_id.nil?
-    end
-
     def self.init(name)
       i = YAML.load(File.open("#{__dir__}/chainparams/#{name}.yml"))
       i.dust_relay_fee ||= Bitcoin::DUST_RELAY_TX_FEE