RecordsKeeperRubyLib 0.1.0 → 0.1.1

data/docs/{assetsdoc.rb → asset_doc.rb}

@@ -1,65 +1,54 @@
-# = Assets Class Usage
-# This is a library to work with RecordsKeeper assets.
-# You can create new assets and list all assets by using Assets class. You just have to pass parameters to invoke the pre-defined functions.
-# ---------
-# == Libraries
-# Require these ruby libraries first to get started with the functionality.
-#  require 'rubygems'
-#  require 'httparty'
-#  require 'json'
-#  require 'binary_parser'
-#  require 'yaml'
-# -----------------
-# == Create Connection
-# Entry point for accessing Address class resources.
-# * URL: Url to connect to the chain ([RPC Host]:[RPC Port])
-# * Chain-name: chain name
-#  cfg = YAML::load(File.open('sample_config.yaml','r'))		# Loads the configuration file
-# * Set a *network* value to change the network-type
-#  network = cfg['testnet']                    # Network variable to store the network that you want to access
-# **NOTE:* Default network is *Test-net*, you can change it to mainnet or testnet
-# Check the network type for url and chain name:
-#  if @network==cfg['testnet']
-#      @url = cfg['testnet']['url']
-#      @chain = cfg['testnet']['chain']
-#  else
-#      @url = cfg['mainnet']['url']
-#      @chain = cfg['mainnet']['chain']
-#  end
-# -------------------
-# == Node Authentication
-# Import values from config file.
-# * User name: The rpc user is used to call the APIs.
-# * Password: The rpc password is used to authenticate the APIs.
-# * Check the network type for username and password:
-#  if @network==cfg['testnet']
-#       @user = cfg['testnet']['rkuser']
-#       @password = cfg['testnet']['passwd']
-#  else
-#       @user = cfg['mainnet']['rkuser']
-#       @password = cfg['mainnet']['passwd']
-#  end
-# Now we have node authentication credentials.
-# ------------
-# = class Assets
-# Assets class is used to call assets related functions like create assets and list assets functions which are used on the RecordsKeeeper Blockchain.
-# === 1. createAsset
-# This function is used to create or issue an asset.
-#	txid = createAsset         # Function call
-#
-#	puts txid                  # prints tx id of the issued asset
-# === 2. retrieveAssets
-# This function is used to list all assets, no of assets, issued quantity and issued transaction id of all the assets on RecordsKeeper Blockchain.
-#	asset_name, issue_id, issue_qty, asset_count = retrieveAssets       # Function call
-#
-#	puts asset_name       # prints all the addresses of the wallet
-#	puts asset_count      # prints the address count
-#	puts issue_qty        # prints assets issued quantity
-#	puts issue_id         # prints assets issued transaction id
-# === 3. sendAsset
-# This function is used to send an asset.
-#	txid = sendAsset         # Function call
-#
-#	puts txid                  # prints tx id of the sent asset
-class Assets
-end
+# = Assets Class Usage
+# This is a library to work with RecordsKeeper assets.
+# You can create new assets and list all assets by using Assets class. You just have to pass parameters to invoke the pre-defined functions.
+# ---------
+# == Libraries
+# Require these ruby libraries first to get started with the functionality.
+#  require 'rubygems'
+#  require 'httparty'
+#  require 'json'
+#  require 'binary_parser'
+#  require 'yaml'
+# -----------------
+# == Create Connection
+# Entry point for accessing Address class resources.
+# * URL: Url to connect to the chain ([RPC Host]:[RPC Port])
+# * Chain-name: chain name
+# 	 	cfg = YAML::load(File.open('sample_config.yaml','r'))		# Loads the configuration file 
+# * Set a *network* value.
+#  		network = cfg['network']                    # Network variable to store the network that you want to access
+# * Set url and chain name:
+#      @url = cfg['network']['url']
+#      @chain = cfg['network']['chain']
+# -------------------
+# == Node Authentication
+# Import values from config file.
+# * User name: The rpc user is used to call the APIs.
+# * Password: The rpc password is used to authenticate the APIs.
+# * Set the rpc username and password:
+#       @user = cfg['network']['rkuser']
+#       @password = cfg['network']['passwd']
+# Now we have node authentication credentials.
+# ------------
+# = class Assets
+# Assets class is used to call assets related functions like create assets and list assets functions which are used on the RecordsKeeeper Blockchain.
+# === 1. createAsset 
+# This function is used to create or issue an asset.
+#	txid = createAsset address, asset_name, asset_qty        # Function call
+#
+#	puts txid                  # prints tx id of the issued asset
+# === 2. retrieveAssets
+# This function is used to list all assets, no of assets, issued quantity and issued transaction id of all the assets on RecordsKeeper Blockchain.
+#	retrievedinfo = JSON.parse retrieveAssets       # Function call
+#
+#	puts retrievedinfo['asset_name']       # prints all the addresses of the wallet
+#	puts retrievedinfo['asset_count']      # prints the address count
+#	puts retrievedinfo['issue_qty']        # prints assets issued quantity
+#	puts retrievedinfo['issue_id']         # prints assets issued transaction id
+# === 3. sendAsset 
+# This function is used to send an asset.
+#	txid = sendAsset address, asset_name, asset_qty        # Function call
+#
+#	puts txid                  # prints tx id of the sent asset
+class Assets
+end

data/docs/block_doc.rb

@@ -0,0 +1,63 @@
+# = Block Class Usage
+# This is a library to work with RecordsKeeper block information.
+# You can generate new address, check all addresses, check address validity, check address permissions, check address balance by using Address class. You just have to pass parameters to invoke the pre-defined functions.
+# ---------
+# == Libraries
+# Require these ruby libraries first to get started with the functionality.
+#  require 'rubygems'
+#  require 'httparty'
+#  require 'json'
+#  require 'binary_parser'
+#  require 'yaml'
+# -----------------
+# == Create Connection
+# Entry point for accessing Address class resources.
+# * URL: Url to connect to the chain ([RPC Host]:[RPC Port])
+# * Chain-name: chain name
+# 	 	cfg = YAML::load(File.open('sample_config.yaml','r'))		# Loads the configuration file 
+# * Set a *network* value.
+#  		network = cfg['network']                    # Network variable to store the network that you want to access
+# * Set url and chain name:
+#      @url = cfg['network']['url']
+#      @chain = cfg['network']['chain']
+# -------------------
+# == Node Authentication
+# Import values from config file.
+# * User name: The rpc user is used to call the APIs.
+# * Password: The rpc password is used to authenticate the APIs.
+# * Set the rpc username and password:
+#       @user = cfg['network']['rkuser']
+#       @password = cfg['network']['passwd']
+# Now we have node authentication credentials.
+# ------------
+# = class Block
+# Block class is used to call block related functions like blockinfo which is used to retrieve block details
+# like block's hash value, size, nonce, transaction ids, transaction count, miner address, previous block hash,
+# next block hash, merkleroot, blocktime and difficulty of the block for which you have made the query.
+# === 1. blockinfo block_height
+# * You have to pass the block height as an argument in the blockinfo function call (Block height: Height of the block of which you want to collect information.)
+# * It will return transaction ids, transaction count, nonce, size, hash value, previous block's hash value, next block hash value, merkle root, difficulty, blocktime and miner address of the block.
+#	information = JSON.parse blockinfo block_height							# Function call
+#
+# 	puts information['tx_count']      # prints transaction count of the block
+# 	puts information['tx']            # prints transaction ids of the block
+# 	puts information['size']          # prints size of the block
+# 	puts information['blockHash']     # prints hash value of the block
+# 	puts information['nonce']         # prints nonce of the block
+# 	puts information['miner']         # prints miner's address of the block
+# 	puts information['nextblock']     # prints next block's hash
+# 	puts information['prevblock']     # prints previous block's hash
+# 	puts information['merkleroot']    # prints merkle root of the block
+# 	puts information['blocktime']     # prints time at which block is mined
+# 	puts information['difficulty']    # prints difficulty of the block
+# === 2. retrieveBlocks block_range
+# * You have to pass the block's height as the argument to the retrieveBlocks function call (Block range: Range of the block of which you want to collect information)
+# * It will return blockhash, miner address, blocktime and transaction count of the blocks.
+#	information = JSON.parse retrieveBlocks block_range						# Function call
+#
+#	puts information['block_hash']    # prints hash of the blocks
+# 	puts information['miner_add']     # prints miner of the blocks
+# 	puts information['block_time']    # prints block time of the blocks
+# 	puts information['txcount']       # prints transaction count of the blocks
+class Block
+end

data/docs/blockchain_doc.rb

@@ -0,0 +1,77 @@
+# = Blockchain Class Usage
+# This is a library to work with Blockchains in RecordsKeeper.
+# You can retrieve information about the chain and node, list all the permissions and the pending transactions and check your node's balance.
+# ---------
+# == Libraries
+# Require these ruby libraries first to get started with the functionality.
+#  require 'rubygems'
+#  require 'httparty'
+#  require 'json'
+#  require 'binary_parser'
+#  require 'yaml'
+# -----------------
+# == Create Connection
+# Entry point for accessing Address class resources.
+# * URL: Url to connect to the chain ([RPC Host]:[RPC Port])
+# * Chain-name: chain name
+# 	 	cfg = YAML::load(File.open('sample_config.yaml','r'))		# Loads the configuration file 
+# * Set a *network* value.
+#  		network = cfg['network']                    # Network variable to store the network that you want to access
+# * Set url and chain name:
+#      @url = cfg['network']['url']
+#      @chain = cfg['network']['chain']
+# -------------------
+# == Node Authentication
+# Import values from config file.
+# * User name: The rpc user is used to call the APIs.
+# * Password: The rpc password is used to authenticate the APIs.
+# * Set the rpc username and password:
+#       @user = cfg['network']['rkuser']
+#       @password = cfg['network']['passwd']
+# Now we have node authentication credentials.
+# ------------
+# = class Blockchain
+# Blockchain class is used to call blockchain related functions to retrieve information about the chain and node, list all the permissions and the pending transactions and check your node's balance.
+# === 1. getChainInfo
+# This function retrieves information about the chain.
+#	getChainInfo						
+#	chainInfo = JSON.parse getChainInfo			 # Function call	   
+#      
+#	puts chainInfo['chain_protocol']			# prints chain-protocol
+#	puts chainInfo['chain_description']			# prints chain-description
+#	puts chainInfo['root_stream']				# prints root-stream-name
+#	puts chainInfo['max_blocksize']				# prints maximum-block-size
+#	puts chainInfo['default_networkport']		# prints default-network-port
+#	puts chainInfo['default_rpcport']			# prints default-rpc-port
+#	puts chainInfo['mining_diversity']			# prints mining-diversity
+#	puts chainInfo['chain_name']				# prints chain-name
+# === 2. getNodeInfo
+# This function retrieves information related to your node.
+# 	getNodeInfo
+#	nodeInfo = JSON.parse getNodeInfo			# Function call
+#	
+# 	puts nodeInfo['node_balance']			# prints balance
+#	puts nodeInfo['synced_blocks']			# prints synced-blocks
+#	puts nodeInfo['node_address']			# prints nodeaddress
+#	puts nodeInfo['difficulty']				# prints difficulty
+# === 3. permissions
+# This function lists all the permissions.
+# 	permissions
+#	listpermissions = permissions			# Function call
+#	
+# 	puts listpermissions				# Prints the list of permissions.
+# === 4. getpendingTransactions
+# This function retrieves information related to your node.
+# 	getpendingTransactions
+#	pentransac = JSON.parse getpendingTransactions				# Function call
+#	
+# 	puts pentransac['tx_count']				# prints transaction count
+#	puts pentransac['tx']					# prints the pending transactions
+# === 5. checkNodeBalance
+# This function retrieves information related to your node.
+# 	checkNodeBalance
+#	nodeBal = checkNodeBalance			# Function call
+#	
+# 	puts nodeBal				# Prints node's balance amount.
+class Blockchain
+end

data/docs/{permissionsdoc.rb → permissions_doc.rb}

@@ -1,65 +1,54 @@
-# = Permissions Class Usage
-# This is a library to work with RecordsKeeper permissions.
-# You can grant and revoke permissions like connect, send, receive, create, issue, mine, activate, admin by using Assets class. You just have to pass parameters to invoke the pre-defined functions.
-# ---------
-# == Libraries
-# Require these ruby libraries first to get started with the functionality.
-#  require 'rubygems'
-#  require 'httparty'
-#  require 'json'
-#  require 'binary_parser'
-#  require 'yaml'
-# -----------------
-# == Create Connection
-# Entry point for accessing Address class resources.
-# * URL: Url to connect to the chain ([RPC Host]:[RPC Port])
-# * Chain-name: chain name
-#  cfg = YAML::load(File.open('sample_config.yaml','r'))		# Loads the configuration file
-# * Set a *network* value to change the network-type
-#  network = cfg['testnet']                    # Network variable to store the network that you want to access
-# **NOTE:* Default network is *Test-net*, you can change it to mainnet or testnet
-# Check the network type for url and chain name:
-#  if @network==cfg['testnet']
-#      @url = cfg['testnet']['url']
-#      @chain = cfg['testnet']['chain']
-#  else
-#      @url = cfg['mainnet']['url']
-#      @chain = cfg['mainnet']['chain']
-#  end
-# -------------------
-# == Node Authentication
-# Import values from config file.
-# * User name: The rpc user is used to call the APIs.
-# * Password: The rpc password is used to authenticate the APIs.
-# * Check the network type for username and password:
-#  if @network==cfg['testnet']
-#       @user = cfg['testnet']['rkuser']
-#       @password = cfg['testnet']['passwd']
-#  else
-#       @user = cfg['mainnet']['rkuser']
-#       @password = cfg['mainnet']['passwd']
-#  end
-# Now we have node authentication credentials.
-# ------------
-# = class Permissions
-# Permissions class is used to call permissions related functions like grant and revoke permissions for an address functions which are used on the RecordsKeeeper Blockchain.
-# === 1. grantPermission address, permissions
-# This function is used to grant permissions like connect, send, receive, create, issue, mine, activate, admin to an address on RecordsKeeper Blockchain.
-#
-# You have to pass these two arguments to the grantPermission function call:
-# * Permissions: list of comma-seperated permissions passed as a string
-# * Address: to which you have to grant permission
-#	result = grantPermission address, permissions
-#
-#	puts txid                  # prints response of the grant permision transaction
-# === 2. revokePermission address, permissions
-# This function is used to revoke permissions like connect, send, receive, create, issue, mine, activate, admin to an address on RecordsKeeper Blockchain.
-#
-# You have to pass these two arguments to the grantPermission function call:
-# * Permissions: list of comma-seperated permissions passed as a string
-# * Address: to which you have to grant permission
-#	result = revokePermission address, permissions
-#
-#	puts result                # prints response of the revoke permision transaction
-class Permissions
-end
+# = Permissions Class Usage
+# This is a library to work with RecordsKeeper permissions.
+# You can grant and revoke permissions like connect, send, receive, create, issue, mine, activate, admin by using Assets class. You just have to pass parameters to invoke the pre-defined functions.
+# ---------
+# == Libraries
+# Require these ruby libraries first to get started with the functionality.
+#  require 'rubygems'
+#  require 'httparty'
+#  require 'json'
+#  require 'binary_parser'
+#  require 'yaml'
+# -----------------
+# == Create Connection
+# Entry point for accessing Address class resources.
+# * URL: Url to connect to the chain ([RPC Host]:[RPC Port])
+# * Chain-name: chain name
+# 	 	cfg = YAML::load(File.open('sample_config.yaml','r'))		# Loads the configuration file 
+# * Set a *network* value.
+#  		network = cfg['network']                    # Network variable to store the network that you want to access
+# * Set url and chain name:
+#      @url = cfg['network']['url']
+#      @chain = cfg['network']['chain']
+# -------------------
+# == Node Authentication
+# Import values from config file.
+# * User name: The rpc user is used to call the APIs.
+# * Password: The rpc password is used to authenticate the APIs.
+# * Set the rpc username and password:
+#       @user = cfg['network']['rkuser']
+#       @password = cfg['network']['passwd']
+# Now we have node authentication credentials.
+# ------------
+# = class Permissions
+# Permissions class is used to call permissions related functions like grant and revoke permissions for an address functions which are used on the RecordsKeeeper Blockchain.
+# === 1. grantPermission address, permissions
+# This function is used to grant permissions like connect, send, receive, create, issue, mine, activate, admin to an address on RecordsKeeper Blockchain.
+#
+# You have to pass these two arguments to the grantPermission function call:
+# * Permissions: list of comma-seperated permissions passed as a string
+# * Address: to which you have to grant permission
+#	result = grantPermission address, permissions
+#
+#	puts txid                  # prints response of the grant permision transaction
+# === 2. revokePermission address, permissions
+# This function is used to revoke permissions like connect, send, receive, create, issue, mine, activate, admin to an address on RecordsKeeper Blockchain.
+#	
+# You have to pass these two arguments to the grantPermission function call:
+# * Permissions: list of comma-seperated permissions passed as a string
+# * Address: to which you have to grant permission
+#	result = revokePermission address, permissions
+#
+#	puts result                # prints response of the revoke permision transaction
+class Permissions
+end

data/docs/{streamdoc.rb → stream_doc.rb}

@@ -1,84 +1,79 @@
-# = Stream Class Usage
-# This is a library to work with streams in RecordsKeeper Blockchain.
-# You can publish address, retrieve data, retrieve with address, retrieve with key, verify data and retrieve items.
-# ---------
-# == Libraries
-# Require these ruby libraries first to get started with the functionality.
-#  require 'rubygems'
-#  require 'httparty'
-#  require 'json'
-#  require 'binary_parser'
-#  require 'yaml'
-#  require 'hex_string'
-# -----------------
-# == Create Connection
-# Entry point for accessing Blockchain class resources.
-# * URL: Url to connect to the chain ([RPC Host]:[RPC Port])
-# * Chain-name: Name of the chain
-#  cfg = YAML::load(File.open('sample_config.yaml','r'))		# Loads the configuration file
-# * Set a *network* value to change the network-type
-#  network = cfg['testnet']                    # Network variable to store the network that you want to access
-# **NOTE:* Default network is *Test-net* ( i.e., you can set it to either testnet or mainnet).
-# Check the network type for url and chain name:
-#  if @network==cfg['testnet']
-#      @url = cfg['testnet']['url']
-#      @chain = cfg['testnet']['chain']
-#  else
-#      @url = cfg['mainnet']['url']
-#      @chain = cfg['mainnet']['chain']
-#  end
-# -------------------
-# == Node Authentication
-# Import values from config file.
-# * User name: The rpc user is used to call the APIs.
-# * Password: The rpc password is used to authenticate the APIs.
-# * Check the network type for username and password:
-#  if @network==cfg['testnet']
-#       @user = cfg['testnet']['rkuser']
-#       @password = cfg['testnet']['passwd']
-#  else
-#       @user = cfg['mainnet']['rkuser']
-#       @password = cfg['mainnet']['passwd']
-#  end
-# Now we have node authentication credentials.
-# ------------
-# = class Stream
-# Stream class is used to call stream related functions to publish address, retrieve data, retrieve with address, retrieve with key, verify data and retrieve items.
-# === 1. publish address, stream, key, data
-# This function retrieves information about the chain.
-#	publish address, stream, key, data
-#	transacid = publish address, stream, key, data	# Function call
-#
-#	puts transacid               # Prints txid.
-# === 2. retrieve stream, txid
-# This function retrieves information related to your node.
-# 	retrieve stream, txid
-#	data = retrieve stream, txid	 # Function call
-#
-# 	puts data				# Prints raw_data.
-# === 3. retrieveWithAddress stream, address
-# This function lists all the permissions.
-# 	retrieveWithAddress stream, address
-#	retadd = retrieveWithAddress stream, address	# Function call
-#
-# 	puts retadd				# Prints key, data and txid.
-# === 4. retrieveWithKey stream, key
-# This function retrieves information related to your node.
-# 	retrieveWithKey stream, key
-#	retkey = retrieveWithKey stream, key		# Function call
-#
-# 	puts retkey				# Prints publisher, data and txid.
-# === 5. verifyData stream, data, count
-# This function retrieves information related to your node.
-# 	verifyData stream, data, count
-#	verifystat = verifyData stream, data, count		# Function call
-#
-# 	puts verifystat				# Prints result.
-# === 6. retrieveItems stream, count
-# This function retrieves information related to your node.
-# 	retrieveItems stream, count
-#	retitem = retrieveItems stream, count		# Function call
-#
-# 	puts retitem				# Prints address, key_value, raw_data and txid.
-class Stream
-end
+# = Stream Class Usage
+# This is a library to work with streams in RecordsKeeper Blockchain.
+# You can publish address, retrieve data, retrieve with address, retrieve with key, verify data and retrieve items.
+# ---------
+# == Libraries
+# Require these ruby libraries first to get started with the functionality.
+#  require 'rubygems'
+#  require 'httparty'
+#  require 'json'
+#  require 'binary_parser'
+#  require 'yaml'
+# -----------------
+# == Create Connection
+# Entry point for accessing Address class resources.
+# * URL: Url to connect to the chain ([RPC Host]:[RPC Port])
+# * Chain-name: chain name
+# 	 	cfg = YAML::load(File.open('sample_config.yaml','r'))		# Loads the configuration file 
+# * Set a *network* value.
+#  		network = cfg['network']                    # Network variable to store the network that you want to access
+# * Set url and chain name:
+#      @url = cfg['network']['url']
+#      @chain = cfg['network']['chain']
+# -------------------
+# == Node Authentication
+# Import values from config file.
+# * User name: The rpc user is used to call the APIs.
+# * Password: The rpc password is used to authenticate the APIs.
+# * Set the rpc username and password:
+#       @user = cfg['network']['rkuser']
+#       @password = cfg['network']['passwd']
+# Now we have node authentication credentials.
+# ------------
+# = class Stream
+# Stream class is used to call stream related functions to publish address, retrieve data, retrieve with address, retrieve with key, verify data and retrieve items.
+# === 1. publish address, stream, key, data
+# This function retrieves information about the chain.
+#	publish address, stream, key, data						
+#	transacid = publish address, stream, key, data	# Function call	   
+#      
+#	puts transacid               # Prints txid.
+# === 2. retrieve stream, txid
+# This function retrieves information related to your node.
+# 	retrieve stream, txid
+#	data = retrieve stream, txid	 # Function call
+#	
+# 	puts data				# Prints raw_data.
+# === 3. retrieveWithAddress stream, address
+# This function lists all the permissions.
+# 	retrieveWithAddress stream, address
+#	retadd = JSON.parse retrieveWithAddress stream, address		# Function call
+#	
+# 	puts retadd['key']				# Prints key, data and txid.
+#	puts retadd['raw_data']			# prints raw data
+#	puts retadd['txid']				# prints transaction id
+# === 4. retrieveWithKey stream, key
+# This function retrieves information related to your node.
+# 	retrieveWithKey stream, key
+#	retkey = JSON.parse retrieveWithKey stream, key		# Function call
+#	
+# 	puts retkey['publisher']				# prints publisher
+#	puts retkey['raw_data']					# prints raw data
+#	puts retkey['txid']						# prints transaction id
+# === 5. verifyData stream, data, count
+# This function retrieves information related to your node.
+# 	verifyData stream, data, count
+#	verifystat = verifyData stream, data, count		# Function call
+#	
+# 	puts verifystat				# Prints result.
+# === 6. retrieveItems stream, count
+# This function retrieves information related to your node.
+# 	retrieveItems stream, count
+#	retitem = JSON.parse retrieveItems stream, count		# Function call
+#	
+# 	puts retitem['address']				# prints address
+#	puts retitem['key_value']			# prints key_value
+#	puts retitem['raw_data']			# prints raw_data
+#	puts retitem['txid']				# prints transaction id
+class Stream
+end