RecordsKeeperRubyLib 0.1.0 → 0.1.1

data/lib/{RecordsKeeperRuby → RecordsKeeperRubyLib}/block.rb

@@ -1,89 +1,94 @@
-# Library to work with RecordsKeeper blocks.
-
-#   You can retrieve complete block information by using block class.
-#   You just have to pass parameters to invoke the pre-defined functions.
-
-# Import the following libraries
-
-require 'rubygems'
-require 'httparty'
-require 'json'
-require 'binary_parser'
-require 'yaml'
-
-module RecordsKeeperRuby
-	class Block
-
-		#Entry point for accessing Block class resources.
-		#Import values from config file.
-		cfg = YAML::load(File.open('config.yaml','r'))
-		@network = cfg['testnet']								# Network variable to store the networrk that you want to access
-		if @network==cfg['testnet']
-			@url = cfg['testnet']['url']
-			@user = cfg['testnet']['rkuser']
-			@password = cfg['testnet']['passwd']
-			@chain = cfg['testnet']['chain']
-		else
-			@url = cfg['mainnet']['url']
-			@user = cfg['mainnet']['rkuser']
-			@password = cfg['mainnet']['passwd']
-			@chain = cfg['mainnet']['chain']
-		end
-
-		def self.variable
-			net = @network
-			return net
-		end
-
-		def self.blockinfo block_height
-			auth = {:username => @user, :password => @password}
-			options = {
-				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-				:basic_auth => auth,
-				:body => [ {"method":"getblock","params":[block_height],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-			}
-			response = HTTParty.get(@url, options)
-			out = response.parsed_response
-			tx_count_number = out[0]['result']['tx']
-			tx_count = tx_count_number.length														# variable returns block's transaction count
-			miner = out[0]['result']['miner']														# variable returns block's miner
-			size = out[0]['result']['size']															# variable returns block's size
-			nonce = out[0]['result']['nonce']														# variable returns block's nonce
-			blockHash = out[0]['result']['hash']												# variable returns blockhash
-			prevblock = out[0]['result']['previousblockhash']						# variable returns prevblockhash
-			nextblock = out[0]['result']['nextblockhash']								# variable returns nextblockhash
-			merkleroot = out[0]['result']['merkleroot']									# variable returns merkleroot
-			blocktime = out[0]['result']['time']												# variable returns blocktime
-			difficulty = out[0]['result']['difficulty']									# variable returns difficulty
-			tx = []																											# list to store transaction ids
-			for i in 0...tx_count
-				tx.push(out[0]['result']['tx'][i])										# pushes transaction ids onto tx list
-			end
-			return  tx_count, tx, miner, size, nonce, blockHash, prevblock, nextblock, merkleroot, blocktime, difficulty;
-		end
-
-		def self.retrieveBlocks block_range
-			blockhash = []
-			miner = []
-			blocktime = []
-			tx_count = []
-			auth = {:username => @user, :password => @password}
-			options = {
-				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-				:basic_auth => auth,
-				:body => [ {"method":"listblocks","params":[block_range],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-			}
-			response = HTTParty.get(@url, options)
-			out = response.parsed_response
-			block_count_len = out[0]['result']
-			block_count = block_count_len.length
-			for i in 0...block_count
-				blockhash.push(out[0]['result'][i]['hash'])
-				miner.push(out[0]['result'][i]['miner'])
-				blocktime.push(out[0]['result'][i]['time'])
-				tx_count.push(out[0]['result'][i]['txcount'])
-			end
-			return blockhash, miner, blocktime, tx_count;
-		end
-	end
-end
+# Library to work with RecordsKeeper blocks.
+
+#   You can retrieve complete block information by using block class.
+#   You just have to pass parameters to invoke the pre-defined functions.
+
+# Import the following libraries
+
+require 'rubygems'
+require 'httparty'
+require 'json'
+require 'binary_parser'
+require 'yaml'
+
+module RecordsKeeperRubyLib
+	class Block
+		# # Entry point for accessing Block class functions
+		if File.exist?('config.yaml')
+			# Import values from configuration file.
+			cfg = YAML::load(File.open('config.yaml','r'))
+			
+			@url = cfg['url']
+			@user = cfg['rkuser']
+			@password = cfg['passwd']
+			@chain = cfg['chain']
+		
+		else
+			#Import using ENV variables
+			
+			@url = ENV['url']
+    		@user = ENV['rkuser']
+    		@password = ENV['passwd']
+    		@chain = ENV['chain']	
+		end
+
+		# function to retrieve data of a particular block no.
+		def self.blockinfo block_height
+			height = block_height.to_s
+			auth = {:username => @user, :password => @password}
+			options = {
+				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
+				:basic_auth => auth,
+				:body => [ {"method":"getblock","params":[height],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
+			}
+			response = HTTParty.get(@url, options)
+			out = response.parsed_response
+			tx_count_number = out[0]['result']['tx']
+			tx_count = tx_count_number.length														# variable returns block's transaction count
+			miner = out[0]['result']['miner']														# variable returns block's miner
+			size = out[0]['result']['size']															# variable returns block's size
+			nonce = out[0]['result']['nonce']														# variable returns block's nonce
+			blockHash = out[0]['result']['hash']												# variable returns blockhash
+			prevblock = out[0]['result']['previousblockhash']						# variable returns prevblockhash
+			nextblock = out[0]['result']['nextblockhash']								# variable returns nextblockhash
+			merkleroot = out[0]['result']['merkleroot']									# variable returns merkleroot
+			blocktime = out[0]['result']['time']												# variable returns blocktime
+			difficulty = out[0]['result']['difficulty']									# variable returns difficulty
+			tx = []																											# list to store transaction ids
+			for i in 0...tx_count
+				tx.push(out[0]['result']['tx'][i])										# pushes transaction ids onto tx list
+			end
+			retrieved = { :tx_count => tx_count,:miner => miner,:size => size,:nonce => nonce,:blockHash => blockHash,:prevblock => prevblock, :nextblock => nextblock,:merkleroot => merkleroot,:blocktime => blocktime,:difficulty => difficulty,:tx => tx}
+			retrievedinfo = JSON.generate retrieved
+			return retrievedinfo
+		end
+
+		# function to retrieve data of blocks in a particular range
+		def self.retrieveBlocks block_range
+			blockhash = []
+			miner = []
+			blocktime = []
+			tx_count = []
+			auth = {:username => @user, :password => @password}
+			options = {
+				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
+				:basic_auth => auth,
+				:body => [ {"method":"listblocks","params":[block_range],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
+			}
+			response = HTTParty.get(@url, options)
+			out = response.parsed_response
+			block_count_len = out[0]['result']
+			block_count = block_count_len.length
+			for i in 0...block_count
+				blockhash.push(out[0]['result'][i]['hash'])
+				miner.push(out[0]['result'][i]['miner'])
+				blocktime.push(out[0]['result'][i]['time'])
+				tx_count.push(out[0]['result'][i]['txcount'])
+			end
+			retrieved = { :blockhash => blockhash,:miner => miner,:blocktime => blocktime,:tx_count => tx_count}
+			retrievedinfo = JSON.generate retrieved
+			return retrievedinfo
+		end
+
+	end
+end

data/lib/{RecordsKeeperRuby → RecordsKeeperRubyLib}/blockchain.rb

@@ -1,135 +1,148 @@
-# 	Library to work with RecordsKeeper Blockchain.
-
-#   You can retrieve blockchain information, node's information, node's balance, node's permissions, pending transaction details
-# 		by using Blockchain class.
-#   You just have to pass parameters to invoke the pre-defined functions."""
-
-require 'rubygems'
-require 'httparty'
-require 'json'
-require 'binary_parser'
-require 'yaml'
-
-module RecordsKeeperRuby
-	class Blockchain
-
-		cfg = YAML::load(File.open('config.yaml','r'))
-		@network = cfg['testnet']
-		if @network==cfg['testnet']
-			@url = cfg['testnet']['url']
-			@user = cfg['testnet']['rkuser']
-			@password = cfg['testnet']['passwd']
-			@chain = cfg['testnet']['chain']
-		else
-			@url = cfg['mainnet']['url']
-			@user = cfg['mainnet']['rkuser']
-			@password = cfg['mainnet']['passwd']
-			@chain = cfg['mainnet']['chain']
-		end
-
-		def self.variable
-			net = @network
-			return net
-		end
-
-		# Function to retrieve RecordsKeeper Blockchain parameters
-		def self.getChainInfo
-			auth = {:username => @user, :password => @password}
-			options = {
-				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-				:basic_auth => auth,
-				:body => [ {"method":"getblockchainparams","params":[],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-			}
-			response = HTTParty.get(@url, options)
-			out = response.parsed_response
-			result = out[0]['result']
-			chain_protocol = result['chain-protocol']
-			chain_description = result['chain-description']
-			root_stream = result['root-stream-name']
-			max_blocksize = result['maximum-block-size']
-			default_networkport = result['default-network-port']
-			default_rpcport = result['default-rpc-port']
-			mining_diversity = result['mining-diversity']
-			chain_name = result['chain-name']
-			return chain_protocol, chain_description, root_stream, max_blocksize, default_networkport, default_rpcport, mining_diversity, chain_name;										#returns chain parameters
-		end
-
-		# Function to retrieve node's information on RecordsKeeper Blockchain
-		def self.getNodeInfo
-			auth = {:username => @user, :password => @password}
-			options = {
-				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-				:basic_auth => auth,
-				:body => [ {"method":"getinfo","params":[],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-			}
-			response = HTTParty.get(@url, options)
-			out = response.parsed_response
-			node_balance = out[0]['result']['balance']
-			synced_blocks = out[0]['result']['blocks']
-			node_address = out[0]['result']['nodeaddress']
-			difficulty = out[0]['result']['difficulty']
-			return node_balance, synced_blocks, node_address, difficulty;						# Returns node's details
-		end
-
-		# Function to retrieve node's permissions on RecordsKeeper Blockchain
-		def self.permissions
-			auth = {:username => @user, :password => @password}
-			options = {
-				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-				:basic_auth => auth,
-				:body => [ {"method":"listpermissions","params":[],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-			}
-			response = HTTParty.get(@url, options)
-			out = response.parsed_response
-			pms_count_len = out[0]['result']
-			pms_count = pms_count_len.length
-			permissions = []
-			for i in 0...pms_count
-				permissions.push(out[0]['result'][i]['type'])
-			end
-			return permissions;																# Returns list of permissions
-		end
-
-		# Function to retrieve pending transactions information on RecordsKeeper Blockchain
-		def self.getpendingTransactions
-			auth = {:username => @user, :password => @password}
-			options = {
-				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-				:basic_auth => auth,
-				:body => [ {"method":"getmempoolinfo","params":[],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-			}
-			response = HTTParty.get(@url, options)
-			out = response.parsed_response
-			tx_count = out[0]['result']['size']											# Stores pending tx count
-			auth = {:username => @user, :password => @password}
-			options = {
-				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-				:basic_auth => auth,
-				:body => [ {"method":"getrawmempool","params":[],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-			}
-			response2 = HTTParty.get(@url, options)
-			out2 = response2.parsed_response
-			tx = []
-			x = 0
-			begin
-				tx.push(out2[0]['result'])
-			end until x <tx_count
-			return tx_count, tx;														# Returns pending tx and tx count
-		end
-
-		# Function to check node's total balance
-		def self.checkNodeBalance
-			auth = {:username => @user, :password => @password}
-			options = {
-				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
-				:basic_auth => auth,
-				:body => [ {"method":"getmultibalances","params":[],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
-			}
-			response = HTTParty.get(@url, options)
-			out = response.parsed_response
-			balance = out[0]['result']['total'][0]['qty']
-			return balance;														# Returns balance of  node
-		end
-	end
-
-end
+# 	Library to work with RecordsKeeper Blockchain.
+
+#   You can retrieve blockchain information, node's information, node's balance, node's permissions, pending transaction details
+# 		by using Blockchain class.
+#   You just have to pass parameters to invoke the pre-defined functions."""
+
+require 'rubygems'
+require 'httparty'
+require 'json'
+require 'binary_parser'
+require 'yaml'
+
+module RecordsKeeperRubyLib
+	class Blockchain
+
+		# # Entry point for accessing Blockchain class functions
+		if File.exist?('config.yaml')
+			# Import values from configuration file.
+			cfg = YAML::load(File.open('config.yaml','r'))
+			
+			@url = cfg['url']
+			@user = cfg['rkuser']
+			@password = cfg['passwd']
+			@chain = cfg['chain']
+		
+		else
+			#Import using ENV variables
+			
+			@url = ENV['url']
+    		@user = ENV['rkuser']
+    		@password = ENV['passwd']
+    		@chain = ENV['chain']	
+		end
+
+		# Function to retrieve RecordsKeeper Blockchain parameters
+		def self.getChainInfo
+			auth = {:username => @user, :password => @password}
+			options = {
+				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
+				:basic_auth => auth,
+				:body => [ {"method":"getblockchainparams","params":[],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
+			}
+			response = HTTParty.get(@url, options)
+			out = response.parsed_response
+			result = out[0]['result']
+			chain_protocol = result['chain-protocol']
+			chain_description = result['chain-description']
+			root_stream = result['root-stream-name']
+			max_blocksize = result['maximum-block-size']
+			default_networkport = result['default-network-port']
+			default_rpcport = result['default-rpc-port']
+			mining_diversity = result['mining-diversity']
+			chain_name = result['chain-name']
+			info = {:chain_protocol => chain_protocol, :chain_description => chain_description, :root_stream => root_stream, :max_blocksize => max_blocksize, :default_networkport => default_networkport, :default_rpcport => default_rpcport, :mining_diversity => mining_diversity, :chain_name => chain_name}										#returns chain parameters
+			retrieved = JSON.generate info
+			return retrieved
+		end
+
+		# Function to retrieve node's information on RecordsKeeper Blockchain
+		def self.getNodeInfo
+			auth = {:username => @user, :password => @password}
+			options = {
+				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
+				:basic_auth => auth,
+				:body => [ {"method":"getinfo","params":[],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
+			}
+			response = HTTParty.get(@url, options)
+			out = response.parsed_response
+			node_balance = out[0]['result']['balance']
+			synced_blocks = out[0]['result']['blocks']
+			node_address = out[0]['result']['nodeaddress']
+			difficulty = out[0]['result']['difficulty']
+ 			info = {:node_balance => node_balance, :synced_blocks => synced_blocks,:node_address => node_address,:difficulty => difficulty}						# Returns node's details
+			retrieved = JSON.generate info
+			return retrieved
+		end
+
+		# Function to retrieve node's permissions on RecordsKeeper Blockchain
+		def self.permissions
+			auth = {:username => @user, :password => @password}
+			options = {
+				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
+				:basic_auth => auth,
+				:body => [ {"method":"listpermissions","params":[],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
+			}
+			response = HTTParty.get(@url, options)
+			out = response.parsed_response
+			pms_count_len = out[0]['result']
+			pms_count = pms_count_len.length
+			permissions = []
+			for i in 0...pms_count
+				permissions.push(out[0]['result'][i]['type'])
+			end
+
+			permissions_list = permissions.uniq
+			return permissions_list;																# Returns list of permissions
+		end
+
+		# Function to retrieve pending transactions information on RecordsKeeper Blockchain
+		def self.getpendingTransactions
+			auth = {:username => @user, :password => @password}
+			options = {
+				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
+				:basic_auth => auth,
+				:body => [ {"method":"getmempoolinfo","params":[],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
+			}
+			response = HTTParty.get(@url, options)
+			out = response.parsed_response
+			tx_count = out[0]['result']['size']											# Stores pending tx count
+
+			if tx_count==0
+				tx = "No pending transactions"
+			else
+				auth = {:username => @user, :password => @password}
+				options = {
+					:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
+					:basic_auth => auth,
+					:body => [ {"method":"getrawmempool","params":[],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
+				}
+				response2 = HTTParty.get(@url, options)
+				out2 = response2.parsed_response
+				tx = []
+				for i in 0...tx_count
+					tx.push(out2[0]['result'])
+				end
+			end
+			pending = {:tx_count => tx_count,:tx => tx}
+			pendingtransaction = JSON.generate pending														# Returns pending tx and tx count
+			return pendingtransaction
+		end
+
+		# Function to check node's total balance
+		def self.checkNodeBalance
+			auth = {:username => @user, :password => @password}
+			options = {
+				:headers => headers= {"Content-Type"=> "application/json","Cache-Control" => "no-cache"},
+				:basic_auth => auth,
+				:body => [ {"method":"getmultibalances","params":[],"jsonrpc":2.0,"id":"curltext","chain_name":@chain}].to_json
+			}
+			response = HTTParty.get(@url, options)
+			out = response.parsed_response
+
+			balance = out[0]['result']['total'][-1]['qty']
+			return balance;														# Returns balance of  node
+		end
+	end
+
+end