casper_network 0.2.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f511c7cefe099bfc5f6a67280f7826c179e9127f4dd8facf554351cdc132ab19
-  data.tar.gz: '08057f40c2f037da844a3a4f816ca538eb7985e71a41ae0d02303fc65f9527f1'
+  metadata.gz: 79a82b8fd4b57919a7bfe74dcd42f79fcdcac5a89a68722ee5d9d0cc4f621f76
+  data.tar.gz: 4c77091a8448de28de05cf8af7b19e32bd21f6e7dc2916f8e91c1def1738db7d
 SHA512:
-  metadata.gz: 61ca00e871d1fba6c79bf31b60dec38c5285d95675c457823843c7cb99956baadd96bf15c1953d0adbdf01caa5b31179a46ad528e9f3c48c5a203dc194194977
-  data.tar.gz: e9eb9a792d46f97a9316914c7d0cb885a48568b2f162feb97225cb64ff2a428d47b5a8b448c9aa941fc19275ad4da6dc8751694c6a95df97fd904948079d03a7
+  metadata.gz: e884413451fb3e760745245319570d2a299c276c0885042c170821e535aaec7eeed65772e68c6c444f63674ba60d4d2ee2933a99dd8512b0b0975909faada95c
+  data.tar.gz: e01d429e70bf95b5a2e3197de1fec5a935a7507adb553bf52cf773d862a919f090c0e6654744aa5d4b7aae1f0915d3a6595f79b7951d6ab8f43236ccbd27ea94

data/README.md

@@ -53,6 +53,8 @@ git checkout main
 rspec spec/testnet_spec.rb
 # To see the test results in detail
 rspec -fd spec/testnet_spec.rb
+# Test for cltypes
+rspec -fd spec/cl_types_spec.rb
 ```
 
 ## Mainnet Tests
@@ -79,7 +81,7 @@ require 'casper_network'
 
 # In order to interact with casper network we should give a valid ip address to the constructor
 
-# if it does not work, please choose another node ip address from the link1
+# 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" 
 # block_Hash taken from Testnet
@@ -93,7 +95,7 @@ switch_block_hash = "9e30104581a492f5c6faad4cdfb098311e3bf0e93897ebbfb47c3df62f5
 
 
 # Uncomment following lines to test on Mainnet 
-# if it does not work, please choose another node ip address from the link2
+# 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" 
 # block_Hash taken from MainNet
@@ -150,5 +152,14 @@ else
   puts "Invalid IP address"
 end
 ```
-- [link1](https://testnet.cspr.live/tools/peers),  [link2](https://cspr.live/tools/peers)
-- [doc](https://htmlpreview.github.io/?https://raw.githubusercontent.com/saitgulmez/casper-ruby-sdk/main/doc/index.html)
+- [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

data/lib/casper_network.rb

@@ -9,8 +9,14 @@ require 'timeout'
 require 'net/http'
 # require "./rpc/rpc.rb"
 require_relative './rpc/rpc_error.rb'
-# Class for interacting with the network via RPC
+require_relative './rpc/rpc_client.rb'
+
+# Dir["./entity/*.rb"].each {|file|  require  file }
+# Dir["./serialization/*.rb"].each {|file|  require file }
+# Dir["./types/*.rb"].each {|file|  require file }
+require_relative './include.rb'
 module Casper
+   # Interacting with the network
   class CasperClient 
     attr_accessor :ip_address, :port, :url, :state_root_hash
 
@@ -33,18 +39,37 @@ module Casper
       @rpc_error = Casper::RpcError::ErrorHandle.new
       @err = @rpc_error.error_handling(@url)
 
+      @pr = []
+
     end
 
     def get_error 
       @err
     end
 
+    # @return [Array<Hash>] peers array
+    # def info_get_peers
+    #     begin
+    #       client = Jimson::Client.new(@url)
+    #       response = client.info_get_peers
+    #       @peer_array = response["peers"]
+    #     rescue
+    #       @rpc_error = Casper::RpcError::ErrorHandle.new
+    #       @error = @rpc_error.error_handling(@url)
+    #     end
+    # end
+
     # @return [Array<Hash>] peers array
     def info_get_peers
         begin
           client = Jimson::Client.new(@url)
           response = client.info_get_peers
-          @peer_array = response["peers"]
+          @peers = response["peers"]
+          # @peers.map! do |peer|
+          #   peer.symbolize_keys
+          # end
+          @peers.map { |item| @pr << Casper::Entity::Peer.new(item.symbolize_keys) }
+          @pr
         rescue
           @rpc_error = Casper::RpcError::ErrorHandle.new
           @error = @rpc_error.error_handling(@url)
@@ -68,19 +93,40 @@ module Casper
     # Get information about a single deploy by hash.
     # @param [String] deploy_hash
     # @return [Hash] Deploy
+    # def info_get_deploy(deploy_hash)
+    #   begin
+    #     status = Timeout::timeout(10) {
+    #       client = Jimson::Client.new(@url)
+    #       response = client.info_get_deploy({"deploy_hash"=> deploy_hash })
+    #       if (deploy_hash == "" || deploy_hash == nil)
+    #         Casper::RpcError::InvalidParameter.error
+    #       end
+    #       @deploy = response["deploy"]
+    #       # @deploy.keys.each do |key|  
+    #       #     @deploy[(key.to_sym rescue key) || key] = @deploy.delete(key)
+    #       # end
+    #       @deploy
+    #     }
+    #   rescue
+    #     Casper::RpcError::InvalidParameter.error 
+    #   end
+    # end
     def info_get_deploy(deploy_hash)
+      @dep = nil
       begin
-        status = Timeout::timeout(10) {
+        status = Timeout::timeout(60) {
           client = Jimson::Client.new(@url)
           response = client.info_get_deploy({"deploy_hash"=> deploy_hash })
           if (deploy_hash == "" || deploy_hash == nil)
             Casper::RpcError::InvalidParameter.error
           end
-          @deploy = response["deploy"]
           # @deploy.keys.each do |key|  
           #     @deploy[(key.to_sym rescue key) || key] = @deploy.delete(key)
           # end
-          @deploy
+          temp = []
+          @deploy = response["deploy"]
+          @deploy.deep_symbolize_keys!
+          Casper::Entity::Deploy.new(@deploy[:hash], @deploy[:header], @deploy[:payment], @deploy[:session], @deploy[:approvals])
         }
       rescue
         Casper::RpcError::InvalidParameter.error 
@@ -111,8 +157,8 @@ module Casper
           response = client.chain_get_block_transfers({
             "block_identifier" => {"Hash" => block_hash}
           })
-          @block_transfers = response["transfers"]
-          @block_transfers
+          @transfers = response["transfers"]
+          @transfers.map { |transfer| Casper::Entity::Transfer.new(transfer.deep_symbolize_keys!)}
         }
       rescue
         Casper::RpcError::InvalidParameter.error
@@ -230,5 +276,13 @@ module Casper
         @error = @rpc_error.error_handling(@url)
       end
     end
+    
+    def put_deploy(deploy)
+      client = Jimson::Client.new(url)
+      response = client.account_put_deploy(deploy)
+      response['deploy_hash']
+    end
+  
   end
-end
+
+end

data/lib/crypto/00_asymmetric_key.rb

@@ -0,0 +1,95 @@
+require_relative '../utils/base_16.rb'
+require_relative '../types/cl_public_key.rb'
+require_relative '../utils/hex_utils.rb'
+require_relative '../utils/hash_utils.rb'
+
+CLPublicKeyTag = {
+  ED25519: 1,
+  SECP256K1: 2
+}
+
+SignatureAlgorithm = {
+  Ed25519: 'ed25519',
+  Secp256K1: 'secp256k1'
+}
+
+class AsymmetricKey
+  attr_reader :public_key, :private_key, :signature_algorithm
+  include Utils::HashUtils
+  # @param [CLPublicKey] public_key
+  # @param [Array] private_key
+  # @param [SignatureAlgorithm] signature_algorithm
+  def initialize(public_key, private_key, signature_algorithm)
+    @public_key = public_key
+    @private_key = private_key
+    @signature_algorithm = signature_algorithm
+    @tag = @public_key.get_cl_public_key_tag
+  end
+
+  # @return [CLPublicKey]
+  def get_public_key
+    @public_key
+  end
+
+  def get_signature_algorithm
+    @signature_algorithm
+  end
+
+  # Get public hex-encoded string
+  #
+  # @return [String]
+  def get_public_key_hex
+   "0#{@tag}" + Utils::Base16.encode16(@public_key.get_value)
+  end
+
+  # @param [CLPublicKey] public_key
+  # @return [String] account_hex
+  def account_hex(public_key)
+    account_hex = @public_key.to_hex
+  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
+ 
+  # @param [String] path_to_private_key
+  def create_from_private_key_file(path_to_private_key)
+    puts "AsymmetricKey::create_from_private_key_file is called!"
+  end
+
+  # Get public key which is stored in pem
+  def export_public_key_in_pem
+    puts "AsymmetricKey::export_public_key_in_pem is called!"
+  end
+
+  # @param [String] message
+  # @return [String]
+  def sign(message)
+    puts "AsymmetricKey:sign is called!"
+  end
+
+
+  # @param [String] signature
+  # @param [String] message
+  # @return [Boolean]
+  def verify(signature, message) 
+    puts "AsymmetricKey::verify is called!"
+  end
+ 
+  protected
+    attr_accessor :private_key
+
+    def to_pem(tag, content) 
+      line1 = "-----BEGIN #{tag}-----\n"
+      line2 = "#{content}"
+      line3 = "-----END #{tag}-----\n"
+      line1 + line2 + line3
+    end
+end

data/lib/crypto/01_ed25519.rb

@@ -0,0 +1,67 @@
+require 'openssl'
+require 'ed25519'
+require_relative './asymmetric_key.rb'
+
+
+
+class Ed25519Key < AsymmetricKey
+
+  def initialize(public_key, private_key)
+    super(public_key, private_key, SignatureAlgorithm[:Ed25519])
+  end
+
+  # @param [Array] public_key
+  # @return [String]
+  # def self.account_hex(public_key)
+  #   '01' + Utils::Base16.encode16(public_key)
+  # end
+
+
+  def create_from_private_key_file(path_to_private_key)
+
+  end
+
+
+  def parse_private_key_file(path)
+  end
+
+  def parse_public_key_file(path)
+  end
+
+  def parse_private_key(bytes)
+  end
+
+  def parse_public_key(bytes)
+  end
+
+  def read_base_64_with_pem(content)
+  end
+
+  # private method
+  def read_base_64_file(path)
+  end
+
+  # private
+  def parse_key(bytes, from, to)
+  end
+
+  def export_private_key_in_pem
+  end
+  
+  def export_public_key_in_pem
+  end
+
+  def sign(msg)
+  end
+
+  def verify(signature, msg)
+  end
+
+  def private_to_public(private_key)
+  end
+
+  def load_keypair_from_private_file(private_key_path)
+  end
+
+end
+

data/lib/crypto/asymmetric_key.rb

@@ -0,0 +1,87 @@
+require_relative '../utils/base_16.rb'
+require_relative '../types/cl_public_key.rb'
+require_relative '../utils/hex_utils.rb'
+require_relative '../utils/hash_utils.rb'
+
+CLPublicKeyTag = {
+  ED25519: 1,
+  SECP256K1: 2
+}
+
+SignatureAlgorithm = {
+  Ed25519: 'ed25519',
+  Secp256K1: 'secp256k1'
+}
+
+class AsymmetricKey
+  attr_reader :public_key, :private_key, :signature_algorithm
+  include Utils::HashUtils
+  # @param [CLPublicKey] public_key
+  # @param [Array] private_key
+  # @param [SignatureAlgorithm] signature_algorithm
+  def initialize(public_key, private_key, signature_algorithm)
+    @public_key = public_key
+    @private_key = private_key
+    @signature_algorithm = signature_algorithm
+    @tag = @public_key.get_cl_public_key_tag
+  end
+
+  # @return [CLPublicKey]
+  def get_public_key
+    @public_key
+  end
+
+  def get_signature_algorithm
+    @signature_algorithm
+  end
+
+  # Get public hex-encoded string
+  #
+  # @return [String]
+  def get_public_key_hex
+   "0#{@tag}" + Utils::Base16.encode16(@public_key.get_value)
+  end
+
+  # @param [CLPublicKey] public_key
+  # @return [String] account_hex
+  def account_hex(public_key)
+    account_hex = @public_key.to_hex
+  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
+ 
+  # @param [String] path_to_private_key
+  def create_from_private_key_file(path_to_private_key)
+  end
+
+  # Get public key which is stored in pem
+  def export_public_key_in_pem
+  end
+
+  # @param [String] message
+  # @return [String]
+  def sign(message)
+  end
+
+
+  # @param [String] signature
+  # @param [String] message
+  # @return [Boolean]
+  def verify(signature, message) 
+  end
+ 
+  protected
+    attr_accessor :private_key
+
+    def to_pem(tag, content) 
+    end
+end

data/lib/crypto/ed25519_key.rb

@@ -0,0 +1,44 @@
+require 'openssl'
+require 'ed25519'
+require_relative './asymmetric_key.rb'
+
+# ED25519 private key length in bytes
+PRIVATE_KEY_LENGTH = 32
+
+class Ed25519Key < AsymmetricKey
+
+  def initialize(public_key, private_key)
+    super(public_key, private_key, SignatureAlgorithm[:Ed25519])
+  end
+
+  # @param [Array] public_key
+  # @return [String]
+  # def self.account_hex(public_key)
+  #   '01' + Utils::Base16.encode16(public_key)
+  # end
+
+
+  def create_from_private_key_file(private_key_path)
+
+  end
+
+  def export_public_key_in_pem
+  end
+
+  def export_private_key_in_pem
+  end
+
+  def sign(msg)
+  end
+
+  def verify(signature, msg)
+  end
+
+  def private_to_public_key(private_key)
+  end
+
+  def parse_private_key(private_key)
+  end
+  
+end
+

data/lib/crypto/key_pair.rb

@@ -0,0 +1,40 @@
+require 'ed25519'
+
+
+signing_key = Ed25519::SigningKey.generate
+puts "signing_key:\t #{signing_key}" 
+
+message = "hello"
+signature = signing_key.sign(message)
+puts "signature:\t #{signature}"
+
+verify_key = signing_key.verify_key
+puts "verify_key:\t #{verify_key}"
+
+check_validity_of_signature = verify_key.verify(signature, message)
+puts "check_validity_of_signature:\t #{check_validity_of_signature}"
+
+# Serializing Keys
+signature_key_bytes = signing_key.to_bytes
+puts "signature_key_bytes:\t #{signature_key_bytes}"
+verify_key_bytes = verify_key.to_bytes
+puts "verify_key_bytes:\t #{verify_key_bytes}"
+
+signing_key = Ed25519::SigningKey.new(signature_key_bytes)
+puts "signing_key:\t #{signing_key}"
+verify_key  = Ed25519::VerifyKey.new(verify_key_bytes)
+puts "verify_key:\t #{verify_key}"
+
+
+require "ssh_data"
+
+# key_data = File.read("/home/mehmet/Desktop/casper-ruby-sdk/lib/crypto/id_ed25519")
+# key = SSHData::PrivateKey.parse_openssh(key_data)
+#=> <SSHData::PrivateKey::ED25519>
+
+# SSHData::PrivateKey::ED25519.generate
+#=> raises SSHData::AlgorithmError
+
+
+# SSHData::PrivateKey::ED25519.generate
+#=> <SSHData::PrivateKey::ED25519>

data/lib/crypto/keys.rb

@@ -0,0 +1,7 @@
+ 
+ SignatureAlgorithm = {
+  Ed25519: 'ed25519',
+  Secp256K1: 'secp256k1'
+}
+
+

data/lib/crypto/test_ed25519_key.rb

@@ -0,0 +1,44 @@
+require 'openssl'
+require 'ed25519'
+require_relative './asymmetric_key.rb'
+
+# SignatureAlgorithm = {
+#   Ed25519: 'ed25519',
+#   Secp256K1: 'secp256k1'
+# }
+public_key = [
+       72, 211, 174,  85,  36, 108, 106, 103,
+        8, 124, 245,  68,  60, 206, 180, 170,
+       17, 175, 158, 175, 142,  32,  64,  61,
+      195,  38, 169, 191,  55, 231, 249,  39
+    ]
+
+private_key = [
+    236, 126,   0, 243,   8,  76,   9, 186, 180, 175,  7,
+    155,  21,  92,  86,  47,  12,  70,  89, 171,  48, 87,
+     37, 172, 174,  34, 140, 219,  24, 190,  42, 192, 72,
+    211, 174,  85,  36, 108, 106, 103,   8, 124, 245, 68,
+     60, 206, 180, 170,  17, 175, 158, 175, 142,  32, 64,
+     61, 195,  38, 169, 191,  55, 231, 249,  39
+  ]
+class Ed25519Key < AsymmetricKey
+
+  def initialize(public_key, private_key)
+    # super(keypair.public_key, keypair.secret_key, SignatureAlgorithm[:Ed25519])
+    super(public_key, private_key, SignatureAlgorithm[:Ed25519])
+  end
+
+  # Generate the account_hex for the Ed25519 public key
+  # 
+  # @param [Array] public_key
+  # @return [String]
+  def account_hex(public_key)
+    '01' + Utils::Base16.encode16(public_key)
+  end
+end
+
+ed25519 = Ed25519Key.new(public_key, private_key)
+
+puts ed25519.account_hash(public_key)
+puts ed25519.get_signature_algorithm
+puts ed25519.get_public_key

data/lib/entity/account.rb

@@ -0,0 +1,45 @@
+module Casper
+  module Entity
+    # An Account is a structure that represents a user on a Casper Network.
+    class Account
+     
+      # @param [CLAccountHash] account_hash
+      # @param [Array] named_keys
+      # @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)
+        @account_hash = account_hash
+        @named_keys = named_keys
+        @main_purse = main_purse
+        @associated_keys = associated_keys
+        @action_thresholds = action_thresholds
+      end
+
+      # @return [CLAccountHash] 
+      def get_account_hash
+        @account_hash
+      end
+
+      # @return [Array]
+      def get_named_keys
+        @named_keys
+      end
+
+      # @return [CLUref]
+      def get_main_purse
+        @main_purse
+      end
+
+      # @return [Array<AssociatedKey>]
+      def get_associated_keys
+        @associated_keys
+      end
+
+      # @return [ActionThresHolds]
+      def get_action_thresholds
+        @action_thresholds
+      end
+    end
+  end
+end

data/lib/entity/action_thresholds.rb

@@ -0,0 +1,25 @@
+module Casper
+  module Entity
+    
+    # @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.
+      def initialize(deployment, key_management)
+        @deployment = deployment
+        @key_management = key_management
+      end
+
+      # @return [Integer] deployment
+      def get_deployment
+        @deployment
+      end
+
+      # @return [Integer] key_management
+      def get_key_management
+        @key_management
+      end
+    end
+  end
+end

data/lib/entity/associated_key.rb

@@ -0,0 +1,24 @@
+module Casper
+  module Entity
+    # A key granted limited permissions to an Account, for purposes such as multisig.
+    class AssociatedKey
+
+      # @param [CLAccountHash] account_hash
+      # @param [Integer] weight
+      def initialize(account_hash, weight)
+        @account_hash = account_hash
+        @weight = weight
+      end
+
+      # @return [CLAccountHash] account hash of associated key
+      def get_account_hash
+        @account_hash
+      end
+
+      # @return [Integer] weight of an associated key.
+      def get_weight
+        @weight
+      end
+    end
+  end
+end

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