casper_network 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5690859dc418eff2224b41b3001cb2c61bd3ec34df10249a4a5d13d42fba979d
-  data.tar.gz: d5faa5ae453065ddae80766f33332c24c4b6f3fe9a6aa530a007f5fc806d1f38
+  metadata.gz: 79a82b8fd4b57919a7bfe74dcd42f79fcdcac5a89a68722ee5d9d0cc4f621f76
+  data.tar.gz: 4c77091a8448de28de05cf8af7b19e32bd21f6e7dc2916f8e91c1def1738db7d
 SHA512:
-  metadata.gz: 7c7f495af10f0ea7c22a392ac6401e57545d748b52adf8d6b987592646d42eb67b8ca2155d9ed7d43e7ac808819bcd5d754c393fb747bd12d6e53b87d6e1477c
-  data.tar.gz: fa704d9f40f44c1099aa2b08ea2452b8e4731fd01356a3d574bb17f9d982de494117ef50aaf7cd92dab65117c6d05ff33b1429c29607f269dc1388350f1633ef
+  metadata.gz: e884413451fb3e760745245319570d2a299c276c0885042c170821e535aaec7eeed65772e68c6c444f63674ba60d4d2ee2933a99dd8512b0b0975909faada95c
+  data.tar.gz: e01d429e70bf95b5a2e3197de1fec5a935a7507adb553bf52cf773d862a919f090c0e6654744aa5d4b7aae1f0915d3a6595f79b7951d6ab8f43236ccbd27ea94

data/lib/casper_network.rb

@@ -15,9 +15,8 @@ require_relative './rpc/rpc_client.rb'
 # Dir["./serialization/*.rb"].each {|file|  require file }
 # Dir["./types/*.rb"].each {|file|  require file }
 require_relative './include.rb'
-# Class for interacting with the network via RPC
-# puts "Hello"
 module Casper
+   # Interacting with the network
   class CasperClient 
     attr_accessor :ip_address, :port, :url, :state_root_hash
 

data/lib/crypto/00_asymmetric_key.rb

@@ -56,7 +56,7 @@ class AsymmetricKey
     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
+    #** @public_key.to_account_hash_byte_array
   end
  
   # @param [String] path_to_private_key

data/lib/crypto/asymmetric_key.rb

@@ -56,7 +56,7 @@ class AsymmetricKey
     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
+    #*** @public_key.to_account_hash_byte_array
   end
  
   # @param [String] path_to_private_key

data/lib/entity/account.rb

@@ -5,7 +5,7 @@ module Casper
      
       # @param [CLAccountHash] account_hash
       # @param [Array] named_keys
-      # @param [CLUref] main_purse, The account's main purse URef
+      # @param [CLUref] main_purse  The account's main purse URef
       # @param [Array] associated_keys
       # @param [Array<ActionThresHolds>] action_thresholds
       def initialize(account_hash, named_keys, main_purse, associated_keys, action_thresholds)

data/lib/entity/action_thresholds.rb

@@ -4,8 +4,8 @@ module Casper
     # @note The minimum weight thresholds that have to be met when executing an action of a certain type. 
     class ActionThresholds
 
-      # @param [Integer] deployment, threshold required to perform deployment actions.
-      # @param [Integer] key_management, threshold required to perform key management actions.
+      # @param [Integer] deployment  Threshold required to perform deployment actions.
+      # @param [Integer] key_management  Threshold required to perform key management actions.
       def initialize(deployment, key_management)
         @deployment = deployment
         @key_management = key_management

data/lib/entity/associated_key.rb

@@ -1,6 +1,6 @@
 module Casper
   module Entity
-
+    # A key granted limited permissions to an Account, for purposes such as multisig.
     class AssociatedKey
 
       # @param [CLAccountHash] account_hash

data/lib/entity/auction_state.rb

@@ -1,5 +1,6 @@
 module Casper
   module Entity
+    # Data structure summarizing auction contract data.
     class AuctionState
       # @param [String] state_root_hash
       # @param [Integer] block_height

data/lib/entity/bid.rb

@@ -1,5 +1,6 @@
 module Casper
   module Entity
+    # An entry in the validator map.
     class Bid
 
       # @param [String] public_key

data/lib/entity/bid_info.rb

@@ -1,5 +1,6 @@
 module Casper
   module Entity
+    # BidInfo
     class BidInfo  
 
       # @param [String] bonding_purse

data/lib/entity/contract.rb

@@ -1,7 +1,7 @@
 module Casper
   module Entity
 
-    # Contract entity class
+    # Information, entry points and named keys belonging to a Contract
     class Contract 
       
       # @param [String] contract_package_hash

data/lib/entity/delegator.rb

@@ -1,5 +1,6 @@
 module Casper
   module Entity
+    # A delegator associated with the given validator.
     class Delegator
       
       # @param [String] public_key

data/lib/entity/deploy.rb

@@ -1,5 +1,6 @@
 module Casper
   module Entity
+    # Deploy, an item containing a smart contract along with the requester's signature(s).
     class Deploy
     
       # @param [String] hash

data/lib/entity/deploy_approval.rb

@@ -1,5 +1,6 @@
 module Casper
   module Entity
+    # Signature and Public Key of the signer.
     class DeployApproval 
      
       # @param [Hash] approval

data/lib/entity/deploy_executable.rb

@@ -4,6 +4,7 @@ require_relative './deploy_executable_transfer.rb'
 
 module Casper
   module Entity
+    # DeployExecutable
     class DeployExecutable 
       attr_accessor :module_bytes, :transfer, :stored_contract_by_hash, :stored_contract_by_name,
       :stored_versioned_contract_by_hash, :stored_versioned_contract_by_name
@@ -81,7 +82,7 @@ module Casper
         @transfer != nil
       end
 
-      # @param [StoredContractByHash] transfer
+      # @param [StoredContractByHash] stored_contract_by_hash
       def set_stored_contract_by_hash(stored_contract_by_hash)
         @stored_contract_by_hash = stored_contract_by_hash
       end
@@ -109,7 +110,7 @@ module Casper
         @stored_contract_by_name != nil
       end
 
-      # @param [StoredVersionedContractByHash] stored_contract_by_name
+      # @param [StoredVersionedContractByHash] stored_versioned_contract_by_hash
       def set_stored_versioned_contract_by_hash(stored_versioned_contract_by_hash)
         @stored_versioned_contract_by_hash = stored_versioned_contract_by_hash
       end
@@ -123,7 +124,7 @@ module Casper
         @stored_versioned_contract_by_hash != nil
       end
 
-      # @param [StoredVersionedContractByName] stored_contract_by_name
+      # @param [StoredVersionedContractByName] stored_versioned_contract_by_name
       def set_stored_versioned_contract_by_name(stored_versioned_contract_by_name)
         @stored_versioned_contract_by_name = stored_versioned_contract_by_name
       end

data/lib/entity/deploy_executable_item_internal.rb

@@ -2,6 +2,7 @@ require_relative './deploy_named_argument.rb'
 
 module Casper
   module Entity
+    # DeployExecutableItemInternal
     class DeployExecutableItemInternal
       attr_accessor :args
       def initialize(deploy_named_args = [])

data/lib/entity/deploy_executable_transfer.rb

@@ -17,6 +17,7 @@ require_relative './deploy_executable_item_internal.rb'
 =end     
 module Casper
   module Entity
+    # A native transfer which does not contain or reference a Wasm code.
     class DeployExecutableTransfer < DeployExecutableItemInternal
    
       # @param [Array<Array<DeployNamedArgument>>] args

data/lib/entity/deploy_hash.rb

@@ -1,5 +1,6 @@
 module Casper
   module Entity
+    # Hex-encoded Deploy hash.
     class DeployHash
 
       # @param [String] hash

data/lib/entity/deploy_header.rb

@@ -1,5 +1,6 @@
 module Casper
   module Entity
+    # Header information of a Deploy.
     class DeployHeader 
      
       # @param [Hash] header

data/lib/entity/deploy_info.rb

@@ -1,5 +1,6 @@
 module Casper
   module Entity
+    # Information relating to the given Deploy.
     class DeployInfo
     
       # @param [String] hash

data/lib/entity/deploy_named_argument.rb

@@ -1,5 +1,6 @@
 module Casper
   module Entity
+    # Named arguments passed as input in a Deploy item. 
     class DeployNamedArgument
 
       def initialize(name, clvalue)

data/lib/entity/deploy_transfer.rb

@@ -1,5 +1,6 @@
 module Casper
   module Entity
+    # A native transfer which does not contain or reference a Wasm code.
     class DeployTransfer
 
       def initialize

data/lib/entity/era_summary.rb

@@ -1,5 +1,6 @@
 module Casper
   module Entity
+    # The summary of an era.
     class EraSummary
 
       # @param [String] block_hash_

data/lib/entity/era_validator.rb

@@ -1,5 +1,6 @@
 module Casper
   module Entity
+    # Validator and weights for an Era.
     class EraValidator
 
       # @param [Integer] era_id

data/lib/entity/executable_deploy_item.rb

@@ -1,6 +1,6 @@
 module Casper
   module Entity
-
+    # Represents possible variants of an executable Deploy.
     class ExecutableDeployItem
 
       def initialize

data/lib/entity/group.rb

@@ -1,7 +1,7 @@
 module Casper
   module Entity
-
-    class Group
+    # Group
+    class Group 
 
       # @param [String] group
       # @param [Array<CLURef>] keys

data/lib/entity/module_bytes.rb

@@ -2,6 +2,7 @@ require_relative './deploy_executable_item_internal.rb'
 
 module Casper
   module Entity
+    # Executable specified as raw bytes that represent Wasm code and an instance of RuntimeArgs.
     class ModuleBytes < DeployExecutableItemInternal
 
       # @param [String] module_bytes

data/lib/entity/peer.rb

@@ -1,5 +1,6 @@
 module Casper
   module Entity
+    # A node in the network.
     class Peer
 
       # @param [Hash] peer

data/lib/entity/stored_contract_by_hash.rb

@@ -2,6 +2,7 @@ require_relative './deploy_executable_item_internal.rb'
 
 module Casper
   module Entity
+    # Stored contract referenced by its ContractHash, entry point and an instance of RuntimeArgs.
     class StoredContractByHash < DeployExecutableItemInternal
       
       # @param [String] hash

data/lib/entity/stored_contract_by_name.rb

@@ -2,6 +2,8 @@ require_relative './deploy_executable_item_internal.rb'
 
 module Casper
   module Entity
+    # Stored contract referenced by a named key existing in the signer's Account context, 
+    #  entry point and an instance of RuntimeArgs.
     class StoredContractByName < DeployExecutableItemInternal
    
       # @param [String] name

data/lib/entity/stored_versioned_contract_by_hash.rb

@@ -2,6 +2,8 @@ require_relative './deploy_executable_item_internal.rb'
 
 module Casper
   module Entity
+    # Stored versioned contract referenced by its ContractPackageHash, 
+    #  entry point and an instance of RuntimeArgs.
     class StoredVersionedContractByHash < DeployExecutableItemInternal
    
       # @param [String] hash

data/lib/entity/stored_versioned_contract_by_name.rb

@@ -2,6 +2,8 @@ require_relative './deploy_executable_item_internal.rb'
 
 module Casper
   module Entity
+    # Stored versioned contract referenced by a named key existing in the signer's Account context, 
+    #  entry point and an instance of RuntimeArgs.
     class StoredVersionedContractByName < DeployExecutableItemInternal
    
       # @param [String] name

data/lib/entity/transfer.rb

@@ -1,5 +1,6 @@
 module Casper
   module Entity
+    # Represents a transfer from one purse to another
     class Transfer
     
       # @param [Hash] transfer

data/lib/entity/validator_weight.rb

@@ -1,5 +1,6 @@
 module Casper
   module Entity
+    # A validator's weight.
     class ValidatorWeight
 
       # @param [String] public_key

data/lib/rpc/rpc_client.rb

@@ -8,8 +8,8 @@ require 'active_support/core_ext/hash/keys'
 require 'timeout'
 require 'net/http'
 require_relative './rpc_error.rb'
-# Class for interacting with the network via RPC
 module Casper
+  # Interacting with the network via RPC
   class RpcClient 
     attr_accessor :ip_address, :port, :url, :state_root_hash
 

data/lib/rpc/rpc_error.rb

@@ -1,6 +1,7 @@
 
 module Casper
   module RpcError
+    # Exception handling
     class ErrorHandle  
       # @param [Integer] code
       # @param [String] message

data/lib/serialization/cl_type_serializer.rb

@@ -20,6 +20,7 @@ require_relative '../types/cl_tuple_type.rb'
 require_relative '../types/cl_any_type.rb'
 require_relative '../types/cl_public_key_type.rb'
 
+# Byte serializer for CLType
 class CLTypeSerizalizer
 
   def self.serialize_cl_type(cl_type)

data/lib/serialization/cl_value_bytes_parsers.rb

@@ -311,7 +311,7 @@ module CLValueBytesParsers
   module CLOptionBytesParser
     extend self
 
-    # @param [CLOption]
+    # @param [CLOption] cl_option
     def to_bytes(cl_option)
       
     end

data/lib/serialization/cl_value_serializer.rb

@@ -20,6 +20,7 @@ require_relative '../types/cl_public_key.rb'
 require_relative '../types/constants.rb'
 require_relative '../serialization/cl_value_bytes_parsers.rb'
 
+# Byte serializer for CLValue
 class CLValueSerializer
 
   def to_bytes(clvalue)

data/lib/serialization/deploy_approval_serializer.rb

@@ -3,6 +3,7 @@ require_relative '../serialization/cl_value_bytes_parsers.rb'
 require_relative '../utils/time_utils.rb'
 require_relative '../utils/byte_utils.rb'
 
+# Byte serializer for DeployApproval object
 class DeployApprovalSerializer
   def to_bytes(deploy_approval)
     @approval_serializer = ""

data/lib/serialization/deploy_executable_serializer.rb

@@ -1,12 +1,13 @@
 require_relative '../entity/deploy_executable.rb'
 
-
+# Byte serializer for DeployExecutable object
 class DeployExecutableSerializer
 
   def initialize 
-    # @deploy_executable = Casper::Entity::DeployExecutable.new
+    @deploy_executable = Casper::Entity::DeployExecutable.new
   end
 
+  # @param [DeployExecutable] deploy_executable
   def to_bytes(deploy_executable)
     if deploy_executable.module_bytes?
       deploy_executable.get_module_bytes.to_bytes

data/lib/serialization/deploy_header_serializer.rb

@@ -3,10 +3,10 @@ require_relative '../serialization/cl_value_bytes_parsers.rb'
 require_relative '../utils/time_utils.rb'
 require_relative '../utils/byte_utils.rb'
 
-
+# Byte serializer for DeployHeader object
 class DeployHeaderSerializer 
 
-  # @param [DeployerHeader] header
+  # @param [DeployerHeader] deploy_header
   # @return [String] serialized_header
   def to_bytes(deploy_header)
     @serialized_header = ""

data/lib/serialization/deploy_named_arg_serializer.rb

@@ -4,6 +4,7 @@ require_relative '../utils/byte_utils.rb'
 require_relative './cl_type_serializer.rb'
 require_relative './cl_value_serializer.rb'
 
+# Byte serializer for DeployNamedArg object
 class DeployNamedArgSerializer
 
   def to_bytes(arg)

data/lib/serialization/deploy_serializer.rb

@@ -4,6 +4,7 @@ require_relative './deploy_executable_serializer'
 require_relative './deploy_named_arg_serializer'
 require_relative '../utils/byte_utils.rb'
 
+# Byte serializer for Deploy object
 class DeploySerializer
 
   def to_bytes(deploy)

data/lib/types/cl_type.rb

@@ -1,5 +1,7 @@
 require 'json'
 
+# Casper types, i.e. types which can be stored and manipulated by smart contracts.
+# Provides a description of the underlying data type of a CLValue.
 class CLType    
   TAGS = {
     # Boolean primitive.
@@ -71,7 +73,7 @@ class CLType
     TAGS[key]
   end
 
-  # @param [Integer]
+  # @param [Integer] value
   # @return [String] 
   def get_tag_key(value)
     TAGS.key(value).to_s
@@ -86,8 +88,8 @@ class CLType
     TAGS
   end
 
-  # @param [Integer] tag_value
-  # @return [Boolean] true or false
+  # @param [Integer] value
+  # @return [Boolean] 
   def tag_value_isvalid(value)
     TAGS.has_value?(value)
   end

data/lib/types/cl_uref.rb

@@ -11,7 +11,8 @@ require 'json'
 class CLURef < CLValue  
   include CLValueBytesParsers::CLURefBytesParser
   attr_accessor :err
-  # @param [Array<Integer>]
+  # @param [Array<Integer>] value
+  # @param [AccessRights] access_rights
   # value is an uint8array
   def initialize(value = nil, access_rights = nil)
     super()

data/lib/types/cl_value.rb

@@ -1,5 +1,6 @@
 require_relative './cl_type.rb'
 
+# A Casper value, i.e. a value which can be stored and manipulated by smart contracts.
 class CLValue
 
   def initialize(bytes = nil, cl_type =  nil, parsed = nil)

data/lib/utils/byte_utils.rb

@@ -2,7 +2,7 @@ module Utils
   module ByteUtils
     extend self
 
-    # @param [String] string
+    # @param [String] str
     # @return [String] 
     def string_to_hex(str)
       # str.unpack1("H*")
@@ -28,7 +28,7 @@ module Utils
       byte_array.pack("C*").unpack("H*").first
     end
 
-    # @param [String] string
+    # @param [String] str
     # @return [Array]
     def string_to_byte_array(str)
       str.unpack("C*")
@@ -78,7 +78,7 @@ module Utils
     end
 
     # @param [String] hex_str
-    # @param [String] 
+    # @return [String] 
     def hex_from_little_endian_to_big_endian(hex_str)
       # [hex_str].pack("H*").unpack('N*').pack('V*').unpack1('H*')
       [hex_str].pack("H*").unpack('N*').pack('V*').unpack('H*').first

data/lib/version.rb

@@ -1,3 +1,3 @@
 module CasperNetworkSDK
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/spec/client_spec.rb

@@ -1,25 +1,25 @@
 # client_spec.rb
-# require './lib/casper_network.rb'
+require './lib/casper_network.rb'
 
-# describe CasperClient do
-#   client1 = CasperClient.new("185.246.84.43")
-#   # Test info_get_peers()
-#   describe "#info_get_peers" do
-#     it "returns peers array." do
-#       # Check whether ıt is an array or not
-#       expect(client1.info_get_peers).to be_an(Array)
-#       # Check the length of the peers array 
-#       expect(client1.info_get_peers.length).to be > 0
+describe CasperClient do
+  client1 = CasperClient.new("185.246.84.43")
+  # Test info_get_peers()
+  describe "#info_get_peers" do
+    it "returns peers array." do
+      # Check whether ıt is an array or not
+      expect(client1.info_get_peers).to be_an(Array)
+      # Check the length of the peers array 
+      expect(client1.info_get_peers.length).to be > 0
 
-#     end
-#   end   
-#    # Test chain_get_StateRootHash() 
-#   describe "#chain_get_StateRootHash" do
-#     it "returns current state_root_hash." do
-#       # Check whether its type is string or not
-#       expect(client1.chain_get_StateRootHash).to be_an(String)
-#     end
-#   end  
+    end
+  end   
+   # Test chain_get_StateRootHash() 
+  describe "#chain_get_StateRootHash" do
+    it "returns current state_root_hash." do
+      # Check whether its type is string or not
+      expect(client1.chain_get_StateRootHash).to be_an(String)
+    end
+  end  
 
 
-# end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: casper_network
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Mehmet Sait Gülmez
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-18 00:00:00.000000000 Z
+date: 2022-09-20 00:00:00.000000000 Z
 dependencies: []
 description: Ruby gem enables developers to interact with the Casper Network.
 email: cenggulmez.65@gmail.com