iota-ruby 1.1.5 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7213d4251e2127c9eb86cc3e6962357f9b174a9d
-  data.tar.gz: 8de076c67c080a09864226c81cb8c9f37d706ba8
+  metadata.gz: 001faa9697735af3ccb7dc1b9e853808a09d9ebc
+  data.tar.gz: 46f4cb83b7559dad8265ec8b3b4e080467c180db
 SHA512:
-  metadata.gz: 59003e99d4eeb6e956e4a6675ebaa1081e8d357dd4f74e1f7823765095c28dcab425ac2e2068826c6f62a9b4219052c9cf400a9be568b44b76430299a83ea72f
-  data.tar.gz: 88d1cbdeb5958ebf3247e5c971a6d5ca80a24d2a281e49ce30c720cba4cacef9d0b9275bf1771a4fbd436a657d3abc7fdd2f76e7c9452ed6160acba0623a52b5
+  metadata.gz: f9057f008b0a7647b49ff7d9a3bd11e5c719f42f39922d4ae819ce214377fd2ff1d3b7f06e63115a6b01b5723966d3f1f4e4e250cd929e5a351d078228593df1
+  data.tar.gz: a6209e6d04d1295017d4e738cd8770e0e18036cdf45be69ffc6155227655685fa815f6b4dd60bee1ff1418d881da17f738a35eda07ca58493df2b8c9ae9dc7d1

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## [1.1.6] - 2018-07-22
+### Added
+- `wasAddressSpentFrom` API
+- Inbuilt batching for following apis: `getTrytes`, `getBalances`, `wereAddressesSpentFrom`, `getInclusionStates` & `findTransactions`
+- adding changelog file to keep track of future changes
+
+### Changed
+- Only returning balance array as reponse for `getBalances` api call (Major)

data/README.md

@@ -9,7 +9,7 @@ This is the **unofficial** Ruby gem for the IOTA Core. It implements both the [o
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'iota-ruby', '~> 1.1.2'
+gem 'iota-ruby'
 ```
 
 And then execute:
@@ -87,4 +87,4 @@ else
 end
 ```
 
-If you'd like to support development, please consider donating to my IOTA address: **LOBYBAFIKJFEGTLCCQSHOPX9ROIRAI99QSTD9BRALHMHUOISF9DIZJYICXAIQMJCPZYTXMRMPOWG9WOICGMMNHQIH9**
+If you'd like to support development, please consider donating to my IOTA address: **SGBYR9DXPBPGTFLILQWAYIMINZ9MQAFKGDBHQSXGLKNIHCQZEDYPVNRMDVWFPXQTAIVKWCVWXVXZVZ9R9HIKTZWUAC**

data/lib/iota.rb

@@ -8,6 +8,7 @@ require "iota/utils/broker"
 
 require "iota/api/commands"
 require "iota/api/wrappers"
+require "iota/api/transport"
 require "iota/api/api"
 
 require "iota/crypto/curl"
@@ -31,7 +32,7 @@ require "iota/models/account"
 
 module IOTA
   class Client
-    attr_reader :version, :host, :port, :provider, :sandbox, :token, :broker, :api, :utils, :validator, :multisig
+    attr_reader :version, :host, :port, :provider, :sandbox, :token, :broker, :api, :utils, :validator, :multisig, :batch_size
 
     def initialize(settings = {})
       setSettings(settings)
@@ -56,6 +57,7 @@ module IOTA
       @sandbox = settings[:sandbox] || false
       @token = settings[:token] || false
       @timeout = settings[:timeout] || 120
+      @batch_size = settings[:batch_size] || 500
 
       if @sandbox
         @sandbox = @provider.gsub(/\/$/, '')
@@ -63,7 +65,7 @@ module IOTA
       end
 
       @broker = IOTA::Utils::Broker.new(@provider, @token, @timeout)
-      @api = IOTA::API::Api.new(@broker, @sandbox)
+      @api = IOTA::API::Api.new(@broker, @sandbox, @batch_size)
     end
 
     def symbolize_keys(hash)

data/lib/iota/api/api.rb

@@ -2,17 +2,15 @@ module IOTA
   module API
     class Api
       include Wrappers
+      include Transport
 
-      def initialize(broker, sandbox)
+      def initialize(broker, sandbox, batch_size = 500)
         @broker = broker
         @sandbox = sandbox
         @commands = Commands.new
         @utils = IOTA::Utils::Utils.new
         @validator = @utils.validator
-      end
-
-      def sendCommand(command, &callback)
-        @broker.send(command, &callback)
+        @batch_size = batch_size
       end
 
       def findTransactions(searchValues, &callback)
@@ -23,7 +21,8 @@ module IOTA
         searchKeys = searchValues.keys
         validKeys = ['bundles', 'addresses', 'tags', 'approvees']
 
-        error = false;
+        error = false
+        entry_count = 0
 
         searchKeys.each do |key|
           if !validKeys.include?(key.to_s)
@@ -32,6 +31,7 @@ module IOTA
           end
 
           hashes = searchValues[key]
+          entry_count += hashes.count
 
           if key.to_s == 'addresses'
             searchValues[key] = hashes.map do |address|
@@ -66,18 +66,21 @@ module IOTA
         if error
           return sendData(false, error, &callback)
         else
-          sendCommand(@commands.findTransactions(searchValues), &callback)
+          if entry_count <= @batch_size || searchKeys.count > 1
+            return sendCommand(@commands.findTransactions(searchValues), &callback)
+          else
+            return sendBatchedCommand(@commands.findTransactions(searchValues), &callback)
+          end
         end
       end
 
       def getBalances(addresses, threshold, &callback)
-        # Check if correct transaction hashes
         if !@validator.isArrayOfHashes(addresses)
           return sendData(false, "Invalid Trytes provided", &callback)
         end
 
         command = @commands.getBalances(addresses.map{|address| @utils.noChecksum(address)}, threshold)
-        sendCommand(command, &callback)
+        sendBatchedCommand(command, &callback)
       end
 
       def getTrytes(hashes, &callback)
@@ -85,21 +88,15 @@ module IOTA
           return sendData(false, "Invalid Trytes provided", &callback)
         end
 
-        sendCommand(@commands.getTrytes(hashes), &callback)
+        sendBatchedCommand(@commands.getTrytes(hashes), &callback)
       end
 
       def getInclusionStates(transactions, tips, &callback)
-        # Check if correct transaction hashes
-        if !@validator.isArrayOfHashes(transactions)
-          return sendData(false, "Invalid Trytes provided", &callback)
-        end
-
-        # Check if correct tips
-        if !@validator.isArrayOfHashes(tips)
+        if !@validator.isArrayOfHashes(transactions) || !@validator.isArrayOfHashes(tips)
           return sendData(false, "Invalid Trytes provided", &callback)
         end
 
-        sendCommand(@commands.getInclusionStates(transactions, tips), &callback)
+        sendBatchedCommand(@commands.getInclusionStates(transactions, tips), &callback)
       end
 
       def getNodeInfo(&callback)
@@ -193,6 +190,15 @@ module IOTA
         sendCommand(@commands.checkConsistency(tails), &callback)
       end
 
+      def wereAddressesSpentFrom(addresses, &callback)
+        if !@validator.isArrayOfHashes(addresses)
+          return sendData(false, "Invalid Trytes provided", &callback)
+        end
+
+        command = @commands.wereAddressesSpentFrom(addresses.map{|address| @utils.noChecksum(address)})
+        sendBatchedCommand(command, &callback)
+      end
+
       private
       def sendData(status, data, &callback)
         callback ? callback.call(status, data) : [status, data]

data/lib/iota/api/commands.rb

@@ -6,7 +6,7 @@ module IOTA
           command: 'findTransactions'
         }
 
-        searchValues.each { |k, v| command[k] = v }
+        searchValues.each { |k, v| command[k.to_sym] = v }
 
         command
       end
@@ -101,6 +101,13 @@ module IOTA
           tails: tails
         }
       end
+
+      def wereAddressesSpentFrom(addresses)
+        {
+          command: 'wereAddressesSpentFrom',
+          addresses: addresses
+        }
+      end
     end
   end
 end

data/lib/iota/api/transport.rb

@@ -0,0 +1,43 @@
+module IOTA
+  module API
+    module Transport
+      def sendCommand(command, &callback)
+        @broker.send(command, &callback)
+      end
+
+      def sendBatchedCommand(command, &callback)
+        # Key and value both should be symbols
+        mapping = {
+          getTrytes: [ :hashes ],
+          getBalances: [ :addresses ],
+          wereAddressesSpentFrom: [ :addresses ],
+          getInclusionStates: [ :transactions ],
+          findTransactions: [ :bundles, :addresses, :tags, :approvees ]
+        }
+
+        command_name = command[:command].to_sym
+        if mapping[command_name]
+          results = []
+
+          keys_to_batch = mapping[command_name]
+          keys_to_batch.each do |key|
+            if command[key]
+              command[key].each_slice(@batch_size) do |group|
+                batchedCommand = command.clone.merge({ key => group })
+                sendCommand(batchedCommand) do |status, response|
+                  if !status
+                    return sendData(false, response, &callback)
+                  end
+                  results += response
+                end
+              end
+            end
+          end
+          return sendData(true, results, &callback)
+        else
+          return sendCommand(command, &callback)
+        end
+      end
+    end
+  end
+end

data/lib/iota/api/wrappers.rb

@@ -10,7 +10,7 @@ module IOTA
         ret_status = false
         ret_data = nil
         # get the trytes of the transaction hashes
-        getTrytesInBatches(hashes) do |status, trytes|
+        getTrytes(hashes) do |status, trytes|
           ret_status = status
           if status
             transactionObjects = []
@@ -425,25 +425,6 @@ module IOTA
           end
         end
       end
-
-      def getTrytesInBatches(hashes, batchSize = 500, &callback)
-        if !@validator.isArrayOfHashes(hashes)
-          return sendData(false, "Invalid Trytes provided", &callback)
-        end
-
-        data = []
-
-        hashes.each_slice(batchSize) do |group|
-          getTrytes(group) do |status, trytes|
-            if !status
-              return sendData(false, trytes, &callback)
-            end
-            data += trytes
-          end
-        end
-
-        sendData(true, data, &callback)
-      end
     end
   end
 end

data/lib/iota/models/account.rb

@@ -58,7 +58,7 @@ module IOTA
               raise StandardError, balancesData
             end
 
-            balancesData['balances'].each_with_index do |balance, index|
+            balancesData.each_with_index do |balance, index|
               balance = balance.to_i
               @balance += balance
 
@@ -208,7 +208,7 @@ module IOTA
               confirmedInputs = []
               totalBalance = 0
 
-              balances['balances'].each_with_index do |balance, i|
+              balances.each_with_index do |balance, i|
                 # If input has balance, add it to confirmedInputs
                 balance = balance.to_i
 
@@ -318,9 +318,22 @@ module IOTA
           loop do
             newAddress = @seed.getAddress(index, security, checksum)
 
-            @api.findTransactions(addresses: [newAddress]) do |status, trx_hashes|
+            @api.wereAddressesSpentFrom([newAddress]) do |status, spent_states|
               if !status
-                raise StandardError, trx_hashes
+                raise StandardError, spent_states
+              end
+
+              spent = spent_states[0]
+
+              # Check transactions if not spent
+              if !spent
+                @api.findTransactions(addresses: [newAddress]) do |status, trx_hashes|
+                  if !status
+                    raise StandardError, trx_hashes
+                  end
+
+                  spent = trx_hashes.length > 0
+                end
               end
 
               if return_all
@@ -328,8 +341,7 @@ module IOTA
               end
 
               index += 1
-
-              return (return_all ? allAddresses : newAddress) if trx_hashes.length == 0
+              return (return_all ? allAddresses : newAddress) if !spent
             end
           end
         end

data/lib/iota/multisig/multisig.rb

@@ -125,7 +125,7 @@ module IOTA
               if !st1
                 raise StandardError, "Error fetching balances: #{balances}"
               else
-                return createBundle(balances['balances'][0].to_i, totalValue, bundle, input, remainderAddress, tag, signatureFragments)
+                return createBundle(balances[0].to_i, totalValue, bundle, input, remainderAddress, tag, signatureFragments)
               end
             end
           end

data/lib/iota/utils/broker.rb

@@ -98,7 +98,9 @@ module IOTA
           'getTrytes'             =>   'trytes',
           'getInclusionStates'    =>   'states',
           'attachToTangle'        =>   'trytes',
-          'checkConsistency'      =>   'state'
+          'checkConsistency'      =>   'state',
+          'getBalances'           =>   'balances',
+          'wereAddressesSpentFrom'=>   'states'
         }
 
         # If correct result and we want to prepare the result

data/lib/iota/version.rb

@@ -1,3 +1,3 @@
 module IOTA
-  VERSION = "1.1.5"
+  VERSION = "1.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iota-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.6
 platform: ruby
 authors:
 - Vivek Marakana
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-11 00:00:00.000000000 Z
+date: 2018-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,6 +92,7 @@ files:
 - ".editorconfig"
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -104,6 +105,7 @@ files:
 - lib/iota.rb
 - lib/iota/api/api.rb
 - lib/iota/api/commands.rb
+- lib/iota/api/transport.rb
 - lib/iota/api/wrappers.rb
 - lib/iota/crypto/bundle.rb
 - lib/iota/crypto/converter.rb