casper_network 0.2.1 → 1.0.1

data/lib/entity/contract.rb

@@ -0,0 +1,47 @@
+module Casper
+  module Entity
+
+    # Information, entry points and named keys belonging to a Contract
+    class Contract 
+      
+      # @param [String] contract_package_hash
+      # @param [String] contract_wasm_hash
+      # @param [Array] entry_points
+      # @param [Array] named_keys
+      # @param [String] protocol_version
+      def initialize(contract_package_hash, contract_wasm_hash, named_keys, entry_points, protocol_version)
+        @contract_package_hash = contract_package_hash
+        @contract_wasm_hash = contract_wasm_hash
+        @entry_points = entry_points
+        @named_keys = named_keys
+        @protocol_version = protocol_version
+      end
+
+      # @return [String] contract_package_hash
+      def get_contract_package_hash
+        @contract_package_hash
+      end
+
+      # @return [String] contract_wasm_hash
+      def get_contract_wasm_hash
+        @contract_wasm_hash
+      end
+
+      # @return [Array] entry_points
+      def get_entry_points
+        @entry_points
+      end
+
+      # @return [Array] named_keys
+      def get_named_keys
+        @named_keys
+      end
+
+      # @return [String] protocol_version
+      def get_protocol_version
+        @protocol_version
+      end
+
+    end
+  end
+end

data/lib/entity/contract_package.rb

@@ -0,0 +1,41 @@
+module Casper
+  module Entity
+
+    # Contract definition, metadata and security container.
+    class ContractPackage 
+      
+      # @param [CLURef] access_key
+      # @param [ContractVersion] versions
+      # @param [DisabledVersion] disabled_versions
+      # @param [Group] groups
+      def initialize(access_key, versions, disabled_versions, groups)
+        @access_key = access_key
+        @versions = versions
+        @disabled_versions = disabled_versions
+        @groups = groups
+      end
+
+      # @return [CLURef] access_key
+      def get_access_key
+        @access_key
+      end
+
+      # @return [ContractVersion] versions
+      def get_versions
+        @versions
+      end
+
+      # @return [DisabledVersion] versions
+      def get_disabled_versions
+        @disabled_versions
+      end
+
+      # @return [Group] groups
+      def get_groups
+        @groups
+      end
+
+
+    end
+  end
+end

data/lib/entity/contract_version.rb

@@ -0,0 +1,33 @@
+module Casper
+  module Entity
+
+    # The version of the contract.
+    class ContractVersion
+      
+      # @param [Integer] protocol_version_major
+      # @param [Integer] contract_version 
+      # @param [String] contract_hash
+      def initialize(protocol_version_major, contract_version, contract_hash)
+        @protocol_version_major = protocol_version_major
+        @contract_version = contract_version
+        @contract_hash = contract_hash
+      end
+
+      # @return [Integer] protocol_version_major
+      def get_protocol_version_major
+        @protocol_version_major
+      end
+
+      # @return [Integer] contract_version 
+      def get_contract_version
+        @contract_version
+      end
+      
+      # @return [String] contract_hash
+      def get_contract_hash
+        @contract_hash
+      end
+
+    end    
+  end
+end

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,12 +1,14 @@
 module Casper
   module Entity
+    # Signature and Public Key of the signer.
     class DeployApproval 
-
-      # @param [String] signer
-      # @param [String] signature
-      def initialize(signer, signature)
-        @signer = signer
-        @signature = signature
+     
+      # @param [Hash] approval
+      # @option approval [String] :signer
+      # @option approval [String] :signature
+      def initialize(approval = {})
+        @signer = approval[:signer]
+        @signature = approval[:signature]
       end
 
       # @return [String] signer

data/lib/entity/deploy_executable.rb

@@ -1,8 +1,162 @@
+require_relative './deploy_named_argument.rb'
+require_relative './module_bytes.rb'
+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
       def initialize
+        @module_bytes = nil
+        @stored_contract_by_hash = nil
+        @stored_contract_by_name = nil
+        @stored_versioned_contract_by_hash = nil
+        @stored_versioned_contract_by_name = nil
+        @transfer = nil
+      end
+
+      def standard_payment(payment_amount)
+        @module_bytes = ModuleBytes.new("", [])
+        arg = DeployNamedArgument.new("amount", CLu512.new(payment_amount))
+        @module_bytes.set_arg(arg) # => Add arg and return args
+        @module_bytes
+      end
+
+      # @param [Integer] id
+      # @param [Integer] amount
+      # @param [CLURef | CLPublicKey] target
+      # @param [CLURef | CLPublicKey] source_purse
+      # @return [DeployExecutable] 
+      def new_transfer(id, amount, target, source_purse = nil)
+        if target.instance_of? CLURef
+          @target = target
+        elsif target.instance_of? CLPublicKey
+          @target = target.to_account_hash_byte_array
+        else
+          raise ArgumentError.new("Please specify target")
+        end
+        arg1 = DeployNamedArgument.new("amount", CLu512.new(amount))
+        # arg2 = DeployNamedArgument.new("target", @target)
+        @transfer = DeployExecutableTransfer.new([])
+        # @transfer.set_arg(DeployNamedArgument.new("target", @target))
+        # @transfer.set_arg(arg1)
+        # @transfer.set_arg(arg2)
+        # @transfer
+
+        if source_purse != nil
+          @transfer.set_arg(DeployNamedArgument.new("source", source_purse))
+          # @transfer
+        end
+        @transfer.set_arg(DeployNamedArgument.new("target", @target))
+        @transfer.set_arg(DeployNamedArgument.new("id", CLu64.new(id)))
+        @transfer
+      end
+
+      def set_module_bytes(module_bytes)
+        @module_bytes = module_bytes
+      end
+
+      # @return [ModuleBytes] module_bytes
+      def get_module_bytes
+        @module_bytes
+      end
+
+      # @return [Boolean]
+      def module_bytes?
+        @module_bytes != nil
+      end
+
+      # @param [DeployExecutableTransfer] transfer
+      def set_transfer(transfer)
+        @transfer = transfer
+      end
+
+      def get_transfer
+        @transfer
+      end
+
+      # @return [Boolean]
+      def transfer?
+        @transfer != nil
+      end
+
+      # @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
+
+      def get_stored_contract_by_hash
+        @stored_contract_by_hash
+      end
+
+      # @return [Boolean]
+      def stored_contract_by_hash?
+        @stored_contract_by_hash != nil
+      end
+
+      # @param [StoredContractByName] stored_contract_by_name
+      def set_stored_contract_by_name(stored_contract_by_name)
+        @stored_contract_by_name = stored_contract_by_name
+      end
+
+      def get_stored_contract_by_name
+        @stored_contract_by_name
+      end
+
+      # @return [Boolean]
+      def stored_contract_by_name?
+        @stored_contract_by_name != nil
+      end
+
+      # @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
+
+      def get_stored_versioned_contract_by_hash
+        @stored_versioned_contract_by_hash
+      end
+
+      # @return [Boolean]
+      def stored_versioned_contract_by_hash?
+        @stored_versioned_contract_by_hash != nil
+      end
+
+      # @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
+
+      def get_stored_versioned_contract_by_name
+        @stored_versioned_contract_by_name
+      end
+
+      # @return [Boolean]
+      def stored_versioned_contract_by_name?
+        @stored_versioned_contract_by_name != nil
+      end
+
+      def to_bytes
+        if module_bytes?
+          @module_bytes.to_bytes
+        elsif stored_contract_by_name?
+          @stored_contract_by_name.to_bytes
+        elsif stored_contract_by_hash?
+          @stored_contract_by_hash.to_bytes
+        elsif stored_contract_by_name?
+          @stored_contract_by_name.to_bytes
+        elsif stored_versioned_contract_by_hash?
+          @stored_versioned_contract_by_hash.to_bytes
+        elsif stored_versioned_contract_by_name?
+          @stored_versioned_contract_by_name.to_bytes
+        elsif stored_versioned_contract_by_hash?
+          @stored_versioned_contract_by_hash.to_bytes
+        elsif transfer?
+          @transfer.to_bytes
+        end
+        raise "failed to serialize ExecutableDeployItemJsonWrapper"
       end
     end
   end

data/lib/entity/deploy_executable_item_internal.rb

@@ -0,0 +1,27 @@
+require_relative './deploy_named_argument.rb'
+
+module Casper
+  module Entity
+    # DeployExecutableItemInternal
+    class DeployExecutableItemInternal
+      attr_accessor :args
+      def initialize(deploy_named_args = [])
+        @args = deploy_named_args
+      end
+
+      # @return [Array<DeployNamedArg>]
+      def get_args
+        @args
+      end
+
+      # @return [DeployNamedArg]
+      def get_arg_by_name(arg)
+        @args.include?(arg) == true ? arg : nil
+      end
+
+      def set_arg(deploy_named_arg)
+        @args << [deploy_named_arg]
+      end
+    end
+  end
+end

data/lib/entity/deploy_executable_transfer.rb

@@ -0,0 +1,51 @@
+require_relative './deploy_executable_item_internal.rb'
+
+=begin
+"Transfer": {
+  "args": [
+    [
+      "amount",
+      {
+        "cl_type": "I32",
+        "bytes": "e8030000",
+        "parsed": 1000
+      }
+    ]
+  ]
+}
+
+=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
+      def initialize(args)
+        @tag = 5
+        @args = args
+      end
+
+      def get_tag
+        @tag
+      end
+
+      def get_args
+        @args 
+      end
+
+      def to_bytes
+        serializer = DeployNamedArgSerializer.new
+        num_of_args = @args.length
+        bytes = Utils::ByteUtils.to_u8(@tag) + Utils::ByteUtils.to_u32(num_of_args)
+
+        @args.each do |arg|
+          arg.each do |item|
+            bytes += serializer.to_bytes(item)
+          end
+        end
+        Utils::ByteUtils.hex_to_byte_array(bytes)
+      end
+    end
+  end
+end

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,24 +1,27 @@
 module Casper
   module Entity
+    # Header information of a Deploy.
     class DeployHeader 
      
-      # @param [String] account
-      # @param [Integer] timestamp
-      # @param [Integer] ttl
-      # @param [Integer] gas_price
-      # @param [String] body_hash
-      # @param [Array] dependencies
-      # @param [String] chain_name
-      def initialize(account, timestamp, ttl, gas_price, body_hash, dependencies, chain_name)
-        @account = account
-        @timestamp = timestamp
-        @ttl = ttl
-        @gas_price = gas_price
-        @body_hash = body_hash
-        @dependencies = dependencies
-        @chain_name = chain_name
+      # @param [Hash] header
+      # @option header [String] :account
+      # @option header [Integer] :timestamp
+      # @option header [Integer] :ttl
+      # @option header [Integer] :gas_price
+      # @option header [String] :body_hash
+      # @option header [Array] :dependencies
+      # @option header [String] :chain_name
+      def initialize(header = {})
+        @account = header[:account]
+        @timestamp = header[:timestamp]
+        @ttl = header[:ttl]
+        @gas_price = header[:gas_price]
+        @body_hash = header[:body_hash]
+        @dependencies = header[:dependencies]
+        @chain_name = header[:chain_name]
       end
 
+
       # @return [String] account
       def get_account
         @account

data/lib/entity/deploy_info.rb

@@ -0,0 +1,45 @@
+module Casper
+  module Entity
+    # Information relating to the given Deploy.
+    class DeployInfo
+    
+      # @param [String] hash
+      # @param [Array] transfers
+      # @param [String] from
+      # @param [String] source
+      # @param [String] gas
+      def initialize(hash, transfers, from, source, gas)
+        @hash = hash
+        @transfers = transfers
+        @from = from
+        @source = source
+        @gas = gas
+      end
+
+      # @return [String] hash
+      def get_hash
+        @hash 
+      end
+
+      # @return [Array] transfers
+      def get_transfers
+        @transfers 
+      end
+
+      # @return [String] from
+      def get_from 
+        @from  
+      end
+
+      # @return [String] source
+      def get_source 
+        @source  
+      end
+
+      # @return [String] gas
+      def get_gas
+        @gas  
+      end
+    end
+  end
+end

data/lib/entity/deploy_named_argument.rb

@@ -0,0 +1,20 @@
+module Casper
+  module Entity
+    # Named arguments passed as input in a Deploy item. 
+    class DeployNamedArgument
+
+      def initialize(name, clvalue)
+        @name = name
+        @value = clvalue
+      end
+
+      def get_name
+        @name
+      end
+
+      def get_value
+        @value
+      end
+    end
+  end
+end

data/lib/entity/deploy_transfer.rb

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

data/lib/entity/disabled_version.rb

@@ -0,0 +1,26 @@
+module Casper
+  module Entity
+
+    # A disabled version of a contract.
+    class DisabledVersion
+
+      # @param [Integer] protocol_version_major
+      # @param [Integer] contract_version
+      def initialize(protocol_version_major, contract_version)
+        @protocol_version_major = protocol_version_major
+        @contract_version = contract_version
+      end
+
+      # @return [Integer] protocol_version_major
+      def get_protocol_version_major
+        @protocol_version_major
+      end
+
+      # @return [Integer] contract_version
+      def get_contract_version
+        @contract_version
+      end
+
+    end
+  end
+end

data/lib/entity/era_info.rb

@@ -0,0 +1,18 @@
+module Casper
+  module Entity
+
+    # Auction metadata, intended to be recorded each era.
+    class EraInfo
+
+      # @param [Array] seigniorage_allocations rewards list allocated to validators and delegators
+      def initialize(seigniorage_allocations)
+        @seigniorage_allocations = seigniorage_allocations
+      end
+
+      # @return [Array]
+      def get_seigniorage_allocations
+        @seigniorage_allocations
+      end
+    end 
+  end
+end

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

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

data/lib/entity/group.rb

@@ -0,0 +1,25 @@
+module Casper
+  module Entity
+    # Group
+    class Group 
+
+      # @param [String] group
+      # @param [Array<CLURef>] keys
+      def initialize(group, keys)
+        @group = group
+        @keys = keys
+      end
+
+      # @return [String] group
+      def get_group
+        @group
+      end
+
+      # @return [Array<CLURef>] keys
+      def get_keys
+        @keys
+      end
+
+    end
+  end
+end

data/lib/entity/module_bytes.rb

@@ -0,0 +1,51 @@
+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
+      # @param [Array<Array<DeployNamedArgument>>] args
+      def initialize(module_bytes=nil, args = [])
+        @tag = 0
+        @module_bytes = module_bytes
+        @args = args
+      end
+
+      def get_tag
+        @tag
+      end
+      
+      def get_module_bytes
+        @module_bytes
+      end
+
+      def get_args
+        @args
+      end
+
+      def set_arg(deploy_named_arg)
+        @args << [deploy_named_arg]
+      end
+
+      def to_bytes
+        bytes = ""
+        serializer = DeployNamedArgSerializer.new
+        num_of_args = @args.length
+        bytes += Utils::ByteUtils.to_u8(@tag)
+
+        if @module_bytes == ""
+          bytes += Utils::ByteUtils.to_u32(0)
+        end
+        bytes += Utils::ByteUtils.to_u32(num_of_args)
+        @args.each do |arg|
+          arg.each do |item|
+            bytes += serializer.to_bytes(item)
+          end
+        end
+        Utils::ByteUtils.hex_to_byte_array(bytes)
+      end
+    end
+  end
+end