bitcoin-ruby 0.0.5 → 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e801e5256acce9c4fc02ef046d2388365111fd23
+  data.tar.gz: 81781d99c978635c078d7aae95a2e29c892f6e52
+SHA512:
+  metadata.gz: 84a5f6f668b5fb3590ab5e3d9bc58255f06fbcc2adad65e8fe3943253630e12510a348257ce7181e382411ab2ae68171f5d9787fa5780e7a5c9f410910f568f0
+  data.tar.gz: d07c7abc49e3f1eb0caf2244808be898855a82001504f1747c7c1328e960a2dccad6c0291740a02320bd59e84ba02adbc79af67656e0ceb6aee7b506edbf7313

data/.gitignore

@@ -9,7 +9,9 @@ tmp/
 log/
 rdoc/
 coverage/
+spec/bitcoin/fixtures/fake_chain
 *.conf
 *.db
 .rbx/
 /vendor
+.ruby-version

data/.travis.yml

@@ -2,9 +2,9 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0
 before_script:
   - psql -c 'create database bitcoin_test;' -U postgres
   - mysql -e 'create database bitcoin_test;'
 env:
-  - TEST_DB_POSTGRES="postgres://postgres@localhost/bitcoin_test"
-  - TEST_DB_MYSQL="mysql:/bitcoin_test"
+  - TEST_DB_POSTGRES="postgres://postgres@localhost/bitcoin_test" TEST_DB_MYSQL="mysql:/bitcoin_test"

data/COPYING

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Julian Langschaedel <meta.rb@gmail.com>
+Copyright (c) 2014 Julian Langschaedel <meta.rb@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to

data/Gemfile

@@ -3,23 +3,17 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in bitcoin-ruby.gemspec
 gemspec
 
-group :test do 
-  gem 'sqlite3', :platforms => :ruby
-
-  gem 'bacon', '>= 1.2.0'
-  gem 'simplecov', :require => false
-
-  gem 'rake', '>= 0.8.0'
-end
-
 group :development do
   gem 'eventmachine'
   gem 'ffi'
   gem 'log4r'
   gem 'sequel'
+  gem 'scrypt'
 
-  gem 'sqlite3', :platforms => :ruby, :require => false
-  gem 'pg', :platforms => :ruby, :require => false
+  gem 'sqlite3', platforms: :ruby, require: false
+  gem 'pg', platforms: :ruby, require: false
 
   gem "rake", ">= 0.8.0"
+  gem 'bacon', '>= 1.2.0'
+  gem 'simplecov', require: false
 end

data/README.rdoc

@@ -1,4 +1,4 @@
-= Bitcoin-ruby {<img src="https://api.travis-ci.org/lian/bitcoin-ruby.png?branch=master" />}[http://travis-ci.org/lian/bitcoin-ruby]
+= Bitcoin-ruby {<img src="https://api.travis-ci.org/lian/bitcoin-ruby.svg?branch=master" />}[http://travis-ci.org/lian/bitcoin-ruby]
 
 This is a ruby library for interacting with the bitcoin protocol/network.
 
@@ -15,11 +15,13 @@ Some of the main features are:
 * Bitcoin::Builder provides a high-level API for creating transactions (and blocks)
 * Bitcoin::Wallet is a draft implementation of a simple wallet
 * Bitcoin::Namecoin implements all the namecoin-specific differences (see NAMECOIN)
+* Bitcoin::Litecoin implements all the litecoin-sepcific differences
 
 == Compatible with...
 
 * ruby 1.9.3
 * ruby 2.0.0
+* ruby 2.1.2
 
 == Installation
 
@@ -30,7 +32,7 @@ We assume you already have a ruby 1.9 or 2.0 compatible interpreter and rubygems
 
 if you want to have it available system-wide, just build the gem and install it:
 
- gem build bitcoin-ruby.gemspec && gem install bitcoin-ruby-0.0.2.gem
+ gem build bitcoin-ruby.gemspec && gem install bitcoin-ruby-0.0.5.gem
 
 now you can just call +bitcoin_node+ from anywhere.
 
@@ -44,6 +46,7 @@ intentionally kept to a minimum, so nobody has to install unneeded dependencies.
 * +em-dns+ or +nslookup+ to get peer addrs from DNS seeds
 * +gir_ffi+ for the gui
 * +bacon+ to run the specs
+* +scrypt+ to use a much faster scrypt hash implementation for Litecoin
 
 If you would like to install using Bundler, put it in your Gemfile and run bundle install
  gem 'bitcoin-ruby', git: 'https://github.com/lian/bitcoin-ruby', branch: 'master', require: 'bitcoin'
@@ -54,7 +57,7 @@ There is a node which connects to the network and downloads
 the blockchain into a database. see NODE, Bitcoin::Network::Node.
 
 It also opens an extra socket where local clients can query statistics,
-monitor blockchain data, and relay there transactions to the network.
+monitor blockchain data, and relay their own transactions to the network.
 see NODE, Bitcoin::Network::CommandHandler, Bitcoin::Network::CommandClient.
 
 There is a WALLET implementation to manage a set of keys, list balances and create
@@ -185,7 +188,7 @@ as well as the private key for the address required to sign for it.
  
  end
  
- # examine your transaction. you can relay it through http://webbtc.com/relay_tx
+ # examine your transaction. you can relay it through http://test.webbtc.com/relay_tx
  # that will also give you a hint on the error if something goes wrong
  puts new_tx.to_json
 
@@ -194,7 +197,7 @@ as well as the private key for the address required to sign for it.
 The Bitcoin::Network::Node can connect to peers and download the blockchain into a
 Bitcoin::Storage backend. For now it works completely self-contained:
 
- node = Bitcoin::Network::Node.new(options) # options = {:network => :bitcoin, ...}
+ node = Bitcoin::Network::Node.new(options) # options = {network: :bitcoin, ...}
  node.run
 
 In the future you will be able to register callbacks to the node and control many aspects
@@ -254,3 +257,6 @@ Even if you are completely lost, just pointing out what is unclear helps a lot!
 
 If you are curious or like to participate in development, drop by \#bitcoin-ruby on irc.freenode.net!
 
+== License
+
+Available here: [link:COPYING]

data/Rakefile

@@ -29,6 +29,11 @@ task :bacon do
   specs = PROJECT_SPECS
   #specs.delete_if{|i| File.basename(i) == 'storage_spec.rb' } # skip for now
 
+  # E.g. SPEC=specs/bitcoin/script/ to run script-related specs only.
+  if spec_mask = ENV["SPEC"]
+    specs.delete_if{|s| !s[spec_mask] }
+  end
+
   some_failed = false
   specs_size = specs.size
   len = specs.map{|s| s.size }.sort.last

data/bin/bitcoin_node

@@ -43,6 +43,16 @@ optparse = OptionParser.new do |opts|
     end
   end
 
+  opts.on("-a", "--announce",
+    "Announce our own address to the network, so we will get incoming connections.") do
+    options[:announce] = true
+  end
+
+  opts.on("--external-port PORT",
+    "Specify external port that can be used to reach this node (uses local port otherwise).") do |port|
+    options[:external_port] = port.to_i
+  end
+
   opts.on("-s", "--storage [BACKEND::CONFIG]",
     "Use storage backend (default: #{options[:storage]})") do |storage|
     options[:storage] = storage
@@ -136,35 +146,7 @@ Bitcoin.network = options[:network]
 FileUtils.mkdir_p File.join(ENV['HOME'], ".bitcoin-ruby/#{Bitcoin.network_name}")
 
 if ARGV.any?
-  EM.run do
-    Bitcoin::Network::CommandClient.connect(*options[:command]) do
-      on_response do |cmd, data|
-        unless cmd == "monitor"
-          puts JSON.pretty_generate data
-          EM.stop
-        end
-      end
-      on_block do |block, depth|
-        puts "block: #{block['hash']} (#{depth})"
-      end
-      on_tx do |tx, confirmations|
-        puts "tx(#{confirmations}): #{tx['hash']}"
-      end
-      on_output do |tx_hash, address, value, confirmations|
-        puts "output(#{confirmations}): tx #{tx_hash[0..8]}: #{address} received #{value.to_f / 1e8} BTC"
-      end
-      on_connection do |type, host|
-        if type == "connected"
-          puts "Connected: #{host['host']}:#{host['port']}"
-        else
-          puts "Disconnected: #{host.inspect}"
-        end
-      end
-      on_connected do
-        request(ARGV[0], *(ARGV[1] || "").split(" "))
-      end
-    end
-  end
+  system(File.join(File.dirname(__FILE__), "bitcoin_node_cli"), *ARGV) 
 else
   node = Bitcoin::Network::Node.new(options)
   node.run

data/bin/bitcoin_node_cli

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+$:.unshift( File.expand_path("../../lib", __FILE__) )
+
+require 'bitcoin'
+require 'optparse'
+require 'fileutils'
+Bitcoin.require_dependency :eventmachine
+Bitcoin.require_dependency :json
+
+defaults = Bitcoin::Network::Node::DEFAULT_CONFIG
+
+options = Bitcoin::Config.load(defaults, :blockchain)
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: bitcoin_node [options]"
+
+  opts.separator("\nAvailable options:\n")
+
+  opts.on("-c", "--config FILE",
+    "Config file (default: #{Bitcoin::Config::CONFIG_PATHS})") do |file|
+    options = Bitcoin::Config.load_file(options, file, :blockchain)
+  end
+
+  opts.on("-n", "--network [NETWORK]",
+    "User Network (default: #{options[:network]})") do |network|
+    options[:network] = network
+  end
+
+  opts.on("--command [HOST:PORT]",
+          "Command socket (default: #{options[:command].join(':')})") do |command|
+    options[:command] = command.split(":")
+  end
+
+  opts.on( '-h', '--help', 'Display this screen' ) do
+    puts opts; exit
+  end
+end
+
+optparse.parse!
+
+Bitcoin.network = options[:network]
+FileUtils.mkdir_p File.join(ENV['HOME'], ".bitcoin-ruby/#{Bitcoin.network_name}")
+                  
+EM.run do
+  Bitcoin::Network::CommandClient.connect(*options[:command]) do
+    on_response do |cmd, data|
+      unless cmd == "monitor"
+        puts JSON.pretty_generate data
+        EM.stop
+      end
+    end
+    on_block do |block, depth|
+      hash = Bitcoin::P::Block.new(block['hex'].htb).to_hash.merge("depth" => block['depth'])
+      puts JSON.pretty_generate(hash)
+    end
+    on_tx do |tx, confirmations|
+      hash = Bitcoin::P::Tx.new(tx['hex'].htb).to_hash.merge("nhash" => tx['nhash'], "conf" => tx['conf'])
+      puts JSON.pretty_generate(hash)
+    end
+    on_output do |data|
+      puts JSON.pretty_generate(data)
+    end
+    on_connection do |data|
+      p data
+    end
+    on_connected do
+      cmd, params = ARGV.shift, Hash[ARGV.map {|a| a.split("=") }]
+      case cmd
+      when "create_tx"
+        params["keys"] = JSON.parse(params["keys"])
+        params["recipients"] = JSON.parse(params["recipients"])
+      when "assemble_tx"
+        params["sig_pubs"] = JSON.parse(params["sig_pubs"])
+      when "monitor"
+        params["addresses"] = JSON.parse(params["addresses"])  if params["addresses"]
+        $stdout.sync = true
+      end
+      request(cmd, params)
+    end
+  end
+end

data/bin/bitcoin_wallet

@@ -69,7 +69,7 @@ optparse.parse!
 
 cmd = ARGV.shift; cmdopts = ARGV
 unless cmd
-  exit puts optparse
+  puts optparse; exit
 end
 
 Bitcoin.network = options[:network]
@@ -120,6 +120,8 @@ def send_transaction(storage, options, tx, ask = true)
         puts "#{script.get_address} (address)"
       elsif script.is_multisig?
         puts "#{script.get_addresses.join(' ')} (multisig)"
+      elsif script.is_op_return?
+        puts "#{script.get_op_return_data} (op_return)"
       elsif script.is_namecoin?
         puts "#{script.get_address} (#{script.type})"
         print " " * 16
@@ -141,7 +143,7 @@ def send_transaction(storage, options, tx, ask = true)
     end
   end
   EM.run do
-    Bitcoin::Network::CommandClient.connect(*options[:command].split(":")) do
+    Bitcoin::Network::CommandClient.connect(*options[:command]) do
       on_connected do
         request(:relay_tx, tx.to_payload.hth)
       end
@@ -311,8 +313,9 @@ when "name_update"
   puts tx.hash
 
 when "send"
-  to = cmdopts[0].split(',').map do |pair|
-    type, *addrs, value = pair.split(":")
+  to = cmdopts[0].split(',').map do |opts|
+    o = opts.split(":")
+    type, *addrs, value = *(o.size == 2 ? [:address, *o] : o)
     value = val_str(value)
     [type.to_sym, *addrs, value]
   end
@@ -382,7 +385,7 @@ when "relay"
   end
 
   EM.run do
-    EM.connect(*options[:command].split(":")) do |conn|
+    EM.connect(*options[:command]) do |conn|
       conn.send_data(["relay_tx", tx.to_payload.unpack("H*")[0]].to_json)
       def conn.receive_data(data)
         (@buf ||= BufferedTokenizer.new("\x00")).extract(data).each do |packet|
@@ -395,5 +398,5 @@ when "relay"
   end
 
 else
-  puts "Unknown command."
+  puts "Unknown command. See --help for available commands."
 end

data/doc/NODE.rdoc

@@ -33,7 +33,7 @@ Some common options you might want to use:
   Skip validation of received blockchain data. Can be used to speed up import/sync when
   blockchain data is received from a trusted source.
 
-<tt>--check-blocks <i><count></i>::
+<tt>--check-blocks <i><count></i></tt>::
   Check consistency of the +count+ most recent blocks. Pass -1 to check all blocks.
 
 <tt>-v --verbose</tt>::
@@ -49,15 +49,18 @@ It will take a long time to download/store the entire blockchain at first, so be
 
 The node opens a separate command socket which you can connect to and query statistics
 or get notified about new blocks/tx, etc. See below for a list of available commands.
+For more details, see Bitcoin::Network::CommandHandler.
 
 === CLI interface
 
-The easiest way is to just call `bitcoin_node` again in the same way you started it,
-but with an extra command argument:
+The `bitcoin_node_cli` command can be used to interface with a running node, send it commands
+and subscribe to notifications about new blocks/txs, etc.
+The easiest way is to just call `bitcoin_node_cli` in the same way you started
+`bitcoin_node`, but with extra command arguments:
 
- bitcoin_node info
- bitcoin_node -c config.yml info
- bitcoin_node monitor "block tx"
+ bitcoin_node_cli info
+ bitcoin_node_cli -c config.yml info
+ bitcoin_node_cli monitor "block tx"
 
 
 === CommandClient
@@ -68,11 +71,18 @@ Bitcoin::Network::CommandClient convenient.
 === Raw socket
 
 Of course you can also connect to the socket by any other means you like, just
-send [<command>, <params>] pairs and receive [<command>, <response>] pairs back (both
-encoded in JSON):
+your commands as valid JSON, like:
 
- $ echo -e '["tslb", []]\0' | nc 127.0.0.1 9999
- ["tslb",{"tslb":2700}]
+ {"id": 0, "method": <command>, "params": <params>}
+
+and you'll receive responses in the form:
+
+ {"id": <id>, "method": <method>, "result": <result>}
+
+For example:
+
+ $ echo -e '{"id": 1, "method": "tslb", "params": {}}\0' | nc 127.0.0.1 9999
+ {"id":1,"method":"tslb","result":{"tslb":10}}
 
 
 === Commands
@@ -81,92 +91,135 @@ encoded in JSON):
 
 Get various statistics.
 
- bitcoin_node info
+ bitcoin_node_cli info
 
 ==== config
 
 Get the currently active configuration.
 
- bitcoin_node config
+ bitcoin_node_cli config
 
 ==== connections
 
 Get currently connected peers.
 
- bitcoin_node connections
+ bitcoin_node_cli connections
 
 ==== connect
 
 Connect to given peer(s).
 
- bitcoin_node connect <ip>:<port>[,<ip>:<port>]
+ bitcoin_node_cli connect <ip>:<port>[,<ip>:<port>]
 
 ==== disconnect
 
 Disconnect given peer(s).
 
- bitcoin_node disconnect <ip>:<port>[,<ip>,<port>]
+ bitcoin_node_cli disconnect <ip>:<port>[,<ip>,<port>]
 
 ==== getblocks
 
 Trigger the node to ask its peers for new blocks.
 
- bitcoin_node getblocks
+ bitcoin_node_cli getblocks
 
 ==== getaddr
 
 Trigger the node to ask its for new peer addresses.
 
- bitcoin_node getaddr
+ bitcoin_node_cli getaddr
 
 ==== addrs
 
 Get known peer addresses (used by bin/bitcoin_dns_seed)
 
- bitcoin_node addrs [count]
+ bitcoin_node_cli addrs [count]
 
 ==== tslb
 
 Get Time Since Last Block.
 
- bitcoin_node tslb
+ bitcoin_node_cli tslb
 
 ==== create_tx
 
-TODO
+Create a transaction, collecting outputs from given +keys+, spending to +recipients+
+with an optional +fee+.
+Keys is an array that can contain either privkeys, pubkeys or addresses.
+When a privkey is given, the corresponding inputs are signed. If not, the
+signature_hash is computed and passed along with the response.
+After creating an unsigned transaction, one just needs to sign the sig_hashes
+and send everything to #assemble_tx, to receive the complete transaction that
+can be relayed to the network.
+
+ bitcoin_node_cli create_tx 'keys=[<addr|pub|priv>, <...>]' 'recipients=[[<addr>, <amount>], ...]'
 
 ==== assemble_tx
 
-TODO
+Assemble an unsigned transaction from the +tx+ and +sig_pubkeys+ params and return
+a valid transaction that can be relayed to the network.
+The +tx+ is the regular transaction structure, with empty input scripts
+(as returned by #create_tx when called without privkeys).
++sig_pubkeys+ is an array of [signature, pubkey] pairs used to build the input scripts.
+
+ bitcoin_node_cli assemble_tx tx=<hex> 'sig_pubkeys=[[<sig>, <pub>], ...]'
 
 ==== relay_tx
 
 Relay given transaction (in hex).
 
- bitcoin_node relay_tx <tx in hex>
+ bitcoin_node_cli relay_tx <tx in hex>
 
 ==== store_block
 
 Validate and store given block (in hex) as if it was received by a peer.
 
- bitcoin_node store_block <block in hex>
+ bitcoin_node_cli store_block <block in hex>
 
 ==== store_tx
 
 Store given transaction (in hex) as if it was received by a peer.
 
- bitcoin_node store_tx <tx in hex>
+ bitcoin_node_cli store_tx <tx in hex>
 
 ==== stop
 
 Stop the bitcoin node.
 
- bitcoin_node stop
+ bitcoin_node_cli stop
 
 ==== help
 
 List all available commands.
 
- bitcoin_node help
+ bitcoin_node_cli help
+
+
+=== Monitors
+
+==== block
+
+Monitor new blocks that are accepted into the main chain.
+If +last+ parameter is given, it will send all blocks since then.
+
+ bitcoin_node_cli monitor channel=block
+ bitcoin_node_cli monitor channel=block last=1234
+
+==== tx
+
+Monitor new transactions.
+If +conf+ parameter is given, it will only send txs with at least that many confirmations.
+If +last+ parameter is given, it will send all txs since then.
+
+ bitcoin_node_cli monitor channel=tx
+ bitcoin_node_cli monitor channel=tx conf=1 last=b187505ce2acbafcb02948657c0cadb855fbcbf0491f12670f9ff8d271de1983
+
+==== output
 
+Monitor transaction outputs.
+If +conf+ parameter is given, it will only send outputs with at least that many confirmations.
+If +last+ parameter is given, it will send all outputs since then.
+If +addresses+ parameter is given, it will only send outputs related to those addresses.
 
+ bitcoin_node_cli monitor channel=output
+ bitcoin_node_cli monitor channel=output conf=1 last=b187505ce2acbafcb02948657c0cadb855fbcbf0491f12670f9ff8d271de1983:0