casper_network 1.0.0 → 1.0.2

data/lib/entity/block_header.rb

@@ -0,0 +1,81 @@
+module Casper
+  module Entity
+    # BlockHeader  
+    class BlockHeader
+
+      # @param [Hash] header
+      # @option header [String] :parent_hash
+      # @option header [String] :state_root_hash
+      # @option header [String] :parent_hash
+      # @option header [String] :body_hash
+      # @option header [Boolean] :random_bit
+      # @option header [String] :accumulated_seed
+      # @option header [String] :era_end
+      # @option header [Integer] :timestamp
+      # @option header [Integer] :era_id
+      # @option header [Integer] :height
+      def initialize(header = {})
+        @parent_hash = header[:parent_hash]
+        @state_root_hash = header[:state_root_hash]
+        @body_hash = header[:body_hash]
+        @random_bit = header[:random_bit]
+        @accumulated_seed = header[:accumulated_seed]
+        @era_end = header[:era_end]
+        @timestamp = header[:timestamp]
+        @era_id = header[:era_id]
+        @height = header[:height]
+        @protocol_version = header[:protocol_version]
+      end
+
+      # @return [String] parent_hash
+      def get_parent_hash
+        @parent_hash
+      end
+
+      # @return [String] state_root_hash
+      def get_state_root_hash
+        @state_root_hash
+      end
+
+      # @return [String] body_hash
+      def get_body_hash
+        @body_hash
+      end
+
+      # @return [Boolean] random_bit
+      def get_random_bit
+        @random_bit
+      end
+
+      # @return [String] accumulated_seed
+      def get_accumulated_seed
+        @accumulated_seed
+      end
+
+      # @return [String] era_end
+      def get_era_end
+        @era_end
+      end
+
+      # @return [Integer] timestamp
+      def get_timestamp
+        @timestamp
+      end
+
+      # @return [Integer] era_id
+      def get_era_id
+        @era_id
+      end
+
+      # @return [Integer] height
+      def get_height
+        @height
+      end
+
+      # @return [String] protocol_version
+      def get_protocol_version
+        @protocol_version
+      end
+    end
+  end
+end

data/lib/entity/block_info.rb

@@ -0,0 +1,56 @@
+module Casper
+  module Entity
+    # BlockInfo class entity
+    class BlockInfo
+
+      # @param [Hash] last_added_block_info
+      # @option last_added_block_info [String] :hash
+      # @option last_added_block_info [String] :timestamp
+      # @option last_added_block_info [Integer] :era_id
+      # @option last_added_block_info [Integer] :height
+      # @option last_added_block_info [String] :state_root_hash
+      # @option last_added_block_info [String] :creator
+      def initialize(last_added_block_info = {})
+        @hash = last_added_block_info[:hash]
+        @timestamp = last_added_block_info[:timestamp]
+        @era_id = last_added_block_info[:era_id]
+        @height = last_added_block_info[:height]
+        @state_root_hash = last_added_block_info[:state_root_hash]
+        @creator = last_added_block_info[:creator]
+      end
+
+      # @return [String] a cryptographic hash identifying a Block.
+      def get_hash
+        @hash
+      end
+
+      # @return [String] timestamp formatted as per RFC 3339.
+      def get_timestamp
+        @timestamp
+      end
+
+      # @return [Integer] era id in which this block was created.
+      def get_era_id 
+        @era_id
+      end
+
+      # @return [Integer] the height of this block, 
+      #   i.e., the number of ancestors.
+      def get_height
+        @height
+      end
+
+      # @return [String] the global state root hash produced by 
+      #   executing this block’s body.
+      def get_state_root_hash
+        @state_root_hash
+      end
+
+      # @return [String] hex-encoded cryptographic public key, 
+      #   including the algorithm tag prefix.
+      def get_creator
+        @creator
+      end
+    end
+  end
+end

data/lib/entity/block_proof.rb

@@ -0,0 +1,24 @@
+module Casper
+  module Entity
+    # BlockProof 
+    class BlockProof
+      # @param [Hash] proof
+      # @option proof [String] :public_key
+      # @option proof [String] :signature 
+      def initialize(proof = {})
+        @public_key = proof[:public_key]
+        @signature = proof[:signature]
+      end
+
+      # @return [String] public_key
+      def get_public_key
+        @public_key
+      end
+
+      # @return [String] signature
+      def get_signature
+        @signature
+      end
+    end
+  end
+end

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,18 +1,20 @@
 module Casper
   module Entity
+    # The summary of an era.
     class EraSummary
 
-      # @param [String] block_hash_
-      # @param [Integer] era_id_
-      # @param [StoredValue] stored_value_
-      # @param [String] state_root_hash_
-      # @param [String] merkle_proof_
-      def initialize(block_hash_, era_id_, stored_value_, state_root_hash_, merkle_proof_)
-        @block_hash = block_hash_
-        @era_id = era_id_
-        @stored_value = stored_value_
-        @state_root_hash = state_root_hash_
-        @merkle_proof = merkle_proof_
+      # @param [Hash] era_summary
+      # @option era_summary [String] :block_hash
+      # @option era_summary [Integer] :era_id
+      # @option era_summary [Hash] :stored_value
+      # @option era_summary [String] :state_root_hash
+      # @option era_summary [String] :merkle_proof
+      def initialize(era_summary = {})
+        @block_hash = era_summary[:block_hash]
+        @era_id = era_summary[:era_id]
+        @stored_value = Casper::Entity::StoredValue.new(era_summary[:stored_value])
+        @state_root_hash = era_summary[:state_root_hash]
+        @merkle_proof = era_summary[:merkle_proof]
       end
 
       # @return [String] block_hash
@@ -25,7 +27,7 @@ module Casper
         @era_id
       end
 
-      # @return [StoredValue] StoredValue
+      # @return [Hash] StoredValue
       def get_stored_value
         @stored_value
       end

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/status.rb

@@ -0,0 +1,80 @@
+module Casper
+  module Entity
+    class Status
+      # @param [Hash] status
+      # @option status [String] :api_version
+      # @option status [String] :chainspec_name
+      # @option status [String] :starting_state_root_hash
+      # @option status [Array<Hash>] :peers
+      # @option status [Hash] :last_added_block_info
+      # @option status [String] :our_public_signing_key
+      # @option status [Integer] :round_length 
+      # @option status [String] :next_upgrade
+      # @option status [String] :build_version
+      # @option status [String] :uptime
+      def initialize(status = {})
+        @api_version = status[:api_version] 
+        @chainspec_name = status[:chainspec_name] 
+        @starting_state_root_hash = status[:starting_state_root_hash] 
+        @peers = []
+        status[:peers].map { |peer| @peers << Casper::Entity::Peer.new(peer)}
+        @last_added_block_info = status[:last_added_block_info]
+        @our_public_signing_key = status[:our_public_signing_key]
+        @round_length = status[:round_length]
+        @next_upgrade = status[:next_upgrade]
+        @build_version = status[:build_version]
+        @uptime = status[:uptime]
+      end
+
+      # @return [String] the RPC API version.
+      def get_api_version
+        @api_version
+      end
+
+      # @return [String] the chainspec name.
+      def get_chainspec_name
+        @chainspec_name
+      end
+
+      # @return [String] the state root hash used at the start of the current sessio
+      def get_starting_state_root_hash
+        @starting_state_root_hash
+      end
+
+      # @return [Array<Peer>] the node ID and network address of each connected peer.
+      def get_peers
+        @peers
+      end
+
+      # @return [Hash] the minimal info of the last block from the linear chain.
+      def get_last_added_block_info
+        @last_added_block_info
+      end
+
+      # @return [String] Our public signing key.
+      def get_our_public_signing_key
+        @our_public_signing_key
+      end
+
+      # @return [Integer] the next round length if this node is a validator.
+      def get_round_length
+        @round_length
+      end
+
+      # @return [String] information about the next scheduled upgrade.
+      def get_next_upgrade
+        @next_upgrade
+      end
+
+      # @return [String] the compiled node version.
+      def get_build_version
+        @build_version
+      end
+
+      # @return [String] the time that passed since the node has started.
+      def get_uptime
+        @uptime
+      end
+    end
+  end
+end

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_value.rb

@@ -1,57 +1,132 @@
+
 module Casper
   module Entity
 
     # A class that represents a value stored in global state.
     class StoredValue
 
-      def initialize(cl_value, account, contract, contract_package, transfer, deploy_info, era_info, bid, withdraw)
-        @cl_value = cl_value
-        @account = account
-        @contract = contract
-        @contract_package = contract_package 
-        @transfer = transfer
-        @deploy_info = deploy_info
-        @era_info = era_info
-        @bid = bid
-        @withdraw = withdraw
+      # @param [Hash] stored_value
+      # @option stored_value [CLValue] :CLValue
+      # @option stored_value [Account] :Account
+      # @option stored_value [String] :ContractWasm
+      # @option stored_value [Contract] :Contract
+      # @option stored_value [ContractPackage] :ContractPackage
+      # @option stored_value [Transfer] :Transfer 
+      # @option stored_value [DeployInfo] :DeployInfo 
+      # @option stored_value [EraInfo] :EraInfo 
+      # @option stored_value [Bid] :Bid
+      # @option stored_value [Array] :Withdraw 
+      def initialize(stored_value = {})
+        @stored_value = stored_value
+        @cl_value = nil
+        @account = nil
+        @contract_wasm = nil
+        @contract = nil
+        @contract_package = nil
+        @transfer = nil
+        @deploy_info = nil
+        @era_info = nil
+        @bid = nil
+        @withdraw = nil
+        @key = nil
+        if stored_value.has_key?(:CLValue)
+          @cl_value = stored_value[:CLValue]
+          @key = :CLValue
+        end
+        if stored_value.has_key?(:Account)
+          @account = stored_value[:Account]
+          @key = :Account
+        end
+        if stored_value.has_key?(:ContractWasm)
+          @contract_wasm = stored_value[:ContractWasm]
+          @key = :ContractWasm
+        end
+        if stored_value.has_key?(:Contract)
+          @contract = stored_value[:Contract]
+          @key = :Contract
+        end
+        if stored_value.has_key?(:ContractPackage)
+          @contract_package = stored_value[:ContractPackage]
+          @key = :ContractPackage
+        end
+        if stored_value.has_key?(:Transfer)
+          @transfer = stored_value[:Transfer]
+          @key = :Transfer
+        end
+        if stored_value.has_key?(:DeployInfo)
+          @transfer = stored_value[:DeployInfo]
+          @key = :Deploy
+        end
+        if stored_value.has_key?(:EraInfo)
+          @era_info = stored_value[:EraInfo]
+          @key = :EraInfo
+        end
+        if stored_value.has_key?(:Bid)
+          @bid = stored_value[:Bid]
+          @key = :Bid
+        end
+        if stored_value.has_key?(:Withdraw)
+          @withdraw = stored_value[:Withdraw]
+          @key = :Withdraw
+        end
       end
 
+      # @return [CLValue] a CasperLabs value.
       def get_cl_value
         @cl_value
       end
 
+      # @return [Account] an account.
       def get_account
         @account
       end
 
+      # @return [String] a contract’s Wasm
       def get_contract
         @contract
       end
-
+      
+      # @return [Contract] methods and type signatures supported by a contract.
+      def get_contract
+        @contract
+      end
+      #  @return [ContractPackage] contract definition, metadata, and security container.
       def get_contract_package
         @contract_package
       end
 
+      # @return [Transfer] record of a transfer
       def get_transfer
         @transfer
       end
 
+      # @return [DeployInfo] record of a deploy
       def get_deploy_info
         @deploy_info
       end
 
+      # @return [EraInfo] auction metadata
       def get_era_info
         @era_info
       end
 
+      # @return [Bid] a bid
       def get_bid
         @bid
       end
 
+      # @return [Array] a withdraw
       def get_withdraw
         @withdraw
       end
 
+      def get_stored_value
+        @stored_value[@key]
+      end
+
+      def get_key
+        @key
+      end
     end
   end
 end

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