casper_network 1.0.0 → 1.0.2

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
@@ -22,32 +23,32 @@ module Casper
         @id = transfer[:id]
       end
 
-      # @return [String] deploy_hash
+      # @return [String] deploy that created the transfer
       def get_deploy_hash
         @deploy_hash
       end
 
-      # @return [String] from
+      # @return [String] account from which transfer was executed
       def get_from
         @from
       end
 
-      # @return [String] to
+      # @return [String] account to which funds are transferred
       def get_to
         @to
       end
 
-      # @return [String] source
+      # @return [String] tource purse
       def get_source
         @source
       end
 
-      # @return [String] target
+      # @return [String] target purse
       def get_target
         @target
       end
 
-      # @return [String] amount
+      # @return [String] transfer amount
       def get_amount
         @amount
       end
@@ -56,7 +57,7 @@ module Casper
       def get_gas
         @gas
       end
-      # @return [Integer] id
+      # @return [Integer] user-defined id
       def get_id
         @id
       end

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.2'
 end

data/spec/client_spec.rb

@@ -1,25 +1,25 @@
 # client_spec.rb
-# require './lib/casper_network.rb'
+require './lib/rpc/rpc_client.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 Casper::RpcClient do
+  client1 = Casper::RpcClient.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.2
 platform: ruby
 authors:
 - Mehmet Sait Gülmez
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-18 00:00:00.000000000 Z
+date: 2022-09-24 00:00:00.000000000 Z
 dependencies: []
 description: Ruby gem enables developers to interact with the Casper Network.
 email: cenggulmez.65@gmail.com
@@ -35,6 +35,11 @@ files:
 - lib/entity/auction_state.rb
 - lib/entity/bid.rb
 - lib/entity/bid_info.rb
+- lib/entity/block.rb
+- lib/entity/block_body.rb
+- lib/entity/block_header.rb
+- lib/entity/block_info.rb
+- lib/entity/block_proof.rb
 - lib/entity/contract.rb
 - lib/entity/contract_package.rb
 - lib/entity/contract_version.rb
@@ -58,6 +63,7 @@ files:
 - lib/entity/module_bytes.rb
 - lib/entity/peer.rb
 - lib/entity/seigniorage_allocation.rb
+- lib/entity/status.rb
 - lib/entity/stored_contract_by_hash.rb
 - lib/entity/stored_contract_by_name.rb
 - lib/entity/stored_value.rb