nanook 0.7.0 → 1.0.0

data/docs/js/searcher.js

@@ -0,0 +1,229 @@
+Searcher = function(data) {
+  this.data = data;
+  this.handlers = [];
+}
+
+Searcher.prototype = new function() {
+  // search is performed in chunks of 1000 for non-blocking user input
+  var CHUNK_SIZE = 1000;
+  // do not try to find more than 100 results
+  var MAX_RESULTS = 100;
+  var huid = 1;
+  var suid = 1;
+  var runs = 0;
+
+  this.find = function(query) {
+    var queries = splitQuery(query);
+    var regexps = buildRegexps(queries);
+    var highlighters = buildHilighters(queries);
+    var state = { from: 0, pass: 0, limit: MAX_RESULTS, n: suid++};
+    var _this = this;
+
+    this.currentSuid = state.n;
+
+    if (!query) return;
+
+    var run = function() {
+      // stop current search thread if new search started
+      if (state.n != _this.currentSuid) return;
+
+      var results =
+        performSearch(_this.data, regexps, queries, highlighters, state);
+      var hasMore = (state.limit > 0 && state.pass < 4);
+
+      triggerResults.call(_this, results, !hasMore);
+      if (hasMore) {
+        setTimeout(run, 2);
+      }
+      runs++;
+    };
+    runs = 0;
+
+    // start search thread
+    run();
+  }
+
+  /*  ----- Events ------  */
+  this.ready = function(fn) {
+    fn.huid = huid;
+    this.handlers.push(fn);
+  }
+
+  /*  ----- Utilities ------  */
+  function splitQuery(query) {
+    return jQuery.grep(query.split(/(\s+|::?|\(\)?)/), function(string) {
+      return string.match(/\S/);
+    });
+  }
+
+  function buildRegexps(queries) {
+    return jQuery.map(queries, function(query) {
+      return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i');
+    });
+  }
+
+  function buildHilighters(queries) {
+    return jQuery.map(queries, function(query) {
+      return jQuery.map(query.split(''), function(l, i) {
+        return '\u0001$' + (i*2+1) + '\u0002$' + (i*2+2);
+      }).join('');
+    });
+  }
+
+  // function longMatchRegexp(index, longIndex, regexps) {
+  //     for (var i = regexps.length - 1; i >= 0; i--){
+  //         if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) return false;
+  //     };
+  //     return true;
+  // }
+
+
+  /*  ----- Mathchers ------  */
+
+  /*
+   * This record matches if the index starts with queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassBeginning(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the longIndex starts with queries[0] and the
+   * longIndex matches all of the regexps
+   */
+  function matchPassLongIndex(index, longIndex, queries, regexps) {
+    if (longIndex.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the index contains queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassContains(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) == -1) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if regexps[0] matches the index and the record
+   * matches all of the regexps
+   */
+  function matchPassRegexp(index, longIndex, queries, regexps) {
+    if (!index.match(regexps[0])) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+
+  /*  ----- Highlighters ------  */
+  function highlightRegexp(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    for (var i=0, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function hltSubstring(string, pos, length) {
+    return string.substring(0, pos) + '\u0001' + string.substring(pos, pos + length) + '\u0002' + string.substring(pos + length);
+  }
+
+  function highlightQuery(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    var pos = 0;
+    var lcTitle = result.title.toLowerCase();
+
+    pos = lcTitle.indexOf(queries[0]);
+    if (pos != -1) {
+      result.title = hltSubstring(result.title, pos, queries[0].length);
+    }
+
+    result.namespace = result.namespace.replace(regexps[0], highlighters[0]);
+    for (var i=1, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function createResult(info) {
+    var result = {};
+    result.title = info[0];
+    result.namespace = info[1];
+    result.path = info[2];
+    result.params = info[3];
+    result.snippet = info[4];
+    result.badge = info[6];
+    return result;
+  }
+
+  /*  ----- Searching ------  */
+  function performSearch(data, regexps, queries, highlighters, state) {
+    var searchIndex = data.searchIndex;
+    var longSearchIndex = data.longSearchIndex;
+    var info = data.info;
+    var result = [];
+    var i = state.from;
+    var l = searchIndex.length;
+    var togo = CHUNK_SIZE;
+    var matchFunc, hltFunc;
+
+    while (state.pass < 4 && state.limit > 0 && togo > 0) {
+      if (state.pass == 0) {
+        matchFunc = matchPassBeginning;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 1) {
+        matchFunc = matchPassLongIndex;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 2) {
+        matchFunc = matchPassContains;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 3) {
+        matchFunc = matchPassRegexp;
+        hltFunc = highlightRegexp;
+      }
+
+      for (; togo > 0 && i < l && state.limit > 0; i++, togo--) {
+        if (info[i].n == state.n) continue;
+        if (matchFunc(searchIndex[i], longSearchIndex[i], queries, regexps)) {
+          info[i].n = state.n;
+          result.push(hltFunc(info[i], queries, regexps, highlighters));
+          state.limit--;
+        }
+      };
+      if (searchIndex.length <= i) {
+        state.pass++;
+        i = state.from = 0;
+      } else {
+        state.from = i;
+      }
+    }
+    return result;
+  }
+
+  function triggerResults(results, isLast) {
+    jQuery.each(this.handlers, function(i, fn) {
+      fn.call(this, results, isLast)
+    })
+  }
+}
+

data/docs/panel/index.html

@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <title>search index</title>
+  <link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="../css/panel.css" type="text/css" media="screen" charset="utf-8" />
+  <script src="../js/search_index.js" type="text/javascript" charset="utf-8"></script>
+  <script src="../js/searcher.js" type="text/javascript" charset="utf-8"></script>
+  <script src="tree.js" type="text/javascript" charset="utf-8"></script>
+  <script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
+  <script src="../js/searchdoc.js" type="text/javascript" charset="utf-8"></script>
+  <script type="text/javascript" charset="utf-8">
+  $(function() {
+    $('#links').hide();
+    var panel = new Searchdoc.Panel($('#panel'), search_data, tree, top.frames[1]);
+    $('#search').focus();
+
+    var s = window.parent.location.search.match(/\?q=([^&]+)/);
+    if (s) {
+      s = decodeURIComponent(s[1]).replace(/\+/g, ' ');
+      if (s.length > 0) {
+        $('#search').val(s);
+        panel.search(s, true);
+      }
+    }
+  })
+  </script>
+</head>
+
+<body>
+  <div class="panel panel_tree" id="panel">
+    <div class="header">
+      <input type="text" placeholder="Search for a class, method, ..." autosave="searchdoc" results="10" id="search" autocomplete="off" />
+    </div>
+    <div class="tree">
+      <ul>
+      </ul>
+    </div>
+    <div class="result">
+      <ul>
+      </ul>
+    </div>
+  </div>
+  <a href="links.html" id="links">index</a>
+</body>
+
+</html>

data/docs/panel/links.html

@@ -0,0 +1,32 @@
+<html>
+    <head>File index</head>
+    <body>
+    
+      <a href="../files/README_md.html">README.md</a>
+    
+      <a href="../files/lib/nanook_rb.html">lib/nanook.rb</a>
+    
+      <a href="../files/lib/nanook/account_rb.html">lib/nanook/account.rb</a>
+    
+      <a href="../files/lib/nanook/block_rb.html">lib/nanook/block.rb</a>
+    
+      <a href="../files/lib/nanook/error_rb.html">lib/nanook/error.rb</a>
+    
+      <a href="../files/lib/nanook/key_rb.html">lib/nanook/key.rb</a>
+    
+      <a href="../files/lib/nanook/node_rb.html">lib/nanook/node.rb</a>
+    
+      <a href="../files/lib/nanook/rpc_rb.html">lib/nanook/rpc.rb</a>
+    
+      <a href="../files/lib/nanook/util_rb.html">lib/nanook/util.rb</a>
+    
+      <a href="../files/lib/nanook/version_rb.html">lib/nanook/version.rb</a>
+    
+      <a href="../files/lib/nanook/wallet_rb.html">lib/nanook/wallet.rb</a>
+    
+      <a href="../files/lib/nanook/wallet_account_rb.html">lib/nanook/wallet_account.rb</a>
+    
+      <a href="../files/lib/nanook/work_peer_rb.html">lib/nanook/work_peer.rb</a>
+    
+    </body>
+</html>

data/docs/panel/tree.js

@@ -0,0 +1 @@
+var tree = [["","","files",[["README.md","files/README_md.html","",[]],["","","lib",[["","","nanook",[["account.rb","files/lib/nanook/account_rb.html","",[]],["block.rb","files/lib/nanook/block_rb.html","",[]],["error.rb","files/lib/nanook/error_rb.html","",[]],["key.rb","files/lib/nanook/key_rb.html","",[]],["node.rb","files/lib/nanook/node_rb.html","",[]],["rpc.rb","files/lib/nanook/rpc_rb.html","",[]],["util.rb","files/lib/nanook/util_rb.html","",[]],["version.rb","files/lib/nanook/version_rb.html","",[]],["wallet.rb","files/lib/nanook/wallet_rb.html","",[]],["wallet_account.rb","files/lib/nanook/wallet_account_rb.html","",[]],["work_peer.rb","files/lib/nanook/work_peer_rb.html","",[]]]],["nanook.rb","files/lib/nanook_rb.html","",[]]]]]],["Nanook","classes/Nanook.html"," < Object",[["Account","classes/Nanook/Account.html"," < Object",[]],["Block","classes/Nanook/Block.html"," < Object",[]],["Error","classes/Nanook/Error.html"," < StandardError",[]],["Key","classes/Nanook/Key.html"," < Object",[]],["Node","classes/Nanook/Node.html"," < Object",[]],["Rpc","classes/Nanook/Rpc.html"," < Object",[]],["Util","classes/Nanook/Util.html"," < Object",[]],["Wallet","classes/Nanook/Wallet.html"," < Object",[]],["WalletAccount","classes/Nanook/WalletAccount.html"," < Object",[]],["WorkPeer","classes/Nanook/WorkPeer.html"," < Object",[]]]]]

data/lib/nanook.rb

@@ -3,22 +3,58 @@ require 'uri'
 
 Dir[File.dirname(__FILE__) + '/nanook/*.rb'].each {|file| require file }
 
+# ==== Initializing
+#
+# Connect to the default RPC host at http://localhost:7076 and with a timeout of 500 seconds:
+#
+#    nanook = Nanook.new
+#
+# To connect to another host instead:
+#
+#   nanook = Nanook.new("http://ip6-localhost.com:7076")
+#
+# To give a specific timeout value:
+#
+#   Nanook.new(timeout: 600)
+#   Nanook.new("http://ip6-localhost.com:7076", timeout: 600)
 class Nanook
 
+  # ==== Arguments
+  #
+  # * +uri+ - RPC host to connect to (default is "http://localhost:7076")
+  # * +timeout:+ - Connection timeout in number of seconds (default is 500)
+  #
+  # ==== Examples
+  #
+  #   Nanook.new # Connect to http://localhost:7076 with 500s timeout
+  #
+  #   Nanook.new(timeout: 600)
+  #   Nanook.new("http://ip6-localhost.com:7076", timeout: 600)
   def initialize(uri=Nanook::Rpc::DEFAULT_URI, timeout:Nanook::Rpc::DEFAULT_TIMEOUT)
     @rpc = Nanook::Rpc.new(uri, timeout: timeout)
   end
 
+  ##
+  # Returns a Nanook::Account instance.
+  #
+  #   nanook = Nanook.new
+  #
+  #   account = nanook.account
+  #   account = nanook.account("xrb_3e3j5tkog48pnny9dmfzj1r16pg8t1e76dz5tmac6iq689wyjfpi00000000")
   def account(account=nil)
-    Nanook::Account.new(account, @rpc)
+    Nanook::Account.new(@rpc, account)
   end
 
   def block(block=nil)
-    Nanook::Block.new(block, @rpc)
+    Nanook::Block.new(@rpc, block)
+  end
+
+  def inspect # :nodoc
+    "#{self.class.name}(rpc: #{@rpc.inspect}, object_id: \"#{"0x00%x" % (object_id << 1)}\")"
   end
 
   def key(key=nil)
-    Nanook::Key.new(key, @rpc)
+    Nanook::Key.new(@rpc, key)
   end
 
   def node
@@ -26,7 +62,7 @@ class Nanook
   end
 
   def wallet(wallet=nil)
-    Nanook::Wallet.new(wallet, @rpc)
+    Nanook::Wallet.new(@rpc, wallet)
   end
 
   def work_peers

data/lib/nanook/account.rb

@@ -1,54 +1,290 @@
 class Nanook
+
+  # The <tt>Nanook::Account</tt> class contains methods to discover
+  # publicly-available information about accounts on the nano network.
+  #
+  # === Initializing
+  #
+  # Initialize this class through the convenient Nanook#account method:
+  #
+  #   nanook = Nanook.new
+  #   account = nanook.account("xrb_...")
+  #
+  # Or compose the longhand way like this:
+  #
+  #   rpc_conn = Nanook::Rpc.new
+  #   account = Nanook::Account.new(rpc_conn, "xrb_...")
   class Account
 
-    def initialize(account, rpc)
-      @account = account
+    def initialize(rpc, account)
       @rpc = rpc
+      @account = account
     end
 
+    # ==== Example response
+    #   {
+    #     "xrb_13bqhi1cdqq8yb9szneoc38qk899d58i5rcrgdk5mkdm86hekpoez3zxw5sd": "500000000000000000000000000000000000",
+    #     "xrb_17k6ug685154an8gri9whhe5kb5z1mf5w6y39gokc1657sh95fegm8ht1zpn": "961647970820730000000000000000000000"
+    #   }
     def delegators
       account_required!
       rpc(:delegators)[:delegators]
     end
 
+    # Returns a boolean indicating if account is known. Note, the
+    # reliability of the check depends on the node host having
+    # synchronized itself with most of the blocks on the nano network,
+    # otherwise you may get a false +false+. You can check if a node's
+    # synchronization is particular low using Nanook::Node#sync_progress.
+    #
+    # ==== Example response
+    #   true
     def exists?
       account_required!
       response = rpc(:validate_account_number)
       !response.empty? && response[:valid] == 1
     end
 
+    # Returns an account's history of send and receive payments.
+    # Amounts are in {raw}[https://nano.org/en/faq#what-are-nano-units-].
+    #
+    # ==== Arguments
+    #
+    # [+limit:+] Integer representing the maximum number of history
+    #            items to return (default is 1000)
+    #
+    # ==== Example
+    #
+    #   account.history
+    #   account.history(limit: 1)
+    #
+    # ==== Example response
+    #   [
+    #     {
+    #      :type=>"send",
+    #      :account=>"xrb_1kdc5u48j3hr5r7eof9iao47szqh81ndqgq5e5hrsn1g9a3sa4hkkcotn3uq",
+    #      :amount=>200000000000000000000000000000,
+    #      :hash=>"2C3C570EA8898443C0FD04A1C385A3E3A8C985AD792635FCDCEBB30ADF6A0570"
+    #     },
+    #     {
+    #      :type=>"receive",
+    #      :account=>"xrb_1niabkx3gbxit5j5yyqcpas71dkffggbr6zpd3heui8rpoocm5xqbdwq44oh",
+    #      :amount=>7836413000000000000000000000000,
+    #      :hash=>"16743E8FF52F454E876E68EDD11F23094DCB96795A3B7F32F74F88563ACDDB04"
+    #     }
+    #   ]
     def history(limit: 1000)
       account_required!
       rpc(:account_history, count: limit)[:history]
     end
 
+    # Returns the public key belonging to an account.
+    #
+    # ==== Example response
+    #   "3068BB1CA04525BB0E416C485FE6A67FD52540227D267CC8B6E8DA958A7FA039"
     def public_key
       account_required!
       rpc(:account_key)[:key]
     end
 
+    # Returns a String of the representative account for the account.
+    # Representatives are accounts which cast votes in the case of a
+    # fork in the network.
+    #
+    # ==== Example response
+    #
+    #   "xrb_3pczxuorp48td8645bs3m6c3xotxd3idskrenmi65rbrga5zmkemzhwkaznh"
     def representative
       account_required!
       rpc(:account_representative)[:representative]
     end
 
-    def balance
+    # Returns a Hash containing the account's balance. Units are in
+    # {raw}[https://nano.org/en/faq#what-are-nano-units-].
+    #
+    # [+:balance+] Account balance
+    # [+:pending+] Amount pending and not yet received by the account
+    #
+    # ==== Arguments
+    #
+    # [+unit:+]   Symbol (default is +:nano+) Represents the unit that
+    #             the balances will be returned in.
+    #             Must be either +:nano+ or +:raw+. (Note: this method
+    #             interprets +:nano+ as NANO, which is technically Mnano
+    #             See {What are Nano's Units}[https://nano.org/en/faq#what-are-nano-units-])
+    #
+    # ===== Example response
+    #   {
+    #    "balance": "2",
+    #    "pending": "1"
+    #   }
+    def balance(unit: Nanook::WalletAccount::DEFAULT_UNIT)
       account_required!
-      rpc(:account_balance)
+
+      unless Nanook::WalletAccount::UNITS.include?(unit)
+        raise ArgumentError.new("Unsupported unit: #{unit}")
+      end
+
+      rpc(:account_balance).tap do |r|
+        if unit == :nano
+          r[:balance] = Nanook::Util.raw_to_NANO(r[:balance])
+          r[:pending] = Nanook::Util.raw_to_NANO(r[:pending])
+        end
+      end
+    end
+
+    def id
+      @block
     end
 
-    def info
+    # Returns a Hash containing the following information about an
+    # account:
+    #
+    # [+: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-]
+    # [+:last_modified+] Unix timestamp
+    # [+:block_count+] Number of blocks in the account's blockchain
+    #
+    # When <tt>detailed: true</tt> is passed as an argument, this method
+    # makes four additional calls to the RPC to return more information
+    # about an account:
+    #
+    # [+:weight+] See #weight
+    # [+:pending+] See #balance
+    # [+:representative+] See #representative
+    # [+:public_key+] See #public_key
+    #
+    # ==== Arguments
+    #
+    # [+detailed:+] Boolean (default is false). When +true+, four
+    #               additional calls are made to the RPC to return more
+    #               information
+    #
+    # ==== Example 1
+    #
+    #   account.info
+    #
+    # ==== Example 1 response
+    #   {
+    #     :balance=>11.439597000000001,
+    #     :block_count=>4
+    #     :frontier=>"2C3C570EA8898443C0FD04A1C385A3E3A8C985AD792635FCDCEBB30ADF6A0570",
+    #     :modified_timestamp=>1520500357,
+    #     :open_block=>"C82376314C387080A753871A32AD70F4168080C317C5E67356F0A62EB5F34FF9",
+    #     :representative_block=>"C82376314C387080A753871A32AD70F4168080C317C5E67356F0A62EB5F34FF9",
+    #   }
+    #
+    # ==== Example 2
+    #
+    #   account.info(detailed: true)
+    #
+    # ==== Example 2 response
+    #   {
+    #     :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
+    #   }
+    def info(detailed: false)
       account_required!
-      rpc(:account_info)
+
+      response = rpc(:account_info)
+
+      # Return the response if we don't need any more info
+      return response unless detailed
+
+      # Otherwise make additional calls
+      response = response.merge({
+        weight: weight,
+        pending: balance[:pending],
+        representative: representative,
+        public_key: public_key
+      })
+
+      # Sort this new hash by keys
+      Hash[response.sort].to_symbolized_hash
+    end
+
+    def inspect # :nodoc:
+      "#{self.class.name}(id: \"#{id}\", object_id: \"#{"0x00%x" % (object_id << 1)}\")"
     end
 
+    # Returns 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
+    #
+    #   ledger(limit: 2)
+    #
+    # ==== Example response
+    #   {
+    #    :xrb_3c3ek3k8135f6e8qtfy8eruk9q3yzmpebes7btzncccdest8ymzhjmnr196j=>{
+    #      :frontier=>"2C3C570EA8898443C0FD04A1C385A3E3A8C985AD792635FCDCEBB30ADF6A0570",
+    #      :open_block=>"C82376314C387080A753871A32AD70F4168080C317C5E67356F0A62EB5F34FF9",
+    #      :representative_block=>"C82376314C387080A753871A32AD70F4168080C317C5E67356F0A62EB5F34FF9",
+    #      :balance=>11439597000000000000000000000000,
+    #      :modified_timestamp=>1520500357,
+    #      :block_count=>4
+    #    },
+    #    :xrb_3c3ettq59kijuuad5fnaq35itc9schtr4r7r6rjhmwjbairowzq3wi5ap7h8=>{ ... }
+    #  }
     def ledger(limit: 1)
       account_required!
       rpc(:ledger, count: limit)[:accounts]
     end
 
-    # Returns Array of block hashes
-    # Or, with detailed: true, returns Hashes
+
+    # Returns information about pending block hashes that are waiting to
+    # be received by the account.
+    #
+    # The default response is an Array of block hashes.
+    # With the +detailed:+ argument, the method can return a more
+    # complex Hash containing the amount in
+    # {raw}[https://nano.org/en/faq#what-are-nano-units-] of the pending
+    # block and the source account that sent it.
+    #
+    # ==== Arguments
+    #
+    # [+limit:+] Number of pending blocks to return (default is 1000)
+    # [+detailed:+] Boolean to have this method return a more complex
+    #               Hash of pending block information (default is +false+)
+    #
+    # ==== Example 1
+    #
+    #   pending
+    #
+    # ==== Example 1 response
+    #
+    #   ["000D1BAEC8EC208142C99059B393051BAC8380F9B5A2E6B2489A277D81789F3F"]
+    #
+    # ==== Example 2
+    #
+    #   pending(detailed: true)
+    #
+    # ==== Example 2 response
+    #
+    #   {
+    #     "000D1BAEC8EC208142C99059B393051BAC8380F9B5A2E6B2489A277D81789F3F"=>{
+    #      "amount"=>"6000000000000000000000000000000",
+    #      "source"=>"xrb_3dcfozsmekr1tr9skf1oa5wbgmxt81qepfdnt7zicq5x3hk65fg4fqj58mbr"
+    #     }
+    #   }
     def pending(limit: 1000, detailed: false)
       account_required!
 
@@ -59,6 +295,12 @@ class Nanook
       Nanook::Util.coerce_empty_string_to_type(response, (detailed ? Hash : Array))
     end
 
+    # Returns the account's weight. Weight is determined by the
+    # account's balance, and represents the voting weight that account
+    # has on the network if it is a representative.
+    #
+    # ==== Example response
+    #   1
     def weight
       account_required!
       rpc(:account_weight)[:weight]