tapyrus 0.1.0

data/lib/tapyrus/slip39.rb

@@ -0,0 +1,93 @@
+module Tapyrus
+  module SLIP39
+
+    WORDS = File.readlines("#{__dir__}/slip39/wordlist/english.txt").map(&:strip)
+
+    module_function
+
+    def bits_to_bytes(n)
+      (n + 7) / 8
+    end
+
+    def bits_to_words(n)
+      (n + RADIX_BITS - 1) / RADIX_BITS
+    end
+
+    # The length of the radix in bits.
+    RADIX_BITS = 10
+    # The number of words in the wordlist.
+    RADIX = 2 ** RADIX_BITS
+    # The length of the random identifier in bits.
+    ID_LENGTH_BITS = 15
+    # The length of the iteration exponent in bits.
+    ITERATION_EXP_LENGTH_BITS = 5
+    # The length of the random identifier and iteration exponent in words.
+    ID_EXP_LENGTH_WORDS = bits_to_words(ID_LENGTH_BITS + ITERATION_EXP_LENGTH_BITS)
+    # The maximum number of shares that can be created.
+    MAX_SHARE_COUNT = 16
+    # The length of the RS1024 checksum in words.
+    CHECKSUM_LENGTH_WORDS = 3
+    # The length of the digest of the shared secret in bytes.
+    DIGEST_LENGTH_BYTES = 4
+    # The customization string used in the RS1024 checksum and in the PBKDF2 salt.
+    CUSTOMIZATION_STRING = 'shamir'.bytes
+    # The length of the mnemonic in words without the share value.
+    METADATA_LENGTH_WORDS = ID_EXP_LENGTH_WORDS + 2 + CHECKSUM_LENGTH_WORDS
+    # The minimum allowed entropy of the master secret.
+    MIN_STRENGTH_BITS = 128
+    # The minimum allowed length of the mnemonic in words.
+    MIN_MNEMONIC_LENGTH_WORDS = METADATA_LENGTH_WORDS + bits_to_words(MIN_STRENGTH_BITS)
+    # The minimum number of iterations to use in PBKDF2.
+    BASE_ITERATION_COUNT = 10000
+    # The number of rounds to use in the Feistel cipher.
+    ROUND_COUNT = 4
+    # The index of the share containing the shared secret.
+    SECRET_INDEX = 255
+    # The index of the share containing the digest of the shared secret.
+    DIGEST_INDEX = 254
+
+    EXP_TABLE = [
+        1, 3, 5, 15, 17, 51, 85, 255, 26, 46, 114, 150, 161, 248, 19,
+        53, 95, 225, 56, 72, 216, 115, 149, 164, 247, 2, 6, 10, 30, 34,
+        102, 170, 229, 52, 92, 228, 55, 89, 235, 38, 106, 190, 217, 112, 144,
+        171, 230, 49, 83, 245, 4, 12, 20, 60, 68, 204, 79, 209, 104, 184,
+        211, 110, 178, 205, 76, 212, 103, 169, 224, 59, 77, 215, 98, 166, 241,
+        8, 24, 40, 120, 136, 131, 158, 185, 208, 107, 189, 220, 127, 129, 152,
+        179, 206, 73, 219, 118, 154, 181, 196, 87, 249, 16, 48, 80, 240, 11,
+        29, 39, 105, 187, 214, 97, 163, 254, 25, 43, 125, 135, 146, 173, 236,
+        47, 113, 147, 174, 233, 32, 96, 160, 251, 22, 58, 78, 210, 109, 183,
+        194, 93, 231, 50, 86, 250, 21, 63, 65, 195, 94, 226, 61, 71, 201,
+        64, 192, 91, 237, 44, 116, 156, 191, 218, 117, 159, 186, 213, 100, 172,
+        239, 42, 126, 130, 157, 188, 223, 122, 142, 137, 128, 155, 182, 193, 88,
+        232, 35, 101, 175, 234, 37, 111, 177, 200, 67, 197, 84, 252, 31, 33,
+        99, 165, 244, 7, 9, 27, 45, 119, 153, 176, 203, 70, 202, 69, 207,
+        74, 222, 121, 139, 134, 145, 168, 227, 62, 66, 198, 81, 243, 14, 18,
+        54, 90, 238, 41, 123, 141, 140, 143, 138, 133, 148, 167, 242, 13, 23,
+        57, 75, 221, 124, 132, 151, 162, 253, 28, 36, 108, 180, 199, 82, 246
+    ]
+
+    LOG_TABLE = [
+        0, 0, 25, 1, 50, 2, 26, 198, 75, 199, 27, 104, 51, 238, 223, 3,
+        100, 4, 224, 14, 52, 141, 129, 239, 76, 113, 8, 200, 248, 105, 28,
+        193, 125, 194, 29, 181, 249, 185, 39, 106, 77, 228, 166, 114, 154, 201,
+        9, 120, 101, 47, 138, 5, 33, 15, 225, 36, 18, 240, 130, 69, 53,
+        147, 218, 142, 150, 143, 219, 189, 54, 208, 206, 148, 19, 92, 210, 241,
+        64, 70, 131, 56, 102, 221, 253, 48, 191, 6, 139, 98, 179, 37, 226,
+        152, 34, 136, 145, 16, 126, 110, 72, 195, 163, 182, 30, 66, 58, 107,
+        40, 84, 250, 133, 61, 186, 43, 121, 10, 21, 155, 159, 94, 202, 78,
+        212, 172, 229, 243, 115, 167, 87, 175, 88, 168, 80, 244, 234, 214, 116,
+        79, 174, 233, 213, 231, 230, 173, 232, 44, 215, 117, 122, 235, 22, 11,
+        245, 89, 203, 95, 176, 156, 169, 81, 160, 127, 12, 246, 111, 23, 196,
+        73, 236, 216, 67, 31, 45, 164, 118, 123, 183, 204, 187, 62, 90, 251,
+        96, 177, 134, 59, 82, 161, 108, 170, 85, 41, 157, 151, 178, 135, 144,
+        97, 190, 220, 252, 188, 149, 207, 205, 55, 63, 91, 209, 83, 57, 132,
+        60, 65, 162, 109, 71, 20, 42, 158, 93, 86, 242, 211, 171, 68, 17, 146,
+        217, 35, 32, 46, 137, 180, 124, 184, 38, 119, 153, 227, 165, 103, 74, 237,
+        222, 197, 49, 254, 24, 13, 99, 140, 128, 192, 247, 112, 7
+    ]
+
+    autoload :SSS, 'tapyrus/slip39/sss'
+    autoload :Share, 'tapyrus/slip39/share'
+
+  end
+end

data/lib/tapyrus/store/chain_entry.rb

@@ -0,0 +1,67 @@
+module Tapyrus
+  module Store
+
+    # wrap a block header object with extra data.
+    class ChainEntry
+
+      attr_reader :header
+      attr_reader :height
+
+      # @param [Tapyrus::BlockHeader] header a block header.
+      # @param [Integer] height a block height.
+      def initialize(header, height)
+        @header = header
+        @height = height
+      end
+
+      # get database key
+      def key
+        Tapyrus::Store::KEY_PREFIX[:entry] + header.block_hash
+      end
+
+      def hash
+        header.hash
+      end
+
+      # block hash
+      def block_hash
+        header.block_hash
+      end
+
+      # previous block hash
+      def prev_hash
+        header.prev_hash
+      end
+
+      # whether genesis block
+      def genesis?
+        Tapyrus.chain_params.genesis_block.header == header
+      end
+
+      # @param [String] payload a payload with binary format.
+      def self.parse_from_payload(payload)
+        buf = StringIO.new(payload)
+        len = Tapyrus.unpack_var_int_from_io(buf)
+        height = buf.read(len).reverse.bth.to_i(16)
+        new(Tapyrus::BlockHeader.parse_from_payload(buf.read(80)), height)
+      end
+
+      # build next block +StoredBlock+ instance.
+      # @param [Tapyrus::BlockHeader] next_block a next block candidate header.
+      # @return [Tapyrus::Store::ChainEntry] a next stored block (not saved).
+      def build_next_block(next_block)
+        ChainEntry.new(next_block, height + 1)
+      end
+
+      # generate payload
+      def to_payload
+        height_value = height.to_even_length_hex
+        height_value = height_value.htb.reverse
+        Tapyrus.pack_var_int(height_value.bytesize) + height_value + header.to_payload
+      end
+
+    end
+
+  end
+
+end

data/lib/tapyrus/store/db/level_db.rb

@@ -0,0 +1,98 @@
+require 'leveldb-native'
+
+module Tapyrus
+  module Store
+    module DB
+
+      class LevelDB
+
+        attr_reader :db
+        attr_reader :logger
+
+        def initialize(path = "#{Tapyrus.base_dir}/db/spv")
+          # @logger = Tapyrus::Logger.create(:debug)
+          FileUtils.mkdir_p(path)
+          @db = ::LevelDBNative::DB.new(path)
+          # logger.debug 'Opened LevelDB successfully.'
+        end
+
+        # put data into LevelDB.
+        # @param [Object] key a key.
+        # @param [Object] value a value.
+        def put(key, value)
+          # logger.debug "put #{key} data"
+          db.put(key, value)
+        end
+
+        # get value from specified key.
+        # @param [Object] key a key.
+        # @return[Object] the stored value.
+        def get(key)
+          db.get(key)
+        end
+
+        # get best block hash.
+        def best_hash
+          db.get(KEY_PREFIX[:best])
+        end
+
+        # delete specified key data.
+        def delete(key)
+          db.delete(key)
+        end
+
+        # get block hash specified +height+
+        def get_hash_from_height(height)
+          db.get(height_key(height))
+        end
+
+        # get next block hash specified +hash+
+        def next_hash(hash)
+          db.get(KEY_PREFIX[:next] + hash)
+        end
+
+        # get entry payload
+        # @param [String] hash the hash with hex format.
+        # @return [String] the ChainEntry payload.
+        def get_entry_payload_from_hash(hash)
+          db.get(KEY_PREFIX[:entry] + hash)
+        end
+
+        def save_entry(entry)
+          db.batch do
+            db.put(entry.key ,entry.to_payload)
+            db.put(height_key(entry.height), entry.block_hash)
+            connect_entry(entry)
+          end
+        end
+
+        def close
+          db.close
+        end
+
+        private
+
+        # generate height key
+        def height_key(height)
+          height = height.to_even_length_hex
+          KEY_PREFIX[:height] + height.rhex
+        end
+
+        def connect_entry(entry)
+          unless entry.genesis?
+            tip_block = Tapyrus::Store::ChainEntry.parse_from_payload(get_entry_payload_from_hash(best_hash))
+            unless tip_block.block_hash == entry.prev_hash
+              raise "entry(#{entry.block_hash}) does not reference current best block hash(#{tip_block.block_hash})"
+            end
+            unless tip_block.height + 1 == entry.height
+              raise "block height is small than current best block."
+            end
+          end
+          db.put(KEY_PREFIX[:best], entry.block_hash)
+          db.put(KEY_PREFIX[:next] + entry.prev_hash, entry.block_hash)
+        end
+      end
+
+    end
+  end
+end

data/lib/tapyrus/store/db.rb

@@ -0,0 +1,9 @@
+module Tapyrus
+  module Store
+
+    module DB
+      autoload :LevelDB, 'tapyrus/store/db/level_db'
+    end
+
+  end
+end

data/lib/tapyrus/store/spv_chain.rb

@@ -0,0 +1,101 @@
+module Tapyrus
+
+  module Store
+
+    KEY_PREFIX = {
+        entry: 'e',   # key: block hash, value: Tapyrus::Store::ChainEntry payload
+        height: 'h',  # key: block height, value: block hash.
+        best: 'B',    # value: best block hash.
+        next: 'n'     # key: block hash, value: A hash of the next block of the specified hash
+    }
+
+    class SPVChain
+
+      attr_reader :db
+      attr_reader :logger
+
+      def initialize(db = Tapyrus::Store::DB::LevelDB.new)
+        @db = db # TODO multiple db switch
+        @logger = Tapyrus::Logger.create(:debug)
+        initialize_block
+      end
+
+      # get latest block in the store.
+      # @return[Tapyrus::Store::ChainEntry]
+      def latest_block
+        hash = db.best_hash
+        return nil unless hash
+        find_entry_by_hash(hash)
+      end
+
+      # find block entry with the specified height.
+      def find_entry_by_height(height)
+        find_entry_by_hash(db.get_hash_from_height(height))
+      end
+
+      # find block entry with the specified hash
+      def find_entry_by_hash(hash)
+        payload = db.get_entry_payload_from_hash(hash)
+        return nil unless payload
+        ChainEntry.parse_from_payload(payload)
+      end
+
+      # append block header to chain.
+      # @param [Tapyrus::BlockHeader] header a block header.
+      # @return [Tapyrus::Store::ChainEntry] appended block header entry.
+      def append_header(header)
+        logger.info("append header #{header.block_id}")
+        raise "this header is invalid. #{header.block_hash}" unless header.valid?
+        best_block = latest_block
+        current_height = best_block.height
+        if best_block.block_hash == header.prev_hash
+          entry = Tapyrus::Store::ChainEntry.new(header, current_height + 1)
+          db.save_entry(entry)
+          entry
+        else
+          unless find_entry_by_hash(header.block_hash)
+            # TODO implements recovery process
+            raise "header's previous hash(#{header.prev_hash}) does not match current best block's(#{best_block.block_hash})."
+          end
+        end
+      end
+
+      # get next block hash for specified +hash+
+      # @param [String] hash the block hash(little endian)
+      # @return [String] the next block hash. If it does not exist yet, return nil.
+      def next_hash(hash)
+        db.next_hash(hash)
+      end
+
+      # get median time past for specified block +hash+
+      # @param [String] hash the block hash.
+      # @return [Integer] the median time past value.
+      def mtp(hash)
+        time = []
+        Tapyrus::MEDIAN_TIME_SPAN.times do
+          entry = find_entry_by_hash(hash)
+          break unless entry
+
+          time << entry.header.time
+          hash = entry.header.prev_hash
+        end
+        time.sort!
+        time[time.size / 2]
+      end
+
+      private
+
+      # if database is empty, put genesis block.
+      def initialize_block
+        unless latest_block
+          block = Tapyrus.chain_params.genesis_block
+          genesis = ChainEntry.new(block.header, 0)
+          db.save_entry(genesis)
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/tapyrus/store.rb

@@ -0,0 +1,9 @@
+module Tapyrus
+  module Store
+
+    autoload :DB, 'tapyrus/store/db'
+    autoload :SPVChain, 'tapyrus/store/spv_chain'
+    autoload :ChainEntry, 'tapyrus/store/chain_entry'
+
+  end
+end