blockchain 2.0.0 → 3.0.0

data/docs/exchangerates.md

@@ -1,32 +1,57 @@
-##Exchange rates functionality
+# Exchange Rates functionality
 
-All functions support an optional parameter called `api_code`. It won't be listed with every function description.
+Initialize an instance of the `ExchangeRateExplorer` class:
 
-####`get_ticker`
-Call the 'ticker' method and return a dictionary of `Currency` objects. Keys are currency symbols (str) and values are `Currency` objects.
+```ruby
+# as with other classes, you can set optional params base_url and / or api_code
+
+require 'Blockchain'
+explorer = Blockchain::ExchangeRateExplorer.new
+```
 
+## Methods
 
-Usage:
-```ruby
-require 'blockchain'
+### `get_ticker`
+Call the 'ticker' method and return a dictionary of `Currency` objects. Keys are currency codes (str) and values are `Currency` objects.
 
-ticker = Blockchain::get_ticker()
+##### Usage:
+```ruby
+ticker = explorer.get_ticker
 #print the 15 min price for every currency
 ticker.keys.each do |key|
 	puts ticker[key].p15min
 end
 ```
 
-####`to_btc`
-Call the 'tobtc' method and convert x value in the provided currency to BTC. Returns a `float`.
+### `to_btc`
+Convert x value in the provided currency to BTC. Returns a `float`.
 
-Params:
-```
-ccy : str - currency code
-value : float
+##### Params:
+* `str ccy` - code of the currency to convert from
+* `float value` - amount in selected currency
+
+##### Usage:
+```ruby
+btc_amount = explorer.to_btc('USD', 4342.11)
 ```
 
-Usage:
+### `from_btc`
+Convert x value in satoshi to the provided currency. Returns a `float`
+
+##### Params:
+* `str ccy` (optional) - code of the currency to convert to (default USD)
+* `float satoshi_value` - amount of satoshi to convert
+
+##### Usage:
 ```ruby
-btc_amount = Blockchain::to_btc('USD', 4342.11)
-```
+one_btc_usd_value = explorer.from_btc(100000000)
+```
+
+## Response Object Properties
+
+### Currency Object
+* `last`
+* `buy`
+* `sell`
+* `symbol`
+* `p15min`

data/docs/pushtx.md

@@ -1,18 +1,24 @@
-##Push transaction functionality
+# 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.
+Initialize an instance of the `PushTx` class:
 
-Params:
-```
-tx : str (hex encoded)
-api_code : str (optional)
+```ruby
+# as with other classes, you can set optional params base_url and / or api_code
+
+require 'Blockchain'
+push_tx = Blockchain::PushTx.new
 ```
 
-Usage:
-```ruby
-require 'blockchain'
+## Methods
 
-Blockchain::pushtx( '0100000001fd468e431cf5797b108e4d22724e1e055b3ecec59af4ef17b063afd36d3c5cf6010000008c4930460221009918eee8be186035be8ca573b7a4ef7bc672c59430785e5390cc375329a2099702210085b86387e3e15d68c847a1bdf786ed0fdbc87ab3b7c224f3c5490ac19ff4e756014104fe2cfcf0733e559cbf28d7b1489a673c0d7d6de8470d7ff3b272e7221afb051b777b5f879dd6a8908f459f950650319f0e83a5cf1d7c1dfadf6458f09a84ba80ffffffff01185d2033000000001976a9144be9a6a5f6fb75765145d9c54f1a4929e407d2ec88ac00000000')
+### `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:
+* `str tx` (hex encoded)
+
+##### Usage:
+```ruby
+push_tx.pushtx( '0100000001fd468e431cf5797b108e4d22724e1e055b3ecec59af4ef17b063afd36d3c5cf6010000008c4930460221009918eee8be186035be8ca573b7a4ef7bc672c59430785e5390cc375329a2099702210085b86387e3e15d68c847a1bdf786ed0fdbc87ab3b7c224f3c5490ac19ff4e756014104fe2cfcf0733e559cbf28d7b1489a673c0d7d6de8470d7ff3b272e7221afb051b777b5f879dd6a8908f459f950650319f0e83a5cf1d7c1dfadf6458f09a84ba80ffffffff01185d2033000000001976a9144be9a6a5f6fb75765145d9c54f1a4929e407d2ec88ac00000000')
 
 ```

data/docs/receive.md

@@ -1,36 +1,63 @@
-##Receive V2 functionality
+# Receive Payments V2 functionality
 
-####`receive`
-Call the 'v2/receive' endpoint and create a new address. Returns a `V2::ReceiveResponse` object.
+Initialize an instance of the `Receive` class:
 
-Params:
-```
-xpub : str
-callback : str
-api_key : str
+```ruby
+# you can set optional param base_url (https://api.blockchain.info/v2/ by default).
+
+require 'Blockchain'
+receive_payment = Blockchain::V2::Receive.new
 ```
 
-Usage:
-```ruby
-require 'blockchain'
 
-resp = Blockchain::V2::receive('xpub1hNapz1CuH4DhnV1DFHH7hafwDE8FJRheA', 'http://your.url.com', 'yourApiKey')
+## Methods
 
-```
+### `receive`
+Call the 'v2/receive' endpoint and create a new address. Returns a `V2::ReceiveResponse` object.
 
-####`callback_log`
-Call the 'v2/receive/callback_log' endpoint. Returns an array of `LogEntry` objects.
+##### Params:
+* `str xpub`
+* `str callback`
+* `str api_key`
 
-Params:
+##### Usage:
+```ruby
+resp = receive_payment.receive('xpub1hNapz1CuH4DhnV1DFHH7hafwDE8FJRheA', 'http://your.url.com', 'yourApiKey')
 ```
-callback : str
-api_key : str
+
+### `callback_log`
+Call the 'v2/receive/callback_log' endpoint to see logs related to callback attempts. Returns an array of `LogEntry` objects.
+
+##### Params:
+* `str callback`
+* `str api_key`
+
+##### Usage:
+```ruby
+resp = receive_payment.callback_log('http://your.url.com', 'yourApiKey')
 ```
 
-Usage:
+### `callback_log`
+Call the 'v2/receive/checkgap' endpoint to check the index gap betweem the last address paid and the last address generated. Returns an `int`.
+
+##### Params:
+* `str xpub`
+* `str api_key`
+
+##### Usage:
 ```ruby
-require 'blockchain'
+resp = receive_payment.callback_log('xpub1hNapz1CuH4DhnV1DFHH7hafwDE8FJRheA', 'yourApiKey')
+```
+
+## Response Object Properties
 
-resp = Blockchain::callback_log('1hNapz1CuH4DhnV1DFHH7hafwDE8FJRheA', 'http://your.url.com')
+### ReceiveResponse Object
+* `address`
+* `index`
+* `callback_url`
 
-```
+### LogEntry Object
+* `callback_url`
+* `called_at`
+* `raw_response`
+* `response_code`

data/docs/statistics.md

@@ -1,16 +1,79 @@
-## Statistics functionality
+# Statistics functionality
 
-####`get`
+Initialize an instance of the `StatisticsExplorer` class:
+
+```ruby
+# as with other classes, you can set optional params base_url and / or api_code
+
+require 'Blockchain'
+explorer = Blockchain::StatisticsExplorer.new
+```
+
+## Methods
+
+### `get_statistics`
 Get network statistics. Returns a `StatisticsResponse` object.
 
-Params:
+##### Usage:
+```ruby
+stats = explorer.get_statistics()
 ```
-api_code : str (optional)
+
+### `get_chart`
+Get data from a Blockchain.info chart. Returns a `ChartResponse` object.
+
+##### Params
+* `str chart_type` - the name of the chart to get data for
+* `str timespan` (optional) - the duration of the chart (1 year by default in most cases, 1 week for mempool charts)
+* `str rolling_average` (optional) - the duration over which data should be averaged
+
+##### Usage
+```ruby
+chart_stats = explorer.get_chart('transactions-per-second', '5weeks', '8hours')
 ```
 
-Usage:
+### `get_pools`
+Get all mining pools and the total blocks they each mined in the last 4 days. Returns a `str` => `int` hash.
+
+##### Params
+* `int timespan` (optional) - number of days to get data for (default 4, maximum 10)
+
+##### Usage
 ```ruby
-require 'blockchain'
+pool_stats = explorer.get_pools(8)
+```
+
+## Response Object Properties
+
+### StatisticsResponse Object
+* `trade_volume_btc`
+* `miners_revenue_usd`
+* `btc_mined`
+* `trade_volume_usd`
+* `difficulty`
+* `minutes_between_blocks`
+* `number_of_transactions`
+* `hash_rate`
+* `timestamp`
+* `mined_blocks`
+* `blocks_size`
+* `total_fees_btc`
+* `total_btc_sent`
+* `estimated_btc_sent`
+* `total_btc`
+* `total_blocks`
+* `next_retarget`
+* `estimated_transaction_volume_usd`
+* `miners_revenue_btc`
+* `market_price_usd`
+
+### ChartResponse Object
+* `chart_name`
+* `unit`
+* `timespan`
+* `description`
+* `values`
 
-stats = Blockchain::get_statistics()
-```
+### ChartValue Object
+* `x`
+* `y`

data/docs/wallet.md

@@ -1,54 +1,49 @@
-##`wallet` module
+# Wallet functionality
 
 An instance of the `Wallet` class needs to be initialized before it can be used.
 
-Constructor params:
-```
-identifier : str
-password : str
-url : str
-second_password : str (optional)
-api_code : str (optional)
-```
+##### Constructor params:
+
+* `str identifier`
+* `str password`
+* `str url` (optional, defaults to http://localhost:3000)
+* `str second_password` (optional)
+* `str api_code` (optional)
 
-Usage:
+##### Usage:
 ```ruby
-require 'blockchain'
+require 'Blockchain'
 
-wallet = Blockchain::Wallet.new('ada4e4b6-3c9f-11e4-baad-164230d1df67', 'password123', 'http://localhost:3000/')
+wallet = Blockchain::Wallet.new('ada4e4b6-3c9f-11e4-baad-164230d1df67', 'password123')
 ```
 
-####`send`
+## Methods
+
+### `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)
-```
+##### Params:
+* `str to` - receiving address
+* `int amount` - amount to send (in satoshi)
+* `str from_address` (optional, keyword) - specific address to send from
+* `int fee` (optional, keyword) - transaction fee in satoshi. Must be greater than default
 
-Usage:
+##### Usage:
 ```ruby
 payment = wallet.send('1NAF7GbdyRg3miHNrw2bGxrd63tfMEmJob', 1000000, from_address: '1A8JiWcwvpY7tAopUkSnGuEYHmzGYfZPiq')
 
 puts payment.tx_hash
 ```
 
-####`send_many`
+### `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)
-```
+##### Params:
+* `dictionary recipients` - hash with the structure of `str address` => `int amount` in satoshi
+* `str from_address` (optional, keyword) - specific address to send from
+* `int fee` (optional, keyword) - transaction fee in satoshi. Must be greater than default
 
-Usage:
+##### Usage:
 ```ruby
 recipients = { '1NAF7GbdyRg3miHNrw2bGxrd63tfMEmJob' => 1428300,
 				'1A8JiWcwvpY7tAopUkSnGuEYHmzGYfZPiq' => 234522117 }
@@ -57,23 +52,18 @@ payment = wallet.send_many(recipients)
 puts payment.tx_hash
 ```
 
-####`get_balance`
+### `get_balance`
 Fetch the wallet balance. Includes unconfirmed transactions and possibly double spends. Returns the wallet balance in satoshi.
 
-Usage:
+##### Usage:
 ```ruby
-puts wallet.get_balance() 
+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)
-```
+### `list_addresses`
+List all active addresses in the wallet. Returns an array of `WalletAddress` objects.
 
-Usage:
+##### Usage:
 ```ruby
 addresses = wallet.list_addresses()
 addresses.each do |a|
@@ -82,68 +72,60 @@ end
 
 ```
 
-####`get_address`
-Retrieve an address from the wallet. Returns an `Address` object.
+### `get_address`
+Retrieve an address from the wallet. Returns an `WalletAddress` object.
 
-Params:
-```
-confirmations : int - minimum number of confirmations transactions must have before being included in the balance (optional)
-```
+##### Params:
+* `str address` - the address to retrieve
 
-Usage:
+##### Usage:
 ```ruby
-addr = wallet.get_address('1NAF7GbdyRg3miHNrw2bGxrd63tfMEmJob', confirmations = 2)
+addr = wallet.get_address('1NAF7GbdyRg3miHNrw2bGxrd63tfMEmJob')
 puts addr.balance
 ```
 
-####`new_address`
-Generate a new address and add it to the wallet. Returns an `Address` object.
+### `new_address`
+Generate a new address and add it to the wallet. Returns an `WalletAddress` object.
 
-Params:
-```
-label : str - label to attach to the address (optional, keyword)
-```
+##### Params:
+* `str label` (optional, keyword) - label to attach to the address
 
-Usage:
+##### Usage:
 ```ruby
 newaddr = wallet.new_address('test_label')
 ```
 
-####`archive_address`
+### `archive_address`
 Archive an address. Returns a string representation of the archived address.
 
-Params:
-```
-address : str - address to archive
-```
+##### Params:
+* `str address` - address to archive
 
-Usage:
+##### Usage:
 ```ruby
 wallet.archive_address('1NAF7GbdyRg3miHNrw2bGxrd63tfMEmJob')
 ```
 
-####`unarchive_address`
+### `unarchive_address`
 Unarchive an address. Returns a string representation of the unarchived address.
 
-Params:
-```
-address : str - address to unarchive
-```
+##### Params:
+* `str address` - address to unarchive
 
-Usage:
+##### Usage:
 ```ruby
 wallet.unarchive_address('1NAF7GbdyRg3miHNrw2bGxrd63tfMEmJob')
 ```
 
-####`consolidate`
-Consolidate the wallet addresses. Returns a string array of consolidated addresses.
+## Response Object Properties
 
-Params:
-```
-days : int - addresses which have not received any transactions in at least this many days will be consolidated.
-```
+### WalletAddress Object
+* `balance`
+* `address`
+* `label`
+* `total_received`
 
-Usage:
-```ruby
-wallet.consolidate(50)
-```
+### PaymentResponse Object
+* `message`
+* `tx_hash`
+* `notice`