cryptocoin 0.0.1b

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae2ad988c5dfd3d449144149aa36ef902ed9a221
+  data.tar.gz: 19dba874b95a3fd7d475f9ff5efe9b3b0c95690f
+SHA512:
+  metadata.gz: 79067c43a159c2136d7c2f020d365b6e0d135ae9dcd2de0629b2c31705fd7f8b36bed213fdcd9bca1e457d5199673224fcaaed30017691f96c34794cb3e42520
+  data.tar.gz: 20bc7fb25bb18b2020b80904724c26fcbdb3b6557eec2586721425ad45d356d7614f90166ad1055976523d4e516cfec1ee77abd49a64bf25e549746ea1c9c4a8

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Joshua Smock
+
+MIT License
+
+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,85 @@
+# Cryptocoin
+
+Cryptocoin is a library for processing information from a Bitcoin-based cryptocoin network and wrapping that data in a useful and Ruby-like manner. Although based off of `bitcoin-ruby` in concept, it deviates largely due to its philosophy in implementations; rather than trying to do everything, `cryptocoin` just provides wrappers around cryptocoin structures such as a block or merkle tree. Due to this difference, it cannot do certain features such as block validation, as block validation requires information beyond the basic structure (multiple transactions). 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cryptocoin'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cryptocoin
+
+## Notes
+
+### Usage Notes
+
+Since Ruby uses the method `hash` as an internal descriptor for objects, in general, the result of a hashing function such as `RIPEMD160` or `SHA256` will be referred to as a digest.
+
+### Library Notes
+
+Cryptocoin will only work with cryptocurrencies that follow the Bitcoin protocol.
+
+This library does not perform validation of blocks or transactions; it only acts as a data parser. The reason for this is that validation is inherently coupled with a storage solution, such as an SQL database, for certain validation rules and the purpose of this library is only to parse data. For a library that performs validation, see `cryptocoin-validator`.
+
+For importing from a blockchain data file, see `cryptocoin-import`.
+
+## Sample Usage
+
+### Generate a new key pair
+
+```
+require 'cryptocoin'
+key_pair = Cryptocoin::Structure::KeyPair.generate
+public_address = key_pair.public_key.to_address.to_s
+private_address = key_pair.private_key.to_address.to_s
+```
+
+(Note: The reason `to_s` is called is that `to_address` creates a new `Cryptocoin::Structure::Address` instance which can then be turned into a string via `to_s`.)
+
+### Create a new Script
+
+```
+require 'cryptocoin'
+script = Cryptocoin::Script.from_s("OP_1")
+script.parse! #=> true
+```
+
+## What's built with `cryptocoin`?
+
+Officially supported (coming soon!):
+* `cryptocoin-validator`: a block and transaction validator based off of Bitcoin protocol validation rules. Works with SHA256 (Bitcoin) and Scrypt (Litecoin) based currencies
+* `cryptocoin-import`: a blockchain data file importer. Reads a blockchain file, i.e. `blk00001.dat`, and imports it into the database. 
+
+## Thanks
+
+A lot of this code couldn't be possible without `bitcoin-ruby`, the library that started this idea. Also a huge help were the [Bitcoin wiki](https://www.bitcoin.it) and the current Bitcoin source code v0.9. A special thanks to the `bitcoinj` library for its Script directive processing, especially for OP_CHECKSIG.
+
+## Contributing
+
+### What's missing?
+
+* Support for BIP 0037, titled, "Connection Bloom Filtering"
+* Support for other cryptocurrencies besides Litecoin, Bitcoin, and Dogecoin
+
+### How to Contribute
+
+If you find a bug or would like to add a new feature, fork the library and create a PR based on your changes! Keep the code consistent with my existing code, and follow similar conventions to the existing ones.
+
+When creating a PR that adds a new feature, make sure you justify its utility to the base library, with some use cases in the PR or in a gist. Ideally the library will be kept as slim as possible, and additonal non-essential functionality for data parsing will be added to other libraries.
+
+One area I would really like help with is adding various networks to the library, as I only included a handful (Bitcoin, Litecoin, Dogecoin). If you're knowledgeable with a different cryptocoin and want to add it to the library, fork, create, and request to pull it! I'd love to have more than just three!
+
+#### Instructions for forking
+
+1. Fork it ( https://github.com/joshuasmock/cryptocoin/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/cryptocoin.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cryptocoin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cryptocoin"
+  spec.version       = Cryptocoin::VERSION
+  spec.authors       = ["Joshua Smock"]
+  spec.email         = ["joshua.smock@gmail.com"]
+  spec.summary       = %q{Cryptocoin is a library for interfacing with Bitcoin and Bitcoin-like coins}
+  spec.description   = %q{Cryptocoin is a library for processing messages and information from a cryptocoin network, such as a packet of information, and creating useful wrappers for such data.}
+  spec.homepage      = "https://github.com/joshuasmock/cryptocoin"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/cryptocoin/core_ext/integer.rb

@@ -0,0 +1,24 @@
+class Integer
+  def to_bool
+    !self.zero?
+  end
+
+  def to_openssl_bn
+    require 'openssl'
+    s = OpenSSL::BN.new(self.to_s).to_s(0)
+    s = s[s.length-1..-1]
+    s
+  end
+  
+  def to_base58
+    alphabet = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz'
+    encoded = ''
+    i = self
+
+    while i > 0
+      i, rem = i.divmod(58)
+      encoded = alphabet[rem] + encoded
+    end
+    encoded
+  end
+end

data/lib/cryptocoin/core_ext/string.rb

@@ -0,0 +1,30 @@
+require 'cryptocoin/core_ext/integer'
+
+class String
+  def to_openssl_bn_int
+    require 'openssl'
+    OpenSSL::BN.new([self.bytesize].pack('N') + self.reverse, 0).to_i
+  end
+  
+  # Returns the integer value from a base58 encoded string
+  def from_base58
+    return nil if self.match(/[0OIl]/)
+    alphabet = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz'
+    j = 0
+        
+    self.reverse.each_char.with_index do |c, i|
+      j += alphabet.index(c) * (58**i)
+    end
+    j
+  end
+  
+  def reverse_every(n)
+    self.each_char.each_slice(n).reverse_each.reduce(''){|r,i| r+=i.join}
+  end
+  
+  def encode_to_base58
+    return nil if self.to_i(16) == 0
+    i = (self.match(/^([0]+)/) ? $1 : '').size / 2
+    ('1'*i) + self.to_i(16).to_base58
+  end
+end

data/lib/cryptocoin/digest.rb

@@ -0,0 +1,36 @@
+require 'digest/sha2'
+require 'digest/rmd160'
+
+module Cryptocoin
+  class Digest
+    def initialize(str, encoding)
+      return false if ![:string, :binary].include?(encoding)
+      @plaintext = str.to_s
+      @encoding = encoding
+    end
+
+    def sha256
+      if @encoding == :binary
+        ::Digest::SHA256.hexdigest(@plaintext)
+      elsif @encoding == :string
+        ::Digest::SHA256.hexdigest([@plaintext].pack('H*'))
+      end
+    end
+
+    def double_sha256
+      if @encoding == :binary
+        ::Digest::SHA256.hexdigest(::Digest::SHA256.digest(@plaintext))
+      elsif @encoding == :string
+        ::Digest::SHA256.hexdigest(::Digest::SHA256.digest([@plaintext].pack('H*')))
+      end
+    end
+
+    def hash160
+      if @encoding == :binary
+        ::Digest::RMD160.hexdigest(::Digest::SHA256.digest(@plaintext))
+      elsif @encoding == :string
+        ::Digest::RMD160.hexdigest(::Digest::SHA256.digest([@plaintext].pack('H*')))
+      end
+    end
+  end
+end

data/lib/cryptocoin/merkle_tree.rb

@@ -0,0 +1,78 @@
+require 'cryptocoin/digest'
+require 'cryptocoin/core_ext/string'
+
+module Cryptocoin
+  class MerkleTree
+    def initialize(arr, hashed=true)
+      # Build the merkle tree!
+      @children = []
+      create_tree(arr)
+    end
+
+    def root
+      if @children.first.children.count == 1 # only child has one child, which means it's got one leaf
+        @children.first.children.first.digest
+      else
+        @children.first.digest
+      end
+    end
+
+    def children
+      @children
+    end
+        
+    # Each child is either the product of two children or one/two leaves
+    class Child
+      attr_reader :children
+      
+      def initialize(children)
+        @children = children
+      end
+      
+      def digest
+        if @children.count == 1
+          return @children.first.digest if @children.first.initially_hashed?
+          @digest ||= Cryptocoin::Digest.new(@children.first.digest.reverse_every(2), :string).double_sha256.reverse_every(2)
+        else
+          @digest ||= Cryptocoin::Digest.new((@children.last.digest + @children.first.digest).reverse_every(2), :string).double_sha256.reverse_every(2)
+        end
+      end
+      
+      def initially_hashed?
+        false
+      end
+    end
+    
+    # The base element of a merkle tree
+    class Leaf
+      attr_reader :value
+      def initialize(val, hashed=false)
+        @value = val
+        @hashed = hashed
+      end
+      
+      def digest
+        return @value if initially_hashed?
+        Cryptocoin::Digest.new(@value, :string).double_sha256.reverse_every(2)
+      end
+      
+      def initially_hashed?
+        !!@hashed
+      end
+    end
+    
+    private
+    
+    def create_tree(arr)
+      return @children = [Child.new([Leaf.new(arr[0], truee)])] if arr.length == 1
+      children = arr.map{|e| Leaf.new(e, true)}
+      until children.length == 1
+        children.push(children.last) if children.length % 2 == 1
+        children = children.each_slice(2).map {|a,b|
+          Child.new([a,b])
+        }
+      end
+      @children = children
+    end
+  end
+end

data/lib/cryptocoin/network/bitcoin.rb

@@ -0,0 +1,9 @@
+module Cryptocoin
+  class Network
+    Bitcoin = self.new
+    Bitcoin.magic_head_raw = "\xF9\xBE\xB4\xD9"
+    Bitcoin.hash160_version_raw = "\x00"
+    Bitcoin.p2sh_version_raw = "\x05"
+    Bitcoin.private_key_version_raw = "\x80"
+  end
+end

data/lib/cryptocoin/network/dogecoin.rb

@@ -0,0 +1,9 @@
+module Cryptocoin
+  class Network
+    Dogecoin = self.new
+    Dogecoin.magic_head_raw = "\xc0\xc0\xc0\xc0"
+    Dogecoin.hash160_version_raw = "\x1e"
+    Dogecoin.p2sh_version_raw = "\x22"
+    Dogecoin.private_key_version_raw = "\x9e"
+  end
+end

data/lib/cryptocoin/network/litecoin.rb

@@ -0,0 +1,9 @@
+module Cryptocoin
+  class Network
+    Litecoin = self.new
+    Litecoin.magic_head_raw = "\xfb\xc0\xb6\xdb"
+    Litecoin.hash160_version_raw = "\x30"
+    Litecoin.p2sh_version_raw = "\x05"
+    Litecoin.private_key_version_raw = "\xb0"
+  end
+end

data/lib/cryptocoin/network.rb

@@ -0,0 +1,53 @@
+module Cryptocoin
+  # Class contains protocol information like the magic_head and address types
+  # Does NOT contain validation information as this would require dependence on an outside source
+  # of information
+  class Network
+    attr_accessor :magic_head_raw, :hash160_version_raw, :p2sh_version_raw, :private_key_version_raw, :protocol_version_raw
+    
+    def magic_head
+      @magic_head ||= @magic_head_raw.unpack('H*')[0]
+    end
+    
+    def magic_head=(magic_head)
+      @magic_head_raw = [magic_head].pack('H*')
+      @magic_head = nil
+    end
+    
+    def hash160_version
+      @hash160_version ||= @hash160_version_raw.unpack('H*')[0]
+    end
+    
+    def hash160_version=(hash160_version)
+      @hash160_version_raw = [hash160_version].pack('H*')
+      @hash160_version = nil
+    end
+    
+    def p2sh_version
+      @p2sh_version ||= @p2sh_version_raw.unpack('H*')[0]
+    end
+    
+    def p2sh_version=(p2sh_version)
+      @p2sh_version_raw = [p2sh_version].pack('H*')
+      @p2sh_version = nil
+    end
+    
+    def private_key_version
+      @private_key_version_raw.unpack('H*')[0]
+    end
+    
+    def private_key_version=(private_key_version)
+      @private_key_version_raw = [private_key_version].pack('H*')
+      @private_key_version = nil
+    end
+    
+    def protocol_version
+      @protocol_version ||= @protocol_version_raw.unpack('H*')[0]
+    end
+    
+    def protocol_version=(protocol_version)
+      @protocol_version_raw = [protocol_version].pack('H*')
+      @protocol_version = nil
+    end
+  end
+end

data/lib/cryptocoin/protocol/block_header.rb

@@ -0,0 +1,58 @@
+require 'cryptocoin/protocol/var_len_int'
+
+module Cryptocoin
+  module Protocol
+    class BlockHeader
+      attr_reader :transaction_count
+      
+      def self.parse_from_raw(raw)
+        version = raw[0..3]
+        previous_block_digest = raw[4..35]
+        merkle_root_digest = raw[36..67]
+        timestamp = raw[68..71]
+        bits = raw[72..75]
+        nonce = raw[76..79]
+        tx_count = Cryptocoin::Protocol::VarLenInt.parse_from_raw(raw[80..-1])
+        self.new(version, previous_block_digest, merkle_root_digest, timestamp, bits, nonce, tx_count)
+      end
+      
+      def initialize(version, previous_block_digest, merkle_root_digest, timestamp, bits, nonce, tx_count)
+        @version_raw = version
+        @previous_block_digest_raw = previous_block_digest
+        @merkle_root_digest_raw = merkle_root_digest
+        @timestamp_raw = timestamp
+        @bits_raw = bits
+        @nonce_raw = nonce
+        @transaction_count = tx_count
+      end
+      
+      def version
+        @version ||= @version_raw.unpack('L')[0]
+      end
+      
+      def previous_block_digest
+        @previous_block_digest ||= @previous_block_digest_raw.unpack('H*')[0]
+      end
+      
+      def merkle_root_digest
+        @merkle_root_digest_raw ||= @merkle_root_digest_raw.unpack('H*')[0]
+      end
+      
+      def timestamp
+        @timestamp ||= @timestamp_raw.unpack('L')[0]
+      end
+      
+      def bits
+        @bits ||= @bits_raw.unpack('L')[0]
+      end
+      
+      def nonce
+        @nonce ||= @nonce_raw.unpack('L')[0]
+      end
+      
+      def raw
+        @version_raw + @previous_block_digest_raw + @merkle_root_digest_raw + @timestamp_raw + @bits_raw + @nonce_raw + @transaction_count.raw
+      end
+	  end
+  end
+end

data/lib/cryptocoin/protocol/inventory_vector.rb

@@ -0,0 +1,28 @@
+module Cryptocoin
+  module Protocol
+    class InventoryVector
+	  def self.parse_from_raw(raw)
+	    type = raw[0..3]
+      digest = raw[4..-1]
+      self.new(type, digest)
+	  end
+	  
+	  def initialize(type, digest)
+	    @type_raw = type
+      @digest_raw = digest
+	  end
+	  
+	  def type
+	  	@type_raw.unpack('L')[0]
+	  end
+	  
+	  def digest
+	  	@digest_raw.unpack('H*')[0]
+	  end
+	  
+	  def raw
+	  	@type_raw + @digest_raw
+	  end
+	end
+  end
+end

data/lib/cryptocoin/protocol/message/addr.rb

@@ -0,0 +1,29 @@
+require 'cryptocoin/protocol/var_len_int'
+require 'cryptocoin/protocol/net_addr'
+
+module Cryptocoin
+  module Protocol
+    class Message
+      class Addr
+        attr_reader :count, :addresses
+        def parse_from_raw(payload)
+          count = Cryptocoin::Protocol::VarLenInt.parse_from_raw(payload)
+          addresses = []
+          count.times do
+            addresses.push(Cryptocoin::Protocol::NetAddr.parse_from_raw(payload[@count.raw.bytesize + 30*@addresses.count]))
+          end
+          self.new(count, addresses)
+        end
+        
+        def initialize(count, addresses)
+          @count = count
+          @addresses = addresses
+        end
+        
+        def raw
+          @count.raw + @addresses.map{|e| e.raw}.join
+        end
+      end
+    end
+  end
+end

data/lib/cryptocoin/protocol/message/block.rb

@@ -0,0 +1,13 @@
+require 'cryptocoin/structure/block'
+
+module Cryptocoin
+  module Protocol
+    class Message
+      class Block
+        def initialize(payload)
+          Cryptocoin::Structure::Block.parse_from_raw(payload)
+        end
+      end
+    end
+  end
+end

data/lib/cryptocoin/protocol/message/getaddr.rb

@@ -0,0 +1,17 @@
+module Cryptocoin
+  module Protocol
+    class Message
+      class Getaddr
+        def parse_from_raw(payload)
+          # https://en.bitcoin.it/wiki/Protocol_specification#getaddr
+          # This message has no payload
+          self.new
+        end
+        
+        def raw
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/cryptocoin/protocol/message/getblocks.rb

@@ -0,0 +1,44 @@
+module Cryptocoin
+  module Protocol
+    class Message
+      class Getblocks
+        attr_reader :digest_count
+        
+        def parse_from_raw(payload)
+          block_locator_digests, i = [], 0
+          version = payload[0..3]
+          digest_count = Cryptocoin::Protocol::VarLenInt.parse_from_raw(payload[4..-1])
+          digest_count.times do
+            c = digest_count.raw.bytesize+i*32
+            block_locator_digests.push(payload[c..c+31])
+            i+=1
+          end
+          digest_stop = payload[5+i*32..-1]
+        end
+        
+        def initialize(version, digest_count, block_locator_digests, digest_stop)
+          @version_raw = version
+          @digest_count = digest_count
+          @block_locator_digests_raw = block_locator_digests
+          @digest_stop_raw = digest_stop
+        end
+        
+        def version
+          @version ||= @version_raw.unpack('L')[0]
+        end
+        
+        def block_locator_digests
+          @block_locator_digests ||= @block_locator_digests_raw.map{|e| e.unpack('H*')[0] }
+        end
+        
+        def digest_stop
+          @digest_stop ||= @digest_stop_raw.unpack('H*')[0]
+        end
+        
+        def raw
+          @version_raw + @digest_count.raw + @block_locator_digests_raw.join + @digest_stop_raw
+        end
+      end
+    end
+  end
+end

data/lib/cryptocoin/protocol/message/getdata.rb

@@ -0,0 +1,31 @@
+require 'cryptocoin/protocol/inventory_vector'
+require 'cryptocoin/protocol/var_len_int'
+
+module Cryptocoin
+  module Protocol
+    class Message
+      class Getdata
+        def self.parse_from_raw(payload)
+          inventory = []
+          i = 0
+          count = Cryptocoin::Protocol::VarLenInt.parse_from_raw(payload)
+          count.times do
+            c = count.raw.bytesize+i*36
+            inventory.push(Cryptocoin::Protocol::InventoryVector.parse_from_raw(payload[c..c+35]))
+            i+=1
+          end
+          self.new(count, inventory)
+        end
+        
+        def initialize(count, inventory)
+          @count_raw = count
+          @inventory = inventory
+        end
+        
+        def raw
+          @count_raw + @inventory.map{|e| e.raw}.join
+        end
+      end
+    end
+  end
+end