nanook 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 632d341b2aa122d7c5049077fbebf1fd67097abb9bc0a4814ae938d2a5d70356
-  data.tar.gz: 9e640aadc4074e46b95e2ceafff4a67808aeca2f181dd95d530fb1d52fb5be30
+  metadata.gz: 7431dc051a61aef23d118372d17df3c833e0963f05279a246c60b65eea10d478
+  data.tar.gz: cadd03df615dca28120483b30720215d15f357ac3afa57dcf226938a17ca45af
 SHA512:
-  metadata.gz: a697f30061015b19d30075698e7d08fb4c868d886abfb8c420367e929dbf94b800b49f735785f1c6a72cda9ae8287704a90532b553c37c1ac0e8130118197b53
-  data.tar.gz: 79ecfa816e0c6d2b7b2c671ac99a28bc8840dfff71a5c6e5608a5700a80c3dcf18632141b91d76d9d31219cb111395d220bb05b9ca744513415238cc6003ab1a
+  metadata.gz: c6249a2d0e98a38d38058c11f50a6b3677d014e35600792d3c18609532f7b97399320d004523eb730863f4bc9bbdab378e3349122e16caa66c394b717be73442
+  data.tar.gz: ba7494dc21db212d20dae2d7a436c5a0766675a76086fa35e9cbc0a98fac4249f451e99f145f8033f77bd1a3966d319a4d3d4d83f2eaf9d9793281100b2875d3

data/CHANGELOG.md

@@ -4,6 +4,23 @@ 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.5.0
+
+### Added
+
+- New `Nanook::Node#bootstrap_lazy` method.
+- New `Nanook::Node#bootstrap_status` method.
+- New `Nanook::Node#difficulty` method.
+- New `Nanook::Node#uptime` method.
+- New `Nanook::Wallet#lock` method.
+
+### Changed
+
+- `Nanook::Node#chain` now takes optional `offset` argument.
+- `Nanook::Node#successors` now takes optional `offset` argument.
+- `Nanook::Node#successors` now aliased as `Nanook::Node#ancestors`
+- Updated docs to use `nano_` prefixed addresses.
+
 ## 2.4.0
 
 ### Added

data/README.md

@@ -1,6 +1,6 @@
 # Nanook
 
-This is a Ruby library for managing a [nano currency](https://nano.org/) node, including making and receiving payments, using the [nano RPC protocol](https://github.com/nanocurrency/raiblocks/wiki/RPC-protocol). Nano is a fee-less, fast, environmentally-friendly cryptocurrency. It's awesome. See [https://nano.org](https://nano.org/).
+This is a Ruby library for managing a [nano currency](https://nano.org/) node, including making and receiving payments, using the [nano RPC protocol](https://developers.nano.org/docs/rpc). Nano is a fee-less, fast, environmentally-friendly cryptocurrency. It's awesome. See [https://nano.org](https://nano.org/).
 
 [![Gem Version](https://badge.fury.io/rb/nanook.svg)](https://badge.fury.io/rb/nanook)
 [![CircleCI](https://circleci.com/gh/lukes/nanook/tree/master.svg?style=shield)](https://circleci.com/gh/lukes/nanook/tree/master)
@@ -76,7 +76,7 @@ wallet = Nanook.new.wallet(wallet_id)
 wallet.pay(from: your_account_id, to: recipient_account_id, amount: 0.2, id: unique_id)
 ```
 
-The `id` can be any string and needs to be unique per payment. It serves an important purpose; it allows you to make this call multiple times with the same `id` and be reassured that you will only ever send that nano payment once. From the [Nano RPC](https://github.com/nanocurrency/raiblocks/wiki/RPC-protocol#account-create):
+The `id` can be any string and needs to be unique per payment. It serves an important purpose; it allows you to make this call multiple times with the same `id` and be reassured that you will only ever send that nano payment once. From the [Nano RPC](https://developers.nano.org/docs/rpc#send):
 
 > You can (and should) specify a unique id for each spend to provide idempotency. That means that if you [make the payment call] two times with the same id, the second request won't send any additional Nano.
 
@@ -86,7 +86,7 @@ The unit of the `amount` is NANO (which is currently technically Mnano — s
 account.pay(to: recipient_account_id, amount: 999, unit: :raw, id: unique_id)
 ```
 
-Note, there may be a delay in receiving a response due to Proof of Work being done. From the [Nano RPC](https://github.com/nanocurrency/raiblocks/wiki/RPC-protocol#account-create):
+Note, there may be a delay in receiving a response due to Proof of Work being done. From the [Nano RPC](https://developers.nano.org/docs/rpc#send):
 
 > Proof of Work is precomputed for one transaction in the background. If it has been a while since your last transaction it will send instantly, the next one will need to wait for Proof of Work to be generated.
 
@@ -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.4.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.5.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.4.0/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.5.0/Nanook/Wallet.html) for a detailed description of each method and example responses.
 
 #### Create wallet:
 
@@ -159,6 +159,7 @@ wallet.receive(into: account_id)
 wallet.receive(pending_block_id, into: account_id)
 
 wallet.account.create
+wallet.account.create(5)
 wallet.accounts
 wallet.contains?(account_id)
 
@@ -167,6 +168,7 @@ wallet.change_default_representative(new_representative)
 wallet.info
 wallet.info(unit: :raw)
 wallet.export
+wallet.lock
 wallet.locked?
 wallet.unlock(password)
 wallet.change_password(password)
@@ -189,7 +191,7 @@ 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.4.0/Nanook/WalletAccount.html) for a detailed description of each method and example responses.
+See the [full documentation for Nanook::WalletAccount](https://lukes.github.io/nanook/2.5.0/Nanook/WalletAccount.html) for a detailed description of each method and example responses.
 
 ```ruby
 account = Nanook.new.wallet(wallet_id).account(account_id)
@@ -229,7 +231,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.4.0/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.5.0/Nanook/Account.html) for a detailed description of each method and example responses.
 
 ```ruby
 account = Nanook.new.account(account_id)
@@ -262,7 +264,7 @@ account.weight
 
 ### Blocks
 
-See the [full documentation for Nanook::Block](https://lukes.github.io/nanook/2.4.0/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.5.0/Nanook/Block.html) for a detailed description of each method and example responses.
 
 ```ruby
 block = Nanook.new.block(block_id)
@@ -272,6 +274,7 @@ block.info(allow_unchecked: true) # Verified blocks AND unchecked synchronizing
 block.account
 block.chain
 block.chain(limit: 10)
+block.chain(offset: 10)
 block.confirm
 block.confirmed_recently?
 block.history
@@ -283,6 +286,7 @@ block.pending?
 block.publish
 block.successors
 block.successors(limit: 10)
+block.successors(offset: 10)
 
 block.generate_work
 block.generate_work(use_peers: true)
@@ -292,7 +296,7 @@ block.is_valid_work?(work_id)
 
 ### Managing your nano node
 
-See the [full documentation for Nanook::Node](https://lukes.github.io/nanook/2.4.0/Nanook/Node.html) for a detailed description of each method and example responses.
+See the [full documentation for Nanook::Node](https://lukes.github.io/nanook/2.5.0/Nanook/Node.html) for a detailed description of each method and example responses.
 
 ```ruby
 node = Nanook.new.node
@@ -300,9 +304,14 @@ node = Nanook.new.node
 node.account_count
 node.block_count
 node.block_count_by_type
-node.bootstrap_any
 node.bootstrap(address: "::ffff:138.201.94.249", port: 7075)
+node.bootstrap_any
+node.bootstrap_lazy(block_id)
+node.bootstrap_lazy(block_id, force: true)
+node.bootstrap_status
 node.confirmation_history
+node.difficulty
+node.difficulty(include_trend: true)
 node.peers
 node.representatives
 node.representatives(unit: :raw)
@@ -344,12 +353,12 @@ key.info
 
 ## Nanook Metal
 
-You can do any call listed in the [Nano RPC](https://github.com/nanocurrency/raiblocks/wiki/RPC-protocol) directly through the `rpc` method. The first argument should match the `action` of the RPC call, and then all remaining parameters are passed in as arguments.
+You can do any call listed in the [Nano RPC](https://developers.nano.org/docs/rpc) directly through the `rpc` method. The first argument should match the `action` of the RPC call, and then all remaining parameters are passed in as arguments.
 
-E.g., the [accounts_create command](https://github.com/nanocurrency/raiblocks/wiki/RPC-protocol#accounts-create) can be called like this:
+E.g., the [accounts_create command](https://developers.nano.org/docs/rpc#accounts-create) can be called like this:
 
 ```ruby
-Nano.new.rpc(:accounts_create, wallet: wallet_id, count: 2)
+Nanook.new.rpc.call(:accounts_create, wallet: wallet_id, count: 2)
 ```
 
 ## Contributing
@@ -370,11 +379,11 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Buy me a nano coffee
 
-This library is totally free to use, but feel free to send some nano [my way](https://www.nanode.co/account/xrb_3c3ek3k8135f6e8qtfy8eruk9q3yzmpebes7btzncccdest8ymzhjmnr196j) if you'd like to!
+This library is totally free to use, but feel free to send some nano [my way](https://www.nanode.co/account/nano_3c3ek3k8135f6e8qtfy8eruk9q3yzmpebes7btzncccdest8ymzhjmnr196j) if you'd like to!
 
-    xrb_3c3ek3k8135f6e8qtfy8eruk9q3yzmpebes7btzncccdest8ymzhjmnr196j
+    nano_3c3ek3k8135f6e8qtfy8eruk9q3yzmpebes7btzncccdest8ymzhjmnr196j
 
-![alt xrb_3c3ek3k8135f6e8qtfy8eruk9q3yzmpebes7btzncccdest8ymzhjmnr196j](https://raw.githubusercontent.com/lukes/nanook/master/img/qr.png)
+![alt nano_3c3ek3k8135f6e8qtfy8eruk9q3yzmpebes7btzncccdest8ymzhjmnr196j](https://raw.githubusercontent.com/lukes/nanook/master/img/qr.png)
 
 
 

data/lib/nanook.rb

@@ -58,7 +58,7 @@ class Nanook
   # Returns a new instance of {Nanook::Account}.
   #
   # ==== Example:
-  #   account = Nanook.new.account("xrb_3e3j5tkog48pnny9dmfzj1r16pg8t1e76dz5tmac6iq689wyjfpi00000000")
+  #   account = Nanook.new.account("nano_3e3j5tkog48pnny9dmfzj1r16pg8t1e76dz5tmac6iq689wyjfpi00000000")
   #
   # @param account [String] the id of the account you want to work with
   # @return [Nanook::Account]

data/lib/nanook/account.rb

@@ -8,12 +8,12 @@ class Nanook
   # Initialize this class through the convenient {Nanook#account} method:
   #
   #   nanook = Nanook.new
-  #   account = nanook.account("xrb_...")
+  #   account = nanook.account("nano_...")
   #
   # Or compose the longhand way like this:
   #
   #   rpc_conn = Nanook::Rpc.new
-  #   account = Nanook::Account.new(rpc_conn, "xrb_...")
+  #   account = Nanook::Account.new(rpc_conn, "nano_...")
   class Account
 
     def initialize(rpc, account)
@@ -30,8 +30,8 @@ class Nanook
     # Example response:
     #
     #   {
-    #     :xrb_13bqhi1cdqq8yb9szneoc38qk899d58i5rcrgdk5mkdm86hekpoez3zxw5sd=>500000000000000000000000000000000000,
-    #     :xrb_17k6ug685154an8gri9whhe5kb5z1mf5w6y39gokc1657sh95fegm8ht1zpn=>961647970820730000000000000000000000
+    #     :nano_13bqhi1cdqq8yb9szneoc38qk899d58i5rcrgdk5mkdm86hekpoez3zxw5sd=>500000000000000000000000000000000000,
+    #     :nano_17k6ug685154an8gri9whhe5kb5z1mf5w6y39gokc1657sh95fegm8ht1zpn=>961647970820730000000000000000000000
     #   }
     #
     # @param unit (see #balance)
@@ -89,7 +89,7 @@ class Nanook
     #   [
     #     {
     #      type: "send",
-    #      account: "xrb_1kdc5u48j3hr5r7eof9iao47szqh81ndqgq5e5hrsn1g9a3sa4hkkcotn3uq",
+    #      account: "nano_1kdc5u48j3hr5r7eof9iao47szqh81ndqgq5e5hrsn1g9a3sa4hkkcotn3uq",
     #      amount: 2,
     #      hash: "2C3C570EA8898443C0FD04A1C385A3E3A8C985AD792635FCDCEBB30ADF6A0570"
     #     }
@@ -146,7 +146,7 @@ class Nanook
     #
     # ==== Example:
     #
-    #   account.representative # => "xrb_3pc..."
+    #   account.representative # => "nano_3pc..."
     #
     # @return [String] Representative account of the account
     def representative
@@ -209,7 +209,7 @@ class Nanook
     #
     # ==== Example:
     #
-    #   account.id # => "xrb_16u..."
+    #   account.id # => "nano_16u..."
     #
     # @return [String] the id of the account
     def id
@@ -225,7 +225,7 @@ class Nanook
     # Example response:
     #
     #   {
-    #     id: "xrb_16u1uufyoig8777y6r8iqjtrw8sg8maqrm36zzcm95jmbd9i9aj5i8abr8u5",
+    #     id: "nano_16u1uufyoig8777y6r8iqjtrw8sg8maqrm36zzcm95jmbd9i9aj5i8abr8u5",
     #     balance: 11.439597000000001,
     #     block_count: 4,
     #     frontier: "2C3C570EA8898443C0FD04A1C385A3E3A8C985AD792635FCDCEBB30ADF6A0570",
@@ -241,7 +241,7 @@ class Nanook
     # Example response:
     #
     #   {
-    #     id: "xrb_16u1uufyoig8777y6r8iqjtrw8sg8maqrm36zzcm95jmbd9i9aj5i8abr8u5",
+    #     id: "nano_16u1uufyoig8777y6r8iqjtrw8sg8maqrm36zzcm95jmbd9i9aj5i8abr8u5",
     #     balance: 11.439597000000001,
     #     block_count: 4,
     #     frontier: "2C3C570EA8898443C0FD04A1C385A3E3A8C985AD792635FCDCEBB30ADF6A0570",
@@ -249,7 +249,7 @@ class Nanook
     #     open_block: "C82376314C387080A753871A32AD70F4168080C317C5E67356F0A62EB5F34FF9",
     #     pending: 0,
     #     public_key: "A82C906460046D230D7D37C6663723DC3EFCECC4B3254EBF45294B66746F4FEF",
-    #     representative: "xrb_3pczxuorp48td8645bs3m6c3xotxd3idskrenmi65rbrga5zmkemzhwkaznh",
+    #     representative: "nano_3pczxuorp48td8645bs3m6c3xotxd3idskrenmi65rbrga5zmkemzhwkaznh",
     #     representative_block: "C82376314C387080A753871A32AD70F4168080C317C5E67356F0A62EB5F34FF9",
     #     weight: 0
     #   }
@@ -316,7 +316,7 @@ class Nanook
     # Example response:
     #
     #   {
-    #    :xrb_3c3ek3k8135f6e8qtfy8eruk9q3yzmpebes7btzncccdest8ymzhjmnr196j=>{
+    #    :nano_3c3ek3k8135f6e8qtfy8eruk9q3yzmpebes7btzncccdest8ymzhjmnr196j=>{
     #      :frontier=>"2C3C570EA8898443C0FD04A1C385A3E3A8C985AD792635FCDCEBB30ADF6A0570",
     #      :open_block=>"C82376314C387080A753871A32AD70F4168080C317C5E67356F0A62EB5F34FF9",
     #      :representative_block=>"C82376314C387080A753871A32AD70F4168080C317C5E67356F0A62EB5F34FF9",
@@ -324,7 +324,7 @@ class Nanook
     #      :modified_timestamp=>1520500357,
     #      :block_count=>4
     #    },
-    #    :xrb_3c3ettq59kijuuad5fnaq35itc9schtr4r7r6rjhmwjbairowzq3wi5ap7h8=>{ ... }
+    #    :nano_3c3ettq59kijuuad5fnaq35itc9schtr4r7r6rjhmwjbairowzq3wi5ap7h8=>{ ... }
     #  }
     #
     # @param [Integer] limit number of accounts to return in the ledger (default is 1)
@@ -380,7 +380,7 @@ class Nanook
     #     {
     #       block: "000D1BAEC8EC208142C99059B393051BAC8380F9B5A2E6B2489A277D81789F3F",
     #       amount: 6,
-    #       source: "xrb_3dcfozsmekr1tr9skf1oa5wbgmxt81qepfdnt7zicq5x3hk65fg4fqj58mbr"
+    #       source: "nano_3dcfozsmekr1tr9skf1oa5wbgmxt81qepfdnt7zicq5x3hk65fg4fqj58mbr"
     #     },
     #     { ... }
     #   ]

data/lib/nanook/block.rb

@@ -45,8 +45,11 @@ class Nanook
       rpc(:work_cancel, :hash).empty?
     end
 
-    # Returns an Array of block hashes in the account chain starting at
-    # this block.
+    # Returns a consecutive list of block hashes in the account chain
+    # starting at block back to count (direction from frontier back to
+    # open block, from newer blocks to older). Will list all blocks back
+    # to the open block of this chain when count is set to "-1".
+    # The requested block hash is included in the answer.
     #
     # See also #successors.
     #
@@ -60,11 +63,14 @@ class Nanook
     #     "36A0FB717368BA8CF8D255B63DC207771EABC6C6FFC22A7F455EC2209464897E",
     #     "FBF8B0E6623A31AB528EBD839EEAA91CAFD25C12294C46754E45FD017F7939EB"
     #   ]
+    #
     # @param limit [Integer] maximum number of block hashes to return (default is 1000)
-    def chain(limit: 1000)
-      response = rpc(:chain, :block, count: limit)[:blocks]
+    # @param offset [Integer] return the account chain block hashes offset by the specified number of blocks (default is 0)
+    def chain(limit: 1000, offset: 0)
+      response = rpc(:chain, :block, count: limit, offset: offset)[:blocks]
       Nanook::Util.coerce_empty_string_to_type(response, Array)
     end
+    alias_method :ancestors, :chain
 
     # Request confirmation for a block from online representative nodes.
     # Will return immediately with a boolean to indicate if the request for
@@ -81,6 +87,9 @@ class Nanook
       rpc(:block_confirm, :hash)[:started] == 1
     end
 
+    # This call is for internal diagnostics/debug purposes only. Do not
+    # rely on this interface being stable and do not use in a production system.
+    #
     # Check if the block appears in the list of recently confirmed blocks by
     # online representatives. The full list of blocks can be queried for with {Nanook::Node#confirmation_history}.
     #
@@ -127,7 +136,7 @@ class Nanook
     #
     #   [
     #     {
-    #       :account=>"xrb_3x7cjioqahgs5ppheys6prpqtb4rdknked83chf97bot1unrbdkaux37t31b",
+    #       :account=>"nano_3x7cjioqahgs5ppheys6prpqtb4rdknked83chf97bot1unrbdkaux37t31b",
     #       :amount=>539834279601145558517940224,
     #       :hash=>"36A0FB717368BA8CF8D255B63DC207771EABC6C6FFC22A7F455EC2209464897E",
     #       :type=>"send"
@@ -164,7 +173,7 @@ class Nanook
     #     :id=>"36A0FB717368BA8CF8D255B63DC207771EABC6C6FFC22A7F455EC2209464897E",
     #     :type=>"send",
     #     :previous=>"FBF8B0E6623A31AB528EBD839EEAA91CAFD25C12294C46754E45FD017F7939EB",
-    #     :destination=>"xrb_3x7cjioqahgs5ppheys6prpqtb4rdknked83chf97bot1unrbdkaux37t31b",
+    #     :destination=>"nano_3x7cjioqahgs5ppheys6prpqtb4rdknked83chf97bot1unrbdkaux37t31b",
     #     :balance=>"00000000000000000000000000000000",
     #     :work=>"44cc24b60705083a",
     #     :signature=>"42ADFEFE7C3FFF188AE92A202F8A5734DE91779C454613E446EEC93D001D6C953E9FD16730AF32C891791BA8EDAECEB059A213E2FE1EEB7ADF9D5D0815464D06"
@@ -260,10 +269,12 @@ class Nanook
     #   ["36A0FB717368BA8CF8D255B63DC207771EABC6C6FFC22A7F455EC2209464897E"]
     #
     # @param limit [Integer] maximum number of send/receive block hashes
-    #    to return in the chain (default is 1000)
+    #   to return in the chain (default is 1000)
+    # @param offset [Integer] return the account chain block hashes offset
+    #   by the specified number of blocks (default is 0)
     # @return [Array<String>] block hashes in the account chain ending at this block
-    def successors(limit: 1000)
-      response = rpc(:successors, :block, count: limit)[:blocks]
+    def successors(limit: 1000, offset: 0)
+      response = rpc(:successors, :block, count: limit, offset: offset)[:blocks]
       Nanook::Util.coerce_empty_string_to_type(response, Array)
     end
 

data/lib/nanook/node.rb

@@ -90,7 +90,57 @@ class Nanook
       rpc(:bootstrap_any).has_key?(:success)
     end
 
-    # Returns block and tally weight (in raw) for recent elections winners
+    # Initialize lazy bootstrap with given block hash
+    #
+    # @param hash [String]
+    # @param force [Boolean] False by default. Manually force closing
+    #   of all current bootstraps
+    # @return [Boolean] indicating if the action was successful
+    def bootstrap_lazy(hash, force: false)
+      rpc(:bootstrap_lazy, hash: hash, force: force)[:started] == 1
+    end
+
+    # Returning status of current bootstrap attempt for debug purposes only.
+    # This call is for internal diagnostics/debug purposes only.
+    # Do not rely on this interface being stable and do not use in a
+    # production system.
+    #
+    # ==== Example:
+    #
+    #   node.bootstrap_status
+    #
+    # Example response:
+    #
+    #   {
+    #     clients: 5790,
+    #     pulls: 141065,
+    #     pulling: 3,
+    #     connections: 16,
+    #     idle: 0,
+    #     target_connections: 64,
+    #     total_blocks: 536820,
+    #     lazy_mode: true,
+    #     lazy_blocks: 423388,
+    #     lazy_state_unknown: 2,
+    #     lazy_balances: 0,
+    #     lazy_pulls: 0,
+    #     lazy_stopped: 644,
+    #     lazy_keys: 449,
+    #     lazy_key_1: "A86EB2B479AAF3CD531C8356A1FBE3CB500DFBF5BF292E5E6B8D1048DE199C32"
+    #   }
+    #
+    # @return [Hash{Symbol=>String|Integer|Boolean}]
+    def bootstrap_status
+      rpc(:bootstrap_status)
+    end
+
+    # This call is for internal diagnostics/debug purposes only.
+    # Do not rely on this interface being stable and do not use in a
+    # production system.
+    #
+    # Returns block and tally weight (in raw) election duration (in
+    # milliseconds), election confirmation timestamp for recent elections
+    # winners.
     #
     # ==== Example:
     #
@@ -101,11 +151,15 @@ class Nanook
     #   [
     #     {
     #       block: "EA70B32C55C193345D625F766EEA2FCA52D3F2CCE0B3A30838CC543026BB0FEA",
-    #       tally: 80394786589602980996311817874549318248
+    #       tally: 80394786589602980996311817874549318248,
+    #       duration: 4000,
+    #       time: 1544819986,
     #     },
     #     {
     #       block: "F2F8DA6D2CA0A4D78EB043A7A29E12BDE5B4CE7DE1B99A93A5210428EE5B8667",
-    #       tally: 68921714529890443063672782079965877749
+    #       tally: 68921714529890443063672782079965877749,
+    #       duration: 6000,
+    #       time: 1544819988,
     #     }
     #   ]
     #
@@ -118,6 +172,48 @@ class Nanook
       end
     end
 
+    # Returns the difficulty values (16 hexadecimal digits string, 64 bit)
+    # for the minimum required on the network (network_minimum) as well
+    # as the current active difficulty seen on the network (network_current,
+    # 5 minute trended average of adjusted difficulty seen on confirmed
+    # transactions) which can be used to perform rework for better
+    # prioritization of transaction processing. A multiplier of the
+    # network_current from the base difficulty of network_minimum is also
+    # provided for comparison.
+    #
+    # ==== Example:
+    #
+    #   node.difficulty(include_trend: true)
+    #
+    # Example response:
+    #
+    #   {
+    #     network_minimum: "ffffffc000000000",
+    #     network_current: "ffffffc1816766f2",
+    #     multiplier: 1.024089858417128,
+    #     difficulty_trend: [
+    #       1.156096135149775,
+    #       1.190133894573061,
+    #       1.135567138563921,
+    #       1.000000000000000,
+    #     ]
+    #   }
+    #
+    # @param include_trend [Boolean] false by default. Also returns the
+    #   trend of difficulty seen on the network as a list of multipliers.
+    #   Sampling occurs every 16 to 36 seconds. The list is ordered such
+    #   that the first value is the most recent sample.
+    # @return [Hash{Symbol=>String|Float|Array}]
+    def difficulty(include_trend: false)
+      rpc(:active_difficulty, include_trend: include_trend).tap do |response|
+        response[:multiplier] = response[:multiplier].to_f
+
+        if response.key?(:difficulty_trend)
+          response[:difficulty_trend].map!(&:to_f)
+        end
+      end
+    end
+
     # @return [String]
     def inspect
       "#{self.class.name}(object_id: \"#{"0x00%x" % (object_id << 1)}\")"
@@ -136,9 +232,9 @@ class Nanook
     # Example response:
     #
     #   {
-    #     xrb_1111111111111111111111111111111111111111111111111117353trpda: 3822372327060170000000000000000000000,
-    #     xrb_1111111111111111111111111111111111111111111111111awsq94gtecn: 30999999999999999999999999000000,
-    #     xrb_114nk4rwjctu6n6tr6g6ps61g1w3hdpjxfas4xj1tq6i8jyomc5d858xr1xi: 0
+    #     nano_1111111111111111111111111111111111111111111111111117353trpda: 3822372327060170000000000000000000000,
+    #     nano_1111111111111111111111111111111111111111111111111awsq94gtecn: 30999999999999999999999999000000,
+    #     nano_114nk4rwjctu6n6tr6g6ps61g1w3hdpjxfas4xj1tq6i8jyomc5d858xr1xi: 0
     #   }
     #
     # @return [Hash{Symbol=>Integer}] known representatives and their voting weight
@@ -165,7 +261,7 @@ class Nanook
     #
     # ==== Example:
     #
-    #   node.representatives_online # => ["xrb_111...", "xrb_222"]
+    #   node.representatives_online # => ["nano_111...", "nano_222"]
     #
     # @return [Array<String>] array of representative account ids
     def representatives_online
@@ -208,6 +304,13 @@ class Nanook
       count.to_f * 100 / total.to_f
     end
 
+    # Returns node uptime in seconds
+    #
+    # @return [Integer] seconds of uptime
+    def uptime
+      rpc(:uptime)['seconds']
+    end
+
     # This method is deprecated and will be removed in 3.0, as a node never
     # reaches 100% synchronization.
     #

data/lib/nanook/version.rb

@@ -1,3 +1,3 @@
 class Nanook
-  VERSION = "2.4.0"
+  VERSION = "2.5.0"
 end

data/lib/nanook/wallet.rb

@@ -33,7 +33,7 @@ class Nanook
   # want to restore the wallet anywhere else on the nano network besides
   # the node you originally created it on. The nano command line interface
   # (CLI) is the only method for discovering a wallet's seed. See the
-  # {https://github.com/nanocurrency/raiblocks/wiki/Command-line-interface
+  # {https://developers.nano.org/docs/command-line-interface/#wallet_decrypt_unsafe
   # --wallet_decrypt_unsafe CLI command}.
   #
   # === Initializing
@@ -67,7 +67,7 @@ class Nanook
     #
     # ==== Examples:
     #
-    #   wallet.account("xrb_...") # => Nanook::WalletAccount
+    #   wallet.account("nano_...") # => Nanook::WalletAccount
     #   wallet.account.create     # => Nanook::WalletAccount
     #
     # @param [String] account optional String of an account (starting with
@@ -128,11 +128,11 @@ class Nanook
     # Example response:
     #
     #   {
-    #     "xrb_3e3j5tkog48pnny9dmfzj1r16pg8t1e76dz5tmac6iq689wyjfpi00000000"=>{
+    #     "nano_3e3j5tkog48pnny9dmfzj1r16pg8t1e76dz5tmac6iq689wyjfpi00000000"=>{
     #       "balance"=>2.5,
     #       "pending"=>1
     #     },
-    #     "xrb_1e5aqegc1jb7qe964u4adzmcezyo6o146zb8hm6dft8tkp79za3sxwjym5rx"=>{
+    #     "nano_1e5aqegc1jb7qe964u4adzmcezyo6o146zb8hm6dft8tkp79za3sxwjym5rx"=>{
     #       "balance"=>51.4,
     #       "pending"=>0
     #     },
@@ -171,6 +171,9 @@ class Nanook
 
     # Changes a wallet's seed.
     #
+    # It's recommended to only change the seed of a wallet that contains
+    # no accounts.
+    #
     # ==== Example:
     #
     #   wallet.change_seed("000D1BA...") # => true
@@ -227,9 +230,9 @@ class Nanook
     # Will return +true+ if the account exists in the wallet.
     #
     # ==== Example:
-    #   wallet.contains?("xrb_...") # => true
+    #   wallet.contains?("nano_...") # => true
     #
-    # @param account [String] id (will start with <tt>"xrb_..."</tt>)
+    # @param account [String] id (will start with <tt>"nano_..."</tt>)
     # @return [Boolean] indicating if the wallet contains the given account
     def contains?(account)
       wallet_required!
@@ -251,7 +254,7 @@ class Nanook
     # on the nano network.
     #
     # Note, there may be a delay in receiving a response due to Proof of
-    # Work being done. From the {Nano RPC}[https://github.com/nanocurrency/raiblocks/wiki/RPC-protocol#account-create]:
+    # Work being done. From the {Nano RPC}[https://developers.nano.org/docs/rpc#send]:
     #
     # <i>Proof of Work is precomputed for one transaction in the
     # background. If it has been a while since your last transaction it
@@ -260,8 +263,8 @@ class Nanook
     #
     # ==== Examples:
     #
-    #   wallet.pay(from: "xrb_...", to: "xrb_...", amount: 1.1, id: "myUniqueId123") # => "9AE2311..."
-    #   wallet.pay(from: "xrb_...", to: "xrb_...", amount: 54000000000000, unit: :raw, id: "myUniqueId123") # => "9AE2311..."
+    #   wallet.pay(from: "nano_...", to: "nano_...", amount: 1.1, id: "myUniqueId123") # => "9AE2311..."
+    #   wallet.pay(from: "nano_...", to: "nano_...", amount: 54000000000000, unit: :raw, id: "myUniqueId123") # => "9AE2311..."
     #
     # @param from [String] account id of an account in your wallet
     # @param to (see Nanook::WalletAccount#pay)
@@ -292,11 +295,11 @@ class Nanook
     # Example response:
     #
     #   {
-    #     :xrb_1111111111111111111111111111111111111111111111111117353trpda=>[
+    #     :nano_1111111111111111111111111111111111111111111111111117353trpda=>[
     #       "142A538F36833D1CC78B94E11C766F75818F8B940771335C6C1B8AB880C5BB1D",
     #       "718CC2121C3E641059BC1C2CFC45666C99E8AE922F7A807B7D07B62C995D79E2"
     #     ],
-    #     :xrb_3t6k35gi95xu6tergt6p69ck76ogmitsa8mnijtpxm9fkcm736xtoncuohr3=>[
+    #     :nano_3t6k35gi95xu6tergt6p69ck76ogmitsa8mnijtpxm9fkcm736xtoncuohr3=>[
     #       "4C1FEEF0BEA7F50BE35489A1233FE002B212DEA554B55B1B470D78BD8F210C74"
     #     ]
     #   }
@@ -308,22 +311,22 @@ class Nanook
     # Example response:
     #
     #   {
-    #     :xrb_1111111111111111111111111111111111111111111111111117353trpda=>[
+    #     :nano_1111111111111111111111111111111111111111111111111117353trpda=>[
     #       {
     #         :amount=>6.0,
-    #         :source=>"xrb_3dcfozsmekr1tr9skf1oa5wbgmxt81qepfdnt7zicq5x3hk65fg4fqj58mbr",
+    #         :source=>"nano_3dcfozsmekr1tr9skf1oa5wbgmxt81qepfdnt7zicq5x3hk65fg4fqj58mbr",
     #         :block=>:"142A538F36833D1CC78B94E11C766F75818F8B940771335C6C1B8AB880C5BB1D"
     #       },
     #       {
     #         :amount=>12.0,
-    #         :source=>"xrb_3dcfozsmekr1tr9skf1oa5wbgmxt81qepfdnt7zicq5x3hk65fg4fqj58mbr",
+    #         :source=>"nano_3dcfozsmekr1tr9skf1oa5wbgmxt81qepfdnt7zicq5x3hk65fg4fqj58mbr",
     #         :block=>:"242A538F36833D1CC78B94E11C766F75818F8B940771335C6C1B8AB880C5BB1D"
     #       }
     #     ],
-    #     :xrb_3t6k35gi95xu6tergt6p69ck76ogmitsa8mnijtpxm9fkcm736xtoncuohr3=>[
+    #     :nano_3t6k35gi95xu6tergt6p69ck76ogmitsa8mnijtpxm9fkcm736xtoncuohr3=>[
     #       {
     #         :amount=>106.370018,
-    #         :source=>"xrb_13ezf4od79h1tgj9aiu4djzcmmguendtjfuhwfukhuucboua8cpoihmh8byo",
+    #         :source=>"nano_13ezf4od79h1tgj9aiu4djzcmmguendtjfuhwfukhuucboua8cpoihmh8byo",
     #         :block=>:"4C1FEEF0BEA7F50BE35489A1233FE002B212DEA554B55B1B470D78BD8F210C74"
     #       }
     #     ]
@@ -395,7 +398,7 @@ class Nanook
     #
     # ==== Example:
     #
-    #   wallet.default_representative # => "xrb_3pc..."
+    #   wallet.default_representative # => "nano_3pc..."
     #
     # @return [String] Representative account of the account
     def default_representative
@@ -411,7 +414,7 @@ class Nanook
     #
     # ==== Example:
     #
-    #   wallet.change_default_representative("xrb_...") # => "xrb_..."
+    #   wallet.change_default_representative("nano_...") # => "nano_..."
     #
     # @param [String] representative the id of the representative account
     #   to set as this account's representative
@@ -470,7 +473,7 @@ class Nanook
     #     id: "2C3C570EA8898443C0FD04A1C385A3E3A8C985AD792635FCDCEBB30ADF6A0570",
     #     accounts: [
     #       {
-    #         id: "xrb_11119gbh8hb4hj1duf7fdtfyf5s75okzxdgupgpgm1bj78ex3kgy7frt3s9n"
+    #         id: "nano_11119gbh8hb4hj1duf7fdtfyf5s75okzxdgupgpgm1bj78ex3kgy7frt3s9n"
     #         frontier: "E71AF3E9DD86BBD8B4620EFA63E065B34D358CFC091ACB4E103B965F95783321",
     #         open_block: "643B77F1ECEFBDBE1CC909872964C1DBBE23A6149BD3CEF2B50B76044659B60F",
     #         representative_block: "643B77F1ECEFBDBE1CC909872964C1DBBE23A6149BD3CEF2B50B76044659B60F",
@@ -505,6 +508,19 @@ class Nanook
       }.to_symbolized_hash
     end
 
+    # Locks the wallet. A locked wallet cannot pocket pending transactions or make payments. See {#unlock}.
+    #
+    # ==== Example:
+    #
+    #   wallet.lock #=> true
+    #
+    # @return [Boolean] indicates if the wallet was successfully locked
+    def lock
+      wallet_required!
+      response = rpc(:wallet_lock)
+      !response.empty? && response[:locked] == 1
+    end
+
     # Returns +true+ if the wallet is locked.
     #
     # ==== Example:

data/lib/nanook/wallet_account.rb

@@ -113,14 +113,14 @@ class Nanook
     # if successful, or a {Nanook::Error} if unsuccessful.
     #
     # Note, there may be a delay in receiving a response due to Proof
-    # of Work being done. From the {Nano RPC}[https://github.com/nanocurrency/raiblocks/wiki/RPC-protocol#account-create]:
+    # of Work being done. From the {Nano RPC}[https://developers.nano.org/docs/rpc#send]:
     #
     # <i>Proof of Work is precomputed for one transaction in the background. If it has been a while since your last transaction it will send instantly, the next one will need to wait for Proof of Work to be generated.</i>
     #
     # ==== Examples:
     #
-    #   account.pay(to: "xrb_...", amount: 1.1, id: "myUniqueId123") # => "9AE2311..."
-    #   account.pay(to: "xrb_...", amount: 54000000000000, id: "myUniqueId123", unit: :raw) # => "9AE2311..."
+    #   account.pay(to: "nano_...", amount: 1.1, id: "myUniqueId123") # => "9AE2311..."
+    #   account.pay(to: "nano_...", amount: 54000000000000, id: "myUniqueId123", unit: :raw) # => "9AE2311..."
     #
     # @param to [String] account id of the recipient of your payment
     # @param amount [Integer|Float]
@@ -211,7 +211,7 @@ class Nanook
     #
     # ==== Example:
     #
-    #   account.change_representative("xrb_...") # => "000D1BAEC8EC208142C99059B393051BAC8380F9B5A2E6B2489A277D81789F3F"
+    #   account.change_representative("nano_...") # => "000D1BAEC8EC208142C99059B393051BAC8380F9B5A2E6B2489A277D81789F3F"
     #
     # @param [String] representative the id of the representative account
     #   to set as this account's representative

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanook
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Luke Duncalfe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-05 00:00:00.000000000 Z
+date: 2019-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -182,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Library for managing a nano currency node, including making and receiving