btcruby 1.5.1 → 1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bbec90a3ce39cd29196eafbbbfc18e884e8c514
-  data.tar.gz: 05eb71dfff15d7b3f4949945623be1dfdebd8855
+  metadata.gz: 217d2c55943bb88f2a02a77774574a82f345845f
+  data.tar.gz: 9e74dfbf5e332e4fbda8cca3c3d6f1dd8962ac1a
 SHA512:
-  metadata.gz: 9d658653097c2a101c5e42f03b287f2769070a379c6a6e2f1ec244f1782421f9cfcc10bad946e3d9e4a6721bb13f8ef4148a21dd6cc2baac6635115cc96b001d
-  data.tar.gz: fc9c6d2bb51365065b558590f0f5a45b8bac0d1ac6df795fd3ce195ee5e4f8af241772d4e34a8634f66826747e08389cb34d497f4a8ccc7ed80194205f2e593f
+  metadata.gz: 509d5068a72d3e04ea612a92348bc7edd9929aed0acc87e55dc10866c24294e6d2f84fb26d0d54f2c18ab19ff09cd6cc0bc267735cb6694be6fbd5e3d757dda0
+  data.tar.gz: 39b60fbdd30baf9ffaa08005d07ac2d767c3f85a8e0c5761380e369ebeae96092bcf9d7d7f1406f4c5a30f63ef3694e1598980efacada1e23e9484aff6c2a40a

data/RELEASE_NOTES.md

@@ -2,8 +2,15 @@
 BTCRuby Release Notes
 =====================
 
+1.6 (January 15, 2015)
+-------------------------
+
+* `BTC::Mnemonic` implements read-only part of BIP44.
+* `BTC::Keychain` implements utility methods to derive BIP44 keys.
+
+
 1.5.1 (December 30, 2015)
------------------------
+-------------------------
 
 * `BTC::TransactionSignatureChecker` accepts `version` and `amount` to support different hashing schemes (e.g. segwit) and passes them to `BTC::Transaction#signature_hash` function.
 

data/lib/btcruby.rb

@@ -22,6 +22,7 @@ require_relative 'btcruby/address.rb'
 require_relative 'btcruby/wif.rb'
 require_relative 'btcruby/key.rb'
 require_relative 'btcruby/keychain.rb'
+require_relative 'btcruby/mnemonic.rb'
 require_relative 'btcruby/wire_format.rb'
 require_relative 'btcruby/hash_id.rb'
 require_relative 'btcruby/outpoint.rb'

data/lib/btcruby/key.rb

@@ -126,7 +126,7 @@ module BTC
 
     # Returns a PublicKeyAddress instance that encodes a public key hash.
     def address(network: nil)
-      PublicKeyAddress.new(public_key: self.public_key, network: network)
+      PublicKeyAddress.new(public_key: self.public_key, network: network || self.network)
     end
 
     # Returns a WIF instance that encodes private key.

data/lib/btcruby/keychain.rb

@@ -452,6 +452,25 @@ module BTC
         end
       end
     end
-
+    
+    # BIP44 Support
+    
+    def bip44_keychain(network: Network.mainnet)
+      network_index = network.mainnet? ? 0 : 1
+      derived_keychain(44, hardened: true).derived_keychain(network_index, hardened: true)
+    end
+    
+    def bip44_account_keychain(account_index)
+      derived_keychain(account_index, hardened: true)
+    end
+    
+    def bip44_external_keychain
+      derived_keychain(0, hardened: false)
+    end
+    
+    def bip44_internal_keychain
+      derived_keychain(1, hardened: false)
+    end
+    
   end # Keychain
 end # BTC

data/lib/btcruby/mnemonic.rb

@@ -0,0 +1,65 @@
+# BTC::Mnemonic implements BIP44: mnemonic-based hierarchical deterministic wallets.
+# Currently only supports restoring keychain from words. Generating sentence.
+require 'openssl'
+require 'openssl/digest'
+module BTC
+  class Mnemonic
+    
+    def initialize(words: nil, password: "")
+      if words.is_a?(String)
+        words = words.split(" ")
+      end
+      # TODO: check if number of words is correct (12, 15, 18, 21, 24)
+      @words = words
+      @password = password
+    end
+    
+    def seed
+      @seed ||= make_seed(words: @words, password: @password)
+    end
+    
+    def keychain
+      @keychain ||= Keychain.new(seed: seed)
+    end
+    
+    private
+    
+    def make_seed(words: nil, password: nil)
+      password ||= ""
+      
+      mnemonic = @words.join(" ").b
+      salt = "mnemonic#{password}".b
+      
+      digest = ::OpenSSL::Digest::SHA512.new
+      length = digest.digest_length
+      
+      return ::OpenSSL::PKCS5.pbkdf2_hmac(
+        mnemonic,
+        salt,
+        2048, # iterations 
+        length,
+        digest
+      )
+    end
+    
+    public
+    
+    # For manual testing
+    
+    def print_addresses(range: 0..100, network: BTC::Network.mainnet, account: 0)
+      kc = keychain.bip44_keychain(network: network).bip44_account_keychain(account)
+      puts "Addresses for account #{account} on #{network.name}"
+      puts "Account xpub:          #{kc.xpub}"
+      puts "Account external xpub: #{kc.bip44_external_keychain.xpub}"
+      puts "Index".ljust(10) + "External Address".ljust(40) + "Internal Address".ljust(40)
+      range.each do |i|
+        s = ""
+        s << "#{i}".ljust(10)
+        s << kc.bip44_external_keychain.derived_key(i).address.to_s.ljust(40)
+        s << kc.bip44_internal_keychain.derived_key(i).address.to_s.ljust(40)
+        puts s
+      end
+    end
+    
+  end
+end

data/lib/btcruby/version.rb

@@ -1,3 +1,3 @@
 module BTC
-  VERSION = "1.5.1".freeze
+  VERSION = "1.6".freeze
 end

data/spec/mnemonic_spec.rb

@@ -0,0 +1,89 @@
+require_relative 'spec_helper'
+
+describe BTC::Mnemonic, "standard test vectors" do
+
+  [
+    [
+      "00000000000000000000000000000000",
+      "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about",
+      "c55257c360c07c72029aebc1b53c05ed0362ada38ead3e3e9efa3708e53495531f09a6987599d18264c1e1c92f2cf141630c7a3c4ab7c81b2f001698e7463b04"
+    ],
+    ["7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f",
+     "legal winner thank year wave sausage worth useful legal winner thank yellow",
+     "2e8905819b8723fe2c1d161860e5ee1830318dbf49a83bd451cfb8440c28bd6fa457fe1296106559a3c80937a1c1069be3a3a5bd381ee6260e8d9739fce1f607"],
+   ["80808080808080808080808080808080",
+     "letter advice cage absurd amount doctor acoustic avoid letter advice cage above",
+     "d71de856f81a8acc65e6fc851a38d4d7ec216fd0796d0a6827a3ad6ed5511a30fa280f12eb2e47ed2ac03b5c462a0358d18d69fe4f985ec81778c1b370b652a8"],
+   ["ffffffffffffffffffffffffffffffff",
+     "zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong",
+     "ac27495480225222079d7be181583751e86f571027b0497b5b5d11218e0a8a13332572917f0f8e5a589620c6f15b11c61dee327651a14c34e18231052e48c069"],
+   ["000000000000000000000000000000000000000000000000",
+     "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon agent",
+     "035895f2f481b1b0f01fcf8c289c794660b289981a78f8106447707fdd9666ca06da5a9a565181599b79f53b844d8a71dd9f439c52a3d7b3e8a79c906ac845fa"],
+   ["7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f",
+     "legal winner thank year wave sausage worth useful legal winner thank year wave sausage worth useful legal will",
+     "f2b94508732bcbacbcc020faefecfc89feafa6649a5491b8c952cede496c214a0c7b3c392d168748f2d4a612bada0753b52a1c7ac53c1e93abd5c6320b9e95dd"],
+   ["808080808080808080808080808080808080808080808080",
+     "letter advice cage absurd amount doctor acoustic avoid letter advice cage absurd amount doctor acoustic avoid letter always",
+     "107d7c02a5aa6f38c58083ff74f04c607c2d2c0ecc55501dadd72d025b751bc27fe913ffb796f841c49b1d33b610cf0e91d3aa239027f5e99fe4ce9e5088cd65"],
+   ["ffffffffffffffffffffffffffffffffffffffffffffffff",
+     "zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo when",
+     "0cd6e5d827bb62eb8fc1e262254223817fd068a74b5b449cc2f667c3f1f985a76379b43348d952e2265b4cd129090758b3e3c2c49103b5051aac2eaeb890a528"],
+   ["0000000000000000000000000000000000000000000000000000000000000000",
+     "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon art",
+     "bda85446c68413707090a52022edd26a1c9462295029f2e60cd7c4f2bbd3097170af7a4d73245cafa9c3cca8d561a7c3de6f5d4a10be8ed2a5e608d68f92fcc8"],
+   ["7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f7f",
+     "legal winner thank year wave sausage worth useful legal winner thank year wave sausage worth useful legal winner thank year wave sausage worth title",
+     "bc09fca1804f7e69da93c2f2028eb238c227f2e9dda30cd63699232578480a4021b146ad717fbb7e451ce9eb835f43620bf5c514db0f8add49f5d121449d3e87"],
+   ["8080808080808080808080808080808080808080808080808080808080808080",
+     "letter advice cage absurd amount doctor acoustic avoid letter advice cage absurd amount doctor acoustic avoid letter advice cage absurd amount doctor acoustic bless",
+     "c0c519bd0e91a2ed54357d9d1ebef6f5af218a153624cf4f2da911a0ed8f7a09e2ef61af0aca007096df430022f7a2b6fb91661a9589097069720d015e4e982f"],
+   ["ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
+     "zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo vote",
+     "dd48c104698c30cfe2b6142103248622fb7bb0ff692eebb00089b32d22484e1613912f0a5b694407be899ffd31ed3992c456cdf60f5d4564b8ba3f05a69890ad"],
+   ["77c2b00716cec7213839159e404db50d",
+     "jelly better achieve collect unaware mountain thought cargo oxygen act hood bridge",
+     "b5b6d0127db1a9d2226af0c3346031d77af31e918dba64287a1b44b8ebf63cdd52676f672a290aae502472cf2d602c051f3e6f18055e84e4c43897fc4e51a6ff"],
+   ["b63a9c59a6e641f288ebc103017f1da9f8290b3da6bdef7b",
+     "renew stay biology evidence goat welcome casual join adapt armor shuffle fault little machine walk stumble urge swap",
+     "9248d83e06f4cd98debf5b6f010542760df925ce46cf38a1bdb4e4de7d21f5c39366941c69e1bdbf2966e0f6e6dbece898a0e2f0a4c2b3e640953dfe8b7bbdc5"],
+   ["3e141609b97933b66a060dcddc71fad1d91677db872031e85f4c015c5e7e8982",
+     "dignity pass list indicate nasty swamp pool script soccer toe leaf photo multiply desk host tomato cradle drill spread actor shine dismiss champion exotic",
+     "ff7f3184df8696d8bef94b6c03114dbee0ef89ff938712301d27ed8336ca89ef9635da20af07d4175f2bf5f3de130f39c9d9e8dd0472489c19b1a020a940da67"],
+   ["0460ef47585604c5660618db2e6a7e7f",
+     "afford alter spike radar gate glance object seek swamp infant panel yellow",
+     "65f93a9f36b6c85cbe634ffc1f99f2b82cbb10b31edc7f087b4f6cb9e976e9faf76ff41f8f27c99afdf38f7a303ba1136ee48a4c1e7fcd3dba7aa876113a36e4"],
+   ["72f60ebac5dd8add8d2a25a797102c3ce21bc029c200076f",
+     "indicate race push merry suffer human cruise dwarf pole review arch keep canvas theme poem divorce alter left",
+     "3bbf9daa0dfad8229786ace5ddb4e00fa98a044ae4c4975ffd5e094dba9e0bb289349dbe2091761f30f382d4e35c4a670ee8ab50758d2c55881be69e327117ba"],
+   ["2c85efc7f24ee4573d2b81a6ec66cee209b2dcbd09d8eddc51e0215b0b68e416",
+     "clutch control vehicle tonight unusual clog visa ice plunge glimpse recipe series open hour vintage deposit universe tip job dress radar refuse motion taste",
+     "fe908f96f46668b2d5b37d82f558c77ed0d69dd0e7e043a5b0511c48c2f1064694a956f86360c93dd04052a8899497ce9e985ebe0c8c52b955e6ae86d4ff4449"],
+   ["eaebabb2383351fd31d703840b32e9e2",
+     "turtle front uncle idea crush write shrug there lottery flower risk shell",
+     "bdfb76a0759f301b0b899a1e3985227e53b3f51e67e3f2a65363caedf3e32fde42a66c404f18d7b05818c95ef3ca1e5146646856c461c073169467511680876c"],
+   ["7ac45cfe7722ee6c7ba84fbc2d5bd61b45cb2fe5eb65aa78",
+     "kiss carry display unusual confirm curtain upgrade antique rotate hello void custom frequent obey nut hole price segment",
+     "ed56ff6c833c07982eb7119a8f48fd363c4a9b1601cd2de736b01045c5eb8ab4f57b079403485d1c4924f0790dc10a971763337cb9f9c62226f64fff26397c79"],
+   ["4fa1a8bc3e6d80ee1316050e862c1812031493212b7ec3f3bb1b08f168cabeef",
+     "exile ask congress lamp submit jacket era scheme attend cousin alcohol catch course end lucky hurt sentence oven short ball bird grab wing top",
+     "095ee6f817b4c2cb30a5a797360a81a40ab0f9a4e25ecd672a3f58a0b5ba0687c096a6b14d2c0deb3bdefce4f61d01ae07417d502429352e27695163f7447a8c"],
+   ["18ab19a9f54a9274f03e5209a2ac8a91",
+     "board flee heavy tunnel powder denial science ski answer betray cargo cat",
+     "6eff1bb21562918509c73cb990260db07c0ce34ff0e3cc4a8cb3276129fbcb300bddfe005831350efd633909f476c45c88253276d9fd0df6ef48609e8bb7dca8"],
+   ["18a2e1d81b8ecfb2a333adcb0c17a5b9eb76cc5d05db91a4",
+     "board blade invite damage undo sun mimic interest slam gaze truly inherit resist great inject rocket museum chief",
+     "f84521c777a13b61564234bf8f8b62b3afce27fc4062b51bb5e62bdfecb23864ee6ecf07c1d5a97c0834307c5c852d8ceb88e7c97923c0a3b496bedd4e5f88a9"],
+   ["15da872c95a13dd738fbf50e427583ad61f18fd99f628c417a61cf8343c90419",
+     "beyond stage sleep clip because twist token leaf atom beauty genius food business side grid unable middle armed observe pair crouch tonight away coconut",
+     "b15509eaa2d09d3efd3e006ef42151b30367dc6e3aa5e44caba3fe4d3e352e65101fbdb86a96776b91946ff06f8eac594dc6ee1d3e82a42dfe1b40fef6bcc3fd"]
+  ].each do |vector|
+    it "should support test vector" do
+      entropy = vector[0].from_hex
+      words = vector[1]
+      seed = vector[2].from_hex
+      mnemonic = BTC::Mnemonic.new(words: words, password: "TREZOR")
+      mnemonic.seed.to_hex.must_equal seed.to_hex
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: btcruby
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: '1.6'
 platform: ruby
 authors:
 - Oleg Andreev
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-30 00:00:00.000000000 Z
+date: 2016-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -84,6 +84,7 @@ files:
 - lib/btcruby/key.rb
 - lib/btcruby/keychain.rb
 - lib/btcruby/merkle_tree.rb
+- lib/btcruby/mnemonic.rb
 - lib/btcruby/network.rb
 - lib/btcruby/open_assets.rb
 - lib/btcruby/open_assets/asset.rb
@@ -147,6 +148,7 @@ files:
 - spec/key_spec.rb
 - spec/keychain_spec.rb
 - spec/merkle_tree_spec.rb
+- spec/mnemonic_spec.rb
 - spec/network_spec.rb
 - spec/open_assets/asset_address_spec.rb
 - spec/open_assets/asset_id_spec.rb
@@ -200,6 +202,7 @@ test_files:
 - spec/key_spec.rb
 - spec/keychain_spec.rb
 - spec/merkle_tree_spec.rb
+- spec/mnemonic_spec.rb
 - spec/network_spec.rb
 - spec/open_assets/asset_address_spec.rb
 - spec/open_assets/asset_id_spec.rb