nanook 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86e9dced1a4ce9942cd123c262d7ff45fad6e982ce67c6903b6495a2609c29f9
-  data.tar.gz: 11d3752a80bc33e41ba7e19c7d4e2ad54b2d4a08212b71e7fd3579092d9b8c55
+  metadata.gz: fd2278329714fcd1e6778b5cbc85791f67e4fc835a7e6210abedc698f677645f
+  data.tar.gz: 074e3d14d1692038016973492c6d7475815e2b67f670ddba8d0e118e6fcbedfa
 SHA512:
-  metadata.gz: c53742261c03ba53fdcc46ffbcd0c556ccfe3d1b025f593d1b3f1ee9c6f1c1fcacb387b419aac07eefab390356022373dcc2121449097e968f051ac0498d4dfc
-  data.tar.gz: d1d4e28e58f28ee5ea161232276454b5eafd8959b63685db3440a6e15e1328e31b6676f5676f94fe0d30420e6e5b0c540a9345033dfb137fbf89d56ccf0de951
+  metadata.gz: 2fb9465657aa458639093281da94821ce9b07731c4b44309fa3372416ec2fa928a77e3d1c8260f4013a21cd51335c92d1cf58aa48cdbb0f5629796b46977c814
+  data.tar.gz: 3d518590b7433bdce1696ccc5d23fa2fc93d60101649ccb954de813493e51f2535f6d85bc91d841bdb7f54539c6f7f20444daaea877562b240191354bd37d3d9

data/CHANGELOG.md

@@ -4,6 +4,17 @@ 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).
 
+## 3.1.0
+
+### Added
+
+- `Block#next`.
+- `Block#descendants` aliases `Block#successors`
+
+### Changed
+
+- `Block.chain` and `Block.successors` no longer return the Block itself in the response.
+
 ## 3.0.1
 
 ### Fixed

data/README.md

@@ -124,11 +124,11 @@ Read the [Using Nanook](https://github.com/lukes/nanook/wiki/Using-nanook) page
 
 ## All commands
 
-Below is a quick reference list of commands. See the [full Nanook documentation](https://lukes.github.io/nanook/3.0.1/) for a searchable detailed description of every class and method, what the arguments mean, and example responses.
+Below is a quick reference list of commands. See the [full Nanook documentation](https://lukes.github.io/nanook/3.1.0/) for a searchable detailed description of every class and method, what the arguments mean, and example responses.
 
 ### Wallets
 
-See the [full documentation for Nanook::Wallet](https://lukes.github.io/nanook/3.0.1/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/3.1.0/Nanook/Wallet.html) for a detailed description of each method and example responses.
 
 #### Create wallet:
 
@@ -212,7 +212,7 @@ Any account on the Nano network that is known by your node can be initialized th
 account = nanook.account(account_id)
 ```
 
-See the [full documentation for Nanook::Account](https://lukes.github.io/nanook/3.0.1/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/3.1.0/Nanook/Account.html) for a detailed description of each method and example responses.
 
 ```ruby
 account.balance
@@ -260,7 +260,7 @@ account = wallet.account(account_id)
 
 As well as the following methods, all methods of [regular accounts](#working-with-any-account) can also be called.
 
-See the [full documentation for Nanook::WalletAccount](https://lukes.github.io/nanook/3.0.1/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/3.1.0/Nanook/WalletAccount.html) for a detailed description of each method and example responses.
 
 ```ruby
 account.pay(to: recipient_account_id, amount: 2, id: unique_id)
@@ -275,7 +275,7 @@ account.destroy
 
 ### Blocks
 
-See the [full documentation for Nanook::Block](https://lukes.github.io/nanook/3.0.1/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/3.1.0/Nanook/Block.html) for a detailed description of each method and example responses.
 
 ```ruby
 block = nanook.block(block_id)
@@ -283,9 +283,16 @@ block = nanook.block(block_id)
 block.account
 block.amount
 block.amount(unit: :raw)
+block.ancestors
+block.ancestors(limit: 10)
+block.ancestors(offset: 10)
 block.balance
 block.change?
 block.checked?
+block.confirm
+block.descendants
+block.descendants(limit: 10)
+block.descendants(offset: 10)
 block.epoch?
 block.exists?
 block.exists?(allow_unchecked: true)
@@ -293,24 +300,17 @@ block.height
 block.info                        # Verified blocks in the ledger
 block.info(allow_unchecked: true) # Verified blocks AND unchecked synchronizing blocks
 block.info(unit: :raw)
-block.account
-block.chain
-block.chain(limit: 10)
-block.chain(offset: 10)
-block.confirm
-block.republish
-block.republish(sources: 2)
-block.republish(destinations: 2)
+block.next
 block.open?
 block.pending?
 block.previous
 block.receive?
 block.representative
+block.republish
+block.republish(sources: 2)
+block.republish(destinations: 2)
 block.send?
 block.signature
-block.successors
-block.successors(limit: 10)
-block.successors(offset: 10)
 block.timestamp
 block.type
 block.unchecked?
@@ -324,7 +324,7 @@ block.valid_work?(work)
 
 ### Managing your nano node
 
-See the [full documentation for Nanook::Node](https://lukes.github.io/nanook/3.0.1/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/3.1.0/Nanook/Node.html) for a detailed description of each method and example responses.
 
 ```ruby
 node = nanook.node

data/lib/nanook/block.rb

@@ -66,16 +66,15 @@ class Nanook
     end
 
     # Returns a consecutive list of block hashes in the account chain
-    # starting at block back to count (direction from frontier back to
+    # from (but not including) 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.
+    # See also #descendants.
     #
     # ==== Example:
     #
-    #   block.chain(limit: 2)
+    #   block.ancestors(limit: 2)
     #
     # ==== Example reponse:
     #
@@ -84,6 +83,9 @@ class Nanook
     # @param limit [Integer] maximum number of block hashes to return (default is 1000)
     # @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)
+      # The RPC includes this block in its response, and Nanook will remove it from the results.
+      # Increment the limit by 1 to account for this (a limit of -1 is valid and means no limit).
+      limit += 1 if limit > 0
       params = {
         count: limit,
         offset: offset,
@@ -91,9 +93,8 @@ class Nanook
         _coerce: Array
       }
 
-      rpc(:chain, :block, params).map do |block|
-        as_block(block)
-      end
+      response = rpc(:chain, :block, params)[1..].to_a
+      response.map { |block| as_block(block) }
     end
     alias ancestors chain
 
@@ -226,14 +227,15 @@ class Nanook
       rpc(:pending_exists, :hash, _access: :exists) == 1
     end
 
-    # Returns an Array of block hashes in the account chain ending at
-    # this block.
+    # Returns an Array of block hashes in the account chain from (but not including) this block up to +count+
+    # (direction from open block up to frontier, from older blocks to newer). Will list all
+    # blocks up to frontier (latest block) of this chain when +count+ is set to +-1+.
     #
-    # See also #chain.
+    # See also #ancestors.
     #
     # ==== Example:
     #
-    #   block.successors # => [Nanook::Block, .. ]
+    #   block.descendants # => [Nanook::Block, .. ]
     #
     # @param limit [Integer] maximum number of send/receive block hashes
     #   to return in the chain (default is 1000)
@@ -241,6 +243,10 @@ class Nanook
     #   by the specified number of blocks (default is 0)
     # @return [Array<Nanook::Block>] blocks in the account chain ending at this block
     def successors(limit: 1000, offset: 0)
+      # The RPC includes this block in its response, and Nanook will remove it from the results.
+      # Increment the limit by 1 to account for this (a limit of -1 is valid and means no limit).
+      limit += 1 if limit > 0
+
       params = {
         count: limit,
         offset: offset,
@@ -248,10 +254,10 @@ class Nanook
         _coerce: Array
       }
 
-      rpc(:successors, :block, params).map do |block|
-        as_block(block)
-      end
+      response = rpc(:successors, :block, params)[1..].to_a
+      response.map { |block| as_block(block) }
     end
+    alias descendants successors
 
     # Returns the {Nanook::Account} of the block representative.
     #
@@ -350,6 +356,16 @@ class Nanook
       true
     end
 
+    # Returns the {Nanook::Block} of the next (newer) block in the account chain.
+    #
+    # ==== Example:
+    #   block.next # => Nanook::Block
+    #
+    # @return [Nanook::Block] next (newer) block in the account chain. Can be nil.
+    def next
+      successors(limit: 1).first
+    end
+
     # Returns the height of the block.
     #
     # ==== Example:
@@ -390,12 +406,12 @@ class Nanook
       memoized_info[:local_timestamp]
     end
 
-    # Returns the {Nanook::Block} of the previous block in the chain.
+    # Returns the {Nanook::Block} of the previous (older) block in the account chain.
     #
     # ==== Example:
     #   block.previous # => Nanook::Block
     #
-    # @return [Nanook::Block] previous block in the chain. Can be nil.
+    # @return [Nanook::Block] previous (older) block in the account chain. Can be nil.
     def previous
       memoized_info[:previous]
     end

data/lib/nanook/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Nanook
-  VERSION = '3.0.1'
+  VERSION = '3.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanook
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Luke Duncalfe
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-28 00:00:00.000000000 Z
+date: 2021-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler