btcruby 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c08f34b042c6881e1117904400ed1fa066cf31f1
-  data.tar.gz: b4c4cf4fec603d4e9f04786fae3afefd46666bbe
+  metadata.gz: 0d9eaa33fb43ddda93be8bb439718983f8595e41
+  data.tar.gz: af06b8d5bcd07f02d8351e398c6b7a8595a8ddff
 SHA512:
-  metadata.gz: 406d2ecfc50fdc0d019188e12d56e0c9a1f286768220ae5bf5fce5a4a95702da91f79ebb816d0d2b4aca1c6a1c19d15afb0f4c452b94d61c657ac152ec13a227
-  data.tar.gz: 12d8493b58fb45a00e1cd115ad1904bfc13dbfa1e31d0ce938706a8d265df7f818486485c210102af0c9c2c03c0507d03580ce74fae1b28c18d25614aae82674
+  metadata.gz: 0f50ec59b1e00e03cf6d23de427ee7b3a50058be67f4931fb9db7b400eee94d54ad58fb8abc66f5337a0960d31efcd010abb276a7a779ef5496a7f489d3d7df4
+  data.tar.gz: 444b559fcbf592eda67d82326510e2433810639b0530d55afdffdf241836d34396221c3fbdea1086c302c9063fe07b7dd2fa38412edcd4eeaf32d5289de8cba5

data/RELEASE_NOTES.md

@@ -0,0 +1,30 @@
+
+BTCRuby Release Notes
+=====================
+
+1.0.4 (July 2, 2015)
+--------------------
+
+* Added `register_class` API to extend `BTC::Address` with custom subclasses.
+* Added `IssuanceID` class to identify unique issuance outputs of any asset (so this can be used as a "issue-once" identifier). Support for `issuance_id` in processor is pending.
+
+1.0.3 (June 9, 2015)
+--------------------
+
+* BTC::Data methods made available as methods on BTC object (`BTC::Data.data_from_hex` -> `BTC.from_hex` etc.)
+
+1.0.2 (June 9, 2015)
+--------------------
+
+* Added `Keychain#to_s` (returns `xpub` or `xprv`).
+* API cleanup.
+
+1.0.1 (June 9, 2015)
+--------------------
+
+* Fixed support for HMAC functions for Ruby 2.2.
+
+1.0.0 (June 8, 2015)
+--------------------
+
+* First public release.

data/lib/btcruby/address.rb

@@ -27,7 +27,8 @@
 #
 module BTC
   class Address
-
+    @@registered_classes = []
+    
     # Decodes address from a Base58Check-encoded string
     def self.parse(string_or_address)
       raise ArgumentError, "Argument is missing" if !string_or_address
@@ -39,27 +40,46 @@ module BTC
       string = string_or_address
       raise ArgumentError, "String is expected" if !string.is_a?(String)
       raw_data = Base58.data_from_base58check(string)
-      result = parse_raw_data(raw_data, string)
+      self.mux_parse_raw_data(raw_data, string)
+    end
+    
+    # Attempts to parse with a proper subclass
+    def self.mux_parse_raw_data(raw_data, _string = nil)
+      result = nil
+      @@registered_classes.each do |cls|
+        if result = cls.parse_raw_data(raw_data, _string)
+          break
+        end
+      end
+      if !result
+        raise ArgumentError, "Unknown kind of address: #{_string}. Registered types: #{@@registered_classes}"
+      end
       if !result.is_a?(self)
         raise ArgumentError, "Argument must be an instance of #{self}, not #{result.class}."
       end
-      result
+      return result
     end
 
     # Internal method to parse address from raw binary data.
+    # Subclasses should implement to return a valid instance or nil if the provided data does not correspond to that subclass.
+    # Default implementation assumes 1-byte version prefix and implementation of mainnet_version and testnet_version class methods.
     def self.parse_raw_data(raw_data, _string = nil)
       raise ArgumentError, "Raw data is missing" if !raw_data
       if raw_data.bytesize < 2 # should contain at least a version byte and some content
         raise FormatError, "Failed to decode BTC::Address: raw data is too short"
       end
       version = raw_data.bytes.first
-      address_class = version_to_class_dictionary[version]
-      if !address_class
-        raise FormatError, "Failed to decode BTC::Address: unknown version #{version}"
+      if self.mainnet_version == version || self.testnet_version == version
+        return self.new(string: _string, _raw_data: raw_data)
       end
-      return address_class.new(string: _string, _raw_data: raw_data)
+      return nil
     end
-
+    
+    # Subclasses should register themselves so they can be parsed via BTC::Address.parse()
+    def self.register_class(cls)
+      @@registered_classes << cls
+    end
+    
     def network
       @network ||= if !@version
         BTC::Network.default
@@ -140,21 +160,21 @@ module BTC
       raise Exception, "Override data_for_base58check_encoding in #{self.class} to return complete data to be base58-encoded."
     end
 
-    private
-
-    def self.version_to_class_dictionary
-      @version_to_class_dictionary ||= [
-        PublicKeyAddress,
-        ScriptHashAddress,
-        WIF,
-        AssetID,
-        AssetAddress
-      ].inject({}) do |dict, cls|
-        dict[cls.mainnet_version] = cls
-        dict[cls.testnet_version] = cls
-        dict
-      end
-    end
+    # private
+    # def self.version_to_class_dictionary
+    #   @version_to_class_dictionary ||= [
+    #     PublicKeyAddress,
+    #     ScriptHashAddress,
+    #     WIF,
+    #     AssetID,
+    #     IssuanceID,
+    #     AssetAddress,
+    #   ].inject({}) do |dict, cls|
+    #     dict[cls.mainnet_version] = cls
+    #     dict[cls.testnet_version] = cls
+    #     dict
+    #   end
+    # end
   end
 
   class BitcoinPaymentAddress < Address
@@ -201,6 +221,8 @@ module BTC
 
   # Standard pulic key (P2PKH) address (e.g. 19FGfswVqxNubJbh1NW8A4t51T9x9RDVWQ)
   class PublicKeyAddress < Hash160Address
+    
+    register_class self
 
     def self.mainnet_version
       0
@@ -236,6 +258,8 @@ module BTC
   # P2SH address (e.g. 3NukJ6fYZJ5Kk8bPjycAnruZkE5Q7UW7i8)
   class ScriptHashAddress < Hash160Address
 
+    register_class self
+
     def self.mainnet_version
       5
     end

data/lib/btcruby/open_assets/asset_address.rb

@@ -1,6 +1,9 @@
 module BTC
   # Represents an Asset Address, where the assets can be sent.
   class AssetAddress < BTC::Address
+    
+    register_class self
+    
     NAMESPACE = 0x13
     
     def self.mainnet_version
@@ -18,7 +21,7 @@ module BTC
         _raw_data ||= Base58.data_from_base58check(string)
         raise FormatError, "Too short AssetAddress" if _raw_data.bytesize < 2
         raise FormatError, "Invalid namespace for AssetAddress" if _raw_data.bytes[0] != NAMESPACE
-        @bitcoin_address = Address.parse_raw_data(_raw_data[1..-1])
+        @bitcoin_address = BTC::Address.mux_parse_raw_data(_raw_data[1..-1])
         @base58check_string = string
       elsif bitcoin_address
         @base58check_string = nil

data/lib/btcruby/open_assets/asset_id.rb

@@ -1,13 +1,14 @@
 module BTC
   # Represents an Asset ID.
   class AssetID < BTC::Hash160Address
+    register_class self
     
     def self.mainnet_version
-      23 # "A" prefix
+      23 # 'A' prefix
     end
 
     def self.testnet_version
-      115
+      115 # 'o' prefix
     end
 
     # Instantiates AssetID with output, output script or raw hash.

data/lib/btcruby/open_assets/issuance_id.rb

@@ -0,0 +1,29 @@
+module BTC
+  # Represents a distinct issuance of any given asset.
+  # Hash160(tx hash || txout index || amount)
+  class IssuanceID < BTC::Hash160Address
+
+    register_class self
+
+    def self.mainnet_version
+      63 # 'S' prefix ('single', 'issuance')
+    end
+
+    def self.testnet_version
+      125 # 's' prefix
+    end
+
+    # Instantiates AssetID with output, output script or raw hash.
+    # To compute an Asset ID for the Asset Definition file, use `trim_script_prefix: true`.
+    def initialize(string: nil, hash: nil, network: nil, outpoint: nil, amount: nil, _raw_data: nil)
+      if outpoint || amount
+        raise ArgumentError, "Outpoint is missing" if !outpoint
+        raise ArgumentError, "Amount is missing" if !amount || amount < 0
+        data = outpoint.transaction_hash + WireFormat.encode_uint32le(outpoint.index) + WireFormat.encode_uint64le(amount) 
+        super(hash: BTC.hash160(data), network: network)
+      else
+        super(string: string, hash: hash, network: network, _raw_data: _raw_data)
+      end
+    end
+  end
+end

data/lib/btcruby/open_assets.rb

@@ -15,6 +15,7 @@
 # * Supporting stock split (AssetV2 is issued by consuming AssetV1, validating software must validate AssetV2 accordingly).
 # * Supporting key rotation (can be done using the same technique as with stock split). Maybe use metadata to link to a previous asset.
 require_relative 'open_assets/asset_id.rb'
+require_relative 'open_assets/issuance_id.rb'
 require_relative 'open_assets/asset_address.rb'
 require_relative 'open_assets/asset.rb'
 require_relative 'open_assets/asset_marker.rb'

data/lib/btcruby/version.rb

@@ -1,3 +1,3 @@
 module BTC
-  VERSION = "1.0.3".freeze
+  VERSION = "1.0.4".freeze
 end

data/lib/btcruby/wif.rb

@@ -2,6 +2,8 @@ module BTC
   # Private key in Wallet Import Format (WIF aka Sipa format).
   # Examples: 5KQntKuhYWSRXNq... or L3p8oAcQTtuokSC...
   class WIF < Address
+    
+    register_class self
 
     KEY_LENGTH = 32
 

data/spec/address_spec.rb

@@ -193,7 +193,7 @@ describe BTC::Address do
     asset_addr_string = "akB4NBW9UuCmHuepksob6yfZs6naHtRCPNy"
     btc_addr = Address.parse(btc_addr_string)
     asset_addr = Address.parse(asset_addr_string)
-    
+
     ->{ BTC::AssetAddress.parse(btc_addr_string) }.must_raise ArgumentError
     ->{ BTC::AssetAddress.parse(btc_addr) }.must_raise ArgumentError
     

data/spec/open_assets/issuance_id_spec.rb

@@ -0,0 +1,16 @@
+require_relative '../spec_helper'
+
+describe BTC::IssuanceID do
+  it "should encode script to a correct address" do
+    key = Key.new(private_key: "18E14A7B6A307F426A94F8114701E7C8E774E7F9A47E2C2035DB29A206321725".from_hex, public_key_compressed: false)
+    issuance_id = IssuanceID.new(outpoint: TransactionOutpoint.new(transaction_hash: BTC.hash256("tx1"), index:0), amount:100, network: Network.mainnet)
+    issuance_id.hash.to_hex.must_equal "5e398b12cce30c0e1550e29f9d1b8f024772ac69"
+    issuance_id.to_s.must_equal "SVtDV3pMkQQu11CQMzsziCmFBx4Ff5FnPT"
+    issuance_id.is_a?(BTC::IssuanceID).must_equal true
+  end
+  it "should decode an asset address" do
+    issuance_id = Address.parse("SVtDV3pMkQQu11CQMzsziCmFBx4Ff5FnPT")
+    issuance_id.is_a?(BTC::IssuanceID).must_equal true
+    issuance_id.hash.to_hex.must_equal "5e398b12cce30c0e1550e29f9d1b8f024772ac69"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: btcruby
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Oleg Andreev
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-09 00:00:00.000000000 Z
+date: 2015-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -44,6 +44,7 @@ files:
 - HOWTO.md
 - LICENSE
 - README.md
+- RELEASE_NOTES.md
 - Rakefile
 - TODO.txt
 - bin/console
@@ -107,6 +108,7 @@ files:
 - lib/btcruby/open_assets/asset_transaction_builder/result.rb
 - lib/btcruby/open_assets/asset_transaction_input.rb
 - lib/btcruby/open_assets/asset_transaction_output.rb
+- lib/btcruby/open_assets/issuance_id.rb
 - lib/btcruby/openssl.rb
 - lib/btcruby/proof_of_work.rb
 - lib/btcruby/safety.rb
@@ -145,6 +147,7 @@ files:
 - 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/spec_helper.rb