tapyrus 0.1.0

data/lib/tapyrus/merkle_tree.rb

@@ -0,0 +1,149 @@
+module Tapyrus
+
+  # merkle tree
+  class MerkleTree
+
+    attr_accessor :root
+
+    def initialize(root = nil)
+      @root = root
+    end
+
+    def merkle_root
+      root.value
+    end
+
+    def self.build_from_leaf(txids)
+      if txids.size == 1
+        nodes = [Node.new(txids.first)]
+      else
+        nodes = txids.each_slice(2).map{ |m|
+          left = Node.new(m[0])
+          right = Node.new(m[1] ? m[1] : m[0])
+          [left, right]
+        }.flatten
+      end
+      new(build_initial_tree(nodes))
+    end
+
+    # https://bitcoin.org/en/developer-reference#creating-a-merkleblock-message
+    def self.build_partial(tx_count, hashes, flags)
+      flags = flags.each_char.map(&:to_i)
+      root = build_initial_tree( Array.new(tx_count) { Node.new })
+      current_node = root
+      hash_index = 0
+      flags.each do |f|
+        current_node.flag = f
+        if f.zero? || current_node.leaf?
+          current_node.value = hashes[hash_index]
+          hash_index += 1
+        end
+        current_node = current_node.next_partial
+        if hash_index == hashes.size
+          if current_node&.leaf?
+            current_node.value = hashes.last
+          end
+          break
+        end
+      end
+      new(root)
+    end
+
+    def self.build_initial_tree(nodes)
+      while nodes.size != 1
+        nodes = nodes.each_slice(2).map { |m|
+          parent = Node.new
+          parent.left = m[0]
+          parent.right = m[1] ? m[1] : m[0].dup
+          parent
+        }
+      end
+      nodes.first
+    end
+
+    def find_node(value)
+      root.find_node(value)
+    end
+
+    # node of merkle tree
+    class Node
+
+      attr_accessor :flag
+      attr_accessor :value
+      attr_accessor :parent
+      attr_accessor :left
+      attr_accessor :right
+
+      def initialize(value = nil)
+        @value = value
+      end
+
+      def left=(node)
+        node.parent = self
+        @left = node
+      end
+
+      def right=(node)
+        node.parent = self
+        @right = node
+      end
+
+      def value
+        return @value if @value
+        self.right = left.dup unless right
+        Tapyrus.double_sha256([left.value + right.value].pack('H*')).bth
+      end
+
+      def root?
+        parent.nil?
+      end
+
+      def leaf?
+        right.nil? && left.nil?
+      end
+
+      def partial?
+        !flag.nil?
+      end
+
+      def next_partial
+        return nil if root? && (flag.zero? || (left.nil? && right.nil?) || (left.partial? && right.partial?))
+        return parent.next_partial if flag.zero? || leaf?
+        return left unless left.partial?
+        self.right = left.dup unless right
+        right.partial? ? parent.next_partial : right
+      end
+
+      # calculate the depth of this node in the tree.
+      def depth
+        d = 0
+        current_node = self
+        until current_node.root? do
+          current_node = current_node.parent
+          d += 1
+        end
+        d
+      end
+
+      # @param target value to be found
+      # @return node which has same value as target. nil if this node and any children don't have same value.
+      def find_node(target)
+        return self if value == target
+        return nil if flag && flag.zero?
+        return left&.find_node(target) || right&.find_node(target)
+      end
+
+      def index
+        i = 0
+        d = 1
+        current_node = self
+        until current_node.root? do
+          i += d if current_node.parent.right == current_node
+          current_node = current_node.parent
+          d *= 2
+        end
+        i
+      end
+    end
+  end
+end

data/lib/tapyrus/message/addr.rb

@@ -0,0 +1,35 @@
+require 'ipaddr'
+
+module Tapyrus
+  module Message
+
+    # addr message
+    # https://bitcoin.org/en/developer-reference#addr
+    class Addr < Base
+
+      COMMAND = 'addr'
+
+      attr_reader :addrs
+
+      def initialize(addrs = [])
+        @addrs = addrs
+      end
+
+      def self.parse_from_payload(payload)
+        buf = StringIO.new(payload)
+        addr_count = Tapyrus.unpack_var_int_from_io(buf)
+        addr = new
+        addr_count.times do
+          addr.addrs << NetworkAddr.parse_from_payload(buf)
+        end
+        addr
+      end
+
+      def to_payload
+        Tapyrus.pack_var_int(addrs.length) << addrs.map(&:to_payload).join
+      end
+
+    end
+
+  end
+end

data/lib/tapyrus/message/base.rb

@@ -0,0 +1,28 @@
+module Tapyrus
+  module Message
+
+    # Base message class
+    class Base
+      include Tapyrus::Util
+      extend Tapyrus::Util
+
+      # generate message header (binary format)
+      # https://bitcoin.org/en/developer-reference#message-headers
+      def to_pkt
+        payload = to_payload
+        magic = Tapyrus.chain_params.magic_head.htb
+        command_name = self.class.const_get(:COMMAND, false).ljust(12, "\x00")
+        payload_size = [payload.bytesize].pack('V')
+        checksum = Tapyrus.double_sha256(payload)[0...4]
+        magic << command_name << payload_size << checksum << payload
+      end
+
+      # abstract method
+      def to_payload
+        raise 'to_payload must be implemented in a child class.'
+      end
+
+    end
+
+  end
+end

data/lib/tapyrus/message/block.rb

@@ -0,0 +1,46 @@
+module Tapyrus
+  module Message
+
+    # block message
+    # https://bitcoin.org/en/developer-reference#block
+    class Block < Base
+
+      attr_accessor :header
+      attr_accessor :transactions
+      attr_accessor :use_segwit
+
+      COMMAND = 'block'
+
+      def initialize(header, transactions = [], use_segwit = false)
+        @header = header
+        @transactions = transactions
+        @use_segwit = use_segwit
+      end
+
+      def self.parse_from_payload(payload)
+        buf = StringIO.new(payload)
+        header = Tapyrus::BlockHeader.parse_from_payload(buf.read(80))
+        transactions = []
+        unless buf.eof?
+          tx_count = Tapyrus.unpack_var_int_from_io(buf)
+          tx_count.times do
+            transactions << Tapyrus::Tx.parse_from_payload(buf)
+          end
+        end
+        new(header, transactions)
+      end
+
+      def to_payload
+        header.to_payload << Tapyrus.pack_var_int(transactions.size) <<
+          transactions.map{|t|use_segwit ? t.to_payload : t.serialize_old_format}.join
+      end
+
+      # generate Tapyrus::Block object.
+      def to_block
+        Tapyrus::Block.new(header, transactions)
+      end
+
+    end
+
+  end
+end

data/lib/tapyrus/message/block_transaction_request.rb

@@ -0,0 +1,45 @@
+module Tapyrus
+  module Message
+
+    # BIP-152 Compact Block's data format.
+    # https://github.com/bitcoin/bips/blob/master/bip-0152.mediawiki#BlockTransactionsRequest
+    class BlockTransactionRequest
+
+      attr_accessor :block_hash # When matching with Tapyrus::BlockHeader#hash It is necessary to reverse the byte order.
+      attr_accessor :indexes
+
+      def initialize(block_hash, indexes)
+        @block_hash = block_hash
+        @indexes = indexes
+      end
+
+      def self.parse_from_payload(payload)
+        buf = StringIO.new(payload)
+        block_hash = buf.read(32).bth
+        index_len = Tapyrus.unpack_var_int_from_io(buf)
+        indexes = index_len.times.map{Tapyrus.unpack_var_int_from_io(buf)}
+        # index data differentially encoded
+        offset = 0
+        index_len.times do |i|
+          index = indexes[i]
+          index += offset
+          indexes[i] = index
+          offset = index + 1
+        end
+        self.new(block_hash, indexes)
+      end
+
+      def to_payload
+        p = block_hash.htb << Tapyrus.pack_var_int(indexes.size)
+        indexes.size.times do |i|
+          index = indexes[i]
+          index -= indexes[i-1] + 1 if i > 0
+          p << Tapyrus.pack_var_int(index)
+        end
+        p
+      end
+
+    end
+
+  end
+end

data/lib/tapyrus/message/block_transactions.rb

@@ -0,0 +1,31 @@
+module Tapyrus
+  module Message
+
+    # BIP-152 Compact Block's data format.
+    # https://github.com/bitcoin/bips/blob/master/bip-0152.mediawiki#BlockTransactions
+    class BlockTransactions
+
+      attr_accessor :block_hash
+      attr_accessor :transactions
+
+      def initialize(block_hash, transactions)
+        @block_hash = block_hash
+        @transactions = transactions
+      end
+
+      def self.parse_from_payload(payload)
+        buf = StringIO.new(payload)
+        block_hash = buf.read(32).bth
+        tx_count = Tapyrus.unpack_var_int_from_io(buf)
+        txn = tx_count.times.map{Tapyrus::Tx.parse_from_payload(buf)}
+        self.new(block_hash, txn)
+      end
+
+      def to_payload
+        block_hash.htb << Tapyrus.pack_var_int(transactions.size) << transactions.map(&:to_payload).join
+      end
+
+    end
+
+  end
+end

data/lib/tapyrus/message/block_txn.rb

@@ -0,0 +1,27 @@
+module Tapyrus
+  module Message
+
+    # blocktxn message.
+    # https://github.com/bitcoin/bips/blob/master/bip-0152.mediawiki#blocktxn
+    class BlockTxn < Base
+
+      COMMAND = 'blocktxn'
+
+      attr_accessor :block_transactions
+
+      def initialize(block_transactions)
+        @block_transactions = block_transactions
+      end
+
+      def self.parse_from_payload(payload)
+        self.new(BlockTransactions.parse_from_payload(payload))
+      end
+
+      def to_payload
+        block_transactions.to_payload
+      end
+
+    end
+
+  end
+end

data/lib/tapyrus/message/cmpct_block.rb

@@ -0,0 +1,42 @@
+module Tapyrus
+  module Message
+
+    # cmpctblock message
+    # https://github.com/bitcoin/bips/blob/master/bip-0152.mediawiki
+    class CmpctBlock < Base
+
+      COMMAND = 'cmpctblock'
+
+      attr_accessor :header_and_short_ids
+
+      def initialize(header_and_short_ids)
+        @header_and_short_ids = header_and_short_ids
+      end
+
+      # generate CmpctBlock from Block data.
+      # @param [Tapyrus::Block] block the block to generate CmpctBlock.
+      # @param [Integer] version Compact Block version specified by sendcmpct message.
+      # @param [Integer] nonce
+      # @return [Tapyrus::Message::CmpctBlock]
+      def self.from_block(block, version, nonce = SecureRandom.hex(8).to_i(16))
+        raise 'Unsupported version.' unless [1, 2].include?(version)
+        h = HeaderAndShortIDs.new(block.header, nonce)
+        block.transactions[1..-1].each do |tx|
+          h.short_ids << h.short_id(version == 1 ? tx.txid : tx.wtxid)
+        end
+        h.prefilled_txn << PrefilledTx.new(0, block.transactions.first)
+        self.new(h)
+      end
+
+      def self.parse_from_payload(payload)
+        self.new(HeaderAndShortIDs.parse_from_payload(payload))
+      end
+
+      def to_payload
+        header_and_short_ids.to_payload
+      end
+
+    end
+
+  end
+end

data/lib/tapyrus/message/error.rb

@@ -0,0 +1,10 @@
+module Tapyrus
+  module Message
+
+    # P2P message layer Error
+    class Error < StandardError
+
+    end
+
+  end
+end

data/lib/tapyrus/message/fee_filter.rb

@@ -0,0 +1,27 @@
+module Tapyrus
+  module Message
+
+    # feefilter message
+    # https://bitcoin.org/en/developer-reference#feefilter
+    class FeeFilter < Base
+
+      COMMAND = 'feefilter'
+
+      # The fee rate (in satoshis per kilobyte)
+      attr_accessor :fee_rate
+
+      def initialize(fee_rate)
+        @fee_rate = fee_rate
+      end
+
+      def self.parse_from_payload(payload)
+        new(payload.unpack('Q').first)
+      end
+
+      def to_payload
+        [fee_rate].pack('Q')
+      end
+
+    end
+  end
+end

data/lib/tapyrus/message/filter_add.rb

@@ -0,0 +1,28 @@
+module Tapyrus
+  module Message
+
+    # filteradd message
+    # https://bitcoin.org/en/developer-reference#filteradd
+    class FilterAdd < Base
+
+      COMMAND = 'filteradd'
+
+      # element must be sent in the byte order they would use when appearing in a raw transaction;
+      attr_accessor :element
+
+      def initialize(element)
+        @element = element
+      end
+
+      def self.parse_from_payload(payload)
+        new(Tapyrus.unpack_var_string(payload).first.bth)
+      end
+
+      def to_payload
+        Tapyrus.pack_var_string(element.htb)
+      end
+
+    end
+
+  end
+end

data/lib/tapyrus/message/filter_clear.rb

@@ -0,0 +1,17 @@
+module Tapyrus
+  module Message
+
+    # filterclear message
+    # https://bitcoin.org/en/developer-reference#filterclear
+    class FilterClear < Base
+
+      COMMAND = 'filterclear'
+
+      def to_payload
+        ''
+      end
+
+    end
+
+  end
+end

data/lib/tapyrus/message/filter_load.rb

@@ -0,0 +1,39 @@
+module Tapyrus
+  module Message
+
+    # filterload message
+    # https://bitcoin.org/en/developer-reference#filterload
+    class FilterLoad < Base
+
+      COMMAND = 'filterload'
+
+      BLOOM_UPDATE_NONE = 0
+      BLOOM_UPDATE_ALL = 1
+      BLOOM_UPDATE_P2PUBKEY_ONLY = 2
+
+      attr_accessor :filter
+      attr_accessor :flag
+
+      def initialize(filter, flag = BLOOM_UPDATE_ALL)
+        @filter = filter
+        @flag = flag
+      end
+
+      def self.parse_from_payload(payload)
+        buf = StringIO.new(payload)
+        filter_count = Tapyrus.unpack_var_int_from_io(buf)
+        filter = buf.read(filter_count).unpack('C*')
+        func_count = buf.read(4).unpack('V').first
+        tweak = buf.read(4).unpack('V').first
+        flag = buf.read(1).unpack('C').first
+        FilterLoad.new(Tapyrus::BloomFilter.new(filter, func_count, tweak), flag)
+      end
+
+      def to_payload
+        Tapyrus.pack_var_int(filter.filter.size) << filter.filter.pack('C*') << [filter.hash_funcs, filter.tweak, flag].pack('VVC')
+      end
+
+    end
+
+  end
+end

data/lib/tapyrus/message/get_addr.rb

@@ -0,0 +1,17 @@
+module Tapyrus
+  module Message
+
+    # getaddr message
+    # https://bitcoin.org/en/developer-reference#getaddr
+    class GetAddr < Base
+
+      COMMAND = 'getaddr'
+
+      def to_payload
+        ''
+      end
+
+    end
+
+  end
+end

data/lib/tapyrus/message/get_block_txn.rb

@@ -0,0 +1,27 @@
+module Tapyrus
+  module Message
+
+    # getblocktxn message.
+    # https://github.com/bitcoin/bips/blob/master/bip-0152.mediawiki
+    class GetBlockTxn < Base
+
+      COMMAND = 'getblocktxn'
+
+      attr_accessor :request
+
+      def initialize(request)
+        @request = request
+      end
+
+      def self.parse_from_payload(payload)
+        self.new(BlockTransactionRequest.parse_from_payload(payload))
+      end
+
+      def to_payload
+        request.to_payload
+      end
+
+    end
+
+  end
+end

data/lib/tapyrus/message/get_blocks.rb

@@ -0,0 +1,29 @@
+module Tapyrus
+  module Message
+
+    # block message
+    # https://bitcoin.org/en/developer-reference#getblocks
+    class GetBlocks < Base
+      include HeadersParser
+      extend HeadersParser
+
+      COMMAND = 'getblocks'
+
+      # protocol version
+      attr_accessor :version
+
+      # block header hashes
+      attr_accessor :hashes
+
+      attr_accessor :stop_hash
+
+      def initialize(version, hashes, stop_hash = DEFAULT_STOP_HASH)
+        @version = version
+        @hashes = hashes
+        @stop_hash = stop_hash
+      end
+
+    end
+
+  end
+end

data/lib/tapyrus/message/get_data.rb

@@ -0,0 +1,21 @@
+module Tapyrus
+  module Message
+
+    # getdadta message
+    # https://bitcoin.org/en/developer-reference#getdata
+    class GetData < Base
+      include InventoriesParser
+      extend InventoriesParser
+
+      COMMAND ='getdata'
+
+      attr_reader :inventories
+
+      def initialize(inventories = [])
+        @inventories = inventories
+      end
+
+    end
+
+  end
+end

data/lib/tapyrus/message/get_headers.rb

@@ -0,0 +1,28 @@
+module Tapyrus
+  module Message
+
+    # getheaders message
+    # https://bitcoin.org/en/developer-reference#getheaders
+    class GetHeaders < Base
+      include HeadersParser
+      extend HeadersParser
+
+      COMMAND = 'getheaders'
+
+      # protocol version
+      attr_accessor :version
+
+      # block header hashes
+      attr_accessor :hashes
+
+      attr_accessor :stop_hash
+
+      def initialize(version, hashes, stop_hash = DEFAULT_STOP_HASH)
+        @version = version
+        @hashes = hashes
+        @stop_hash = stop_hash
+      end
+
+    end
+  end
+end