btcruby 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47f8d99f965f48b15252c34e99721b005d2eed0d
-  data.tar.gz: a364c03eccb5174fe5f110f466bac5e3f147b68c
+  metadata.gz: 668f16c886cfdceb4e178df2ae51b030dd1580d5
+  data.tar.gz: a83d764d41c055fef97c824a46f91f372c5b0e57
 SHA512:
-  metadata.gz: 4161f2211ab6fce89f3e56d2ceef2eb977ffb55c71279ae94e52633b54e06a241ded2607e66db06d945c421e7d05d0ed519daeda839781c87a3b896b261c38ea
-  data.tar.gz: d21def19c9077a78da729fe3604582fb2144607569a9cf85551a73891267967f92e583307ec98fd612f94b1dde6910521751eb5ed89d88ffbe9e767427ddf5f5
+  metadata.gz: 58827f74191443b4d0da51fe2d156072888947081c9c58a56b991a6ecb2b6f6e2915e99da08b4837b96752e94311e4a80fc90ffa0545a418acec59264fd596ba
+  data.tar.gz: 92c6cc676c97dafa2dd903ba24eb1a42e3061d890531c88e7fef096b9d57183e48866009a417cd5904eb167f709526e6dbf641dbaf333e635657998d0173eab8

data/documentation/extensions.md

@@ -58,19 +58,3 @@ Returns a binary string compressed using two passes of [SHA-256](http://en.wikip
 #### hash160
 
 Returns a binary string compressed using composition `ripemd160(sha256(string))`. Known in Bitcoin as *Hash160*.
-
-#### hmac_sha256(key: *String*)
-
-Returns a result of [HMAC](http://en.wikipedia.org/wiki/Hash-based_message_authentication_code) using [SHA-256](http://en.wikipedia.org/wiki/SHA-2) hash using `self` as data.
-
-#### hmac_sha256(data: *String*)
-
-Returns a result of [HMAC](http://en.wikipedia.org/wiki/Hash-based_message_authentication_code) using [SHA-256](http://en.wikipedia.org/wiki/SHA-2) hash using `self` as key.
-
-#### hmac_sha512(key: *String*)
-
-Returns a result of [HMAC](http://en.wikipedia.org/wiki/Hash-based_message_authentication_code) using [SHA-512](http://en.wikipedia.org/wiki/SHA-2) hash using `self` as data.
-
-#### hmac_sha512(data: *String*, key: *String*)
-
-Returns a result of [HMAC](http://en.wikipedia.org/wiki/Hash-based_message_authentication_code) using [SHA-512](http://en.wikipedia.org/wiki/SHA-2) hash using `self` as key.

data/documentation/index.md

@@ -11,7 +11,7 @@ Bitcoin Data Structures                        | Utilities
 [Constants](constants.md)                      | [Base58](base58.md)                 | [HashFunctions](hash_functions.md)
 [Address](address.md)                          | [Core Extensions](extensions.md)    | [Key](key.md)
 ↳ [PublicKeyAddress](p2pkh.md)                 | [Data](data.md)                     | [Keychain](keychain.md)
-↳ [ScriptHashAddress](p2psh.md)                | [Diagnostics](diagnostics.md)       | [OpenSSL](openssl.md)
+↳ [ScriptHashAddress](p2sh.md)                | [Diagnostics](diagnostics.md)       | [OpenSSL](openssl.md)
 ↳ [WIF](wif.md)                                | [Hash↔ID Conversions](hash_id.md)   |
 [Block](block.md)                              | [ProofOfWork](proof_of_work.md)     |
 [BlockHeader](block_header.md)                 | [WireFormat](wire_format.md)        |
@@ -130,7 +130,7 @@ builder.input_addresses = [ "L1uyy5qTuGrVXrmrsvHWHgVzW9kKdrp27wBC7Vs6nZDTF2BRUVw
 builder.unspent_outputs_provider_block = lambda do |addresses, outputs_amount, outputs_size, fee_rate|
   txout = BTC::TransactionOutput.new(
     value: 50_000,
-    script: BTC::PublicKeyAddress.with_string("17XBj6iFEsf8kzDMGQk5ghZipxX49VXuaV").script,
+    script: BTC::PublicKeyAddress.parse("17XBj6iFEsf8kzDMGQk5ghZipxX49VXuaV").script,
     transaction_id: "115e8f72f39fad874cfab0deed11a80f24f967a84079fb56ddf53ea02e308986",
     index: 0
   )
@@ -179,7 +179,7 @@ tx.add_input(TransactionInput.new(
 # 2. Add a raw output with a script
 tx.add_output(TransactionOutput.new(
                 value: 100_000,
-                script: PublicKeyAddress.with_string("1CBtcGivXmHQ8ZqdPgeMfcpQNJrqTrSAcG").script))
+                script: PublicKeyAddress.parse("1CBtcGivXmHQ8ZqdPgeMfcpQNJrqTrSAcG").script))
 
 # 3. Get the private key from WIF
 key = Key.new(wif: "L1uyy5qTuGrVXrmrsvHWHgVzW9kKdrp27wBC7Vs6nZDTF2BRUVwy")

data/documentation/keychain.md

@@ -99,6 +99,11 @@ Starts with `xprv` for mainnet and `tprv` for testnet.
 
 An alias to `extended_private_key`.
 
+#### to_s
+
+A [Base58Check](base58.md)-encoded extended key.
+Returns `extended_private_key` if private, and `extended_public_key` if public.
+
 #### identifier
 
 A 160-bit binary identifier (aka "hash") of the keychain.
@@ -176,5 +181,3 @@ Equivalent to `derived_keychain(...).key`
 #### derived_key(*path*)
 
 Equivalent to `derived_keychain(path).key`
-
-

data/lib/btcruby/address.rb

@@ -28,16 +28,6 @@
 module BTC
   class Address
 
-    # Converts base58-encoded string to a BTC::Address instance.
-    # If BTC::Address is already provided, returns it.
-    def self.with_address(string_or_address)
-      raise ArgumentError, "Use Address.parse(...) instead"
-    end
-
-    def self.with_string(base58check_string)
-      raise ArgumentError, "Use #{self}.parse(...) instead"
-    end
-
     # Decodes address from a Base58Check-encoded string
     def self.parse(string_or_address)
       raise ArgumentError, "Argument is missing" if !string_or_address
@@ -175,11 +165,6 @@ module BTC
 
     HASH160_LENGTH = 20
 
-    # Instantiates addess with the 20-byte hash
-    def self.with_data(hash, network: nil)
-      raise ArgumentError, "Use #{self}.new(hash: ...) instead"
-    end
-
     def initialize(string: nil, hash: nil, network: nil, _raw_data: nil)
       if string || _raw_data
         _raw_data ||= Base58.data_from_base58check(string)
@@ -240,11 +225,6 @@ module BTC
       end
     end
 
-    # Instantiates an address with a public key binary data
-    def self.with_public_key(public_key, network: nil)
-      raise ArgumentError, "Use #{self}.new(public_key: ...) instead"
-    end
-
     # Returns BTC::Script with data 'OP_DUP OP_HASH160 <hash> OP_EQUALVERIFY OP_CHECKSIG'
     def script
       raise ArgumentError, "BTC::PublicKeyAddress: invalid data length (must be 20 bytes)" if self.data.bytesize != 20
@@ -277,16 +257,6 @@ module BTC
       end
     end
 
-    # Instantiates address with a given redeem script.
-    def self.with_redeem_script(redeem_script, network: nil)
-      raise ArgumentError, "Use #{self}.new(redeem_script: ...) instead"
-    end
-
-    # Instantiates address with a given redeem script binary data.
-    def self.with_redeem_script_data(redeem_script_data, network: nil)
-      raise ArgumentError, "Use #{self}.new(hash: BTC.hash160(redeem_script.data)) instead"
-    end
-
     # Returns BTC::Script with data 'OP_HASH160 <hash> OP_EQUAL'
     def script
       raise ArgumentError, "BTC::ScriptHashAddress: invalid data length (must be 20 bytes)" if self.data.bytesize != 20

data/lib/btcruby/block_header.rb

@@ -77,14 +77,6 @@ module BTC
       )
     end
 
-    def self.with_data(data)
-      raise ArgumentError, "Use #{self}.new(data: ...) instead"
-    end
-
-    def self.with_stream(stream)
-      raise ArgumentError, "Use #{self}.new(stream: ...) instead"
-    end
-
     def initialize(data: nil,
                    stream: nil,
                    version: CURRENT_VERSION,

data/lib/btcruby/extensions.rb

@@ -47,16 +47,6 @@ module BTC
       BTC.sha512(self)
     end
 
-    def hmac_sha256(data: nil, key: nil)
-      raise ArgumentError, "Either data or key must be specified" if !data && !key
-      BTC.hmac_sha256(data: data || self, key: key || self)
-    end
-
-    def hmac_sha512(data: nil, key: nil)
-      raise ArgumentError, "Either data or key must be specified" if !data && !key
-      BTC.hmac_sha512(data: data || self, key: key || self)
-    end
-
   end
 end
 

data/lib/btcruby/key.rb

@@ -87,26 +87,6 @@ module BTC
                       network: network)
     end
 
-    # Creates an instance with public key data (compressed or not).
-    # You can verify signatures with that instance, but cannot sign messages.
-    # If the public key is compressed, public_key_compressed attribute will be set to true.
-    def self.with_public_key(public_key, network: nil)
-      raise ArgumentError, "Use Key.new(public_key: ...) instead"
-    end
-
-    # Creates an instance with private key data (32 bytes).
-    # You can sign messages and verify signatures with that instance.
-    # public_key_compressed is set to true as a default.
-    def self.with_private_key(private_key, public_key_compressed: true, network: nil)
-      raise ArgumentError, "Use Key.new(private_key: ...) instead"
-    end
-
-    # Creates an instance with a private key encoded in WIF format.
-    # Uses WIF internally.
-    def self.with_wif(wif_string)
-      raise ArgumentError, "Use Key.new(wif: ...) instead"
-    end
-
 
     # Accessors
     # ---------

data/lib/btcruby/keychain.rb

@@ -113,6 +113,10 @@ module BTC
       end
     end
 
+    def to_s
+      private? ? xprv : xpub
+    end
+
     def xpub
       extended_public_key
     end
@@ -174,17 +178,6 @@ module BTC
                      @network])
     end
 
-    # Initializes master keychain from a seed.
-    # This is the "root" keychain of the entire hierarchy.
-    def self.with_seed(seed, network: nil)
-      raise ArgumentError, "Use Keychain.new(seed: ...) instead"
-    end
-
-    # Initializes keychain from a Base58Check-encoded extended public or private key.
-    def self.with_extended_key(xkey)
-      raise ArgumentError, "Use Keychain.new(extended_key/xpub/xprv: ...) instead"
-    end
-
     # Instantiates Keychain with a binary seed or a base58-encoded extended public/private key.
     # Usage:
     # * Keychain.new(seed: ...[, network: ...])

data/lib/btcruby/script.rb

@@ -60,17 +60,6 @@ module BTC
       end
     end
 
-    # Initializes a script with its binary representation.
-    # Returns nil if data is not a well-formed script.
-    def self.with_data(data)
-      raise ArgumentError, "Use Script.new(data: ...) instead"
-    end
-
-    # Initializes a script of form "OP_RETURN <data>"
-    def self.op_return_script(data)
-      raise ArgumentError, "Use Script.new(op_return:...) instead"
-    end
-
     # Initializes a multisignature script "OP_<M> <pubkey1> ... <pubkeyN> OP_<N> OP_CHECKMULTISIG"
     # N must be >= M, M and N should be from 1 to 16.
     # If you need a more customized transaction with OP_CHECKMULTISIG, create it using other methods.

data/lib/btcruby/transaction.rb

@@ -174,18 +174,6 @@ module BTC
       init_with_components(version: version, inputs: txins, outputs: txouts, lock_time: lock_time)
     end
 
-    def self.with_data(data)
-      raise ArgumentError, "Use Transaction.new(data: ...) instead"
-    end
-
-    def self.with_stream(stream)
-      raise ArgumentError, "Use Transaction.new(stream: ...) instead"
-    end
-
-    def self.with_dictionary(dict)
-      raise ArgumentError, "Use Transaction.new(dictionary: ...)"
-    end
-
     # Returns true if this transaction is a coinbase transaction.
     def coinbase?
       self.inputs.size == 1 && self.inputs[0].coinbase?

data/lib/btcruby/transaction_input.rb

@@ -188,18 +188,6 @@ module BTC
       @sequence = seq
     end
 
-    def self.with_data(data)
-      raise ArgumentError, "Use TransactionInput.new(data: ...) instead"
-    end
-
-    def self.with_stream(stream)
-      raise ArgumentError, "Use TransactionInput.new(stream: ...) instead"
-    end
-
-    def self.with_dictionary(dict)
-      raise ArgumentError, "Use TransactionInput.new(dictionary: ...) instead"
-    end
-
     # Returns true if this input is a coinbase input.
     def coinbase?
       return self.previous_index == INVALID_INDEX && self.previous_hash == ZERO_HASH256

data/lib/btcruby/transaction_output.rb

@@ -150,18 +150,6 @@ module BTC
       end
     end
 
-    def self.with_data(data)
-      raise ArgumentError, "Use TransactionOutput.new(data: ...) instead"
-    end
-
-    def self.with_stream(stream)
-      raise ArgumentError, "Use TransactionOutput.new(stream: ...) instead"
-    end
-
-    def self.with_dictionary(dict)
-      raise ArgumentError, "Use TransactionOutput.new(dictionary: ...) instead"
-    end
-
     def data
       data = "".b
       data << BTC::WireFormat.encode_int64le(self.value)

data/lib/btcruby/version.rb

@@ -1,3 +1,3 @@
 module BTC
-  VERSION = "1.0.1".freeze
+  VERSION = "1.0.2".freeze
 end

data/lib/btcruby/wif.rb

@@ -38,16 +38,6 @@ module BTC
     end
     alias_method :eql?, :==
 
-    # private API
-    def self.with_string(base58check_string, raw_data = nil)
-      raise ArgumentError, "Use WIF.new(string: ...) instead"
-    end
-
-    # Creates an address with private key data and non-compressed pubkey flag.
-    def self.with_data(data, public_key_compressed: false, network: nil)
-      raise ArgumentError, "Use WIF.new(private_key: ...) or WIF.new(key: ...) instead"
-    end
-
     # Usage:
     # * WIF.new(string: ...)
     # * WIF.new(private_key: ..., public_key_compressed: true|false, network: ...)

data/sample_code/creating_a_transaction_manually.rb

@@ -19,7 +19,7 @@ tx.add_input(TransactionInput.new(
 # 2. Add a raw output with a script
 tx.add_output(TransactionOutput.new(
                 value: 100_000,
-                script: PublicKeyAddress.with_string("1CBtcGivXmHQ8ZqdPgeMfcpQNJrqTrSAcG").script))
+                script: PublicKeyAddress.parse("1CBtcGivXmHQ8ZqdPgeMfcpQNJrqTrSAcG").script))
 
 # 3. Get the private key from WIF
 key = Key.new(wif: "L1uyy5qTuGrVXrmrsvHWHgVzW9kKdrp27wBC7Vs6nZDTF2BRUVwy")
@@ -27,7 +27,7 @@ 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.with_string("18oxCAnbuKHDjP7KzLBDj8mLjggDBjE1Q9").script,
+                            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
 

data/sample_code/using_transaction_builder.rb

@@ -20,7 +20,7 @@ builder.input_addresses = [ BTC::Key.new(wif: "L1uyy5qTuGrVXrmrsvHWHgVzW9kKdrp27
 builder.unspent_outputs_provider_block = lambda do |addresses, outputs_amount, outputs_size, fee|
   txout = BTC::TransactionOutput.new(
     value: 50_000,
-    script: BTC::PublicKeyAddress.with_string("17XBj6iFEsf8kzDMGQk5ghZipxX49VXuaV").script,
+    script: BTC::PublicKeyAddress.parse("17XBj6iFEsf8kzDMGQk5ghZipxX49VXuaV").script,
     transaction_id: "115e8f72f39fad874cfab0deed11a80f24f967a84079fb56ddf53ea02e308986",
     index: 0
   )
@@ -30,10 +30,10 @@ end
 # 3. Specify payment address and amount
 builder.outputs = [ BTC::TransactionOutput.new(
                         value: 10_000, 
-                        script: BTC::PublicKeyAddress.with_string("17XBj6iFEsf8kzDMGQk5ghZipxX49VXuaV").script) ]
+                        script: BTC::PublicKeyAddress.parse("17XBj6iFEsf8kzDMGQk5ghZipxX49VXuaV").script) ]
 
 # 4. Specify the change address
-builder.change_address = BTC::PublicKeyAddress.with_string("1CBtcGivXmHQ8ZqdPgeMfcpQNJrqTrSAcG")
+builder.change_address = BTC::PublicKeyAddress.parse("1CBtcGivXmHQ8ZqdPgeMfcpQNJrqTrSAcG")
 
 # 5. Build the transaction and broadcast it.
 result = builder.build

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: btcruby
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Oleg Andreev
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-08 00:00:00.000000000 Z
+date: 2015-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -38,7 +38,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".travis.yml"
 - FAQ.md
 - Gemfile
 - Gemfile.lock

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-rvm:
-- 2.1.1
-- 2.1.0
-notifications:
-  slack:
-    secure: ZbYOCxRusuhvSdSl6nW9/emtZTnwK+o1uuhMKK5yrWDVL/kNV/ejcGTuInOA8TW1ULv6fNI9j2c7Q+zSu3CDO5oTMM7PK4TNeKsCY4koyk+91QKltWIH+aAFpPzbMcWbvnTSzHzTkhRW3ZPhfcQTkb6MRLEA/B6SjmUVc5ADTtc=