nanook 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1c2a7e556469efac09a609f78e8f3a4e0533a89
-  data.tar.gz: 12d86898565f21e0c483c891be2b36f1c838216e
+  metadata.gz: 5a13b3163d4646a6b2be0f571fff5b848a7bb235
+  data.tar.gz: 07ecc5c01111b031717e8f2296405598997adda1
 SHA512:
-  metadata.gz: 47b9839217c59af70980fb20b1f8cefe716654170d15c908dc25f24bcba7ba34ef8b9bc5dc0b50912b447e6a779d022dbc264b2a469219c383fae754d8828843
-  data.tar.gz: 94d4e68c2a9a8debbd06c48b98e3b30d8ec2fac6d567e5c40dba50044c82cd894b11051b9b7df32ae818dbc830b1a27b2826b0a5267e959f415dd9e90c2069bb
+  metadata.gz: 386623ddde38720cb70b25dfb3c24dfbdc05b77ef47f0d977ac0f4e8486a5f0b00b05aee8993f61ece0c47fe1bc827208a1fddf74b5161e149f2e0052d1862b8
+  data.tar.gz: 3c7911c97fb02a1b8b5b449be32e916abfc6f585f3942546933ef6762528aad1bfed3b09abd35735b5451ec984ad5c7ea6133b6756d5c501ab513ad4fe2ae3e2

data/CHANGELOG.md

@@ -4,9 +4,42 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 2.2.0
+
+### Added
+
+- New `Nanook::Account#block_count` method returns number of blocks in ledger for an account.
+- `Account#delegators` now takes `unit` argument.
+- `Account#ledger` now takes `unit` and `modified_since` arguments.
+- `Nanook::Node#block_count_type` is now an alias to the preferred `#block_count_by_type`
+  method.
+- `Nanook::Node#representatives` now takes `unit` argument.
+- new `Nanook::Node#representatives_online` method.
+- `Nanook::Node#synchronizing_blocks` aliased by `#unchecked`, for people familiar with
+  what the RPC calls it.
+- `Nanook::Node#version` now an aliased by `#info`
+  method.
+- `Nanook::WalletAccount#exists?` now aliased by `#open?`
+
+### Removed
+
+- `Nanook::WalletAccount#account_id` Removed, as there was already an `id` method that returned this.
+- `Nanook::WalletAccount#wallet_id` Removed, as the `WalletAccount` object should be considered a kind of Account.
+
+### Changed
+
+- `Nanook::Node#synced?` is deprecated with a `warn`. Nodes never seem to reach 100%
+  synchronized, so this method is useless.
+- `Nanook::Rpc::DEFAULT_TIMEOUT` reduced from 500 to 60.
+
 ## 2.1.0
 
-- Payment methods check the account id of the recipient is valid, raises ArgumentError if not.
+### Changed
+
+- Payment methods no longer check that recipient account has an open block, as this prevents
+  funds being sent to accounts about to be opened.
+- Payment methods now check the account id of the recipient is valid, raises ArgumentError if not.
+- Payment methods now return a Nanook::Error if the RPC returns an error when trying to pay, instead of a String.
 
 ## 2.0.0
 
@@ -24,6 +57,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Added ruby version requirement >= 2.0 to gemspec.
 
 ### Changed
+
 - `Nanook::Rpc#inspect` displays full hostname with scheme and port.
 - `Nanook::Account#new` `account` param is now required.
 - `Nanook::Account#info` now also returns the `id` of the account.
@@ -41,6 +75,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Changed documentation generating tool from rdoc to yard.
 
 ### Fixed
+
 - Missing `Nanook#rpc` accessor.
 - `Nanook::Block#publish` can return false when publish fails.
 - `Nanook::Block#info` correctly handles `allow_unchecked: true` errors.

data/README.md

@@ -11,7 +11,7 @@ This is a Ruby library for managing a [nano currency](https://nano.org/) node, i
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'nanook', "~> 2.1"
+gem 'nanook', "~> 2.2"
 ```
 
 And then execute:
@@ -120,11 +120,11 @@ wallet.receive(block_id, into: account_id)
 
 ## All commands
 
-Below is a quick reference list of commands. See the [full Nanook documentation](https://lukes.github.io/nanook/2.0.0/) for a searchable detailed description of every class and method, what the arguments mean, and example responses (Tip: the classes are listed under the "**Nanook** < Object" item in the sidebar).
+Below is a quick reference list of commands. See the [full Nanook documentation](https://lukes.github.io/nanook/2.2.0/) for a searchable detailed description of every class and method, what the arguments mean, and example responses (Tip: the classes are listed under the "**Nanook** < Object" item in the sidebar).
 
 ### Wallets
 
-See the [full documentation for Nanook::Wallet](https://lukes.github.io/nanook/2.0.0/classes/Nanook/Wallet.html) for a detailed description of each method and example responses.
+See the [full documentation for Nanook::Wallet](https://lukes.github.io/nanook/2.2.0/Nanook/Wallet.html) for a detailed description of each method and example responses.
 
 #### Create wallet:
 
@@ -150,7 +150,7 @@ wallet.balance
 wallet.balance(account_break_down: true)
 wallet.balance(unit: :raw)
 wallet.pay(from: your_account_id, to: recipient_account_id, amount: 2, id: unique_id)
-wallet.pay(from: your_account_id, to: recipient_account_id, amount: 2, unit: :raw, id: unique_id)
+wallet.pay(from: your_account_id, to: recipient_account_id, amount: 2, id: unique_id, unit: :raw)
 wallet.pending
 wallet.pending(limit: 1)
 wallet.pending(detailed: true)
@@ -185,13 +185,15 @@ Nanook.new.wallet(wallet_id).account.create(5)
 
 #### Working with a single account:
 
+See the [full documentation for Nanook::WalletAccount](https://lukes.github.io/nanook/2.2.0/Nanook/WalletAccount.html) for a detailed description of each method and example responses.
+
 ```ruby
 account = Nanook.new.wallet(wallet_id).account(account_id)
 
 account.balance
 account.balance(unit: :raw)
 account.pay(to: recipient_account_id, amount: 2, id: unique_id)
-account.pay(to: recipient_account_id, amount: 2, unit: :raw, id: unique_id)
+account.pay(to: recipient_account_id, amount: 2, id: unique_id, unit: :raw)
 account.pending
 account.pending(limit: 1)
 account.pending(detailed: true)
@@ -206,11 +208,14 @@ account.info(unit: :raw)
 account.last_modified_at
 account.ledger
 account.ledger(limit: 10)
+account.ledger(modified_since: Time.now)
+account.ledger(unit: :raw)
 account.history
 account.history(limit: 1)
 account.history(unit: :raw)
 account.public_key
 account.delegators
+account.delegators(unit: :raw)
 account.representative
 account.change_representative(new_representative)
 account.weight
@@ -220,7 +225,7 @@ account.destroy
 
 #### Working with any account (not necessarily in your wallet):
 
-See the [full documentation for Nanook::Account](https://lukes.github.io/nanook/2.0.0/classes/Nanook/Account.html) for a detailed description of each method and example responses.
+See the [full documentation for Nanook::Account](https://lukes.github.io/nanook/2.2.0/Nanook/Account.html) for a detailed description of each method and example responses.
 
 ```ruby
 account = Nanook.new.account(account_id)
@@ -239,18 +244,21 @@ account.info(unit: :raw)
 account.last_modified_at
 account.ledger
 account.ledger(limit: 10)
+account.ledger(modified_since: Time.now)
+account.ledger(unit: :raw)
 account.history
 account.history(limit: 1)
 account.history(unit: :raw)
 account.public_key
 account.delegators
+account.delegators(unit: :raw)
 account.representative
 account.weight
 ```
 
 ### Blocks
 
-See the [full documentation for Nanook::Block](https://lukes.github.io/nanook/2.0.0/classes/Nanook/Block.html) for a detailed description of each method and example responses.
+See the [full documentation for Nanook::Block](https://lukes.github.io/nanook/2.2.0/Nanook/Block.html) for a detailed description of each method and example responses.
 
 ```ruby
 block = Nanook.new.block(block_id)
@@ -277,20 +285,23 @@ block.is_valid_work?(work_id)
 
 ### Managing your nano node
 
+See the [full documentation for Nanook::Node](https://lukes.github.io/nanook/2.2.0/Nanook/Node.html) for a detailed description of each method and example responses.
+
 ```ruby
 node = Nanook.new.node
 
 node.account_count
 node.block_count
-node.block_count_type
+node.block_count_by_type
 node.bootstrap_any
 node.bootstrap(address: "::ffff:138.201.94.249", port: 7075)
 node.peers
 node.representatives
+node.representatives(unit: :raw)
+node.representatives_online
 node.synchronizing_blocks
 node.synchronizing_blocks(limit: 1)
 node.sync_progress
-node.synced?
 node.version
 
 node.stop

data/lib/nanook.rb

@@ -2,7 +2,7 @@ require 'net/http'
 require 'uri'
 require 'forwardable'
 
-Dir[File.dirname(__FILE__) + '/nanook/*.rb'].each {|file| require file }
+Dir[File.dirname(__FILE__) + '/nanook/*.rb'].each { |file| require file }
 
 # ==== Initializing
 #
@@ -42,12 +42,12 @@ class Nanook
   # Returns a new instance of {Nanook}.
   #
   # ==== Examples:
-  # Connecting to http://localhost:7076 with the default timeout of 600s:
+  # Connecting to http://localhost:7076 with the default timeout of 10s:
   #   Nanook.new
   # Setting a custom timeout:
-  #   Nanook.new(timeout: 600)
+  #   Nanook.new(timeout: 10)
   # Connecting to a custom RPC host and setting a timeout:
-  #   Nanook.new("http://ip6-localhost.com:7076", timeout: 600)
+  #   Nanook.new("http://ip6-localhost.com:7076", timeout: 10)
   #
   # @param uri [String] default is {Nanook::Rpc::DEFAULT_URI}. The RPC host to connect to
   # @param timeout [Integer] default is {Nanook::Rpc::DEFAULT_TIMEOUT}. Connection timeout in number of seconds

data/lib/nanook/account.rb

@@ -21,23 +21,43 @@ class Nanook
       @account = account
     end
 
-    # Returns information about this account's delegators.
-    # === Example response:
+    # Information about this accounts that have set this account as their representative.
+    #
+    # === Example:
+    #
+    #   account.delegators
+    #
+    # Example response:
+    #
     #   {
     #     :xrb_13bqhi1cdqq8yb9szneoc38qk899d58i5rcrgdk5mkdm86hekpoez3zxw5sd=>500000000000000000000000000000000000,
     #     :xrb_17k6ug685154an8gri9whhe5kb5z1mf5w6y39gokc1657sh95fegm8ht1zpn=>961647970820730000000000000000000000
     #   }
     #
-    # @return [Hash{Symbol=>String}] Delegators
-    def delegators
-      rpc(:delegators)[:delegators]
+    # @param unit (see #balance)
+    # @return [Hash{Symbol=>Integer}] account ids which delegate to this account, and their account balance
+    def delegators(unit: Nanook.default_unit)
+      unless Nanook::UNITS.include?(unit)
+        raise ArgumentError.new("Unsupported unit: #{unit}")
+      end
+
+      response = rpc(:delegators)[:delegators]
+
+      return response if unit == :raw
+
+      r = response.map do |account_id, balance|
+        balance = Nanook::Util.raw_to_NANO(balance)
+
+        [account_id, balance]
+      end
+
+      Hash[r].to_symbolized_hash
     end
 
-    # Returns a boolean indicating if the account exists.
+    # Returns true if the account has an <i>open</i> block.
     #
-    # Existence is determined by if the account has an _open_ block.
-    # An _open_ block is a special kind of block that gets published when
-    # an account receives a payment for the first time.
+    # An open block gets published when an account receives a payment
+    # for the first time.
     #
     # The reliability of this check depends on the node host having
     # synchronized itself with most of the blocks on the nano network,
@@ -45,40 +65,33 @@ class Nanook
     # You can check if a node's  synchronization is particular low
     # using {Nanook::Node#sync_progress}.
     #
-    # @return [Boolean] Indicates if this account exists in the nano network
+    # ==== Example:
+    #
+    #   account.exists? # => true
+    #   # or
+    #   account.open?   # => true
+    #
+    # @return [Boolean] Indicates if this account has an open block
     def exists?
       response = rpc(:account_info)
       !response.empty? && !response[:open_block].nil?
     end
+    alias_method :open?, :exists?
 
-    # Returns an account's history of send and receive payments.
+    # An account's history of send and receive payments.
     #
     # ==== Example:
     #
     #   account.history
-    #   account.history(limit: 1)
     #
-    # ==== Example response:
-    #   [
-    #     {
-    #      :type=>"send",
-    #      :account=>"xrb_1kdc5u48j3hr5r7eof9iao47szqh81ndqgq5e5hrsn1g9a3sa4hkkcotn3uq",
-    #      :amount=>2,
-    #      :hash=>"2C3C570EA8898443C0FD04A1C385A3E3A8C985AD792635FCDCEBB30ADF6A0570"
-    #     }
-    #   ]
-    # ==== Example:
-    #
-    #   account.history
-    #   account.history(unit: :raw)
+    # Example response:
     #
-    # ==== Example response:
     #   [
     #     {
-    #      :type=>"send",
-    #      :account=>"xrb_1kdc5u48j3hr5r7eof9iao47szqh81ndqgq5e5hrsn1g9a3sa4hkkcotn3uq",
-    #      :amount=>2000000000000000000000000000000,
-    #      :hash=>"2C3C570EA8898443C0FD04A1C385A3E3A8C985AD792635FCDCEBB30ADF6A0570"
+    #      type: "send",
+    #      account: "xrb_1kdc5u48j3hr5r7eof9iao47szqh81ndqgq5e5hrsn1g9a3sa4hkkcotn3uq",
+    #      amount: 2,
+    #      hash: "2C3C570EA8898443C0FD04A1C385A3E3A8C985AD792635FCDCEBB30ADF6A0570"
     #     }
     #   ]
     #
@@ -102,65 +115,78 @@ class Nanook
       end
     end
 
-    # @return [Time] last modified time of the account in UTC time zone.
+    # The last modified time of the account in the time zone of
+    # your nano node (usually UTC).
+    #
+    # ==== Example:
+    #
+    #   account.last_modified_at # => Time
+    #
+    # @return [Time] last modified time of the account in the time zone of
+    #   your nano node (usually UTC).
     def last_modified_at
       response = rpc(:account_info)
       Time.at(response[:modified_timestamp])
     end
 
-    # Returns the public key belonging to an account.
+    # The public key of the account.
     #
-    # ==== Example response:
-    #   "3068BB1CA04525BB0E416C485FE6A67FD52540227D267CC8B6E8DA958A7FA039"
+    # ==== Example:
+    #
+    #   account.public_key # => "3068BB1..."
     #
-    # @return [String] public key of this account
+    # @return [String] public key of the account
     def public_key
       rpc(:account_key)[:key]
     end
 
-    # Returns the representative account for the account.
+    # The representative account id for the account.
     # Representatives are accounts which cast votes in the case of a
     # fork in the network.
     #
-    # ==== Example response
+    # ==== Example:
     #
-    #   "xrb_3pczxuorp48td8645bs3m6c3xotxd3idskrenmi65rbrga5zmkemzhwkaznh"
+    #   account.representative # => "xrb_3pc..."
     #
-    # @return [String] Representative account of this account
+    # @return [String] Representative account of the account
     def representative
       rpc(:account_representative)[:representative]
     end
 
-    # Returns a Hash containing the account's balance.
+    # The account's balance, including pending (unreceived payments).
+    # To receive a pending amount see {WalletAccount#receive}.
     #
-    # ==== Example:
+    # ==== Examples:
     #
     #   account.balance
     #
-    #   # =>
-    #   # {
-    #   #   balance=>2,   # Account balance
-    #   #   pending=>1.1  # Amount pending and not yet received by the account
-    #   # }
+    # Example response:
     #
-    # ==== Example balance returned in raw:
+    #   {
+    #     balance: 2,
+    #     pending: 1.1
+    #   }
+    #
+    # Asking for the balance to be returned in raw instead of NANO:
     #
     #   account.balance(unit: :raw)
     #
-    #   # =>
-    #   # {
-    #   #   balance: 2000000000000000000000000000000,
-    #   #   pending: 1100000000000000000000000000000
-    #   # }
+    # Example response:
+    #
+    #   {
+    #     balance: 2000000000000000000000000000000,
+    #     pending: 1100000000000000000000000000000
+    #   }
     #
     # @param unit [Symbol] default is {Nanook.default_unit}.
     #   Must be one of {Nanook::UNITS}.
     #   Represents the unit that the balances will be returned in.
     #   Note: this method interprets
-    #   +:nano+ as NANO, which is technically Mnano
+    #   +:nano+ as NANO, which is technically Mnano.
     #   See {https://nano.org/en/faq#what-are-nano-units- What are Nano's Units}
     #
     # @raise ArgumentError if an invalid +unit+ was given.
+    # @return [Hash{Symbol=>Integer|Float}]
     def balance(unit: Nanook.default_unit)
       unless Nanook::UNITS.include?(unit)
         raise ArgumentError.new("Unsupported unit: #{unit}")
@@ -174,57 +200,69 @@ class Nanook
       end
     end
 
-    # Returns the id of the account.
+    # @return [Integer] number of blocks for this account
+    def block_count
+      rpc(:account_block_count)[:block_count]
+    end
+
+    # The id of the account.
+    #
+    # ==== Example:
+    #
+    #   account.id # => "xrb_16u..."
+    #
     # @return [String] the id of the account
     def id
       @account
     end
 
-    # Returns a Hash containing information about the account.
+    # Information about the account.
     #
-    # ==== Example 1
+    # ==== Examples:
     #
     #   account.info
     #
-    # ==== Example 1 response
+    # Example response:
+    #
     #   {
-    #     :id=>"xrb_16u1uufyoig8777y6r8iqjtrw8sg8maqrm36zzcm95jmbd9i9aj5i8abr8u5"
-    #     :balance=>11.439597000000001,
-    #     :block_count=>4
-    #     :frontier=>"2C3C570EA8898443C0FD04A1C385A3E3A8C985AD792635FCDCEBB30ADF6A0570",
-    #     :modified_timestamp=>1520500357,
-    #     :open_block=>"C82376314C387080A753871A32AD70F4168080C317C5E67356F0A62EB5F34FF9",
-    #     :representative_block=>"C82376314C387080A753871A32AD70F4168080C317C5E67356F0A62EB5F34FF9",
+    #     id: "xrb_16u1uufyoig8777y6r8iqjtrw8sg8maqrm36zzcm95jmbd9i9aj5i8abr8u5",
+    #     balance: 11.439597000000001,
+    #     block_count: 4,
+    #     frontier: "2C3C570EA8898443C0FD04A1C385A3E3A8C985AD792635FCDCEBB30ADF6A0570",
+    #     modified_timestamp: 1520500357,
+    #     open_block: "C82376314C387080A753871A32AD70F4168080C317C5E67356F0A62EB5F34FF9",
+    #     representative_block: "C82376314C387080A753871A32AD70F4168080C317C5E67356F0A62EB5F34FF9"
     #   }
     #
-    # ==== Example 2
+    # Asking for more detail to be returned:
     #
     #   account.info(detailed: true)
     #
-    # ==== Example 2 response
+    # Example response:
+    #
     #   {
-    #     :id=>"xrb_16u1uufyoig8777y6r8iqjtrw8sg8maqrm36zzcm95jmbd9i9aj5i8abr8u5"
-    #     :balance=>11.439597000000001,
-    #     :block_count=>4,
-    #     :frontier=>"2C3C570EA8898443C0FD04A1C385A3E3A8C985AD792635FCDCEBB30ADF6A0570",
-    #     :modified_timestamp=>1520500357,
-    #     :open_block=>"C82376314C387080A753871A32AD70F4168080C317C5E67356F0A62EB5F34FF9",
-    #     :pending=>0,
-    #     :public_key=>"A82C906460046D230D7D37C6663723DC3EFCECC4B3254EBF45294B66746F4FEF",
-    #     :representative=>"xrb_3pczxuorp48td8645bs3m6c3xotxd3idskrenmi65rbrga5zmkemzhwkaznh",
-    #     :representative_block=>"C82376314C387080A753871A32AD70F4168080C317C5E67356F0A62EB5F34FF9",
-    #     :weight=>0
+    #     id: "xrb_16u1uufyoig8777y6r8iqjtrw8sg8maqrm36zzcm95jmbd9i9aj5i8abr8u5",
+    #     balance: 11.439597000000001,
+    #     block_count: 4,
+    #     frontier: "2C3C570EA8898443C0FD04A1C385A3E3A8C985AD792635FCDCEBB30ADF6A0570",
+    #     modified_timestamp: 1520500357,
+    #     open_block: "C82376314C387080A753871A32AD70F4168080C317C5E67356F0A62EB5F34FF9",
+    #     pending: 0,
+    #     public_key: "A82C906460046D230D7D37C6663723DC3EFCECC4B3254EBF45294B66746F4FEF",
+    #     representative: "xrb_3pczxuorp48td8645bs3m6c3xotxd3idskrenmi65rbrga5zmkemzhwkaznh",
+    #     representative_block: "C82376314C387080A753871A32AD70F4168080C317C5E67356F0A62EB5F34FF9",
+    #     weight: 0
     #   }
     #
     # @param detailed [Boolean] (default is false). When +true+, four
     #   additional calls are made to the RPC to return more information
     # @param unit (see #balance)
-    # @return [Hash] information about the account containing:
-    #   [+id] The account id
+    # @return [Hash{Symbol=>String|Integer|Float}] information about the account containing:
+    #   [+id+] The account id
     #   [+frontier+] The latest block hash
     #   [+open_block+] The first block in every account's blockchain. When this block was published the account was officially open
     #   [+representative_block+] The block that named the representative for the account
-    #   [+balance+] Amount in {NANO}[https://nano.org/en/faq#what-are-nano-units-]
+    #   [+balance+] Amount in either NANO or raw (depending on the <tt>unit:</tt> argument)
     #   [+last_modified+] Unix timestamp
     #   [+block_count+] Number of blocks in the account's blockchain
     #
@@ -267,22 +305,16 @@ class Nanook
       "#{self.class.name}(id: \"#{id}\", object_id: \"#{"0x00%x" % (object_id << 1)}\")"
     end
 
-    # Returns information about the given account as well as other
+    # Information about the given account as well as other
     # accounts up the ledger. The number of accounts returned is determined
     # by the <tt>limit:</tt> argument.
     #
-    # The information in each Hash is the same as what the
-    # #info(detailed: false) method returns.
-    #
-    # ==== Arguments
-    #
-    # [+limit:+] Number of accounts to return in the ledger (default is 1)
-    #
-    # ==== Example
+    # ==== Example:
     #
     #   account.ledger(limit: 2)
     #
-    # ==== Example response
+    # Example response:
+    #
     #   {
     #    :xrb_3c3ek3k8135f6e8qtfy8eruk9q3yzmpebes7btzncccdest8ymzhjmnr196j=>{
     #      :frontier=>"2C3C570EA8898443C0FD04A1C385A3E3A8C985AD792635FCDCEBB30ADF6A0570",
@@ -294,40 +326,65 @@ class Nanook
     #    },
     #    :xrb_3c3ettq59kijuuad5fnaq35itc9schtr4r7r6rjhmwjbairowzq3wi5ap7h8=>{ ... }
     #  }
-    def ledger(limit: 1)
-      rpc(:ledger, count: limit)[:accounts]
+    #
+    # @param [Integer] limit number of accounts to return in the ledger (default is 1)
+    # @param [Time] modified_since return only accounts modified in the local database after this time
+    # @param unit (see #balance)
+    # @return [Hash{Symbol=>String|Integer}]
+    def ledger(limit: 1, modified_since:nil, unit: Nanook.default_unit)
+      unless Nanook::UNITS.include?(unit)
+        raise ArgumentError.new("Unsupported unit: #{unit}")
+      end
+
+      params = { count: limit }
+
+      unless modified_since.nil?
+        params[:modified_since] = modified_since.to_i
+      end
+
+      response = rpc(:ledger, params)[:accounts]
+
+      return response if unit == :raw
+
+      r = response.map do |account_id, l|
+        l[:balance] = Nanook::Util.raw_to_NANO(l[:balance])
+
+        [account_id, l]
+      end
+
+      Hash[r].to_symbolized_hash
     end
 
-    # Returns information about pending blocks (payments) that are
+    # Information about pending blocks (payments) that are
     # waiting to be received by the account.
     #
-    # See also the #receive method of this class for how to receive a pending payment.
+    # See also the {Nanook::WalletAccount#receive} method for how to
+    # receive a pending payment.
     #
     # The default response is an Array of block ids.
     #
     # With the +detailed:+ argument, the method returns an Array of Hashes,
     # which contain the source account id, amount pending and block id.
     #
-    # ==== Example 1:
+    # ==== Examples:
     #
-    #   account.pending # => ["000D1BAEC8EC208142C99059B393051BAC8380F9B5A2E6B2489A277D81789F3F"]
+    #   account.pending # => ["000D1BA..."]
     #
-    # ==== Example 2:
+    # Asking for more detail to be returned:
     #
     #   account.pending(detailed: true)
-    #   # =>
-    #   # [
-    #   #   {
-    #   #     :block=>"000D1BAEC8EC208142C99059B393051BAC8380F9B5A2E6B2489A277D81789F3F",
-    #   #     :amount=>6,
-    #   #     :source=>"xrb_3dcfozsmekr1tr9skf1oa5wbgmxt81qepfdnt7zicq5x3hk65fg4fqj58mbr"
-    #   #   },
-    #   #   { ... }
-    #   # ]
-    #
-    # ==== Example 3:
-    #
-    #   account.pending(detailed: true, unit: raw).first[:amount] # => 6000000000000000000000000000000
+    #
+    # Example response:
+    #
+    #   [
+    #     {
+    #       block: "000D1BAEC8EC208142C99059B393051BAC8380F9B5A2E6B2489A277D81789F3F",
+    #       amount: 6,
+    #       source: "xrb_3dcfozsmekr1tr9skf1oa5wbgmxt81qepfdnt7zicq5x3hk65fg4fqj58mbr"
+    #     },
+    #     { ... }
+    #   ]
+    #
     # @param limit [Integer] number of pending blocks to return (default is 1000)
     # @param detailed [Boolean]return a more complex Hash of pending block information (default is +false+)
     # @param unit (see #balance)
@@ -358,13 +415,14 @@ class Nanook
       end
     end
 
-    # Returns the account's weight.
+    # The account's weight.
     #
     # Weight is determined by the account's balance, and represents
     # the voting weight that account has on the network. Only accounts
     # with greater than 256 weight can vote.
     #
     # ==== Example:
+    #
     #   account.weight # => 0
     #
     # @return [Integer] the account's weight