blockchain 1.0.2 → 1.1.1

data/docs/pushtx.md

@@ -1,18 +1,18 @@
-##Push transaction functionality
-
-####`pushtx`
-Call the pushtx endpoint and broadcast a hex encoded transaction. The method does not return anything upon success, but will raise exceptions if the transaction is malformed.
-
-Params:
-```
-tx : str (hex encoded)
-api_code : str (optional)
-```
-
-Usage:
-```ruby
-require 'blockchain'
-
-Blockchain::pushtx( '0100000001fd468e431cf5797b108e4d22724e1e055b3ecec59af4ef17b063afd36d3c5cf6010000008c4930460221009918eee8be186035be8ca573b7a4ef7bc672c59430785e5390cc375329a2099702210085b86387e3e15d68c847a1bdf786ed0fdbc87ab3b7c224f3c5490ac19ff4e756014104fe2cfcf0733e559cbf28d7b1489a673c0d7d6de8470d7ff3b272e7221afb051b777b5f879dd6a8908f459f950650319f0e83a5cf1d7c1dfadf6458f09a84ba80ffffffff01185d2033000000001976a9144be9a6a5f6fb75765145d9c54f1a4929e407d2ec88ac00000000')
-
-```
+##Push transaction functionality
+
+####`pushtx`
+Call the pushtx endpoint and broadcast a hex encoded transaction. The method does not return anything upon success, but will raise exceptions if the transaction is malformed.
+
+Params:
+```
+tx : str (hex encoded)
+api_code : str (optional)
+```
+
+Usage:
+```ruby
+require 'blockchain'
+
+Blockchain::pushtx( '0100000001fd468e431cf5797b108e4d22724e1e055b3ecec59af4ef17b063afd36d3c5cf6010000008c4930460221009918eee8be186035be8ca573b7a4ef7bc672c59430785e5390cc375329a2099702210085b86387e3e15d68c847a1bdf786ed0fdbc87ab3b7c224f3c5490ac19ff4e756014104fe2cfcf0733e559cbf28d7b1489a673c0d7d6de8470d7ff3b272e7221afb051b777b5f879dd6a8908f459f950650319f0e83a5cf1d7c1dfadf6458f09a84ba80ffffffff01185d2033000000001976a9144be9a6a5f6fb75765145d9c54f1a4929e407d2ec88ac00000000')
+
+```

data/docs/receive.md

@@ -1,19 +1,57 @@
-##Receive functionality
-
-####`receive`
-Call the 'api/receive' endpoint and create a forwarding address. Returns a `ReceiveResponse` object.
-
-Params:
-```
-dest_addr : str
-callback : str
-api_code : str (optional)
-```
-
-Usage:
-```ruby
-require 'blockchain'
-
-resp = Blockchain::receive('1hNapz1CuH4DhnV1DFHH7hafwDE8FJRheA', 'http://your.url.com')
-
-```
+##Receive V1 functionality (deprecated)
+
+####`receive`
+Call the 'api/receive' endpoint and create a forwarding address. Returns a `ReceiveResponse` object.
+
+Params:
+```
+dest_addr : str
+callback : str
+api_code : str (optional)
+```
+
+Usage:
+```ruby
+require 'blockchain'
+
+resp = Blockchain::receive('1hNapz1CuH4DhnV1DFHH7hafwDE8FJRheA', 'http://your.url.com')
+
+```
+
+
+##Receive V2 functionality
+
+####`receive`
+Call the 'v2/receive' endpoint and create a new address. Returns a `V2::ReceiveResponse` object.
+
+Params:
+```
+xpub : str
+callback : str
+api_key : str
+```
+
+Usage:
+```ruby
+require 'blockchain'
+
+resp = Blockchain::V2::receive('xpub1hNapz1CuH4DhnV1DFHH7hafwDE8FJRheA', 'http://your.url.com', 'yourApiKey')
+
+```
+
+####`callback_log`
+Call the 'v2/receive/callback_log' endpoint. Returns an array of `LogEntry` objects.
+
+Params:
+```
+callback : str
+api_key : str
+```
+
+Usage:
+```ruby
+require 'blockchain'
+
+resp = Blockchain::callback_log('1hNapz1CuH4DhnV1DFHH7hafwDE8FJRheA', 'http://your.url.com')
+
+```

data/docs/statistics.md

@@ -1,16 +1,16 @@
-## Statistics functionality
-
-####`get`
-Get network statistics. Returns a `StatisticsResponse` object.
-
-Params:
-```
-api_code : str (optional)
-```
-
-Usage:
-```ruby
-require 'blockchain'
-
-stats = Blockchain::get_statistics()
+## Statistics functionality
+
+####`get`
+Get network statistics. Returns a `StatisticsResponse` object.
+
+Params:
+```
+api_code : str (optional)
+```
+
+Usage:
+```ruby
+require 'blockchain'
+
+stats = Blockchain::get_statistics()
 ```

data/docs/wallet.md

@@ -1,148 +1,148 @@
-##`wallet` module
-
-An instance of the `Wallet` class needs to be initialized before it can be used.
-
-Constructor params:
-```
-identifier : str
-password : str
-second_password : str (optional)
-api_code : str (optional)
-```
-
-Usage:
-```ruby
-require 'blockchain'
-
-wallet = Blockchain::Wallet.new('ada4e4b6-3c9f-11e4-baad-164230d1df67', 'password123')
-```
-
-####`send`
-Send bitcoin from your wallet to a single address. Returns a `PaymentResponse` object.
-
-Params:
-```
-to : str - receiving address
-amount : int - amount to send (in satoshi)
-from_address : str - specific address to send from (optional, keyword)
-fee : int - transaction fee in satoshi. Must be greater than default (optional, keyword)
-note : str - public note to include with the transaction if amount >= 0.005 BTC (optional, keyword)
-```
-
-Usage:
-```ruby
-payment = wallet.send('1NAF7GbdyRg3miHNrw2bGxrd63tfMEmJob', 1000000, from_address: '1A8JiWcwvpY7tAopUkSnGuEYHmzGYfZPiq')
-
-puts payment.tx_hash
-```
-
-####`send_many`
-Send bitcoin from your wallet to multiple addresses. Returns a `PaymentResponse` object.
-
-Params:
-```
-recipients : dictionary - dictionary with the structure of 'address':amount
-from_address : str - specific address to send from (optional, keyword)
-fee : int - transaction fee in satoshi. Must be greater than default (optional, keyword)
-note : str - public note to include with the transaction if amount >= 0.005 BTC (optional, keyword)
-```
-
-Usage:
-```ruby
-recipients = { '1NAF7GbdyRg3miHNrw2bGxrd63tfMEmJob' => 1428300,
-				'1A8JiWcwvpY7tAopUkSnGuEYHmzGYfZPiq' => 234522117 }
-payment = wallet.send_many(recipients)
-
-puts payment.tx_hash
-```
-
-####`get_balance`
-Fetch the wallet balance. Includes unconfirmed transactions and possibly double spends. Returns the wallet balance in satoshi.
-
-Usage:
-```ruby
-puts wallet.get_balance() 
-```
-
-####`list_addresses`
-List all active addresses in the wallet. Returns an array of `Address` objects.
-
-Params:
-```
-confirmations : int - minimum number of confirmations transactions must have before being included in balance of addresses (optional)
-```
-
-Usage:
-```ruby
-addresses = wallet.list_addresses()
-addresses.each do |a|
-	puts a.balance
-end
-
-```
-
-####`get_address`
-Retrieve an address from the wallet. Returns an `Address` object.
-
-Params:
-```
-confirmations : int - minimum number of confirmations transactions must have before being included in the balance (optional)
-```
-
-Usage:
-```ruby
-addr = wallet.get_address('1NAF7GbdyRg3miHNrw2bGxrd63tfMEmJob', confirmations = 2)
-puts addr.balance
-```
-
-####`new_address`
-Generate a new address and add it to the wallet. Returns an `Address` object.
-
-Params:
-```
-label : str - label to attach to the address (optional, keyword)
-```
-
-Usage:
-```ruby
-newaddr = wallet.new_address('test_label')
-```
-
-####`archive_address`
-Archive an address. Returns a string representation of the archived address.
-
-Params:
-```
-address : str - address to archive
-```
-
-Usage:
-```ruby
-wallet.archive_address('1NAF7GbdyRg3miHNrw2bGxrd63tfMEmJob')
-```
-
-####`unarchive_address`
-Unarchive an address. Returns a string representation of the unarchived address.
-
-Params:
-```
-address : str - address to unarchive
-```
-
-Usage:
-```ruby
-wallet.unarchive_address('1NAF7GbdyRg3miHNrw2bGxrd63tfMEmJob')
-```
-
-####`consolidate`
-Consolidate the wallet addresses. Returns a string array of consolidated addresses.
-
-Params:
-```
-days : int - addresses which have not received any transactions in at least this many days will be consolidated.
-```
-
-Usage:
-```ruby
-wallet.consolidate(50)
-```
+##`wallet` module
+
+An instance of the `Wallet` class needs to be initialized before it can be used.
+
+Constructor params:
+```
+identifier : str
+password : str
+second_password : str (optional)
+api_code : str (optional)
+```
+
+Usage:
+```ruby
+require 'blockchain'
+
+wallet = Blockchain::Wallet.new('ada4e4b6-3c9f-11e4-baad-164230d1df67', 'password123')
+```
+
+####`send`
+Send bitcoin from your wallet to a single address. Returns a `PaymentResponse` object.
+
+Params:
+```
+to : str - receiving address
+amount : int - amount to send (in satoshi)
+from_address : str - specific address to send from (optional, keyword)
+fee : int - transaction fee in satoshi. Must be greater than default (optional, keyword)
+note : str - public note to include with the transaction if amount >= 0.005 BTC (optional, keyword)
+```
+
+Usage:
+```ruby
+payment = wallet.send('1NAF7GbdyRg3miHNrw2bGxrd63tfMEmJob', 1000000, from_address: '1A8JiWcwvpY7tAopUkSnGuEYHmzGYfZPiq')
+
+puts payment.tx_hash
+```
+
+####`send_many`
+Send bitcoin from your wallet to multiple addresses. Returns a `PaymentResponse` object.
+
+Params:
+```
+recipients : dictionary - dictionary with the structure of 'address':amount
+from_address : str - specific address to send from (optional, keyword)
+fee : int - transaction fee in satoshi. Must be greater than default (optional, keyword)
+note : str - public note to include with the transaction if amount >= 0.005 BTC (optional, keyword)
+```
+
+Usage:
+```ruby
+recipients = { '1NAF7GbdyRg3miHNrw2bGxrd63tfMEmJob' => 1428300,
+				'1A8JiWcwvpY7tAopUkSnGuEYHmzGYfZPiq' => 234522117 }
+payment = wallet.send_many(recipients)
+
+puts payment.tx_hash
+```
+
+####`get_balance`
+Fetch the wallet balance. Includes unconfirmed transactions and possibly double spends. Returns the wallet balance in satoshi.
+
+Usage:
+```ruby
+puts wallet.get_balance() 
+```
+
+####`list_addresses`
+List all active addresses in the wallet. Returns an array of `Address` objects.
+
+Params:
+```
+confirmations : int - minimum number of confirmations transactions must have before being included in balance of addresses (optional)
+```
+
+Usage:
+```ruby
+addresses = wallet.list_addresses()
+addresses.each do |a|
+	puts a.balance
+end
+
+```
+
+####`get_address`
+Retrieve an address from the wallet. Returns an `Address` object.
+
+Params:
+```
+confirmations : int - minimum number of confirmations transactions must have before being included in the balance (optional)
+```
+
+Usage:
+```ruby
+addr = wallet.get_address('1NAF7GbdyRg3miHNrw2bGxrd63tfMEmJob', confirmations = 2)
+puts addr.balance
+```
+
+####`new_address`
+Generate a new address and add it to the wallet. Returns an `Address` object.
+
+Params:
+```
+label : str - label to attach to the address (optional, keyword)
+```
+
+Usage:
+```ruby
+newaddr = wallet.new_address('test_label')
+```
+
+####`archive_address`
+Archive an address. Returns a string representation of the archived address.
+
+Params:
+```
+address : str - address to archive
+```
+
+Usage:
+```ruby
+wallet.archive_address('1NAF7GbdyRg3miHNrw2bGxrd63tfMEmJob')
+```
+
+####`unarchive_address`
+Unarchive an address. Returns a string representation of the unarchived address.
+
+Params:
+```
+address : str - address to unarchive
+```
+
+Usage:
+```ruby
+wallet.unarchive_address('1NAF7GbdyRg3miHNrw2bGxrd63tfMEmJob')
+```
+
+####`consolidate`
+Consolidate the wallet addresses. Returns a string array of consolidated addresses.
+
+Params:
+```
+days : int - addresses which have not received any transactions in at least this many days will be consolidated.
+```
+
+Usage:
+```ruby
+wallet.consolidate(50)
+```

data/lib/blockchain.rb

@@ -8,5 +8,6 @@ require "blockchain/statistics"
 require "blockchain/wallet"
 
 module Blockchain
-
+	module V2
+	end
 end