banano 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11765178fb87fa12d30b11dbe6c454af09e87c2b2ba389e368669698809ee256
-  data.tar.gz: dee6f73a715b2b9e400491fbef8fdfbbb732051ad3d297e1dc49a3803306a0c9
+  metadata.gz: 142f940e2f3c62e5d2c5d1b4e41947f4bb3aa4d09afa6ef7499692538e43cc96
+  data.tar.gz: 8738e7a8e8675e595901e55e2ff2d7acd3841c0695460ca5b66e1e382ec3eddd
 SHA512:
-  metadata.gz: b1cca559663f4ec639fe847d5425c1babf9be16d0d8477af593b9034f3f2093e24e6ea109e7ae6a30b53cc9af3246f061c703d3e6b5f87f2c37ec5d7bebd9c7e
-  data.tar.gz: 37b0964c5ff8a431f403ef81f3eba4df3b44a9238026e3e6b28b993fccf8cd2aff1087ad386597a17a5f0bf1f83fac36ae4f2d193315d3a8ca4178aaea08ba4a
+  metadata.gz: abbacfa91f2ebd5b1cad6e736bc43b63ba65e4c4a0d1b4828624ae1807135f73c2ac6ee40d431e25ebf13f8ade1b480c038f0f8b19854521417e1dc5a74b67d2
+  data.tar.gz: b3e36db244547b823e407536c7951fc2d224502c2abf260eeb1cee0df2b76426831d2916c8c988609b3c7b3f2b621dca2fbe88191a4c87ccc7a2d89bea789d1c

data/CHANGELOG.md

@@ -1,2 +1,12 @@
+## v0.1.1
+
+- Pending payments fixes - block\_id is mandatory
+- Unit conversion on payment bug fixed
+- Some artifacts cleaned up
+- Banano::Key usage added
+- Stringify keys and remove zero balances for Node RPC call responses
+
+## v0.1.0
+
 - Initial import
 - Gem packaging

data/README.md

@@ -40,9 +40,10 @@ The code is divided on following the parts:
 - `Banano::Protocol` - including all other parts. Can be used also for some syntax sugar (to avoid sending node parameter to constructors)
 - `Banano::Client` - very thin wrapper around [Faraday HTTP Client](https://github.com/lostisland/faraday) for easy JSON-based communications
 - `Banano::Node` - Banano Node abstraction - mostly encapsulate JSON communications
-- `Bananp::Wallet` - wallets holding for Banano accounts on the current node
-- `Bananp::Account` - uniq 'ban_...' addresses used for currency tokens exchange
-- `Bananp::WalletAccount` - link between `Account` and `Wallet` - check if account exists in the wallet etc.
+- `Banano::Wallet` - wallets holding for Banano accounts on the current node
+- `Banano::Account` - uniq 'ban_...' addresses used for currency tokens exchange
+- `Banano::WalletAccount` - link between `Account` and `Wallet` - check if account exists in the wallet etc.
+- `Banano::Key` - account key management
 
 ### Banano::Protocol
 
@@ -56,6 +57,7 @@ BETA_URL = 'https://api-beta.banano.cc'
 wallet = @banano.wallet('WALLET15263636...')
 account = @banano.account('ban_1...')
 ```
+
 ### Banano::Client
 
 Not used directly, better use `Banano::Node` instead
@@ -67,7 +69,7 @@ client.rpc_call(action: :version)
 
 ### Banano::Node
 
-Most of the information about the running node is encapsulated here. The other parts using  mostly the `Banano::Node.rpc()` method, not the low level client one: 
+Most of the information about the running node is encapsulated here. The other parts using  mostly the `Banano::Node.rpc()` method, not the low level client one:
 
 ```rb
 Banano::Node.account_count # number of node accounts
@@ -144,6 +146,23 @@ wallet_other_acc.receive   # receive some banano
 
 ```
 
+### Banano::Key
+
+Most of the information is identicat with the [NANO currency docs](https://docs.nano.org/integration-guides/key-management/).
+
+```rb
+key_builder = @banano.key    # create new key (still unpopulated, cannot be used)
+key_builder.generate         # generate private, public key and account address
+{:private=>"43E6B...",
+ :public=>"7EBC0C...",
+ :account=>"ban_1zow3..."}
+SEED = 'ABF56EBB...'         # Random seed
+key_builder.generate(seed: SEED, index: 0)    # will always generate SAME pair of keys and address
+key_builder.generate(seed: SEED, index: 1)
+new_builder = @banano.key(saved_private_key)  # generate keys from saved private key
+new_builder.expand                            # return private, public key and account address
+``` 
+
 ### Banano::Unit
 
 Using [Ruby bigdecimal library](https://apidock.com/ruby/BigDecimal) for all operations:

data/lib/banano/account.rb

@@ -104,7 +104,7 @@ module Banano
       params = {count: limit}
       params[:source] = true if detailed
 
-      response = rpc(action: :pending, params: params)[:blocks]
+      response = rpc(action: :wallet_pending, params: params)[:blocks]
       return response unless detailed && !response.empty?
 
       response.map do |key, val|

data/lib/banano/node.rb

@@ -45,7 +45,8 @@ module Banano
 
     # @return [Hash{Symbol=>String}] information about the node peers
     def peers
-      rpc(action: :peers)[:peers]
+      h = -> (h) { Hash[h.map{ |k,v| [k.to_s, v] }] }
+      h.call(rpc(action: :peers)[:peers])
     end
 
     # All representatives and their voting weight.
@@ -54,6 +55,7 @@ module Banano
     # @return [Hash{Symbol=>Integer}] known representatives and their voting weight
     def representatives(raw = true)
       response = rpc(action: :representatives)[:representatives]
+      response = response.delete_if {|_, balance| balance.to_s == '0' } # remove 0 balance reps
       return response if raw == true
 
       r = response.map do |address, balance|

data/lib/banano/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Banano
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/banano/wallet.rb

@@ -70,7 +70,7 @@ module Banano
     #   wallet.account.create     # => Banano::WalletAccount
     #
     # @param [String] account optional String of an account (starting with
-    #   <tt>"xrb..."</tt>) to start working with. Must be an account within
+    #   <tt>"ban_..."</tt>) to start working with. Must be an account within
     #   the wallet. When no account is given, the instance returned only
     #   allows you to call +create+ on it, to create a new account.
     # @raise [ArgumentError] if the wallet does no contain the account
@@ -357,17 +357,12 @@ module Banano
 
     # Receives a pending payment into an account in the wallet.
     #
-    # When called with no +block+ argument, the latest pending payment
-    # for the account will be received.
-    #
     # Returns a <i>receive</i> block hash id if a receive was successful,
     # or +false+ if there were no pending payments to receive.
     #
-    # You can receive a specific pending block if you know it by
-    # passing the block has in as an argument.
+    # Receive a specific pending block by passing block_id as an argument
     # ==== Examples:
     #
-    #   wallet.receive(into: "ban_..")               # => "9AE2311..."
     #   wallet.receive("718CC21...", into: "ban_..") # => "9AE2311..."
     #
     # @param block (see Banano::WalletAccount#receive)
@@ -375,7 +370,7 @@ module Banano
     #   payment into
     #
     # @return (see Banano::WalletAccount#receive)
-    def receive(block: nil, into:)
+    def receive(block:, into:)
       wallet_required!
       validate_wallet_contains_account!(into)
       # account(into) will return Banano::WalletAccount
@@ -388,7 +383,7 @@ module Banano
     #
     # ==== Example:
     #
-    #   Banano::Protocol.new.wallet.restore(seed) # => Nanook::Wallet
+    #   Banano::Protocol.new.wallet.restore(seed: seed, accounts: 1) # => Banano::Wallet
     #
     # @param seed [String] the wallet seed to restore.
     # @param accounts [Integer] optionally restore the given number of accounts for the wallet.
@@ -398,7 +393,7 @@ module Banano
     def restore(seed:, accounts: 0)
       create
 
-      raise Nanook::Error, "Unable to set seed for wallet" unless change_seed(seed)
+      raise Banano::Error, "Unable to set seed for wallet" unless change_seed(seed)
 
       account.create(accounts) if accounts > 0
       self

data/lib/banano/wallet_account.rb

@@ -7,6 +7,8 @@ require 'forwardable'
 #
 module Banano
   class WalletAccount
+    attr_accessor :account, :wallet
+
     extend Forwardable
     # @!method balance(raw: true)
     #   (see Banano::Account#balance)
@@ -128,7 +130,7 @@ module Banano
       response = rpc(action: :validate_account_number, params: {account: to})
       raise ArgumentError, "Account address is invalid: #{to}" unless response[:valid] == '1'
 
-      raw_amount = raw ? amount : Banano::Unit.ban_to_raw(amount)
+      raw_amount = raw ? amount : Banano::Unit.ban_to_raw(amount).to_s
       # account is called source, so don't use the normal rpc method
       p = {
         wallet: @wallet,
@@ -157,20 +159,15 @@ module Banano
     #
     # ==== Examples:
     #
-    #   account.receive               # => "9AE2311..."
     #   account.receive("718CC21...") # => "9AE2311..."
     #
-    # @param block [String] optional block id of pending payment. If
-    #   not provided, the latest pending payment will be received
+    # @param block [String] block id of pending payment.
     #
     # @return [String] the receive block id
     # @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)
+      response = rpc(action: :receive, params: {block: block})[:block]
+      response.nil? ? false : response
     end
 
     # Sets the representative for the account.
@@ -198,22 +195,6 @@ module Banano
 
     private
 
-    def _receive_without_block
-      # Discover the first pending block
-      pending_blocks = rpc(action: :pending, params: {account: @account, count: 1})
-
-      return false if pending_blocks[:blocks].empty?
-
-      # Then call receive_with_block as normal
-      _receive_with_block(pending_blocks[:blocks][0])
-    end
-
-    # Returns block if successful, otherwise false
-    def _receive_with_block(block)
-      response = rpc(action: :receive, params: {block: block})[:block]
-      response.nil? ? false : response
-    end
-
     def rpc(action:, params: {})
       p = {}
       return p unless @wallet

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: banano
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Stoyan Zhekov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-21 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday