btcruby 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7296b8cbca8113b4795a800e581c220afdbe9b12
-  data.tar.gz: a318bf76d773d9f4bc4955e03bd70f0006bbaf1a
+  metadata.gz: 4b9b9d085300b3e99129f1512fa8b0b7794a4aa4
+  data.tar.gz: 7fc8e5d75b7518afd548c7c5dbf49b7c98ec7f7a
 SHA512:
-  metadata.gz: ef71f62233c862f300abe91608cdc9f100a2ccdcc91f011436f543805fdceb0d8ff795240973a898edb1939c2ceceac43c00329430a0e78914bb97fe6ca5ae94
-  data.tar.gz: de2350b6b17e8c3de1f9e563916bdea830ed23fb0758e49ae1ea30de9d6ae4615fe786015860c1bf707f7a18e6c290eb52695ea77dc6bc63cf34ea546052fd3c
+  metadata.gz: 408fcbdd2fdc406a450382dcce2c86744a7c718f5a4d770a3a7c714f56a28b674d51a450968a2af857bac8c8390f37438efc8db8ef6e5003dc35a4623b3d5204
+  data.tar.gz: 48b073e59fa89922faa469dff926beff3261ef762270efd18de1ba31aabb5506ff84d7297d582192d392d7daee4fec7bb284ee04e0d5445e920dd9df62ead358

data/README.md

@@ -60,7 +60,8 @@ $ rake
 4. Generate and publish the gem:
 
 ```
-$ gem build btcruby
+$ git push origin --tags
+$ gem build btcruby.gemspec
 $ gem push btcruby-<version>.gem
 ```
 

data/RELEASE_NOTES.md

@@ -2,6 +2,12 @@
 BTCRuby Release Notes
 =====================
 
+1.0.6 (July 13, 2015)
+--------------------
+
+* Consistent aliasing between `==` and `eql?`
+* `TransactionOutpoint` implements `hash` method so it can be used as a key in a dictionary.
+
 1.0.5 (July 8, 2015)
 --------------------
 

data/lib/btcruby/address.rb

@@ -111,9 +111,13 @@ module BTC
     # Two instances are equal when they have the same contents and versions.
     def ==(other)
       return false if !other
-      self.data == other.data && self.version == other.version
+      data == other.data && version == other.version
     end
     alias_method :eql?, :==
+    
+    def hash
+      data.hash
+    end
 
     # Returns Base58Check representation of an address.
     def to_s

data/lib/btcruby/transaction_input.rb

@@ -255,6 +255,7 @@ module BTC
       return true if self.data == other.data
       return false
     end
+    alias_method :eql?, :==
 
     # Makes a deep copy of a transaction input
     def dup

data/lib/btcruby/transaction_outpoint.rb

@@ -22,7 +22,17 @@ module BTC
     def outpoint_id
       %{#{transaction_id}:#{index}}
     end
-    
+
+    def ==(other)
+      index == other.index &&
+      transaction_hash == other.transaction_hash
+    end
+    alias_method :eql?, :==
+
+    def hash
+      transaction_hash.hash ^ index
+    end
+
     def to_s
       outpoint_id
     end

data/lib/btcruby/transaction_output.rb

@@ -275,9 +275,10 @@ module BTC
 
     def ==(other)
       return true if super(other)
-      return true if self.data == other.data
+      return true if data == other.data
       return false
     end
+    alias_method :eql?, :==
 
     # Makes a deep copy of a transaction output
     def dup

data/lib/btcruby/version.rb

@@ -1,3 +1,3 @@
 module BTC
-  VERSION = "1.0.5".freeze
+  VERSION = "1.0.6".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: btcruby
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Oleg Andreev
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-08 00:00:00.000000000 Z
+date: 2015-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -31,24 +31,15 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.9.3
-description: Ruby library for interacting with Bitcoin.
+description: Bitcoin toolkit for Ruby
 email: oleganza+btcruby@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- FAQ.md
-- Gemfile
-- Gemfile.lock
-- HOWTO.md
 - LICENSE
 - README.md
 - RELEASE_NOTES.md
-- Rakefile
-- TODO.txt
-- bin/console
-- btcruby.gemspec
 - documentation/address.md
 - documentation/base58.md
 - documentation/block.md
@@ -127,10 +118,6 @@ files:
 - lib/btcruby/version.rb
 - lib/btcruby/wif.rb
 - lib/btcruby/wire_format.rb
-- sample_code/creating_a_p2sh_multisig_address.rb
-- sample_code/creating_a_transaction_manually.rb
-- sample_code/generating_an_address.rb
-- sample_code/using_transaction_builder.rb
 - spec/address_spec.rb
 - spec/all.rb
 - spec/base58_spec.rb
@@ -179,5 +166,28 @@ rubyforge_project: btcruby
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Ruby library for interacting with Bitcoin.
-test_files: []
+summary: Rich library for building awesome Bitcoin apps.
+test_files:
+- spec/address_spec.rb
+- spec/base58_spec.rb
+- spec/block_header_spec.rb
+- spec/block_spec.rb
+- spec/currency_formatter_spec.rb
+- spec/data_spec.rb
+- spec/diagnostics_spec.rb
+- spec/key_spec.rb
+- spec/keychain_spec.rb
+- spec/merkle_tree_spec.rb
+- spec/network_spec.rb
+- spec/open_assets/asset_address_spec.rb
+- spec/open_assets/asset_id_spec.rb
+- spec/open_assets/asset_marker_spec.rb
+- spec/open_assets/asset_processor_spec.rb
+- spec/open_assets/asset_transaction_builder_spec.rb
+- spec/open_assets/asset_transaction_spec.rb
+- spec/open_assets/issuance_id_spec.rb
+- spec/proof_of_work_spec.rb
+- spec/script_spec.rb
+- spec/transaction_builder_spec.rb
+- spec/transaction_spec.rb
+- spec/wire_format_spec.rb

data/.gitignore

@@ -1,20 +0,0 @@
-build/
-*.pbxuser
-!default.pbxuser
-*.mode1v3
-!default.mode1v3
-*.mode2v3
-!default.mode2v3
-*.perspectivev3
-!default.perspectivev3
-xcuserdata
-*.xccheckout
-*.moved-aside
-DerivedData
-*.hmap
-*.ipa
-*.xcuserstate
-*.xcodeproj
-*.xcodeproj/
-*.gem
-.ruby-version

data/FAQ.md

@@ -1,7 +0,0 @@
-
-BTCRuby FAQ
-===========
-
-This will answer questions like "what is compressed public key", "why when I convert private key to address it is not correct?" etc.
-
-

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-gemspec
-gem 'rake'

data/Gemfile.lock

@@ -1,18 +0,0 @@
-PATH
-  remote: .
-  specs:
-    btcruby (0.1.0)
-      ffi (~> 1.9, >= 1.9.3)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ffi (1.9.3)
-    rake (10.3.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  btcruby!
-  rake

data/HOWTO.md

@@ -1,17 +0,0 @@
-# BTCRuby HOWTO
-
-* [Generating Private/Public Keys](#generating-privatepublic-keys)
-
-## Generating Private/Public Keys
-
-```ruby
-require 'btcruby'
-require 'btcruby/extensions'
-
-key = BTC::Key.random
-
-prv = key.to_wif # => L2yVhzwp5F7NXUmP31j274MPjnWi7WbFs3qRJEcdrjyBZ9jmEdWb
-pub = key.address.to_s # => 15M8ocGxsWtaenLQy6hDKXeLHqQgG3ebpB
-
-puts [prv, pub].join(" - ")
-```

data/Rakefile

@@ -1,6 +0,0 @@
-require 'rake/testtask'
-Rake::TestTask.new do |t|
-  t.pattern = "spec/*_spec.rb"
-end
-
-task :default => :test

data/TODO.txt

@@ -1,40 +0,0 @@
-
-TODO:
-
-- verify integrity of the block after reading: hash all txs in a merkle root and compare with the declared merkle root.
-- add BIP70 payment request support
-- add convenience methods to handle BIP44 accounts in BTC::Keychain (like in CoreBitcoin)
-- add Bitcoin URI support to encode and parse `bitcoin:` URIs.
-
-+ replace factory methods like `C.with_data` or `C.with_key` with initializer since we now throw exceptions instead of returning nil on input errors.
-+ block and block header classes
-+ redesigned transaction builder to return a result object like in CoreBitcoin
-+ data helpers
-+ tests
-+ base58
-+ addresses
-+ simplify API for addresses: Address.address_with_string() -> Address.with_string()
-+ add test for private key address
-+ keys and signatures support
-  + canonical signature
-  + deterministic signatures: k = HMAC-SHA256(hash, privkey)
-+ add ffi to Gemspec as a dependency
-+ transaction parsing and composing
-+ script parsing and composing
-+ tx import/export in bitcoin-QT dictionary format
-+ add docs for to_wif/from_wif
-+ add diagnostics to check canonicality of the signature
-+ BIP32 implementation: Keychain
-+ base58/base58check mess: untangle
-+ specs and fixes for zero-padded private keys
-+ clearer testnet/mainnet API for Script
-+ fee computation for transactions
-+ signature_hash for transaction
-+ transaction builder
-+ tx ID conversion to/from hash
-+ helper properties for Transaction and inputs/outputs to hold extra data received from APIs.
-
-- test tool to detect broken or non-canonical transactions
-
-- compact signatures support
-

data/bin/console

@@ -1,19 +0,0 @@
-#!/usr/bin/env ruby
-require_relative '../lib/btcruby.rb'
-require_relative '../lib/btcruby/extensions.rb'
-
-include BTC
-
-require 'irb'
-require 'irb/completion'
-
-# IRB.conf[:PROMPT]||={}
-# IRB.conf[:PROMPT][:BTC_PROMPT] = { # name of prompt mode
-#   :AUTO_INDENT => true,           # enables auto-indent mode
-#   :PROMPT_I => %{>>},             # normal prompt
-#   :PROMPT_S => %{">},             # prompt for continuated strings
-#   :PROMPT_C => %{*>},             # prompt for continuated statement
-#   :RETURN => "=>%s\n"             # format to return value
-# }
-# IRB.conf[:PROMPT_MODE] = :BTC_PROMPT
-IRB.start

data/btcruby.gemspec

@@ -1,20 +0,0 @@
-#encoding: UTF-8
-$:.push File.expand_path("../lib", __FILE__)
-require "btcruby/version"
-
-files = `git ls-files`.split("\n")
-
-Gem::Specification.new do |s|
-  s.name          = "btcruby"
-  s.email         = "oleganza+btcruby@gmail.com"
-  s.version       = BTC::VERSION
-  s.description   = "Ruby library for interacting with Bitcoin."
-  s.summary       = "Ruby library for interacting with Bitcoin."
-  s.authors       = ["Oleg Andreev", "Ryan Smith"]
-  s.homepage      = "https://github.com/oleganza/btcruby"
-  s.rubyforge_project = "btcruby"
-  s.license       = "MIT"
-  s.files         = files
-  s.require_paths = ["lib"]
-  s.add_runtime_dependency 'ffi', '~> 1.9', '>= 1.9.3'
-end

data/sample_code/creating_a_p2sh_multisig_address.rb

@@ -1,21 +0,0 @@
-# Creating a P2SH multisig address
-# --------------------------------
-#
-# To create a P2SH multisig address you will need a set of public keys.
-# In the example below we generate three random keys and compose 2-of-3 multisig script
-# which is then transformed into a P2SH address. To redeem from this address you will need
-# not only two signatures, but also the original multisig script.
-
-require_relative "../lib/btcruby.rb"
-
-keys = [BTC::Key.random, BTC::Key.random, BTC::Key.random]
-pubkeys = keys.map(&:public_key)
-
-multisig_script = BTC::Script.multisig_script(public_keys: pubkeys, signatures_required: 2)
-puts multisig_script.to_s # => "OP_2 03e4e14a... 03b4b3f7... 030fa2ec... OP_3 OP_CHECKMULTISIG"
-
-p2sh_script = multisig_script.p2sh_script
-puts p2sh_script.to_s # => "OP_HASH160 26f5b7ad4e890c07b8c55fc551e39d6693c5e984 OP_EQUAL"
-
-address = p2sh_script.standard_address
-puts address.to_s # => 35F1xaoodzRZUBJHi6TgA85qPjXQcW8XsQ

data/sample_code/creating_a_transaction_manually.rb

@@ -1,44 +0,0 @@
-# Creating a transaction manually
-# -------------------------------
-#
-# To manually create a transaction, you will need to specify raw inputs,
-# compute the signature and compose a signature script for each input and
-# take care of calculating a change amount correctly.
-
-require_relative "../lib/btcruby.rb"
-
-include BTC
-
-tx = Transaction.new
-
-# 1. Add a raw input with previous transaction ID and output index.
-tx.add_input(TransactionInput.new(
-                previous_id: "aa94ab02c182214f090e99a0d57021caffd0f195a81c24602b1028b130b63e31",
-                previous_index: 0))
-
-# 2. Add a raw output with a script
-tx.add_output(TransactionOutput.new(
-                value: 100_000,
-                script: PublicKeyAddress.parse("1CBtcGivXmHQ8ZqdPgeMfcpQNJrqTrSAcG").script))
-
-# 3. Get the private key from WIF
-key = Key.new(wif: "L1uyy5qTuGrVXrmrsvHWHgVzW9kKdrp27wBC7Vs6nZDTF2BRUVwy")
-
-# 4. Sign the input (assuming it links to an output with address 18oxCAnbuKHDjP7KzLBDj8mLjggDBjE1Q9)
-hashtype = BTC::SIGHASH_ALL
-sighash = tx.signature_hash(input_index: 0,
-                            output_script: PublicKeyAddress.parse("18oxCAnbuKHDjP7KzLBDj8mLjggDBjE1Q9").script,
-                            hash_type: hashtype)
-tx.inputs[0].signature_script = Script.new << (key.ecdsa_signature(sighash) + WireFormat.encode_uint8(hashtype)) << key.public_key
-
-# Get transaction data and broadcast it
-puts "Binary transaction:"
-puts tx.data # => raw binary data
-puts "Hex transaction:"
-puts tx.to_hex # hex-encoded data
-# => 0100000001313eb630b128102b60241ca895f1d0ffca2170d5a0990e094f2182c102ab94aa
-#    000000006a473044022039148258144202301221a305adb38ce0a182ecb4055c6015cdd735
-#    8372d7ad6d022008aa259c87177f0e4e887dd0947c57fd140eb8f8a826f14ef8389dbc26ef
-#    a7b20121029f50f51d63b345039a290c94bffd3180c99ed659ff6ea6b1242bca47eb93b59f
-#    ffffffff01a0860100000000001976a9147ab89f9fae3f8043dcee5f7b5467a0f0a6e2f7e1
-#    88ac00000000

data/sample_code/generating_an_address.rb

@@ -1,20 +0,0 @@
-# Generating an address
-# ---------------------
-#
-# This example demonstrates how to generate a key and get its address.
-
-require_relative "../lib/btcruby.rb"
-
-key = BTC::Key.random
-
-puts key.to_wif # private key in WIF format
-# => L4RqZhbn2VsVgy2wCWW8kUPpA4xEkH7WbfPtj1MdFug5MayHzLeT
-
-puts key.address.to_s # public address
-# => 1MFqAcAxNsAKj5e6yksZCCyfNukSdDGsEY
-
-puts key.to_wif(network: BTC::Network.testnet)
-# => cUnq2cbdTZZkrQWCavKG7ntsnJFeQjDCfhYMqRp8m2L5cL1yHDmc
-
-puts key.address(network: BTC::Network.testnet).to_s
-# => n1mnTfFwBtbaWC7ihKqw28BzEuM9YqxRyw

data/sample_code/using_transaction_builder.rb

@@ -1,49 +0,0 @@
-# Using transaction builder
-# -------------------------
-# 
-# Transaction builder helps composing arbitrary transactions using just keys or unspent outputs.
-# It takes care of computing a proper change amount, adding fees and signing inputs.
-# It is also highly customizable, so you may use it for very complex transactions.
-
-require_relative "../lib/btcruby.rb"
-
-builder = BTC::TransactionBuilder.new
-
-# 1. Provide a list of address to get unspent outputs from.
-#    If address is a WIF instance, it will be used to sign corresponding input
-#    If address is a public address (or P2SH), its input will remain unsigned.
-builder.input_addresses = [ BTC::Key.new(wif: "L1uyy5qTuGrVXrmrsvHWHgVzW9kKdrp27wBC7Vs6nZDTF2BRUVwy").to_wif_object ]
-
-# 2. Use external API (e.g. Chain.com) to fetch unspent outputs for the input addresses.
-#    In this example we simply hard-code a single unspent output.
-#    Note: transaction ID and output index must be provided.
-builder.unspent_outputs_provider_block = lambda do |addresses, outputs_amount, outputs_size, fee|
-  txout = BTC::TransactionOutput.new(
-    value: 50_000,
-    script: BTC::PublicKeyAddress.parse("17XBj6iFEsf8kzDMGQk5ghZipxX49VXuaV").script,
-    transaction_id: "115e8f72f39fad874cfab0deed11a80f24f967a84079fb56ddf53ea02e308986",
-    index: 0
-  )
-  [ txout ]
-end
-
-# 3. Specify payment address and amount
-builder.outputs = [ BTC::TransactionOutput.new(
-                        value: 10_000, 
-                        script: BTC::PublicKeyAddress.parse("17XBj6iFEsf8kzDMGQk5ghZipxX49VXuaV").script) ]
-
-# 4. Specify the change address
-builder.change_address = BTC::PublicKeyAddress.parse("1CBtcGivXmHQ8ZqdPgeMfcpQNJrqTrSAcG")
-
-# 5. Build the transaction and broadcast it.
-result = builder.build
-tx = result.transaction
-puts tx.to_hex 
-
-# => 01000000018689302ea03ef5dd56fb7940a867f9240fa811eddeb0fa4c87ad9ff3728f5e11
-#    000000006b483045022100e280f71106a84a4a1b1a2035eae70266eb53630beab2b59cc8cf
-#    f40b1a5bdbb902201dcbae9bb12730fe5563dc37e3a33e064f2efa78ba0af5c0179187aece
-#    180b6c0121029f50f51d63b345039a290c94bffd3180c99ed659ff6ea6b1242bca47eb93b5
-#    9fffffffff0210270000000000001976a91447862fe165e6121af80d5dde1ecb478ed17056
-#    5b88ac30750000000000001976a9147ab89f9fae3f8043dcee5f7b5467a0f0a6e2f7e188ac
-#    00000000