bitcoin-ruby 0.0.1 → 0.0.2

data/bitcoin-ruby.gemspec

@@ -8,8 +8,9 @@ Gem::Specification.new do |s|
   s.authors     = ["lian"]
   s.email       = ["meta.rb@gmail.com"]
   s.homepage    = ""
-  s.summary     = %q{Gem for working with Bitcoin network}
-  s.description = %q{Gem for working with Bitcoin network}
+  s.summary     = %q{bitcoin utils and protocol in ruby}
+  s.description = %q{This is a ruby library for interacting with the bitcoin protocol/network}
+  s.homepage    = "https://github.com/lian/bitcoin-ruby"
 
   s.rubyforge_project = "bitcoin-ruby"
 
@@ -19,9 +20,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.required_rubygems_version = ">= 1.3.6"
-  s.add_dependency "rake",        ">= 0.8.0"
-  s.add_dependency "eventmachine"
-
-  s.add_development_dependency "bacon"
-
+  #s.add_development_dependency "bacon"
 end

data/concept-examples/blockchain-pow.rb

@@ -11,7 +11,7 @@ require 'digest/sha2'
 
 def do_work(data, target, nonce=0)
   found = nil
-  while !found
+  until found
       d = data + [nonce].pack("I")
       h = Digest::SHA256.hexdigest( Digest::SHA256.digest( d ) ).to_i(16)
 

data/doc/CONFIG.rdoc

@@ -6,9 +6,9 @@ All commands accept configuration, either via config file, or at the command lin
 
 There are 3 default locations where configfiles are loaded from:
 
-* +/etc/bitcoin-ruby.yml+
-* +~/.bitcoin-ruby.yml+
-* +./bitcoin-ruby.yml+
+* /etc/bitcoin-ruby.yml
+* ~/.bitcoin-ruby.yml
+* ./bitcoin-ruby.yml
 
 Files are loaded in order (if they exist) and override each others settings.
 
@@ -42,7 +42,7 @@ from the +all+ category (ie. +bitcoin_wallet+ loads +all+ and +wallet+).
    command: "127.0.0.1:9999"              # IP:Port to listen for incomming command connections
    listen: "0.0.0.0:8332"                 # IP:Port to listen for incoming peer connections
    connect: ""                            # List of IP:Port,IP:Port of nodes to connect to
-   storage: "sequel::sqlite://bitcoin.db" # storage backend to use (see STORAGE)
+   storage: "sequel::sqlite://~/.bitcoin-ruby/<network>/blocks.db" # storage backend to use (see STORAGE)
  node:
    headers_only: false                    # download/store only block headers (experimental)
    dns: true                              # query peers from dns server
@@ -63,4 +63,4 @@ from the +all+ category (ie. +bitcoin_wallet+ loads +all+ and +wallet+).
      addrs: 15                            # collect new peer addrs
      connect: 30                          # connect to new peers
  wallet:
-   keystore: "simple::file=~/.bitcoin-ruby/keys.json" # keystore to use
+   keystore: "simple::file=~/.bitcoin-ruby/<network>/keys.json" # keystore to use

data/doc/EXAMPLES.rdoc

@@ -2,8 +2,12 @@
 
 There are a few demo scripts in `examples/` that might give you an idea where to start.
 
-examples/connect.rb::       Connect to a network node and chat a little.
-examples/verify_tx.rb::     Fetch a transaction from local storage and verify signatures.
-examples/bbe_verify_tx.rb:: Fetch transaction from blockexplorer.com and verify signatures.
-examples/balance.rb::       Display balance/transactions for given address.
-examples/relay_tx.rb::      Relay transaction to the network.
+connect.rb::       Connect to a network node and chat a little.
+verify_tx.rb::     Fetch a transaction from local storage and verify signatures.
+bbe_verify_tx.rb:: Fetch transaction from blockexplorer.com and verify signatures.
+balance.rb::       Display balance/transactions for given address.
+relay_tx.rb::      Relay transaction to the network.
+generate_tx.rb::   Create a transaction.
+validate_tx.rb::   Verify transaction signatures.
+simple_network_monitor_and_util:: Connects to the network and lets you monitor and query blocks/txs.
+forwarder.rb::     Waits for tx sent to your address and forwards them to another address.

data/doc/NAMECOIN.rdoc

@@ -0,0 +1,34 @@
+= Namecoin
+
+Namecoin is almost fully supported.
+* connect to the network,
+* store and query the blockchain
+* transact NMC
+* create/handle name_new/first/update transaction types
+
+The AuxPow is parsed from the block header, the only thing missing is actually verifying it.
+
+== Usage
+
+It should suffice to just set the network to :namecoin when running the node/wallet.
+
+ bitcoin_node -n namecoin
+
+ bitcoin_wallet -n namecoin list
+ bitcoin_wallet -n namecoin send address:NCme95FewQEjTeBhBfXTyqjz1GTxw4bo56:1.0 0.1
+
+ bitcoin_wallet -n namecoin name_show d/bitcoin
+ bitcoin_wallet -n namecoin name_history d/bitcoin
+
+ bitcoin_wallet -n namecoin name_new d/bitcoin
+ bitcoin_wallet -n namecoin name_firstupdate d/bitcoin abcdef '{"foo": "bar"}'
+ bitcoin_wallet -n namecoin name_update d/bitcoin '{"bar": "baz"}'
+ bitcoin_wallet -n namecoin name_update d/bitcoin 'transferring...' NCme95FewQEjTeBhBfXTyqjz1GTxw4bo56
+
+== Implementation Details
+
+All the differences from regular bitcoin behaviour should be in separate modules inside
+Bitcoin::Namecoin. (this is still a work in progress)
+
+The AuxPow parsing is implemented in the Bitcoin::Protocol/::Block, because there might
+be other altchains using it one day.

data/doc/NODE.rdoc

@@ -11,25 +11,162 @@ using the sequel::sqlite3 STORAGE backend):
 
 You can specify options (see +--help+) or pass a config file with +--config+ (see CONFIG).
 
-Some common options you might want to change:
+Some common options you might want to use:
 
 <tt>-n --network</tt> <i><name></i>::
-  +bitcoin+ or +testnet+ network
+  Network to use. Usually +bitcoin+. Support for +namecoin+ is also quite good.
+  Use +testnet+ for development.
+
+<tt>-c --config</tt> <i><file></i>::
+  Read options from config file. See also CONFIG.
+
 <tt>--connect</tt> <i><ip:port></i>::
-  list of peers to connect to
+  List of peers to connect to.
+
 <tt>-s --storage</tt> <i><backend-string></i>::
- storage backend to use (see STORAGE)
+  Storage backend to use. See also STORAGE.
+
+<tt>--import</tt> <i><blockchain dir></i>::
+  Import blockchain in bitcoind/qt format from given directory.
+
+<tt>--skip-validation</tt>::
+  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>::
+  Check consistency of the +count+ most recent blocks. Pass -1 to check all blocks.
+
+<tt>-v --verbose</tt>::
+  Display debug output.
+
+<tt>-h --help</tt>::
+  Display all available options.
 
-It will take some time to download/store the entire blockchain at first, so be patient ;)
+It will take a long time to download/store the entire blockchain at first, so be patient ;)
 
 
-== Command client
+== Command socket
 
 The node opens a separate command socket which you can connect to and query statistics
-or get notified about new blocks/tx, etc.
+or get notified about new blocks/tx, etc. See below for a list of available commands.
+
+=== 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:
+
+ bitcoin_node info
+ bitcoin_node -c config.yml info
+ bitcoin_node monitor "block tx"
+
+
+=== CommandClient
+
+If you are programming in an EventMachine context, you might find the
+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):
+
+ $ echo -e '["tslb", []]\0' | nc 127.0.0.1 9999
+ ["tslb",{"tslb":2700}]
+
+
+=== Commands
+
+==== info
+
+Get various statistics.
+
+ bitcoin_node info
+
+==== config
+
+Get the currently active configuration.
+
+ bitcoin_node config
+
+==== connections
+
+Get currently connected peers.
+
+ bitcoin_node connections
+
+==== connect
+
+Connect to given peer(s).
+
+ bitcoin_node connect <ip>:<port>[,<ip>:<port>]
+
+==== disconnect
+
+Disconnect given peer(s).
+
+ bitcoin_node disconnect <ip>:<port>[,<ip>,<port>]
+
+==== getblocks
+
+Trigger the node to ask its peers for new blocks.
+
+ bitcoin_node getblocks
+
+==== getaddr
+
+Trigger the node to ask its for new peer addresses.
+
+ bitcoin_node getaddr
+
+==== addrs
+
+Get known peer addresses (used by bin/bitcoin_dns_seed)
+
+ bitcoin_node addrs [count]
+
+==== tslb
+
+Get Time Since Last Block.
+
+ bitcoin_node tslb
+
+==== create_tx
+
+TODO
+
+==== assemble_tx
+
+TODO
+
+==== relay_tx
+
+Relay given transaction (in hex).
+
+ bitcoin_node 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>
+
+==== store_tx
+
+Store given transaction (in hex) as if it was received by a peer.
+
+ bitcoin_node store_tx <tx in hex>
+
+==== stop
+
+Stop the bitcoin node.
+
+ bitcoin_node stop
+
+==== help
+
+List all available commands.
 
- bitcoin_node info  # general statistics
+ bitcoin_node help
 
- bitcoin_node help  # list all commands
 
- bitcoin_node monitor block # wait for new blocks and output their hashes

data/examples/balance.rb

@@ -15,7 +15,7 @@ store = Bitcoin::Storage.sequel(:db => "sqlite://bitcoin.db")
 address = ARGV.shift
 
 unless Bitcoin.valid_address?(address)
-  puts "Address #{address} is invalid."
+  puts "Address #{address} is invalid for #{Bitcoin.network_name} network."
   exit 1
 end
 
@@ -38,8 +38,14 @@ if ARGV[0] == "--list"
     total += txout.value
     puts "#{tx.hash} |#{str_val(txout.value, '+ ')}  |=> #{str_val(total)}"
 
-    txout.get_tx.in.map(&:get_prev_out).each do |prev_out|
-      puts "  from #{prev_out.get_addresses.join(", ")}"
+    tx = txout.get_tx
+    if tx.is_coinbase?
+      puts " "*12 + "generated (#{tx.get_block.hash})"
+    else
+      tx.in.each do |txin|
+        addresses = txin.get_prev_out.get_addresses.join(", ")
+        puts "  #{str_val(txin.get_prev_out.value)} from #{addresses}"
+      end
     end
     puts
 
@@ -48,7 +54,7 @@ if ARGV[0] == "--list"
       total -= txout.value
       puts "#{tx.hash} |#{str_val(txout.value, '- ')}  |=> #{str_val(total)}"
       txin.get_tx.out.each do |out|
-        puts "  to #{out.get_addresses.join(", ")}"
+        puts "  #{str_val(out.value)} to #{out.get_addresses.join(", ")}"
       end
       puts
     end

data/examples/bbe_verify_tx.rb

@@ -11,11 +11,16 @@ require 'bitcoin'
 require 'open-uri'
 
 tx_hash = ARGV[0]
-$testnet = ARGV[1]
+$testnet = ARGV.select{|i| i.downcase == 'testnet' }[0] ? true : false
+$use_coinbase_bbe = ARGV.select{|i| i.downcase == 'coinbase' }[0] ? true : false
 
 # fetch transaction from bbe as json and deserialize into Bitcoin::Protocol::Tx object
 def get_tx(hash)
-  url = "http://blockexplorer.com/%srawtx/%s" % [$testnet ? 'testnet/' : '',  hash]
+  if $use_coinbase_bbe && !$testnet
+    url = "https://coinbase.com/network/tx/%s.json" % [hash]
+  else
+    url = "http://blockexplorer.com/%srawtx/%s" % [$testnet ? 'testnet/' : '',  hash]
+  end
   json = open(url).read
   Bitcoin::Protocol::Tx.from_json(json)
 rescue Exception

data/examples/forwarder.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+#
+# Connect to a node's command socket, monitor incoming payments to one address
+# and forward everything to another address.
+# Needs the private key of the receiving address (to sign new tx) and the forwarding
+# address where payments are sent to.
+# Note how the private key does NOT have to be passed to the node, we just sign the
+# sig_hash ourselves.
+#
+#  examples/forwarder.rb <base58_privkey> <forwarding_address>
+#  examples/forwarder.rb KyZsiZiFyewBswJpdYywz4b5sif252iN5zZQjGzPVVgAsGYyMk8a 12bL22Pynmp7pDtDqD2w9iP7dRzdM1gNUd
+
+$:.unshift( File.expand_path("../../lib", __FILE__) )
+require 'eventmachine'
+require 'bitcoin'
+
+Bitcoin.network = :testnet3
+
+EM.run do
+
+  # key/address where people can send money
+  KEY = Bitcoin::Key.from_base58(ARGV[0])
+
+  # address where received money is forwarded to
+  FORWARD = ARGV[1]
+
+  # number of confirmations tx need before being forwarded
+  CONFIRMATIONS = 1
+
+  # list of already forwarded txs, to prevent duplicates
+  FORWARDED_TXS = []
+
+  Bitcoin::Network::CommandClient.connect("127.0.0.1", 9999) do
+
+    on_connected do
+      request("monitor", "output", "output_#{CONFIRMATIONS}")
+
+      puts "Running bitcoin forwarder on address #{KEY.addr}."
+      puts "Forwarding every incoming payment to #{FORWARD}."
+    end
+
+    on_output do |tx_hash, recipient_addr, value, confirmations|
+      if recipient_addr == KEY.addr
+        if confirmations >= CONFIRMATIONS
+          next  if FORWARDED_TXS.include?(tx_hash)
+          FORWARDED_TXS << tx_hash
+          puts "Payment of #{value.to_f/1e8} BTC confirmed. Forwarding..."
+
+          # Note: We could also pass KEY.priv instead of KEY.addr here.
+          # Then we would get the complete tx in one step without calling "assemble_tx".
+          request("create_tx", [KEY.addr], [[FORWARD, value]])
+        else
+          puts "Received unconfirmed payment of #{value.to_f/1e8} BTC."
+        end
+      end
+    end
+
+    on_create_tx do |unsigned_tx, sig_hashes|
+      sig_pubkeys = sig_hashes.map do |sig_hash, address|
+        [KEY.sign(sig_hash.htb).hth, KEY.pub]
+      end
+      request("assemble_tx", unsigned_tx, sig_pubkeys)
+    end
+
+    on_assemble_tx do |tx_in_hex|
+      tx = Bitcoin::P::Tx.new(tx_in_hex.htb)
+      puts "Relaying tx #{tx.hash}..."
+      request("relay_tx", tx_in_hex)
+    end
+
+  end
+
+end

data/examples/generate_tx.rb

@@ -0,0 +1,34 @@
+$:.unshift( File.expand_path("../../lib", __FILE__) )
+require 'bitcoin'
+
+# p Bitcoin.generate_address # returns address, privkey, pubkey, hash160
+
+prev_tx = Bitcoin::Protocol::Tx.from_json_file('baedb362adba39753a7d2c58fd3dc4897a1b479859f707a819f096696f3facad.json') # <- redeeming transaction input fetchted by for example simple_network_monitor_and_util.rb
+prev_tx_output_index = 0
+value = prev_tx.outputs[prev_tx_output_index].value
+#value = 1337 # maybe change the value (eg subtract for fees)
+
+
+tx = Bitcoin::Protocol::Tx.new
+tx.add_in Bitcoin::Protocol::TxIn.new(prev_tx.binary_hash, prev_tx_output_index, 0)
+
+tx.add_out Bitcoin::Protocol::TxOut.value_to_address(value, "1MiQ3zD3hzZBZ4cUDfPd8Eqnjcedkwt5jy") # <- dest address (our donation address)
+
+# if all in and outputs are defined, start signing inputs.
+key = Bitcoin.open_key("9b2f08ebc186d435ffc1d10f3627f05ce4b983b72c76b0aee4fcce99e57b0342") # <- privkey
+sig = Bitcoin.sign_data(key, tx.signature_hash_for_input(0, prev_tx))
+tx.in[0].script_sig = Bitcoin::Script.to_signature_pubkey_script(sig, [key.public_key_hex].pack("H*"))
+#tx.in[0].add_signature_pubkey_script(sig, key.public_key_hex)
+
+# finish check
+tx = Bitcoin::Protocol::Tx.new( tx.to_payload )
+p tx.hash
+p tx.verify_input_signature(0, prev_tx) == true
+
+puts "json:\n"
+puts tx.to_json # json
+puts "\nhex:\n"
+puts tx.to_payload.unpack("H*")[0] # hex binary
+
+# use this json file for example with `ruby simple_network_monitor_and_util.rb send_tx=<filename>` to push/send it to the network
+File.open(tx.hash + ".json", 'wb'){|f| f.print tx.to_json }