tapyrus 0.1.0

data/lib/tapyrus/message/header_and_short_ids.rb

@@ -0,0 +1,57 @@
+require 'siphash'
+module Tapyrus
+  module Message
+
+    # BIP-152 Compact Block's data format.
+    # https://github.com/bitcoin/bips/blob/master/bip-0152.mediawiki#HeaderAndShortIDs
+    class HeaderAndShortIDs
+      attr_accessor :header
+      attr_accessor :nonce
+      attr_accessor :short_ids
+      attr_accessor :prefilled_txn
+      attr_accessor :siphash_key
+
+      def initialize(header, nonce, short_ids = [], prefilled_txn = [])
+        @header = header
+        @nonce = nonce
+        @short_ids = short_ids
+        @prefilled_txn = prefilled_txn
+        @siphash_key = Tapyrus.sha256(header.to_payload << [nonce].pack('q*'))[0...16]
+      end
+
+      def self.parse_from_payload(payload)
+        buf = StringIO.new(payload)
+        header = Tapyrus::BlockHeader.parse_from_payload(buf.read(80))
+        nonce = buf.read(8).unpack('q*').first
+        short_ids_len = Tapyrus.unpack_var_int_from_io(buf)
+        short_ids = short_ids_len.times.map do
+           buf.read(6).reverse.bth.to_i(16)
+        end
+        prefilled_txn_len = Tapyrus.unpack_var_int_from_io(buf)
+        prefilled_txn = prefilled_txn_len.times.map do
+          PrefilledTx.parse_from_io(buf)
+        end
+        self.new(header, nonce, short_ids, prefilled_txn)
+      end
+
+      def to_payload
+        p = header.to_payload
+        p << [nonce].pack('q*')
+        p << Tapyrus.pack_var_int(short_ids.size)
+        p << short_ids.map{|id|sprintf('%12x', id).htb.reverse}.join
+        p << Tapyrus.pack_var_int(prefilled_txn.size)
+        p << prefilled_txn.map(&:to_payload).join
+        p
+      end
+
+      # calculate short transaction id which specified by BIP-152.
+      # @param [String] txid a transaction id
+      # @return [Integer] 6 bytes short transaction id.
+      def short_id(txid)
+        hash = SipHash.digest(siphash_key, txid.htb.reverse).to_even_length_hex
+        [hash].pack('H*')[2...8].bth.to_i(16)
+      end
+
+    end
+  end
+end

data/lib/tapyrus/message/headers.rb

@@ -0,0 +1,35 @@
+module Tapyrus
+  module Message
+
+    # headers message
+    # https://bitcoin.org/en/developer-reference#headers
+    class Headers < Base
+
+      COMMAND = 'headers'
+
+      # Array[Tapyrus::BlockHeader]
+      attr_accessor :headers
+
+      def initialize(headers = [])
+        @headers = headers
+      end
+
+      def self.parse_from_payload(payload)
+        buf = StringIO.new(payload)
+        header_count = Tapyrus.unpack_var_int_from_io(buf)
+        h = new
+        header_count.times do
+          h.headers << Tapyrus::BlockHeader.parse_from_payload(buf.read(80))
+          buf.read(1) # read tx count 0x00 (headers message doesn't include any tx.)
+        end
+        h
+      end
+
+      def to_payload
+        Tapyrus.pack_var_int(headers.size) << headers.map { |h| h.to_payload << 0x00 }.join
+      end
+
+    end
+
+  end
+end

data/lib/tapyrus/message/headers_parser.rb

@@ -0,0 +1,24 @@
+module Tapyrus
+  module Message
+
+    # Common message parser which handle multiple block headers as a payload.
+    module HeadersParser
+
+      def parse_from_payload(payload)
+        ver, payload = payload.unpack('Va*')
+        size, payload = Tapyrus.unpack_var_int(payload)
+        hashes = []
+        buf = StringIO.new(payload)
+        size.times do
+          hashes << buf.read(32).bth
+        end
+        new(ver, hashes, buf.read(32).bth)
+      end
+
+      def to_payload
+        [version].pack('V') << Tapyrus.pack_var_int(hashes.length) << hashes.map{|h|h.htb}.join << stop_hash.htb
+      end
+
+    end
+  end
+end

data/lib/tapyrus/message/inv.rb

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

data/lib/tapyrus/message/inventories_parser.rb

@@ -0,0 +1,23 @@
+module Tapyrus
+  module Message
+
+    # Common message parser which only handle multiple inventory as payload.
+    module InventoriesParser
+
+      def parse_from_payload(payload)
+        size, payload = Tapyrus.unpack_var_int(payload)
+        buf = StringIO.new(payload)
+        i = new
+        size.times do
+          i.inventories << Inventory.parse_from_payload(buf.read(36))
+        end
+        i
+      end
+
+      def to_payload
+        Tapyrus.pack_var_int(inventories.length) << inventories.map(&:to_payload).join
+      end
+
+    end
+  end
+end

data/lib/tapyrus/message/inventory.rb

@@ -0,0 +1,51 @@
+module Tapyrus
+  module Message
+    # inventory class. inventory is a part of message.
+    # https://bitcoin.org/en/developer-reference#term-inventory
+    class Inventory
+
+      SEGWIT_FLAG = 1 << 30
+
+      MSG_TX = 1
+      MSG_BLOCK = 2
+      MSG_FILTERED_BLOCK = 3
+      MSG_CMPCT_BLOCK = 4
+      MSG_WITNESS_TX = SEGWIT_FLAG | MSG_TX
+      MSG_WITNESS_BLOCK = SEGWIT_FLAG | MSG_BLOCK
+      MSG_FILTERED_WITNESS_BLOCK = SEGWIT_FLAG | MSG_FILTERED_BLOCK
+
+      attr_accessor :identifier
+      attr_accessor :hash
+
+      def initialize(identifier, hash)
+        raise Error, "invalid type identifier specified. identifier = #{identifier}" unless valid_identifier?(identifier)
+        @identifier = identifier
+        @hash = hash
+      end
+
+      # parse inventory payload
+      def self.parse_from_payload(payload)
+        raise Error, 'invalid inventory size.' if payload.bytesize != 36
+        identifier = payload[0..4].unpack('V').first
+        hash = payload[4..-1].bth # internal byte order
+        new(identifier, hash)
+      end
+
+      def to_payload
+        [identifier].pack('V') << hash.htb
+      end
+
+      def block?
+        [MSG_BLOCK, MSG_WITNESS_BLOCK, MSG_FILTERED_WITNESS_BLOCK].include?(identifier)
+      end
+
+      private
+
+      def valid_identifier?(identifier)
+        [MSG_TX, MSG_BLOCK, MSG_FILTERED_BLOCK, MSG_CMPCT_BLOCK, MSG_WITNESS_TX,
+         MSG_WITNESS_BLOCK, MSG_FILTERED_WITNESS_BLOCK].include?(identifier)
+      end
+
+    end
+  end
+end

data/lib/tapyrus/message/mem_pool.rb

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

data/lib/tapyrus/message/merkle_block.rb

@@ -0,0 +1,42 @@
+module Tapyrus
+  module Message
+
+    # merckleblock message
+    # https://bitcoin.org/en/developer-reference#merkleblock
+    class MerkleBlock < Base
+
+      COMMAND = 'merkleblock'
+
+      attr_accessor :header
+      attr_accessor :tx_count
+      attr_accessor :hashes
+      attr_accessor :flags
+
+      def initialize
+        @hashes = []
+      end
+
+      def self.parse_from_payload(payload)
+        m = new
+        buf = StringIO.new(payload)
+        m.header = Tapyrus::BlockHeader.parse_from_payload(buf.read(80))
+        m.tx_count = buf.read(4).unpack('V').first
+        hash_count = Tapyrus.unpack_var_int_from_io(buf)
+        hash_count.times do
+          m.hashes << buf.read(32).bth
+        end
+        flag_count = Tapyrus.unpack_var_int_from_io(buf)
+        # A sequence of bits packed eight in a byte with the least significant bit first.
+        m.flags = buf.read(flag_count).bth
+        m
+      end
+
+      def to_payload
+        header.to_payload << [tx_count].pack('V') << Tapyrus.pack_var_int(hashes.size) <<
+            hashes.map(&:htb).join << Tapyrus.pack_var_int(flags.htb.bytesize) << flags.htb
+      end
+
+    end
+
+  end
+end

data/lib/tapyrus/message/network_addr.rb

@@ -0,0 +1,63 @@
+require 'ipaddr'
+
+module Tapyrus
+  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_addr # IPAddr
+
+      attr_accessor :port
+
+      attr_reader :skip_time
+
+      def initialize(ip: '127.0.0.1', port: Tapyrus.chain_params.default_port, services: DEFAULT_SERVICE_FLAGS, time: Time.now.to_i)
+        @time = time
+        @ip_addr = IPAddr.new(ip)
+        @port = port
+        @services = services
+      end
+
+      def self.parse_from_payload(payload)
+        buf = payload.is_a?(String) ? StringIO.new(payload) : payload
+        has_time = buf.size > 26
+        addr = new(time: nil)
+        addr.time = buf.read(4).unpack('V').first if has_time
+        addr.services = buf.read(8).unpack('Q').first
+        addr.ip_addr = IPAddr::new_ntoh(buf.read(16))
+        addr.port = buf.read(2).unpack('n').first
+        addr
+      end
+
+      def self.local_addr
+        addr = new
+        addr.ip_addr = IPAddr.new('127.0.0.1')
+        addr.port = Tapyrus.chain_params.default_port
+        addr.services = DEFAULT_SERVICE_FLAGS
+        addr
+      end
+
+      def ip
+        ip_addr.ipv4_mapped? ? ip_addr.native : ip_addr.to_s
+      end
+
+      def to_payload(skip_time = false)
+        p = ''
+        p << [time].pack('V') unless skip_time
+        addr = ip_addr.ipv4? ? ip_addr.ipv4_mapped : ip_addr
+        p << [services].pack('Q') << addr.hton << [port].pack('n')
+      end
+
+    end
+
+  end
+end

data/lib/tapyrus/message/not_found.rb

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

data/lib/tapyrus/message/ping.rb

@@ -0,0 +1,30 @@
+module Tapyrus
+  module Message
+
+    # ping message class
+    # https://bitcoin.org/en/developer-reference#ping
+    class Ping < Base
+
+      COMMAND = 'ping'
+
+      attr_accessor :nonce
+
+      def initialize(nonce = SecureRandom.random_number(0xffffffff))
+        @nonce = nonce
+      end
+
+      def self.parse_from_payload(payload)
+        new(payload.unpack('Q').first)
+      end
+
+      def to_payload
+        [nonce].pack('Q')
+      end
+
+      def to_response
+        Pong.new(nonce)
+      end
+
+    end
+  end
+end

data/lib/tapyrus/message/pong.rb

@@ -0,0 +1,26 @@
+module Tapyrus
+  module Message
+
+    # pong message
+    # https://bitcoin.org/en/developer-reference#pong
+    class Pong < Base
+
+      COMMAND = 'pong'
+
+      attr_reader :nonce
+
+      def initialize(nonce)
+        @nonce = nonce
+      end
+
+      def self.parse_from_payload(payload)
+        new(payload.unpack('Q').first)
+      end
+
+      def to_payload
+        [nonce].pack('Q')
+      end
+    end
+
+  end
+end

data/lib/tapyrus/message/prefilled_tx.rb

@@ -0,0 +1,29 @@
+module Tapyrus
+  module Message
+
+    # A PrefilledTransaction structure is used in HeaderAndShortIDs to provide a list of a few transactions explicitly.
+    # https://github.com/bitcoin/bips/blob/master/bip-0152.mediawiki
+    class PrefilledTx
+
+      attr_accessor :index
+      attr_accessor :tx
+
+      def initialize(index, tx)
+        @index = index
+        @tx = tx
+      end
+
+      def self.parse_from_io(io)
+        index = Tapyrus.unpack_var_int_from_io(io)
+        tx = Tapyrus::Tx.parse_from_payload(io)
+        self.new(index, tx)
+      end
+
+      def to_payload
+        Tapyrus.pack_var_int(index) << tx.to_payload
+      end
+
+    end
+
+  end
+end

data/lib/tapyrus/message/reject.rb

@@ -0,0 +1,46 @@
+module Tapyrus
+  module Message
+
+    # reject message
+    # https://bitcoin.org/en/developer-reference#reject
+    class Reject < Base
+
+      attr_accessor :message
+      attr_accessor :code
+      attr_accessor :reason
+      attr_accessor :extra
+
+      COMMAND = 'reject'
+
+      CODE_MALFORMED = 0x01
+      CODE_INVALID = 0x10
+      CODE_OBSOLETE = 0x11
+      CODE_DUPLICATE = 0x12
+      CODE_NONSTANDARD = 0x40
+      CODE_DUST = 0x41
+      CODE_INSUFFICIENT_FEE = 0x42
+      CODE_CHECKPOINT = 0x43
+
+      def initialize(message, code, reason = '', extra = '')
+        @message = message
+        @code = code
+        @reason = reason
+        @extra = extra
+      end
+
+      def self.parse_from_payload(payload)
+        message, payload = Tapyrus.unpack_var_string(payload)
+        code, payload = payload.unpack('Ca*')
+        reason, payload = Tapyrus.unpack_var_string(payload)
+        extra = ['tx', 'block'].include?(message) ? payload.bth : payload
+        new(message, code, reason, extra)
+      end
+
+      def to_payload
+        e = ['tx', 'block'].include?(message) ? extra.htb : extra
+        Tapyrus.pack_var_string(message) << [code].pack('C') << Tapyrus.pack_var_string(reason) << e
+      end
+
+    end
+  end
+end

data/lib/tapyrus/message/send_cmpct.rb

@@ -0,0 +1,43 @@
+module Tapyrus
+  module Message
+
+    # sendcmpct message
+    # https://github.com/bitcoin/bips/blob/master/bip-0152.mediawiki
+    class SendCmpct < Base
+
+      COMMAND = 'sendcmpct'
+
+      MODE_HIGH = 1
+      MODE_LOW = 0
+
+      attr_accessor :mode
+      attr_accessor :version
+      # TODO support version 2
+
+      def initialize(mode = MODE_HIGH, version = 1)
+        @mode = mode
+        @version = version
+      end
+
+      def self.parse_from_payload(payload)
+        buf = StringIO.new(payload)
+        mode = buf.read(1).unpack('c').first
+        version = buf.read(8).unpack('Q').first
+        new(mode, version)
+      end
+
+      def to_payload
+        [mode, version].pack('cQ')
+      end
+
+      def high?
+        mode == 1
+      end
+
+      def low?
+        mode.zero?
+      end
+    end
+
+  end
+end

data/lib/tapyrus/message/send_headers.rb

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

data/lib/tapyrus/message/tx.rb

@@ -0,0 +1,30 @@
+module Tapyrus
+  module Message
+
+    # tx message
+    # https://bitcoin.org/en/developer-reference#tx
+    class Tx < Base
+
+      COMMAND = 'tx'
+
+      attr_accessor :tx
+      attr_accessor :use_segwit
+
+      def initialize(tx, use_segwit = false)
+        @tx = tx
+        @use_segwit = use_segwit
+      end
+
+      def self.parse_from_payload(payload)
+        tx = Tapyrus::Tx.parse_from_payload(payload)
+        new(tx, tx.witness?)
+      end
+
+      def to_payload
+        use_segwit ? tx.to_payload : tx.serialize_old_format
+      end
+
+    end
+
+  end
+end

data/lib/tapyrus/message/ver_ack.rb

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

data/lib/tapyrus/message/version.rb

@@ -0,0 +1,69 @@
+# encoding: ascii-8bit
+require 'ipaddr'
+module Tapyrus
+  module Message
+
+    # https://bitcoin.org/en/developer-reference#version
+    class Version < Base
+
+      COMMAND = 'version'
+
+      attr_accessor :version
+      attr_accessor :services
+      attr_accessor :timestamp
+      attr_accessor :local_addr
+      attr_accessor :remote_addr
+      attr_accessor :nonce
+      attr_accessor :user_agent
+      attr_accessor :start_height
+      attr_accessor :relay
+
+      def initialize(opts = {})
+        @version = Tapyrus.chain_params.protocol_version
+        @services = DEFAULT_SERVICE_FLAGS
+        @timestamp = Time.now.to_i
+        @local_addr = NetworkAddr.local_addr
+        @remote_addr = NetworkAddr.local_addr
+        @nonce = SecureRandom.random_number(0xffffffffffffffff)
+        @user_agent = Tapyrus::Message::USER_AGENT
+        @start_height = 0
+        opts.each { |k, v| send "#{k}=", v }
+        @relay = opts[:relay] || false
+      end
+
+      def self.parse_from_payload(payload)
+        version, services, timestamp, local_addr, remote_addr, nonce, rest = payload.unpack('VQQa26a26Qa*')
+        v = new
+        v.version = version
+        v.services = services
+        v.timestamp = timestamp
+        v.local_addr = NetworkAddr.parse_from_payload(local_addr)
+        v.remote_addr = NetworkAddr.parse_from_payload(remote_addr)
+        v.nonce = nonce
+        user_agent, rest = unpack_var_string(rest)
+        start_height, rest = rest.unpack('Va*')
+        v.user_agent = user_agent
+        v.start_height = start_height
+        v.relay = v.unpack_relay_field(rest).first
+        v
+      end
+
+      def to_payload
+        [
+          [version, services, timestamp].pack('VQQ'),
+          local_addr.to_payload(true),
+          remote_addr.to_payload(true),
+          [nonce].pack('Q'),
+          pack_var_string(user_agent),
+          [start_height].pack('V'),
+          pack_boolean(relay)
+        ].join
+      end
+
+      def unpack_relay_field(payload)
+        ( version >= 70001 && payload ) ? unpack_boolean(payload) : [ true, nil ]
+      end
+
+    end
+  end
+end