nanook 2.2.0 → 3.0.0

data/lib/nanook/wallet_account.rb

@@ -1,7 +1,10 @@
-class Nanook
+# frozen_string_literal: true
+
+require_relative 'util'
 
-  # The <tt>Nanook::WalletAccount</tt> class lets you manage your nano accounts,
-  # including paying and receiving payment.
+class Nanook
+  # The <tt>Nanook::WalletAccount</tt> class lets you manage your nano accounts
+  # that are on your node, including paying and receiving payment.
   #
   # === Initializing
   #
@@ -14,17 +17,27 @@ class Nanook
   #   rpc_conn = Nanook::Rpc.new
   #   account = Nanook::WalletAccount.new(rpc_conn, wallet_id, account_id)
   class WalletAccount
-
+    include Nanook::Util
     extend Forwardable
+    # @!method ==
+    #   (see Nanook::Account#==)
     # @!method balance(unit: Nanook.default_unit)
     #   (see Nanook::Account#balance)
     # @!method block_count
     #   (see Nanook::Account#block_count)
+    # @!method blocks(limit: 1000, sort: :desc)
+    #   (see Nanook::Account#blocks)
     # @!method delegators(unit: Nanook.default_unit)
     #   (see Nanook::Account#delegators)
+    # @!method delegators_count
+    #   (see Nanook::Account#delegators_count)
+    # @!method eql?
+    #   (see Nanook::Account#eql?)
     # @!method exists?
     #   (see Nanook::Account#exists?)
-    # @!method history(limit: 1000, unit: Nanook.default_unit)
+    # @!method hash
+    #   (see Nanook::Account#hash)
+    # @!method history(limit: 1000, unit: Nanook.default_unit, sort: :desc)
     #   (see Nanook::Account#history)
     # @!method id
     #   (see Nanook::Account#id)
@@ -32,8 +45,10 @@ class Nanook
     #   (see Nanook::Account#info)
     # @!method last_modified_at
     #   (see Nanook::Account#last_modified_at)
-    # @!method ledger(limit: 1, modified_since: nil, unit: Nanook.default_unit)
+    # @!method ledger(limit: 1, modified_since: nil, unit: Nanook.default_unit, sort: :desc)
     #   (see Nanook::Account#ledger)
+    # @!method open_block
+    #   (see Nanook::Account#open_block)
     # @!method pending(limit: 1000, detailed: false, unit: Nanook.default_unit)
     #   (see Nanook::Account#pending)
     # @!method public_key
@@ -42,26 +57,45 @@ class Nanook
     #   (see Nanook::Account#representative)
     # @!method weight
     #   (see Nanook::Account#weight)
-    def_delegators :@nanook_account_instance, :balance, :delegators, :exists?, :history, :id, :info, :last_modified_at, :ledger, :pending, :public_key, :representative, :weight
-    alias_method :open?, :exists?
+    def_delegators :@nanook_account_instance,
+                   :==, :balance, :block_count, :blocks, :delegators, :delegators_count,
+                   :eql?, :exists?, :hash, :history, :id, :info, :last_modified_at, :ledger,
+                   :open_block, :pending, :public_key, :representative, :weight
+    alias open? exists?
 
-    def initialize(rpc, wallet, account)
+    def initialize(rpc, wallet, account = nil)
       @rpc = rpc
-      @wallet = wallet
-      @account = account
+      @wallet = wallet.to_s
+      @account = account.to_s if account
+
+      # Initialize an instance to delegate the RPC commands that do not
+      # need `enable_control` enabled (the read-only RPC commands).
       @nanook_account_instance = nil
 
-      unless @account.nil?
-        # Wallet must contain the account
-        unless Nanook::Wallet.new(@rpc, @wallet).contains?(@account)
-          raise ArgumentError.new("Account does not exist in wallet. Account: #{@account}, wallet: #{@wallet}")
-        end
+      return if @account.nil?
 
-        # An object to delegate account methods that don't
-        # expect a wallet param in the RPC call, to allow this
-        # class to support all methods that can be called on Nanook::Account
-        @nanook_account_instance = Nanook::Account.new(@rpc, @account)
+      # Wallet must contain the account
+      unless Nanook::Wallet.new(@rpc, @wallet).contains?(@account)
+        raise ArgumentError, "Account does not exist in wallet. Account: #{@account}, wallet: #{@wallet}"
       end
+
+      @nanook_account_instance = as_account(@account)
+    end
+
+    # @param other [Nanook::WalletAccount] wallet account to compare
+    # @return [Boolean] true if accounts are equal
+    def ==(other)
+      other.class == self.class &&
+        other.id == @account
+    end
+    alias eql? ==
+
+    # The hash value is used along with #eql? by the Hash class to determine if two objects
+    # reference the same hash key.
+    #
+    # @return [Integer]
+    def hash
+      [@wallet, @account].join('+').hash
     end
 
     # Creates a new account, or multiple new accounts, in this wallet.
@@ -71,23 +105,22 @@ class Nanook
     #   wallet.create     # => Nanook::WalletAccount
     #   wallet.create(2)  # => [Nanook::WalletAccount, Nanook::WalletAccount]
     #
-    # @param n [Integer] number of accounts to create
+    # @param n_accounts [Integer] number of accounts to create
     #
     # @return [Nanook::WalletAccount] returns a single {Nanook::WalletAccount}
     #   if invoked with no argument
     # @return [Array<Nanook::WalletAccount>] returns an Array of {Nanook::WalletAccount}
     #   if method was called with argument +n+ >  1
     # @raise [ArgumentError] if +n+ is less than 1
-    def create(n=1)
-      if n < 1
-        raise ArgumentError.new("number of accounts must be greater than 0")
-      end
+    def create(n_accounts = 1)
+      skip_account_required!
+      raise ArgumentError, 'number of accounts must be greater than 0' if n_accounts < 1
 
-      if n == 1
-        Nanook::WalletAccount.new(@rpc, @wallet, rpc(:account_create)[:account])
+      if n_accounts == 1
+        as_wallet_account(rpc(:account_create, _access: :account))
       else
-        Array(rpc(:accounts_create, count: n)[:accounts]).map do |account|
-          Nanook::WalletAccount.new(@rpc, @wallet, account)
+        rpc(:accounts_create, count: n_accounts, _access: :accounts, _coerce: Array).map do |account|
+          as_wallet_account(account)
         end
       end
     end
@@ -100,27 +133,28 @@ class Nanook
     #
     # @return [Boolean] +true+ if action was successful, otherwise +false+
     def destroy
-      rpc(:account_remove)[:removed] == 1
+      rpc(:account_remove, _access: :removed) == 1
     end
 
     # @return [String]
-    def inspect
-      "#{self.class.name}(wallet_id: #{@wallet}, account_id: #{id}, object_id: \"#{"0x00%x" % (object_id << 1)}\")"
+    def to_s
+      "#{self.class.name}(id: \"#{short_id}\")"
     end
+    alias inspect to_s
 
     # Makes a payment from this account to another account
     # on the nano network. Returns a <i>send</i> block hash
-    # if successful, or a {Nanook::Error} if unsuccessful.
+    # if successful, or a {Nanook::NodeRpcError} 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://docs.nano.org/commands/rpc-protocol/#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]
@@ -129,42 +163,34 @@ class Nanook
     #   purpose; it allows you to make the same call multiple times with
     #   the same +id+ and be reassured that you will only ever send this
     #   nano payment once
-    # @return [String] the send block id for the payment
-    # @raise [Nanook::Error] if unsuccessful
-    def pay(to:, amount:, unit: Nanook::default_unit, id:)
-      unless Nanook::UNITS.include?(unit)
-        raise ArgumentError.new("Unsupported unit: #{unit}")
-      end
+    # @return [Nanook::Block] the send block for the payment
+    # @raise [Nanook::NodeRpcError] if unsuccessful
+    # @raise [Nanook::NanoUnitError] if `unit` is invalid
+    def pay(to:, amount:, id:, unit: Nanook.default_unit)
+      validate_unit!(unit)
 
       # Check that to account is a valid address
-      response = @rpc.call(:validate_account_number, account: to)
-      unless response[:valid] == 1
-        raise ArgumentError.new("Account address is invalid: #{to}")
-      end
+      valid = @rpc.call(:validate_account_number, account: to, _access: :valid) == 1
+      raise ArgumentError, "Account address is invalid: #{to}" unless valid
 
-      # Determin amount in raw
+      # Determine amount in raw
       raw = if unit.to_sym.eql?(:nano)
-        Nanook::Util.NANO_to_raw(amount)
-      else
-        amount
-      end
+              NANO_to_raw(amount)
+            else
+              amount
+            end
 
       # account is called source, so don't use the normal rpc method
-      p = {
+      params = {
         wallet: @wallet,
         source: @account,
         destination: to,
         amount: raw,
-        id: id
+        id: id,
+        _access: :block
       }
 
-      response = @rpc.call(:send, p)
-
-      if response.has_key?(:error)
-        return Nanook::Error.new(response[:error])
-      end
-
-      response[:block]
+      as_block(@rpc.call(:send, params))
     end
 
     # Receives a pending payment for this account.
@@ -181,19 +207,17 @@ class Nanook
     #
     # ==== Examples:
     #
-    #   account.receive               # => "9AE2311..."
-    #   account.receive("718CC21...") # => "9AE2311..."
+    #   account.receive               # => Nanook::Block
+    #   account.receive("718CC21...") # => Nanook::Block
     #
     # @param block [String] optional block id of pending payment. If
     #   not provided, the latest pending payment will be received
-    # @return [String] the receive block id
+    # @return [Nanook::Block] the receive block
     # @return [false] if there was no block to receive
-    def receive(block=nil)
-      if block.nil?
-        _receive_without_block
-      else
-        _receive_with_block(block)
-      end
+    def receive(block = nil)
+      return receive_without_block if block.nil?
+
+      receive_with_block(block)
     end
 
     # Sets the representative for the account.
@@ -206,50 +230,89 @@ class Nanook
     # broadcast to the nano network. The block contains the information
     # about the representative change for your account.
     #
+    # Also see {Nanook::Wallet#change_default_representative} for how to set a default
+    # representative for all new accounts created in a wallet.
+    #
     # ==== Example:
     #
-    #   account.change_representative("xrb_...") # => "000D1BAEC8EC208142C99059B393051BAC8380F9B5A2E6B2489A277D81789F3F"
+    #   account.change_representative("nano_...") # => Nanook::Block
     #
-    # @param [String] representative the id of the representative account
+    # @param representative [String] the id of the representative account
     #   to set as this account's representative
-    # @return [String] id of the <i>change</i> block created
-    # @raise [ArgumentError] if the representative account does not exist
+    # @return [Nanook::Block] <i>change</i> block created
+    # @raise [Nanook::Error] if setting the representative account fails
     def change_representative(representative)
-      unless Nanook::Account.new(@rpc, representative).exists?
-        raise ArgumentError.new("Representative account does not exist: #{representative}")
+      unless as_account(representative).exists?
+        raise Nanook::Error, "Representative account does not exist: #{representative}"
       end
 
-      rpc(:account_representative_set, representative: representative)[:block]
+      params = {
+        representative: representative,
+        _access: :block
+      }
+
+      as_block(rpc(:account_representative_set, params))
+    end
+
+    # Returns the work for the account.
+    #
+    # ==== Example:
+    #
+    #   account.work # => "432e5cf728c90f4f"
+    #
+    # @return [String] work
+    def work
+      rpc(:work_get, _access: :work)
+    end
+
+    # Set work for account.
+    #
+    # ==== Example:
+    #
+    #   account.set_work("432e5cf728c90f4f") # => true
+    #
+    # @return [Boolean] true if action was successful
+    def set_work(work)
+      rpc(:work_set, work: work).key?(:success)
     end
 
     private
 
-    def _receive_without_block
+    def receive_without_block
       # Discover the first pending block
-      pending_blocks = @rpc.call(:pending, { account: @account, count: 1 })
+      block = @rpc.call(:pending, { account: @account, count: 1, _access: :blocks, _coerce: Array }).first
 
-      if pending_blocks[:blocks].empty?
-        return false
-      end
+      return false unless block
 
       # Then call receive_with_block as normal
-      block = pending_blocks[:blocks][0]
-      _receive_with_block(block)
+      receive_with_block(block)
     end
 
     # Returns block if successful, otherwise false
-    def _receive_with_block(block)
-      response = rpc(:receive, block: block)[:block]
-      response.nil? ? false : response
+    def receive_with_block(block)
+      response = rpc(:receive, block: block, _access: :block)
+      response ? as_block(response) : false
     end
 
-    def rpc(action, params={})
-      p = {}
-      p[:wallet] = @wallet unless @wallet.nil?
-      p[:account] = @account unless @account.nil?
+    def rpc(action, params = {})
+      check_account_required!
 
-      @rpc.call(action, p.merge(params))
+      p = { wallet: @wallet, account: @account }.compact
+      @rpc.call(action, p.merge(params)).tap { reset_skip_account_required! }
     end
 
+    def skip_account_required!
+      @skip_account_required_check = true
+    end
+
+    def reset_skip_account_required!
+      @skip_account_required_check = false
+    end
+
+    def check_account_required!
+      return if @account || @skip_account_required_check
+
+      raise ArgumentError, 'Account must be present'
+    end
   end
 end

data/lib/nanook/work_peer.rb

@@ -1,31 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'util'
+
 class Nanook
+  # The <tt>Nanook::WorkPeer</tt> class lets you manage your node's work peers.
   class WorkPeer
+    include Nanook::Util
 
     def initialize(rpc)
       @rpc = rpc
     end
 
     def add(address:, port:)
-      rpc(:work_peer_add, address: address, port: port).has_key?(:success)
+      rpc(:work_peer_add, address: address, port: port).key?(:success)
     end
 
     def clear
-      rpc(:work_peers_clear).has_key?(:success)
+      rpc(:work_peers_clear).key?(:success)
     end
 
-    def inspect
-      "#{self.class.name}(object_id: \"#{"0x00%x" % (object_id << 1)}\")"
+    # @return [String]
+    def to_s
+      self.class.name
     end
+    alias inspect to_s
 
     def list
-      rpc(:work_peers)[:work_peers]
+      rpc(:work_peers, _access: :work_peers, _coerce: Array)
     end
 
     private
 
-    def rpc(action, params={})
+    def rpc(action, params = {})
       @rpc.call(action, params)
     end
-
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanook
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Luke Duncalfe
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-04-16 00:00:00.000000000 Z
+date: 2021-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -44,99 +44,100 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rspec-collection_matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.20
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.20
 - !ruby/object:Gem::Dependency
   name: symbolized
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.0.1
-description: Ruby library for managing a nano currency node, including making and
+description: |
+  Library for managing a nano currency node, including making and
   receiving payments, using the nano RPC protocol
 email:
 - lduncalfe@eml.cc
@@ -152,9 +153,10 @@ files:
 - lib/nanook.rb
 - lib/nanook/account.rb
 - lib/nanook/block.rb
-- lib/nanook/error.rb
-- lib/nanook/key.rb
+- lib/nanook/errors.rb
 - lib/nanook/node.rb
+- lib/nanook/private_key.rb
+- lib/nanook/public_key.rb
 - lib/nanook/rpc.rb
 - lib/nanook/util.rb
 - lib/nanook/version.rb
@@ -166,7 +168,7 @@ licenses:
 - MIT
 metadata:
   yard.run: yri
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -181,9 +183,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Library for managing a nano currency node, including making and receiving
   payments, using the nano RPC protocol