tapyrus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 73863e0b35030aee45baa96661f5bbd0322e78381be022d8372e620f8cd8668c
+  data.tar.gz: 3f6378420bb9940a4829e378bb9975c67f5e5c5b61e4c5e077d85f83e0f59715
+SHA512:
+  metadata.gz: 5ffa34b251d363ade9355430980d50d233c104071b15f46535fee2009b8826f4b163891e384cec997b72e2680387cd3d200b55a41c4ebda8c359fdf6f965f091
+  data.tar.gz: c3860a9b13c2f43ef55b47cb985eb9467d5c4fdf9f1436b6c0e97b9a1b04a2ecdcd726e0103baa5ccd302753cc460f0240c0cd76c32cc08347e46e997e0ec7d6

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+bitcoinrbd.yml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+tapyrusrb

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
+addons:
+  apt:
+    packages:
+      - libleveldb-dev
+bundler_args: --jobs=2
+script:
+  - bundle exec rake spec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at azuchi@haw.co.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tapyrusrb.gemspec
+gemspec
+
+gem 'parallel_tests'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017-2019 HAW International, Inc. / chaintope, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+# Tapyrusrb [![Build Status](https://travis-ci.org/chaintope/tapyrusrb.svg?branch=master)](https://travis-ci.org/chaintope/tapyrusrb) [![Gem Version](https://badge.fury.io/rb/tapyrus.svg)](https://badge.fury.io/rb/tapyrus) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)
+
+
+Tapyrusrb is a Ruby implementation of [Tapyrus](https://github.com/chaintope/tapyrus-core) Protocol.
+
+NOTE: Tapyrusrb work in progress, and there is a possibility of incompatible change. 
+
+## Features
+
+Tapyrusrb supports following feature:
+
+* Tapyrus script interpreter
+* De/serialization of Tapyrus 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.
+* ECDSA signature(RFC6979 -Deterministic ECDSA, LOW-S, LOW-R support)
+* [WIP] SPV node
+* [WIP] 0ff-chain protocol
+
+## Requirements
+
+### use Node implementation
+
+If you use node features, please install level DB as follows.
+
+#### install LevelDB
+
+* for Ubuntu
+
+    $ sudo apt-get install libleveldb-dev
+
++ for Mac
+
+    $ brew install leveldb
+
+and put `leveldb-native` in your Gemfile and run bundle install.
+
+```
+gem leveldb-native
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tapyrus'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tapyrus
+
+And then add to your .rb file:
+
+    require 'tapyrus'
+
+## Usage
+
+### Chain selection
+
+The parameters of the blockchain are managed by `Tapyrus::ChainParams`. Switch chain parameters as follows:
+
+* mainnet
+
+```ruby
+Tapyrus.chain_params = :mainnet
+```
+
+This parameter is described in https://github.com/chaintope/tapyrusrb/blob/master/lib/tapyrus/chainparams/mainnet.yml.
+
+* testnet
+
+```ruby
+Tapyrus.chain_params = :testnet
+```
+
+This parameter is described in https://github.com/chaintope/tapyrusrb/blob/master/lib/tapyrus/chainparams/testnet.yml.
+
+* regtest
+
+```ruby
+Tapyrus.chain_params = :regtest
+```
+
+This parameter is described in https://github.com/chaintope/tapyrusrb/blob/master/lib/tapyrus/chainparams/regtest.yml.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tapyrusrb. 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tapyrus"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/tapyrusrb-cli

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'tapyrus'
+
+Tapyrus::Node::CLI.start(ARGV)

data/exe/tapyrusrbd

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+require 'thor'
+require 'tapyrus'
+require 'daemon_spawn'
+
+class TapyrusDaemon < DaemonSpawn::Base
+
+  def start(args)
+    puts "Tapyrusrb daemon start : #{Time.now}"
+    conf = Tapyrus::Node::Configuration.new(network: args.first[:network])
+    node = Tapyrus::Node::SPV.new(conf)
+    node.run
+  end
+
+end
+
+class Tapyrusrbd < Thor
+
+  class_option :network, aliases: '-n', default: :mainnet
+
+  desc 'start', 'start tapyrusrb daemon.'
+  def start
+    network = options['network'] ? options['network'].to_sym : :mainnet
+    Tapyrus.chain_params = network
+    FileUtils.mkdir_p(Tapyrus.base_dir)
+    execute_daemon(['start', network: network])
+  end
+
+  private
+
+  def execute_daemon(cmd_args)
+    TapyrusDaemon.spawn!({working_dir: Tapyrus.base_dir,
+                          log_file: "#{Tapyrus.base_dir}/log/tapyrusrbd.log",
+                          pid_file: "#{Tapyrus.base_dir}/tapyrusrbd.pid",
+                          sync_log: true,
+                          singleton: true}, cmd_args)
+  end
+
+end
+
+Tapyrusrbd.start(ARGV)

data/lib/openassets/marker_output.rb

@@ -0,0 +1,20 @@
+module OpenAssets
+
+  module MarkerOutput
+
+    # whether this output is marker output for open assets.
+    def open_assets_marker?
+      return false unless script_pubkey.op_return?
+      !oa_payload.nil?
+    end
+
+    # get open asset payload.
+    # @return [OpenAssets::Payload] open asset payload.
+    def oa_payload
+      return nil unless script_pubkey.op_return?
+      Payload.parse_from_payload(script_pubkey.op_return_data)
+    end
+
+  end
+
+end

data/lib/openassets/payload.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module OpenAssets
+
+  MARKER = "\x4f\x41"
+  VERSION = "\x01\x00"
+
+  # the open assets payload
+  class Payload
+
+    attr_accessor :quantities
+    attr_accessor :metadata
+
+    def initialize(quantities = [], metadata = '')
+      @quantities = quantities
+      @metadata = metadata
+    end
+
+    # parse open assets payload
+    # @return [Payload] a open assets payload object, if payload is invalid, return nil.
+    def self.parse_from_payload(payload)
+      buf = StringIO.new(payload)
+      marker = buf.read(2)
+      version = buf.read(2)
+      return nil if marker != MARKER || version != VERSION
+      count = Tapyrus.unpack_var_int_from_io(buf)
+      return nil unless count
+      quantities = []
+      count.times do
+        quantities << LEB128.decode_unsigned(buf, buf.pos)
+      end
+      metadata_length = Tapyrus.unpack_var_int_from_io(buf)
+      return nil if metadata_length.nil? || buf.length < metadata_length + buf.pos
+      metadata = buf.read(metadata_length).each_byte.map(&:chr).join
+      new(quantities, metadata)
+    rescue
+      # LEB128#decode_unsigned raise 'undefined method `unpack' for nil:NilClass'
+      # for invalid format such as "018f8f" (the most significant bit of the last byte should be 0)
+      nil
+    end
+
+    # generate binary payload
+    def to_payload
+      payload = String.new
+      payload << MARKER
+      payload << VERSION
+      payload << Tapyrus.pack_var_int(quantities.size) << quantities.map{|q| LEB128.encode_unsigned(q).read }.join
+      payload << Tapyrus.pack_var_int(metadata.length) << metadata.bytes.map{|b| sprintf("%02x", b)}.join.htb
+      payload
+    end
+
+  end
+
+end

data/lib/openassets/util.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module OpenAssets
+  module Util
+    class << self
+      OA_VERSION_BYTE = '17' # 0x23
+      OA_VERSION_BYTE_TESTNET = '73' # 0x115
+
+      def script_to_asset_id(script)
+        hash_to_asset_id(Tapyrus.hash160(script))
+      end
+
+      private
+
+      def hash_to_asset_id(hash)
+        hash = oa_version_byte + hash
+        Tapyrus::Base58.encode(hash + Tapyrus.calc_checksum(hash))
+      end
+
+      def oa_version_byte
+        case Tapyrus.chain_params.network
+        when 'mainnet' then OA_VERSION_BYTE
+        when 'testnet', 'regtest' then OA_VERSION_BYTE_TESTNET
+        end
+      end
+    end
+  end
+end

data/lib/openassets.rb

@@ -0,0 +1,9 @@
+require 'leb128'
+
+module OpenAssets
+
+  autoload :MarkerOutput, 'openassets/marker_output'
+  autoload :Payload, 'openassets/payload'
+  autoload :Util, 'openassets/util'
+
+end

data/lib/tapyrus/base58.rb

@@ -0,0 +1,38 @@
+module Tapyrus
+
+  # Base58Check encoding
+  # https://en.bitcoin.it/wiki/Base58Check_encoding
+  module Base58
+    module_function
+
+    ALPHABET = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz'
+    SIZE = ALPHABET.size
+
+    # encode hex value to base58 string.
+    def encode(hex)
+      leading_zero_bytes = (hex.match(/^([0]+)/) ? $1 : '').size / 2
+      int_val = hex.to_i(16)
+      base58_val = ''
+      while int_val > 0
+        int_val, remainder = int_val.divmod(SIZE)
+        base58_val = ALPHABET[remainder] + base58_val
+      end
+      ('1' * leading_zero_bytes) + base58_val
+    end
+
+    # decode base58 string to hex value.
+    def decode(base58_val)
+      int_val = 0
+      base58_val.reverse.split(//).each_with_index do |char,index|
+        raise ArgumentError, 'Value passed not a valid Base58 String.' if (char_index = ALPHABET.index(char)).nil?
+        int_val += char_index * (SIZE ** index)
+      end
+      s = int_val.to_even_length_hex
+      s = '' if s == '00'
+      leading_zero_bytes = (base58_val.match(/^([1]+)/) ? $1 : '').size
+      s = ('00' * leading_zero_bytes) + s if leading_zero_bytes > 0
+      s
+    end
+
+  end
+end

data/lib/tapyrus/block.rb

@@ -0,0 +1,77 @@
+module Tapyrus
+  class Block
+
+    attr_accessor :header
+    attr_accessor :transactions
+
+    def initialize(header, transactions = [])
+      @header = header
+      @transactions = transactions
+    end
+
+    def self.parse_from_payload(payload)
+      Tapyrus::Message::Block.parse_from_payload(payload).to_block
+    end
+
+    def hash
+      header.hash
+    end
+
+    def block_hash
+      header.block_hash
+    end
+
+    # calculate block weight
+    def weight
+      stripped_size * (WITNESS_SCALE_FACTOR - 1) + size
+    end
+
+    # calculate total size (include witness data.)
+    def size
+      80 + Tapyrus.pack_var_int(transactions.size).bytesize +
+          transactions.inject(0){|sum, tx| sum + (tx.witness? ? tx.serialize_witness_format.bytesize : tx.serialize_old_format.bytesize)}
+    end
+
+    # calculate base size (not include witness data.)
+    def stripped_size
+      80 + Tapyrus.pack_var_int(transactions.size).bytesize +
+          transactions.inject(0){|sum, tx| sum + tx.serialize_old_format.bytesize}
+    end
+
+    # check the merkle root in the block header matches merkle root calculated from tx list.
+    def valid_merkle_root?
+      calculate_merkle_root == header.merkle_root
+    end
+
+    # calculate merkle root from tx list.
+    def calculate_merkle_root
+      Tapyrus::MerkleTree.build_from_leaf(transactions.map(&:tx_hash)).merkle_root
+    end
+
+    # check the witness commitment in coinbase tx matches witness commitment calculated from tx list.
+    def valid_witness_commitment?
+      transactions[0].witness_commitment == calculate_witness_commitment
+    end
+
+    # calculate witness commitment from tx list.
+    def calculate_witness_commitment
+      witness_hashes = [COINBASE_WTXID]
+      witness_hashes += (transactions[1..-1].map(&:witness_hash))
+      reserved_value = transactions[0].inputs[0].script_witness.stack.map(&:bth).join
+      root_hash = Tapyrus::MerkleTree.build_from_leaf(witness_hashes).merkle_root
+      Tapyrus.double_sha256([root_hash + reserved_value].pack('H*')).bth
+    end
+
+    # return this block height. block height is included in coinbase.
+    # if block version under 1, height does not include in coinbase, so return nil.
+    def height
+      return nil if header.version < 2
+      coinbase_tx = transactions[0]
+      return nil unless coinbase_tx.coinbase_tx?
+      buf = StringIO.new(coinbase_tx.inputs[0].script_sig.to_payload)
+      len = Tapyrus.unpack_var_int_from_io(buf)
+      buf.read(len).reverse.bth.to_i(16)
+    end
+
+  end
+end

data/lib/tapyrus/block_header.rb

@@ -0,0 +1,88 @@
+module Tapyrus
+
+  # Block Header
+  class BlockHeader
+
+    attr_accessor :version
+    attr_accessor :prev_hash
+    attr_accessor :merkle_root
+    attr_accessor :time # unix timestamp
+    attr_accessor :bits
+    attr_accessor :nonce
+
+    def initialize(version, prev_hash, merkle_root, time, bits, nonce)
+      @version = version
+      @prev_hash = prev_hash
+      @merkle_root = merkle_root
+      @time = time
+      @bits = bits
+      @nonce = nonce
+    end
+
+    def self.parse_from_payload(payload)
+      version, prev_hash, merkle_root, time, bits, nonce = payload.unpack('Va32a32VVV')
+      new(version, prev_hash.bth, merkle_root.bth, time, bits, nonce)
+    end
+
+    def to_payload
+      [version, prev_hash.htb, merkle_root.htb, time, bits, nonce].pack('Va32a32VVV')
+    end
+
+    # compute difficulty target from bits.
+    def difficulty_target
+      exponent = ((bits >> 24) & 0xff)
+      mantissa = bits & 0x7fffff
+      mantissa *= -1 if (bits & 0x800000) > 0
+      (mantissa * 2 ** (8 * (exponent - 3)))
+    end
+
+    def hash
+      calc_hash.to_i(16)
+    end
+
+    def block_hash
+      calc_hash
+    end
+
+    # block hash(big endian)
+    def block_id
+      block_hash.rhex
+    end
+
+    # evaluate block header
+    def valid?
+      valid_pow? && valid_timestamp?
+    end
+
+    # evaluate valid proof of work.
+    def valid_pow?
+      block_id.hex < difficulty_target
+    end
+
+    # evaluate valid timestamp.
+    # https://en.bitcoin.it/wiki/Block_timestamp
+    def valid_timestamp?
+      time <= Time.now.to_i + Tapyrus::MAX_FUTURE_BLOCK_TIME
+    end
+
+    # compute chain work of this block.
+    # @return [Integer] a chain work.
+    def work
+      target = difficulty_target
+      return 0 if target < 1
+      115792089237316195423570985008687907853269984665640564039457584007913129639936.div(target + 1) # 115792089237316195423570985008687907853269984665640564039457584007913129639936 is 2**256
+    end
+
+    def ==(other)
+      other && other.to_payload == to_payload
+    end
+
+    private
+
+    def calc_hash
+      Tapyrus.double_sha256(to_payload).bth
+    end
+
+  end
+
+end