money-tree 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c66c0e7219fa0eb2fb74c4fc9b0c5352b8cbd6c7
-  data.tar.gz: 33fae9f04e6342f48b92b66a03abdc6055e2580b
+  metadata.gz: 6c440022c70d98f3f615a3b196094058bc28eae1
+  data.tar.gz: 1633093d7c5d4dced6a636d90767e45cb90e0131
 SHA512:
-  metadata.gz: 66b5806bea2116399a68f405464dd3c255e3bcc4915735f2276c683a4e2d8435d433b3cf4acdeb7109e19151dca1d9cf67605c219f2c350a4c3b8d3a299867c9
-  data.tar.gz: 95a0b8d17a23eb41f20da809869caf72430c74a3841375fcc0180aea7370f2a0d9137de8b8fb9f62c681d31f69df727e6888373a45a46298a32893a944c02e8a
+  metadata.gz: bae317b7a5007778220c746977d70634c6549dfafa8acd49819699d84d195c48554dd5290422c827a4ef48bfd09b19dfbf0a34abc5ca62c88b6d966eda6ead88
+  data.tar.gz: 0f77e37af78cd891f7871b89fc913395a3a12fa98e44b372497bb9211b34be2ab51d9a00348f7265a12d72625dba17df92a4b3d2b4953d30bdf1769f65f984ec

data/README.md

@@ -62,18 +62,20 @@ These instructions assume you have a decent understanding of how Bitcoin wallets
 
 To create a new HD Wallet, we're going to create a tree structure of private/public keypairs (nodes).  You'll first want to start with a master node. This master node should be seeded with at least 16 random bytes but preferably 32 random bytes from a cryptographically secure PRNG (pseudo-random number generator). 
 
-DO NOT use a user generated password. Keep in mind that whoever controls the seed controls ALL coins in the entire tree, so it should not be left up to a human brain, because humans tend to follow patterns and patterns are subject to brute force attacks. Luckily, I've already included the seed generation by default so you don't need to create this on your own.
+DO NOT use a user generated password. Keep in mind that whoever controls the seed controls ALL coins in the entire tree, so it should not be left up to a human brain, because humans tend to follow patterns and patterns are subject to brute force attacks. Luckily, MoneyTree includes the seed generation by default so you don't need to create this on your own.
 
 ```ruby
 # Create a new master node (with automatic seed generation)
 @master = MoneyTree::Master.new
 => MoneyTree::Master instance
+
 @master.seed
 => "N\xC5\x9DD\xAA\xCC\x80a\a\x96%8\xC8\x86\x81\x90\t\x82&\xE4\x97Ay\xECs\xD8\xB1M\xEA\xE6|\xEF"
 
 # Or import an existing seed
 @master = MoneyTree::Master.new seed_hex: "000102030405060708090a0b0c0d0e0f"
 => MoneyTree::Master instance
+
 @master.seed
 => "\x00\x01\x02\x03\x04\x05\x06\a\b\t\n\v\f\r\x0E\x0F"
 ```
@@ -85,28 +87,40 @@ DO NOT use a user generated password. Keep in mind that whoever controls the see
 # Here are some things you can do with a node.
 @master.index # The index is a sequential identifier in relation to its parent node. (i.e. the nth child of its parent)
 => 0
+
 @master.depth # How many steps down the tree this node is. (The master node is at depth 0, its direct child is at depth 1, and so on...)
 => 0
+
 @master.to_identifier
 => "3442193e1bb70916e914552172cd4e2dbc9df811"
+
 @master.to_fingerprint
 => "3442193e"
+
 @master.to_address
 => "15mKKb2eos1hWa6tisdPwwDC1a5J1y9nma"
+
 @master.private_key.to_hex
 => "e8f32e723decf4051aefac8e2c93c9c5b214313817cdb01a1494b917c8436b35"
+
 @master.private_key.to_wif
 => "L52XzL2cMkHxqxBXRyEpnPQZGUs3uKiL3R11XbAdHigRzDozKZeW"
+
 @master.public_key.to_hex
 => "0339a36013301597daef41fbe593a02cc513d0b55527ec2df1050e2e8ff49c85c2"
+
 @master.chain_code_hex 
 => "873dff81c02f525623fd1fe5167eac3a55a049de3d314bb42ee227ffed37d508" # Look up chain codes in the BIP0032 spec
+
 @master.to_serialized_hex(:private)
 => "0488ade4000000000000000000873dff81c02f525623fd1fe5167eac3a55a049de3d314bb42ee227ffed37d50800e8f32e723decf4051aefac8e2c93c9c5b214313817cdb01a1494b917c8436b35"
+
 @master.to_serialized_address(:private)
 => "xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi"
+
 @master.to_serialized_hex
 => "0488b21e000000000000000000873dff81c02f525623fd1fe5167eac3a55a049de3d314bb42ee227ffed37d5080339a36013301597daef41fbe593a02cc513d0b55527ec2df1050e2e8ff49c85c2"
+
 @master.to_serialized_address
 => "xpub661MyMwAqRbcFtXgS5sYJABqqG9YLmC4Q1Rdap9gSE8NqtwybGhePY2gZ29ESFjqJoCu1Rupje8YtGqsefD265TMg7usUDFdp6W1EGMcet8"
 ```
@@ -119,12 +133,16 @@ To generate a child node from a given path:
 ```ruby
 @node = @master.node_for_path "m/0/3"
 => MoneyTree::Node instance
+
 @node.index
 => 3
+
 @node.depth
 => 2
+
 @node.to_serialized_address(:private)
 => "xprv9ww7sMFLzJN15m7zX5JEBXQrQq8h4fU8PVqd929Hjy3xNSMzeBf163idMNBSq47DdCakyZTK7KcC2nbz3jqUkpJj8ZR4FqrijcFcFmcoBAe"
+
 @node.to_serialized_address
 => "xpub6AvUGrnEpfvJJFCTd6qEYfMaxryBU8BykimDwQYuJJawFEh9BiyFdr37Cc4wEKCWWv7TsFQRUMdezXVqV9cfBUbeUEgNYCCP4omxULbNaRr"
 ```
@@ -135,11 +153,14 @@ In HD wallets, chain codes are the mathematical glue that binds a parent node to
 You don't need to worry about chain codes if you are creating or importing from a Master key (it's always the same for all HD wallet master keys), however if you are trying to import a derived child key at some lower depth in the tree, you'll need the chain code. Luckily, whenever we export a node to a wallet file, we encode it in a special format that includes all of the relevant info (including chain code) that we need to reconstruct the node in a single convenient serialized address.
 
 #### Serialized Addresses
-Beacause we need multiple pieces of info to reconstruct nodes in a tree, when we're dealing with HD wallets, we pass around a serialized address format that encodes both the key and the chain code. It lookes like this:
+Beacause we need multiple pieces of info to reconstruct nodes in a tree, when we're dealing with HD wallets, we pass around a serialized address format that encodes both the key and the chain code. It looks like this:
 
 ```ruby
-"xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi" # private key
-"xpub661MyMwAqRbcFtXgS5sYJABqqG9YLmC4Q1Rdap9gSE8NqtwybGhePY2gZ29ESFjqJoCu1Rupje8YtGqsefD265TMg7usUDFdp6W1EGMcet8" # public key
+# private key
+"xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi"
+
+# public key
+"xpub661MyMwAqRbcFtXgS5sYJABqqG9YLmC4Q1Rdap9gSE8NqtwybGhePY2gZ29ESFjqJoCu1Rupje8YtGqsefD265TMg7usUDFdp6W1EGMcet8"
 ```
 
 In addition to the key and the chain code, this encoding also includes info about the depth and index of the key, along with a fingerprint of its parent key (which I presume is for quickly sorting a big pile of keys into a tree).   
@@ -151,6 +172,7 @@ To export a node to a serialized address, you can do:
 ```ruby
 @node.to_serialized_address(:private) # for private keys
 => "xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi"
+
 @node.to_serialized_address
 => "xpub661MyMwAqRbcFtXgS5sYJABqqG9YLmC4Q1Rdap9gSE8NqtwybGhePY2gZ29ESFjqJoCu1Rupje8YtGqsefD265TMg7usUDFdp6W1EGMcet8"
 ```
@@ -175,8 +197,10 @@ For example:
 
 ```ruby
 @node = @master.node_for_path("M/0/3") # or "m/0/3.pub" or "M/0/3.pub"...these are equivalent
+
 @node.to_serialized_address
 => "xpub6AvUGrnEpfvJJFCTd6qEYfMaxryBU8BykimDwQYuJJawFEh9BiyFdr37Cc4wEKCWWv7TsFQRUMdezXVqV9cfBUbeUEgNYCCP4omxULbNaRr"
+
 @node.to_serialized_address(:private)
 -> raises MoneyTree::Node::PrivatePublicMismatch error
 ```
@@ -187,8 +211,10 @@ You can also import a node using only a public key. Keep in mind that this node
 ```ruby
 @node = MoneyTree::Node.from_serialized_address("xpub6AvUGrnEpfvJJFCTd6qEYfMaxryBU8BykimDwQYuJJawFEh9BiyFdr37Cc4wEKCWWv7TsFQRUMdezXVqV9cfBUbeUEgNYCCP4omxULbNaRr")
 => MoneyTree::Node instance
+
 @node.to_serialized_address
 => "xpub6AvUGrnEpfvJJFCTd6qEYfMaxryBU8BykimDwQYuJJawFEh9BiyFdr37Cc4wEKCWWv7TsFQRUMdezXVqV9cfBUbeUEgNYCCP4omxULbNaRr"
+
 @node.to_serialized_address(:private)
 -> raises MoneyTree::Node::PrivatePublicMismatch error
 ```

data/lib/money-tree/node.rb

@@ -1,6 +1,7 @@
 module MoneyTree
   class Node
     include Support
+    extend Support
     attr_reader :private_key, :public_key, :chain_code, :is_private, :depth, :index, :parent, :is_test
     
     class PublicDerivationFailure < Exception; end

data/lib/money-tree/version.rb

@@ -1,3 +1,3 @@
 module MoneyTree
-  VERSION = "0.8.1"
+  VERSION = "0.8.2"
 end

data/spec/lib/money-tree/support_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 require 'money-tree'
-include MoneyTree::Support
 
-describe MoneyTree::Support do  
+describe MoneyTree::Support do
+  include MoneyTree::Support
 
   describe "sha256(str)" do
     it "properly calculates sha256 hash" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: money-tree
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Micah Winkelspecht
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-17 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Bitcoin Hierarchical Deterministic Wallets in Ruby! (Bitcoin standard BIP0032)