vanitygen-wrapper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 413a2d4a3858258fe5778cc45e10b2719e56d662
+  data.tar.gz: 6db5b7f020f2a48d2f5486444a154d1e323cbc77
+SHA512:
+  metadata.gz: a7715ee966b9a2821844df51b9df2eb85a5c063b6d79363e6759a167580215ee21635e3b018fb91c7f5c1e1bea79eafba0faf251971ac499c7eb7707b3e07f4c
+  data.tar.gz: 32dd98358eabe88a4e847c1426389b684f2f9234da83bf8d452c5245b908e1ac6694e367a6b3b550023e9de37c9ee2c60fc2e916dbf666bf10e0751a23025572

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Benjamin Feng
+
+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,68 @@
+# vanitygen-wrapper
+
+Thin ruby wrapper around vanitygen executable. Sibling project of <https://github.com/bitvain/vanitygen-ruby>.
+
+## Installation
+
+Download and install <https://github.com/samr7/vanitygen>
+
+Make sure `vanitygen` is available in your `$PATH`.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vanitygen-wrapper', require 'vanitygen'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vanitygen-wrapper
+
+## Usage
+
+Verify pattern validity:
+
+```ruby
+>> Vanitygen.valid?('1AB')
+=> true
+>> Vanitygen.valid?('2AB')
+=> false
+```
+
+Check pattern difficulty:
+
+```ruby
+>> Vanitygen.difficulty('1AB')
+=> 1330
+>> Vanitygen.difficulty('1AB', case_insensitive: true)
+=> 654
+```
+
+Generate single addresses:
+
+```ruby
+>> Vanitygen.generate('1AB')
+=> {:pattern=>"1AB", :address=>"1ABz3svEbWHyj5penc6LLX6xvDfzZcsZu9", :private_key=>"5KRtsDfuiMf549QU1X6mNcTuYxd2V4XsjQBD8pgUMEPFGFADMzb"}
+```
+
+Continuously generate addresses:
+
+```ruby
+>> Vanitygen.continuous('1AB') { |data| puts data }
+{:pattern=>"1AB", :address=>"1ABsD3pMDJbmpQx941faFn5Tg7aeVccW9c", :private_key=>"5KAjmVJAoBgNNNtVqCWYofNH6N8erSBGd7omsLCzSWg9DHZJd15"}
+{:pattern=>"1AB", :address=>"1ABzPupWHxiWRBhAPYmcxbBQoonE1CgF7u", :private_key=>"5KRB9rV78DdTp6RWD7K1mA7iNgRGTXDuA7aGvC4xJLPg4YLx5j2"}
+{:pattern=>"1AB", :address=>"1ABc8fVqFW2SXBfmQh5B6u1cg9SEPF2xMP", :private_key=>"5JAVeQBXT2ZL5p6oLgK4QAiDVdC8J9ytLHT999TxzSwvHnkgu3T"}
+[...]
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/bitvain/vanitygen-wrapper/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/lib/vanitygen.rb

@@ -0,0 +1,160 @@
+require 'mkfifo'
+require 'open3'
+require 'tempfile'
+
+module Vanitygen
+  autoload :VERSION, 'vanitygen/version'
+
+  class << self
+    NETWORKS = {
+      bitcoin:  nil,
+      testnet3: '-T',
+    }
+
+    def network
+      @network ||= :bitcoin
+    end
+
+    def network=(network)
+      network = network.to_sym
+      raise "network #{network} not supported" unless NETWORKS.has_key?(network)
+      @network = network
+    end
+
+    def valid?(pattern, options={})
+      flags = flags_from({simulate: true,
+                          patterns: [pattern]
+                         }.merge(options))
+      pid = Process.spawn('vanitygen', *flags, out: '/dev/null', err: '/dev/null')
+      pid, status = Process.wait2(pid)
+      status == 0
+    end
+
+    def difficulty(pattern, options={})
+      flags = flags_from({simulate: true,
+                          patterns: [pattern]
+                         }.merge(options))
+      msg = ''
+      Open3.popen3('vanitygen', *flags) do |stdin, stdout, stderr, wait_thr|
+        stdin.close
+        stdout.close
+        while !stderr.eof?
+          msg << stderr.read
+        end
+        stderr.close
+        raise "vanitygen status (#{wait_thr.value}) err: #{msg}" if wait_thr.value != 0
+      end
+      msg.split.last.to_i
+    end
+
+    def generate(pattern, options={})
+      flags = flags_from({patterns: [pattern]
+                         }.merge(options))
+
+      msg = ''
+      Open3.popen3('vanitygen', *flags) do |stdin, stdout, stderr, wait_thr|
+        stdin.close
+        while !stdout.eof?
+          msg << stdout.read
+        end
+        stdout.close
+
+        error = stderr.read
+        stderr.close
+        raise "vanitygen status (#{wait_thr.value}) err: #{error}" if wait_thr.value != 0
+      end
+
+      parse(msg)[0]
+    end
+
+    def continuous(patterns, options={}, &block)
+      raise LocalJumpError if block.nil?
+
+      patterns_file = Tempfile.new('vanitygen-patterns')
+      patterns.each do |pattern|
+        patterns_file.puts pattern
+      end
+      patterns_file.flush
+
+      tmp_pipe = "/tmp/vanitygen-pipe-#{rand(1000000)}"
+      File.mkfifo(tmp_pipe)
+
+      flags = flags_from({continuous: true,
+                          patterns_file: patterns_file.path,
+                          output_file: tmp_pipe,
+                          patterns: patterns,
+                         }.merge(options))
+
+      thread = Thread.new do
+        # FIXME: ignore EOF instead of reopening
+        loop do
+          File.open(tmp_pipe, 'r') do |file|
+            while !file.eof? and (msg = file.read)
+              parse(msg).each do |data|
+                block.call(data)
+              end
+            end
+          end
+        end
+      end
+
+      pid_vanitygen = Process.spawn('vanitygen', *flags, out: '/dev/null', err: '/dev/null')
+      Process.wait(pid_vanitygen)
+    ensure
+      thread && thread.kill
+      if pid_vanitygen
+        begin
+          Process.kill('TERM', pid_vanitygen)
+          Process.detach(pid_vanitygen) # if no detach, vanitygen will zombify
+        rescue Errno::ESRCH
+          # vanitygen died by itself. Ignore and continue cleanup.
+        end
+      end
+
+      tmp_pipe && File.exist?(tmp_pipe) && File.delete(tmp_pipe)
+      if patterns_file
+        patterns_file.close
+        patterns_file.unlink
+      end
+    end
+
+    private
+
+    def flags_from(options)
+      [].tap do |flags|
+        patterns =
+          if options[:patterns].nil?
+            nil
+          elsif options[:patterns].any? { |p| p.is_a?(Regexp) }
+            if options[:patterns].all? { |p| p.is_a?(Regexp) }
+              flags << '-r'
+              options[:patterns].map(&:source)
+            else
+              raise TypeError
+            end
+          else
+            options[:patterns].map(&:to_s)
+          end
+
+        flags << NETWORKS[network]               if NETWORKS[network]
+        flags << '-n'                            if options[:simulate]
+        flags << '-k'                            if options[:continuous]
+        flags << '-i'                            if options[:case_insensitive]
+        flags << '-f' << options[:patterns_file] if options[:patterns_file]
+        flags << '-o' << options[:output_file]   if options[:output_file]
+        flags.concat(patterns)                   if patterns && !options[:patterns_file]
+      end
+    end
+
+    def parse(msg)
+      lines = msg.split("\n").grep(/(Pattern|Address|Privkey)/)
+      lines.each_slice(3).map do |snippet|
+        {
+          pattern: snippet[0].split.last,
+          address: snippet[1].split.last,
+          private_key: snippet[2].split.last,
+        }
+      end
+    end
+  end
+end

data/lib/vanitygen/version.rb

@@ -0,0 +1,3 @@
+module Vanitygen
+  VERSION = '0.0.1'
+end

data/spec/vanitygen_spec.rb

@@ -0,0 +1,150 @@
+require 'vanitygen'
+
+require 'bitcoin'
+require 'devnull'
+require 'timeout'
+
+describe Vanitygen do
+  let(:pattern_string_a)  { '1A' }
+  let(:pattern_string_b)  { '1B' }
+  let(:pattern_string_ab) { '1AB' }
+  let(:pattern_regex_ab)  { /[aA][bB]/ }
+  let(:pattern_any)       { '1' }
+
+  describe '.generate' do
+    context 'string' do
+      subject { Vanitygen.generate(pattern_string_a) }
+
+      it 'has valid address' do
+        expect(subject[:address]).to satisfy { |addr| Bitcoin.valid_address?(addr) }
+      end
+
+      it 'has address starting with pattern' do
+        expect(subject[:address]).to start_with(pattern_string_a)
+      end
+
+      it 'has correct private_key to unlock pattern' do
+        bkey = Bitcoin::Key.from_base58(subject[:private_key])
+        expect(subject[:address]).to eq(bkey.addr)
+      end
+    end
+
+    context 'regex' do
+      subject { Vanitygen.generate(pattern_regex_ab) }
+
+      it 'has valid address' do
+        expect(subject[:address]).to satisfy { |addr| Bitcoin.valid_address?(addr) }
+      end
+
+      it 'has address matching pattern' do
+        expect(subject[:address]).to match(pattern_regex_ab)
+      end
+    end
+  end
+
+  describe '.continuous' do
+    it 'requires a block' do
+      expect{Vanitygen.continuous([pattern_any])}.to raise_error(LocalJumpError)
+    end
+
+    it 'requires same type' do
+      noop = proc{}
+      expect{Vanitygen.continuous([pattern_regex_ab, pattern_string_a], &noop)}.to raise_error(TypeError)
+    end
+
+    context 'threaded with capture block' do
+      let(:captured) { [] }
+
+      def capture(attr=nil)
+        if attr.nil?
+          proc { |data| captured << data }
+        else
+          proc { |data| captured << data[attr] }
+        end
+      end
+
+      def continuous_with_timeout(patterns, options={}, &block)
+        duration = options.delete(:timeout) || 0.1
+        Timeout.timeout duration do
+          Vanitygen.continuous(patterns, options, &block)
+        end
+
+        raise 'Expected timeout but did not happen'
+      rescue Timeout::Error => e
+        # expected
+      end
+
+      context 'base test' do
+        before do
+          continuous_with_timeout([pattern_any], &capture(:address))
+        end
+
+        it 'runs a lot' do
+          expect(captured.count).to be > 10
+        end
+
+        it 'returns valid addresses' do
+          expect(captured).to all(satisfy { |addr| Bitcoin.valid_address?(addr) })
+        end
+      end
+
+      context 'with string' do
+        it 'starts with matching pattern' do
+          continuous_with_timeout([pattern_string_a], &capture(:address))
+          expect(captured.size).to be > 1
+          expect(captured).to all(start_with(pattern_string_a))
+        end
+
+        it 'matches with case insensitivity' do
+          continuous_with_timeout([pattern_string_ab], case_insensitive: true, &capture(:address))
+          prefixes = captured.map { |addr| addr[0..2] }
+          expect(prefixes.uniq.size).to be > 1
+        end
+
+        it 'matches multiple patterns' do
+          continuous_with_timeout([pattern_string_a, pattern_string_b], &capture(:address))
+          # should be
+          # expect(captured).to any(addr.start_with?(pattern_string_a))
+          # expect(captured).to any(addr.start_with?(pattern_string_b))
+          expect(captured).to satisfy { |a| a.any? { |addr| addr.start_with?(pattern_string_a) } }
+          expect(captured).to satisfy { |a| a.any? { |addr| addr.start_with?(pattern_string_b) } }
+        end
+      end
+
+      context 'with regex' do
+        it 'matches the regex' do
+          continuous_with_timeout([pattern_regex_ab], &capture(:address))
+          expect(captured.size).to be > 1
+          expect(captured).to all(match(pattern_regex_ab))
+        end
+      end
+    end
+  end
+
+  describe '.difficulty' do
+    it 'returns difficulty in Numeric' do
+      expect(Vanitygen.difficulty(pattern_string_a)).to be_a Numeric
+    end
+  end
+
+  describe '.valid?' do
+    it 'is true for starting with 1' do
+      expect(Vanitygen.valid?('1abc')).to be(true)
+    end
+
+    it 'is false for starting with something else' do
+      expect(Vanitygen.valid?('abc')).to be(false)
+    end
+
+    it 'is false for really long strings' do
+      expect(Vanitygen.valid?('1abcdefghijklmnopqrstuvwxyz')).to be(false)
+    end
+
+    it 'is false for illegal characters' do
+      expect(Vanitygen.valid?('10')).to be(false)
+      expect(Vanitygen.valid?('1O')).to be(false)
+      expect(Vanitygen.valid?('1I')).to be(false)
+      expect(Vanitygen.valid?('1l')).to be(false)
+    end
+  end
+end

data/vanitygen-wrapper.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vanitygen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vanitygen-wrapper'
+  spec.version       = Vanitygen::VERSION
+  spec.authors       = ['Benjamin Feng']
+  spec.email         = ['contact@fengb.info']
+  spec.summary       = %q{Thin ruby wrapper around vanitygen executable}
+  spec.description   = %q{Thin ruby wrapper around vanitygen executable. Sibling project of <https://github.com/bitvain/vanitygen-ruby>.}
+  spec.homepage      = 'https://github.com/bitvain/vanitygen-wrapper'
+  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_runtime_dependency 'mkfifo', '~> 0.0.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'bitcoin-ruby', '~> 0.0.6'
+  spec.add_development_dependency 'ffi', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: vanitygen-wrapper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Benjamin Feng
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mkfifo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bitcoin-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Thin ruby wrapper around vanitygen executable. Sibling project of <https://github.com/bitvain/vanitygen-ruby>.
+email:
+- contact@fengb.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vanitygen.rb
+- lib/vanitygen/version.rb
+- spec/vanitygen_spec.rb
+- vanitygen-wrapper.gemspec
+homepage: https://github.com/bitvain/vanitygen-wrapper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Thin ruby wrapper around vanitygen executable
+test_files:
+- spec/vanitygen_spec.rb