test_sdk1 1.0.3 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b89def3f15a842a7ddc8c15b72f04e2cddf49b781fb8d838addcd7854e5dfc4
-  data.tar.gz: 980521ad36c1ea8acc77e573ff24cd961d3de5f55e12e3a609d2a64b2ec5e074
+  metadata.gz: 19df95113627970cd416e5bd602df39ec2d0791714803544df62302b6f0f490b
+  data.tar.gz: bedf1c745ccdaca73523d2c93885f3a15a6136adb8ed3ff01a8d3caa4afa7e38
 SHA512:
-  metadata.gz: 15907f268c7f6e4fb4f30ca4bb42518c545d8c01f6803db931381ac76a22c360771a788e435062d862302ba3b4e7da320f2a0069dba9c984b2cbe4bad7907757
-  data.tar.gz: fce9046fe2e0f2978f949b8c2ae09585a5936225b50137a622f48f0c87ac101c1b92d11bb4b89d90030e89ed3d6d4ea51794a21908bbb8061c7c486be4f106fd
+  metadata.gz: da16ea0326db013e89e67e62903b7be37fb2fb6d91108e0045e4fb88f19f32fed30c1ec6d2b3d7ae9a36ec5125535100271acd8eec3e183a3e7fcf4fe25f7f3d
+  data.tar.gz: cf129cf4821b1f60a2b0a86f8751565ebe463736c92b1479f9f114cdb0e9fd01dced89510ac325c57db59e0581adb53e67bc6afa7ac311fa8be9848f56aa613d

data/README.md

@@ -70,108 +70,497 @@ yardoc lib/**/*.rb lib/*.rb - README.md LICENSE CONTRIBUTING.md SECURITY.md
 yardoc --help 
 ```
 
-## Documentation:
+## Documentation
+
+The SDK documentation can be found [here](https://www.rubydoc.info/gems/casper_network/1.0.2) in detail.
+
+### Serialization
+Casper provides a custom implementation to serialize data structures used by the Casper node to their byte representation.
+More information on this custom implementation can be found [here](https://caspernetwork.readthedocs.io/en/latest/implementation/serialization-standard.html).
+
+* [Serialization](https://github.com/saitgulmez/testing/blob/main/docs/serialization.md#serialization)
+* [Examples](https://github.com/saitgulmez/testing/blob/main/docs/serialization.md#examples)
+
+### Key Management
+* [CLPublicKey](https://github.com/saitgulmez/testing/blob/main/docs/keys.md#public-keys)
+
 ### Casper-Ruby-Sdk RPC
-* [info_get_peers](https://github.com/saitgulmez/testing/blob/main/docs/rpc.md#info_get_peers)
-* [chain_get_StateRootHash](https://github.com/saitgulmez/testing/blob/main/docs/rpc.md#get-state_root_hash)
-* [info_get_deploy](https://github.com/saitgulmez/testing/blob/main/docs/rpc.md#get-deploy)
-* [info_get_status](https://github.com/saitgulmez/testing/blob/main/docs/rpc.md#get-status)
-* [chain_get_block_transfers](https://github.com/saitgulmez/testing/blob/main/docs/rpc.md#get-block-transfers)
-* [chain_get_block](https://github.com/saitgulmez/testing/blob/main/docs/rpc.md#get-block-by-hash)
-* [chain_get_eraInfo_by_SwitchBlock](https://github.com/saitgulmez/testing/blob/main/docs/rpc.md#get-era-summary-by-switch-block-hash)
-* [state_get_item](https://github.com/saitgulmez/testing/blob/main/docs/rpc.md#get--state-item)
-* [state_get_dictionary_item](https://github.com/saitgulmez/testing/blob/main/docs/rpc.md#get-dictionary-item)
-* [state_get_balance](https://github.com/saitgulmez/testing/blob/main/docs/rpc.md#get-account-balance)
-* [state_get_AuctionInfo](https://github.com/saitgulmez/testing/blob/main/docs/rpc.md#get-auction-state)
-* [put_deploy](https://github.com/saitgulmez/testing/blob/main/docs/rpc.md#put-deploy)
+* [info_get_peers](https://github.com/saitgulmez/casper-ruby-sdk/blob/main/docs/rpc.md#info_get_peers)
+* [chain_get_StateRootHash](https://github.com/saitgulmez/casper-ruby-sdk/blob/main/docs/rpc.md#get-state_root_hash)
+* [info_get_deploy](https://github.com/saitgulmez/casper-ruby-sdk/blob/main/docs/rpc.md#get-deploy)
+* [info_get_status](https://github.com/saitgulmez/casper-ruby-sdk/blob/main/docs/rpc.md#get-status)
+* [chain_get_block_transfers](https://github.com/saitgulmez/casper-ruby-sdk/blob/main/docs/rpc.md#get-block-transfers)
+* [chain_get_block](https://github.com/saitgulmez/casper-ruby-sdk/blob/main/docs/rpc.md#get-block-by-hash)
+* [chain_get_eraInfo_by_SwitchBlock](https://github.com/saitgulmez/casper-ruby-sdk/blob/main/docs/rpc.md#get-era-summary-by-switch-block-hash)
+* [state_get_item](https://github.com/saitgulmez/casper-ruby-sdk/blob/main/docs/rpc.md#get--state-item)
+* [state_get_dictionary_item](https://github.com/saitgulmez/casper-ruby-sdk/blob/main/docs/rpc.md#get-dictionary-item)
+* [state_get_balance](https://github.com/saitgulmez/casper-ruby-sdk/blob/main/docs/rpc.md#get-account-balance)
+* [state_get_AuctionInfo](https://github.com/saitgulmez/casper-ruby-sdk/blob/main/docs/rpc.md#get-auction-state)
+* [put_deploy](https://github.com/saitgulmez/casper-ruby-sdk/blob/main/docs/rpc.md#put-deploy)
 
 
 ## Usage examples
-### Get 5 peer IP addresses randomly
+
+## Include 'casper_network' gem into the source file
+
 ```ruby
 require 'casper_network'
+```
+## Create a Client
+
+Pass the node ip address to constructor
+
+```ruby
+node_ip_address = "5.9.23.55" # IP is taken from "testnet"
+client = Casper::CasperClient.new(node_ip_address)
+```
+## RPC Calls
+
+### Get network peers list
+
+Retrieves the list of connected peers.
+
+```ruby
+peers = client.info_get_peers
+# Retrieve to the first peer object
+peer = peers[0]
+# Retrieve to info of the first peer object
+node_id = peer[0].get_node_id
+address = peer[0].get_address
+```
+
+### Get State Root Hash
+
+Retrieves  the state root hash String.
+
+```ruby
+state_root_hash = client.chain_get_StateRootHash
+```
+
+### Get Deploy
+
+Retrieves a Deploy object from the network.
+
+call parameters :
+- deploy hash
+
+```ruby
+deploy_hash = "0806cc477a5282574bc5302d7598cd33a09875704c5fef9264d984535c945e31"
+deploy =  client.info_get_deploy(deploy_hash)
+# Deploy members
+hash = Casper::Entity::DeployHash.new(deploy.get_hash)
+header = Casper::Entity::DeployHeader.new(deploy.get_header)
+payment = deploy.get_payment
+session = deploy.get_session
+```
+
+### Get Node Status
 
-# In order to interact with casper network we should give a valid ip address to the constructor
+Retrieves the current status of the node.
 
-# if it does not work, please choose another node ip address from the Testnet
-# IP is taken from "Testnet"
-node_ip_address = "85.114.132.129" 
+```ruby
+node_status = client.info_get_status
+# Examples of retrieving and printing the members of node status
+puts node_status.get_api_version
+puts node_status.get_chainspec_name
+puts node_status.get_starting_state_root_hash
+puts node_status.get_peers
+puts node_status.get_last_added_block_info
+puts node_status.get_our_public_signing_key
+puts node_status.get_round_length
+puts node_status.get_next_upgrade
+puts node_status.get_build_version
+puts node_status.get_uptime
+```
+
+### Get BlockTransfers
+
+Retrieve all transfers for a Block from the network
+
+```ruby
 # block_Hash taken from Testnet
-block_hash = "71e19e2e9629c716dc9578066cfeceace559d32fe51b08245ddd4d218f8c18da"
-# deploy_Hash taken from Testnet
-deploy_hash = "d3e0a1bd85ee74916e096cf4b18df391ada414d0915aeb865eff0ba75f04c3d8"
-state_root_hash = "2a62440a1e1e57bff71344aac8a7de169f6dd08d29cffe83b2fb5d6648971855"
+block_hash = "ff2ad232c3efc22a385fce44df844fc696e904ce8ba78599a576aa68c76889c4"
+transfers = client.chain_get_block_transfers(block_hash)
+# Examples of accessing and printing the members of each transfer object
+transfers.each do |transfer|
+  puts transfer.get_deploy_hash
+  puts transfer.get_from
+  puts transfer.get_to
+  puts transfer.get_source
+  puts transfer.get_target
+  puts transfer.get_amount
+  puts transfer.get_gas
+  puts transfer.get_id
+end
+```
+
+### Get Block
+
+Retrieve a Block object from the network
+
+```ruby
+block_hash = "ff2ad232c3efc22a385fce44df844fc696e904ce8ba78599a576aa68c76889c4"
+block = client.chain_get_block(block_hash)
+puts block # => It is an instance of Block
+# To retrieve BlockHeader object
+block_header =  block.get_header
+puts block_header
+# To access and print members of the block_header object (block_header is an instance of BlockHeader )
+puts block_header.get_parent_hash
+puts block_header.get_state_root_hash
+puts block_header.get_body_hash
+puts block_header.get_random_bit
+puts block_header.get_accumulated_seed
+puts block_header.get_era_end
+puts block_header.get_timestamp
+puts block_header.get_era_id
+puts block_header.get_height
+puts block_header.get_protocol_version
+
+# To retrieve BlockBody object
+block_body = block.get_body
+# To access and print members of the block_body object (block_body is an instance of BlockBody )
+puts block_body
+puts block_body.get_proposer
+puts block_body.get_deploy_hashes
+puts block_body.get_transfer_hashes
+
+# To retrieve an array of BlockProof objects
+proofs = block.get_proofs
+# To access and print members of the block_proof objects (block_proof is an instance of BlockProof )
+puts proofs
+# To access and print each proof object and its members
+i = 0
+proofs.each do |proof|
+  puts "proofs[#{i}]: #{proof}"
+  puts "public_key: " + proof.get_public_key
+  puts "signature: "  + proof.get_signature
+  i += 1
+end
+```
+
+### Get EraInfo By Switch Block
+
+Retrieves an EraSummury object.
+
+```ruby
+block_hash = "d2077716e5b8796723c5720237239720f54e6ada54e3357f2c4896f2a51a6d8f"
+era_summary = client.chain_get_eraInfo_by_SwitchBlock(block_hash)
+puts era_summary # => It is an instance of EraSummary
+puts era_summary.get_block_hash
+puts era_summary.get_era_id
+puts era_summary.get_stored_value # => Retrieve and print the instance of StoredValue
+puts era_summary.get_stored_value.get_stored_value
+puts era_summary.get_state_root_hash
+puts era_summary.get_merkle_proof
+```
+
+### Get StateItem
+
+Retrieves a StoredValue object.
+
+```ruby
+node_ip_address = "65.108.78.120" # => Taken from the Mainnet
+client = Casper::CasperClient.new(node_ip_address)
+# Retrieve the stored_value object which is an instance of StoredValue
+stored_value = client.state_get_item("647C28545316E913969B032Cf506d5D242e0F857061E70Fb3DF55980611ace86", "bid-24b6D5Aabb8F0AC17D272763A405E9CECa9166B75B745Cf200695E172857c2dD", [])
+puts stored_value # => #<Casper::Entity::StoredValue:0x0000000003767a48>
+puts stored_value.get_key # => Bid
+puts stored_value.get_bid # => Retrieve and print Bid object related data
+# or
+puts stored_value.get_stored_value # => Retrieve and print Bid object related data
+```
+
+### Get DictionaryItem
+
+Retrieves a CLValue object.
+
+```ruby
+node_ip_address = "65.108.78.120" # => Taken from Mainnet
+client = Casper::CasperClient.new(node_ip_address)
+state_root_hash = "7b605ad991c949832fd966495afc3f97a2b8122a1a6afc2610b545a8c07e3456"
 item_key = "f870e3cadfde21d7d7686fdf3d1a8413838274d363ca7b27ae71fc9125eb6743"
-uref = "uref-9199d08ff4ca4d52cd7a05ba0d2694204b7ebff963fec1c216f81bf654e0e59f-007"
-switch_block_hash = "9e30104581a492f5c6faad4cdfb098311e3bf0e93897ebbfb47c3df62f5e6375"
+uref = "uref-0d689e987db7ee5be246282c3a7badf0411e34baeeab8e9d73c1223ae4ad02e5-007"
+# Retrieve folowing data from the network and convert it into its proper CLValue 
+# {"CLValue"=>{"cl_type"=>"String", "bytes"=>"1a00000068747470733a2f2f636173706572636f6d6d756e6974792e696f", "parsed"=>"https://caspercommunity.io"}}
+stored_value = client.state_get_dictionary_item(state_root_hash, item_key, uref)
+puts stored_value # => #<CLString:0x0000000002b3c8e0>
+puts stored_value.get_cl_type # => String
+puts stored_value.get_value # => https://caspercommunity.io
+puts CLValueBytesParsers::CLStringBytesParser.to_bytes(stored_value.get_value) # => 1a00000068747470733a2f2f636173706572636f6d6d756e6974792e696f
+```
+
+### Get Balance
+
+Retrieves the balances(in motes) of an account
+
+Parameters :
+
+- state root hash
+- account uref hash
 
+```ruby
+node_ip_address = "65.108.78.120" # => Taken from Mainnet
+client = Casper::CasperClient.new(node_ip_address)
+state_root_hash = "610e932aef10d3e1fa04940c79a4a2789ee79c17046f1a9b45a2919f3600f3d5"
+uref = "uref-7de5e973b7d70bc2b328814411f2009aafd8dba901cfc2c588ba65088dcd22bb-007"
+balance = client.state_get_balance(state_root_hash, uref)
+puts balance # => 29269647684075  (current balance  9/24/2022)
+```
+
+### Get current auction state
+
+Retrieves an AutionState object.
 
-# Uncomment following lines to test on Mainnet 
-# if it does not work, please choose another node ip address from the Mainnet
-# IP is taken from "Mainnet"
-# node_ip_address = "65.108.78.12" 
+call parameters :
+- block hash
+
+```ruby
 # block_Hash taken from MainNet
-# block_hash = "5fdbdf3fa70d37821aa2d1752743e9653befc15e65e40c2655e1ce93a807260f"
-# # deploy_Hash taken from MainNet
-# deploy_hash = "52a40996a88523c475c12e5370ff90b0ae4ec051cfaa57cd048c136b1a83319d"
-# state_root_hash = "7b605ad991c949832fd966495afc3f97a2b8122a1a6afc2610b545a8c07e3456"
-# item_key = "f870e3cadfde21d7d7686fdf3d1a8413838274d363ca7b27ae71fc9125eb6743"
-# uref = "uref-0d689e987db7ee5be246282c3a7badf0411e34baeeab8e9d73c1223ae4ad02e5-007"
-# switch_block_hash = "4696285db1ca6572f425cada612257f85a58a6a4034c09846afe360ba40e5df0"
-
-if (IPAddress.valid? node_ip_address)
-  client = Casper::CasperClient.new(node_ip_address)
-  peers = client.info_get_peers.sample(5)
-  puts "node_id and address of five randomly selected 5 peers:"
-  puts peers
-
-  # Store ip addresses of these peers into an array
-  ips = []
-  peers.select do |item|
-    ip = item["address"]
-    ips << ip[0, ip.index(':')]
-  end
-
-  clients = []
-  puts "Randomly selected 5 peers ip addresses:"
-  ips.each do |ip_address|
-    # Create a client object for each iteration
-    puts ip_address
-    client = CasperClient.new(ip_address)
-    clients.push(client)
-  end
-
-
-  clients.each do |client|
-    puts client.info_get_peers
-    puts client.chain_get_StateRootHash(block_hash)
-    puts client.chain_get_StateRootHash
-    puts client.info_get_deploy(deploy_hash)
-    puts client.info_get_status
-    puts client.chain_get_block_transfers(block_hash)
-    puts client.chain_get_block_transfers
-    puts client.chain_get_block(block_hash)
-    puts client.chain_get_eraInfo_by_SwitchBlock(switch_block_hash)
-    puts client.state_get_item("647C28545316E913969B032Cf506d5D242e0F857061E70Fb3DF55980611ace86", "bid-24b6D5Aabb8F0AC17D272763A405E9CECa9166B75B745Cf200695E172857c2dD", [])
-    puts client.state_get_dictionary_item(state_root_hash, item_key, uref)
-    state_root_hash = "610e932aef10d3e1fa04940c79a4a2789ee79c17046f1a9b45a2919f3600f3d5"
-    uref = "uref-7de5e973b7d70bc2b328814411f2009aafd8dba901cfc2c588ba65088dcd22bb-007"
-    puts client.state_get_balance(state_root_hash, uref)
-    puts client.state_get_AuctionInfo
-
-  end
-else
-  puts "Invalid IP address"
-end
+block_hash = "5fdbdf3fa70d37821aa2d1752743e9653befc15e65e40c2655e1ce93a807260f"
+node_ip_address = "65.108.78.120" # => Taken from Mainnet
+client = Casper::CasperClient.new(node_ip_address)
+auction = client.state_get_AuctionInfo
+# Retrieve and print an instance of AuctionState entity
+puts auction # => #<Casper::Entity::AuctionState:0x0000000003306bc0>
+# Retrieve and print state root hash as a String value
+puts auction.get_state_root_hash # => "6448b55f1dd7c9ad337f4fd4c77586d7ae30da146e0b340932aba7e7efa9cbcb"
+# Retrieve and print block height as an Integer value
+puts auction.get_block_height    # => 1128800
+# Retrieve and print an array of instances of EraValidor entity
+puts auction.get_era_validators # => [#<Casper::Entity::EraValidator:0x0000000002b69980>, #<Casper::Entity::EraValidator:0x0000000002b68940>]
+# Retrieve and print an array of instances of Bid entity
+puts auction.get_bids # => [#<Casper::Entity::Bid:0x000000000430bcf0>, #<Casper::Entity::Bid:0x000000000430b6d8>....]
+
+# Retrieve and print an instance of BidInfo, which is also the member of bid object
+bids = auction.get_bids
+bid =  bids[0] # => #<Casper::Entity::Bid:0x0000000003773dc0>
+bid_info = bid.get_bid_info # => #<Casper::Entity::BidInfo:0x00000000042cffc0>
+# Retrieve and print an array of delegator objects, which are instance of Delegator entity
+delegators = bid_info.get_delegators
+puts delegators # => [#<Casper::Entity::Delegator:0x000000000396c550>, #<Casper::Entity::Delegator:0x000000000396c500>.....]
+# How to access members of one of the above delegator instances
+# For instance, access to stake amount at first delegator    
+delegator = delegators[0]
+stake_amount = delegator.get_staked_amount # => 27871095039894
 ```
-- [Testnet](https://testnet.cspr.live/tools/peers),  [Mainnet](https://cspr.live/tools/peers)
-- [doc](https://www.rubydoc.info/gems/casper_network/0.2.1)
 
 
-## TODO
-- [ ] Ruby version of CLType primitives
-- [ ] Ruby version for Casper domain-specific objects
-- [ ] Serialization of Casper domain-specific objects
-- [ ] ED25519/SECP256K1 key pairs  Wrappers implemented
-- [ ] PutDeploy call implemented and tested
-- [ ] SDK calls will return Casper domain-specific objects
+### Example
+```bash
+# example.rb
+# how to execute example.rb
+$ ruby example.rb
+```
+
+```ruby
+# example.rb
+require 'casper_network'
+# Class-Object Level
+# Casper::CasperClient
+node_ip_address = "5.9.23.55" # IP is taken from "testnet"
+client = Casper::CasperClient.new(node_ip_address)
+
+#********** info_get_peers *********************************#
+
+# Uncomment following lines to see the outputs
+# puts client.info_get_peers
+# puts client.info_get_peers[0].get_node_id
+# puts client.info_get_peers[0].get_address
+
+
+#********** chain_get_StateRootHash *********************************#
+# Uncomment following line to see the outputs
+# puts client.chain_get_StateRootHash
+
+
+#********** info_get_deploy(deploy_hash) *********************************#
+deploy_hash = "0806cc477a5282574bc5302d7598cd33a09875704c5fef9264d984535c945e31"
+deploy =  client.info_get_deploy(deploy_hash)
+# Uncomment following lines to see the outputs
+# puts deploy
+# hash = Casper::Entity::DeployHash.new(deploy.get_hash)
+# puts hash
+# header = Casper::Entity::DeployHeader.new(deploy.get_header)
+# puts header
+# payment = deploy.get_payment
+# puts payment
+# session = deploy.get_session
+# puts session
+
+# approvals = []
+# num_of_approvals = deploy.get_approvals.size
+# num_of_approvals.times do |i|
+#   approvals.push(Casper::Entity::DeployApproval.new(deploy.get_approvals[i]))
+# end
+# puts approvals[0].get_signer
+# puts hash, header, payment, session, approvals
+
+#********** info_get_status *********************************#
+node_status = client.info_get_status
+# Uncomment following lines to see the outputs
+# puts node_status
+# puts node_status.get_api_version
+# puts node_status.get_chainspec_name
+# puts node_status.get_starting_state_root_hash
+# puts node_status.get_peers
+# puts node_status.get_last_added_block_info
+# puts node_status.get_our_public_signing_key
+# puts node_status.get_round_length
+# puts node_status.get_next_upgrade
+# puts node_status.get_build_version
+# puts node_status.get_uptime
+
+#********** chain_get_block_transfers(block_hash = "")  *********************************#
+# block_Hash taken from Testnet
+block_hash = "ff2ad232c3efc22a385fce44df844fc696e904ce8ba78599a576aa68c76889c4"
+transfers = client.chain_get_block_transfers(block_hash)
+# Uncomment following lines to see the outputs
+# puts transfers
+# transfers.each do |transfer|
+#   puts transfer.get_deploy_hash
+#   puts transfer.get_from
+#   puts transfer.get_to
+#   puts transfer.get_source
+#   puts transfer.get_target
+#   puts transfer.get_amount
+#   puts transfer.get_gas
+#   puts transfer.get_id
+# end
+
+
+
+#**********  chain_get_block(block_hash) *********************************#
+block_hash = "ff2ad232c3efc22a385fce44df844fc696e904ce8ba78599a576aa68c76889c4"
+block = client.chain_get_block(block_hash)
+# Uncomment following lines to see the outputs
+# puts block
+# To retrieve BlockHeader object
+# block_header =  block.get_header
+# puts block_header
+# To access and print members of the block_header object (block_header is an instance of BlockHeader )
+# puts block_header.get_parent_hash
+# puts block_header.get_state_root_hash
+# puts block_header.get_body_hash
+# puts block_header.get_random_bit
+# puts block_header.get_accumulated_seed
+# puts block_header.get_era_end
+# puts block_header.get_timestamp
+# puts block_header.get_era_id
+# puts block_header.get_height
+# puts block_header.get_protocol_version
+
+# To retrieve BlockBody object
+# block_body = block.get_body
+# To access and print members of the block_body object (block_body is an instance of BlockBody )
+# puts block_body
+# puts block_body.get_proposer
+# puts block_body.get_deploy_hashes
+# puts block_body.get_transfer_hashes
+
+ # To retrieve an array of BlockProof objects
+# proofs = block.get_proofs
+# To access and print members of the block_proof objects (block_proof is an instance of BlockProof )
+# puts proofs
+# To access and print each proof object and its members
+# i = 0
+# proofs.each do |proof|
+#   puts "proofs[#{i}]: #{proof}"
+#   puts "public_key: " + proof.get_public_key
+#   puts "signature: "  + proof.get_signature
+#   i += 1
+# end
+
+
+
+#********** chain_get_eraInfo_by_SwitchBlock(block_hash) *********************************#
+block_hash = "d2077716e5b8796723c5720237239720f54e6ada54e3357f2c4896f2a51a6d8f"
+era_summary = client.chain_get_eraInfo_by_SwitchBlock(block_hash)
+# Uncomment following lines to see the outputs
+# puts era_summary
+# puts era_summary.get_block_hash
+# puts era_summary.get_era_id
+# puts era_summary.get_stored_value
+# puts era_summary.get_stored_value.get_stored_value
+# puts era_summary.get_state_root_hash
+# puts era_summary.get_merkle_proof
+# era_summary.map { |k, v| puts "#{k}" }
+# 
+
+
+
+#********** state_get_item(state_root_hash, key, path) *********************************#
+node_ip_address = "65.108.78.120" # => Taken from Mainnet
+client = Casper::CasperClient.new(node_ip_address)
+# Retrieve the stored_value object which is an instance of StoredValue
+# Uncomment following lines to see the outputs
+stored_value = client.state_get_item("647C28545316E913969B032Cf506d5D242e0F857061E70Fb3DF55980611ace86", "bid-24b6D5Aabb8F0AC17D272763A405E9CECa9166B75B745Cf200695E172857c2dD", [])
+# puts stored_value # => #<Casper::Entity::StoredValue:0x0000000003767a48>
+# puts stored_value.get_key # => Bid
+# puts stored_value.get_bid # => Retrieve and print Bid object related data
+# # or
+# puts stored_value.get_stored_value # => Retrieve and print Bid object related data
+
+
+
+
+#********** state_get_dictionary_item(state_root_hash, item_key, uref) *********************************#
+node_ip_address = "65.108.78.120" # => Taken from Mainnet
+client = Casper::CasperClient.new(node_ip_address)
+state_root_hash = "7b605ad991c949832fd966495afc3f97a2b8122a1a6afc2610b545a8c07e3456"
+item_key = "f870e3cadfde21d7d7686fdf3d1a8413838274d363ca7b27ae71fc9125eb6743"
+uref = "uref-0d689e987db7ee5be246282c3a7badf0411e34baeeab8e9d73c1223ae4ad02e5-007"
+# # Retrieve folowing data from the network and convert it into its proper CLValue 
+# # {"CLValue"=>{"cl_type"=>"String", "bytes"=>"1a00000068747470733a2f2f636173706572636f6d6d756e6974792e696f", "parsed"=>"https://caspercommunity.io"}}
+
+# Uncomment following lines to see the outputs
+# stored_value = client.state_get_dictionary_item(state_root_hash, item_key, uref)
+# puts stored_value # => #<CLString:0x0000000002b3c8e0>
+# puts stored_value.get_cl_type # => String
+# puts stored_value.get_value # => https://caspercommunity.io
+# puts CLValueBytesParsers::CLStringBytesParser.to_bytes(stored_value.get_value) # => 1a00000068747470733a2f2f636173706572636f6d6d756e6974792e696f
+
+
+
+#********** state_get_balance(state_root_hash, balance_uref) *********************************#
+node_ip_address = "65.108.78.120" # => Taken from Mainnet
+client = Casper::CasperClient.new(node_ip_address)
+state_root_hash = "610e932aef10d3e1fa04940c79a4a2789ee79c17046f1a9b45a2919f3600f3d5"
+uref = "uref-7de5e973b7d70bc2b328814411f2009aafd8dba901cfc2c588ba65088dcd22bb-007"
+
+# Uncomment following lines to see the outputs
+# balance = client.state_get_balance(state_root_hash, uref)
+# puts balance # => 29269647684075  (current balance  9/24/2022)
+
+
+#********** state_get_AuctionInfo *********************************#
+# block_Hash taken from MainNet
+block_hash = "5fdbdf3fa70d37821aa2d1752743e9653befc15e65e40c2655e1ce93a807260f"
+node_ip_address = "65.108.78.120" # => Taken from Mainnet
+client = Casper::CasperClient.new(node_ip_address)
+
+# Uncomment following lines to see the outputs
+# auction = client.state_get_AuctionInfo
+# Retrieve and print an instance of AuctionState entity
+# puts auction # => #<Casper::Entity::AuctionState:0x0000000003306bc0>
+# Retrieve and print state root hash as a String value
+# puts auction.get_state_root_hash # => "6448b55f1dd7c9ad337f4fd4c77586d7ae30da146e0b340932aba7e7efa9cbcb"
+# Retrieve and print block height as an Integer value
+# puts auction.get_block_height    # => 1128800
+# Retrieve and print an array of instances of EraValidor entity
+# puts auction.get_era_validators # => [#<Casper::Entity::EraValidator:0x0000000002b69980>, #<Casper::Entity::EraValidator:0x0000000002b68940>]
+# Retrieve and print an array of instances of Bid entity
+# puts auction.get_bids # => [#<Casper::Entity::Bid:0x000000000430bcf0>, #<Casper::Entity::Bid:0x000000000430b6d8>....]
+
+# Retrieve and print an instance of BidInfo, which is also the member of bid object
+# bids = auction.get_bids
+# bid =  bids[0] # => #<Casper::Entity::Bid:0x0000000003773dc0>
+# bid_info = bid.get_bid_info # => #<Casper::Entity::BidInfo:0x00000000042cffc0>
+# Retrieve and print an array of delegator objects, which are instance of Delegator entity
+# delegators = bid_info.get_delegators
+# puts delegators # => [#<Casper::Entity::Delegator:0x000000000396c550>, #<Casper::Entity::Delegator:0x000000000396c500>.....]
+# How to access members of one of the above delegator instances
+# For instance, access to stake amount at first delegator    
+# delegator = delegators[0]
+# stake_amount = delegator.get_staked_amount # => 27871095039894
+```

data/lib/crypto/asymmetric_key.rb

@@ -3,15 +3,15 @@ require_relative '../types/cl_public_key.rb'
 require_relative '../utils/hex_utils.rb'
 require_relative '../utils/hash_utils.rb'
 
-CLPublicKeyTag = {
-  ED25519: 1,
-  SECP256K1: 2
-}
+# CLPublicKeyTag = {
+#   ED25519: 1,
+#   SECP256K1: 2
+# }
 
-SignatureAlgorithm = {
-  Ed25519: 'ed25519',
-  Secp256K1: 'secp256k1'
-}
+# SignatureAlgorithm = {
+#   Ed25519: 'ed25519',
+#   Secp256K1: 'secp256k1'
+# }
 
 class AsymmetricKey
   attr_reader :public_key, :private_key, :signature_algorithm
@@ -19,7 +19,8 @@ class AsymmetricKey
   # @param [CLPublicKey] public_key
   # @param [Array] private_key
   # @param [SignatureAlgorithm] signature_algorithm
-  def initialize(public_key, private_key, signature_algorithm)
+  def initialize(public_key = CLPublicKey.new([204, 238, 25, 54, 110, 175, 3, 72, 124, 184, 17, 151, 174, 142, 220, 
+  177, 180, 127, 33, 76, 238, 0, 214, 89, 115, 128, 9, 107, 159, 132, 99, 193], 1), private_key = nil, signature_algorithm = nil)
     @public_key = public_key
     @private_key = private_key
     @signature_algorithm = signature_algorithm
@@ -49,15 +50,15 @@ class AsymmetricKey
   end
 
   # @return [Array<Integer>] 
-  def account_hash
-    @tag = @public_key.get_cl_public_key_tag
-    key_name = CLPublicKeyTag.key(@tag).to_s
-    prefix = key_name.downcase.unpack("C*") + [0]
-    bytes = prefix + @public_key.get_value
-    result_array = Utils::HashUtils.byte_hash(bytes)
-    @public_key.get_value.length == 0 ? [] : result_array
-    #*** @public_key.to_account_hash_byte_array
-  end
+  # def account_hash
+  #   @tag = @public_key.get_cl_public_key_tag
+  #   key_name = CLPublicKeyTag.key(@tag).to_s
+  #   prefix = key_name.downcase.unpack("C*") + [0]
+  #   bytes = prefix + @public_key.get_value
+  #   result_array = Utils::HashUtils.byte_hash(bytes)
+  #   @public_key.get_value.length == 0 ? [] : result_array
+  #   #*** @public_key.to_account_hash_byte_array
+  # end
  
   # @param [String] path_to_private_key
   def create_from_private_key_file(path_to_private_key)