nanook 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4453793303eb12685b219bed3586cfe92f09909f
-  data.tar.gz: 0b4a3a21470ba6b7916a8fe7304234be89fd6234
+SHA256:
+  metadata.gz: 632d341b2aa122d7c5049077fbebf1fd67097abb9bc0a4814ae938d2a5d70356
+  data.tar.gz: 9e640aadc4074e46b95e2ceafff4a67808aeca2f181dd95d530fb1d52fb5be30
 SHA512:
-  metadata.gz: 1dc885c8cf50d2773de155e3b970cdf3f400641d9cc5a378996cc544ba18b96eab0a97dfc01592a33bf027fac2df6fa3f29bdf886e8c7fecaf827f4bcc848968
-  data.tar.gz: ff5a87c994fa30e96730336a9ea5ee6c14939302ee2dd329dd83faa01a4479cbd0dfcd79dc0374a44d9c7562813e6799038d532b0c0f05c75fd30aa5c3214ebc
+  metadata.gz: a697f30061015b19d30075698e7d08fb4c868d886abfb8c420367e929dbf94b800b49f735785f1c6a72cda9ae8287704a90532b553c37c1ac0e8130118197b53
+  data.tar.gz: 79ecfa816e0c6d2b7b2c671ac99a28bc8840dfff71a5c6e5608a5700a80c3dcf18632141b91d76d9d31219cb111395d220bb05b9ca744513415238cc6003ab1a

data/CHANGELOG.md

@@ -4,6 +4,18 @@ 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.4.0
+
+### Added
+
+- New `Nanook::Node#confirmation_history` method.
+- New `Nanook::Block#confirm` method.
+- New `Nanook::Block#confirmed_recently?` method.
+
+### Changed
+
+- `Nanook::Block#generate_work` now can take optional `use_peers` argument.
+
 ## 2.3.0
 
 ### Added

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.3"
+gem 'nanook'
 ```
 
 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.3.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.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).
 
 ### Wallets
 
-See the [full documentation for Nanook::Wallet](https://lukes.github.io/nanook/2.3.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.4.0/Nanook/Wallet.html) for a detailed description of each method and example responses.
 
 #### Create wallet:
 
@@ -189,7 +189,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.3.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.4.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 +229,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.3.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.4.0/Nanook/Account.html) for a detailed description of each method and example responses.
 
 ```ruby
 account = Nanook.new.account(account_id)
@@ -262,7 +262,7 @@ account.weight
 
 ### Blocks
 
-See the [full documentation for Nanook::Block](https://lukes.github.io/nanook/2.3.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.4.0/Nanook/Block.html) for a detailed description of each method and example responses.
 
 ```ruby
 block = Nanook.new.block(block_id)
@@ -272,6 +272,8 @@ block.info(allow_unchecked: true) # Verified blocks AND unchecked synchronizing
 block.account
 block.chain
 block.chain(limit: 10)
+block.confirm
+block.confirmed_recently?
 block.history
 block.history(limit: 10)
 block.republish
@@ -283,13 +285,14 @@ block.successors
 block.successors(limit: 10)
 
 block.generate_work
+block.generate_work(use_peers: true)
 block.cancel_work
 block.is_valid_work?(work_id)
 ```
 
 ### Managing your nano node
 
-See the [full documentation for Nanook::Node](https://lukes.github.io/nanook/2.3.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.4.0/Nanook/Node.html) for a detailed description of each method and example responses.
 
 ```ruby
 node = Nanook.new.node
@@ -299,6 +302,7 @@ node.block_count
 node.block_count_by_type
 node.bootstrap_any
 node.bootstrap(address: "::ffff:138.201.94.249", port: 7075)
+node.confirmation_history
 node.peers
 node.representatives
 node.representatives(unit: :raw)

data/lib/nanook/block.rb

@@ -66,14 +66,54 @@ class Nanook
       Nanook::Util.coerce_empty_string_to_type(response, Array)
     end
 
+    # Request confirmation for a block from online representative nodes.
+    # Will return immediately with a boolean to indicate if the request for
+    # confirmation was successful. Note that this boolean does not indicate
+    # the confirmation status of the block. If confirmed, your block should
+    # appear in {Nanook::Node#confirmation_history} within a short amount of
+    # time, or you can use the convenience method {Nanook::Block#confirmed_recently?}
+    #
+    # ==== Example:
+    #   block.confirm # => true
+    #
+    # @return [Boolean] if the confirmation request was sent successful
+    def confirm
+      rpc(:block_confirm, :hash)[:started] == 1
+    end
+
+    # 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}.
+    #
+    # This method can work in conjunction with {Nanook::Block#confirm},
+    # whereby you can send any block (old or new) out to online representatives to
+    # confirm. The confirmation process can take up to a couple of minutes.
+    #
+    # The method returning +false+ can indicate that the block is still in the process of being
+    # confirmed and that you should call the method again soon, or that it
+    # was confirmed earlier than the list available in {Nanook::Node#confirmation_history},
+    # or that it was not confirmed.
+    #
+    # ==== Example:
+    #   block.confirmed_recently? # => true
+    #
+    # @return [Boolean] +true+ if the block has been recently confirmed by
+    #   online representatives.
+    def confirmed_recently?
+      @rpc.call(:confirmation_history)[:confirmations].map{|h| h[:hash]}.include?(@block)
+    end
+    alias_method :recently_confirmed?, :confirmed_recently?
+
     # Generate work for a block.
     #
     # ==== Example:
     #   block.generate_work # => "2bf29ef00786a6bc"
     #
+    # @param use_peers [Boolean] if set to +true+, then the node will query
+    #   its work peers (if it has any, see {Nanook::WorkPeer#list}).
+    #   When +false+, the node will only generate work locally (default is +false+)
     # @return [String] the work id of the work completed.
-    def generate_work
-      rpc(:work_generate, :hash)[:work]
+    def generate_work(use_peers: false)
+      rpc(:work_generate, :hash, use_peers: use_peers)[:work]
     end
 
     # Returns Array of Hashes containing information about a chain of

data/lib/nanook/node.rb

@@ -90,6 +90,34 @@ class Nanook
       rpc(:bootstrap_any).has_key?(:success)
     end
 
+    # Returns block and tally weight (in raw) for recent elections winners
+    #
+    # ==== Example:
+    #
+    #   node.confirmation_history
+    #
+    # Example response:
+    #
+    #   [
+    #     {
+    #       block: "EA70B32C55C193345D625F766EEA2FCA52D3F2CCE0B3A30838CC543026BB0FEA",
+    #       tally: 80394786589602980996311817874549318248
+    #     },
+    #     {
+    #       block: "F2F8DA6D2CA0A4D78EB043A7A29E12BDE5B4CE7DE1B99A93A5210428EE5B8667",
+    #       tally: 68921714529890443063672782079965877749
+    #     }
+    #   ]
+    #
+    # @return [Hash{Symbol=>String|Integer}]
+    def confirmation_history
+      rpc(:confirmation_history)[:confirmations].map do |history|
+        # Rename hash key to block
+        block = history.delete(:hash)
+        {block: block}.merge(history)
+      end
+    end
+
     # @return [String]
     def inspect
       "#{self.class.name}(object_id: \"#{"0x00%x" % (object_id << 1)}\")"
@@ -141,7 +169,7 @@ class Nanook
     #
     # @return [Array<String>] array of representative account ids
     def representatives_online
-      response = rpc(:representatives_online)[:representatives].keys.map(&:to_s)
+      rpc(:representatives_online)[:representatives].keys.map(&:to_s)
     end
 
     # Safely shuts down the node.

data/lib/nanook/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanook
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Luke Duncalfe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-24 00:00:00.000000000 Z
+date: 2018-07-05 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.4.5.1
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Library for managing a nano currency node, including making and receiving