tezos_client 1.2.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37c983e5bf0b57cb2d3758165076d7c17e091214c61401b5107989fab6b3e09f
-  data.tar.gz: 301462a20464486d1ad37bf0708aa00d1e2db30105f1944eacc4dbd67074d6a8
+  metadata.gz: a4767efa7b67fc781a2bee7f46beefc6a40f649fc4d3639fd279f1a0fcf76ed4
+  data.tar.gz: 4fef498bf7d952d82202ee4323efa107f7456b2d2f4aabfaabc5fb20cd451a9d
 SHA512:
-  metadata.gz: ec1a70b4066f70964182d811877cc6a2cad18ae95403a4a86e3e3758a35413922c85115fcf7e3c26edaf9e34f1d27f00f5a109c4050dfa9cc001479a3916b570
-  data.tar.gz: 3e2d3c82e9b811990f2682f7d4ce8992c1399850f43dfa587d0fe9f5f2c88f3307235792677210d8c71348ae0d9f083844e7617b194c851e6bbbf2b1c86a2bc3
+  metadata.gz: 4fcdbd1fca67c85791fd3259c29d140417f2712d458cb61d57136fe035a3aacbecfd89a1de8f47db0772481251fc6b670696044c3e424042b80afd59265530ab
+  data.tar.gz: 3a6eeff8a54d35eddaf62da354b420718805f110e2996838aab6b6a564f1e44a57bd5572a1b5a3717cec311234820e5ebbd51fb18d908064eaff861862b0f0ad

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.6.5

data/.travis.yml

@@ -13,11 +13,11 @@ rvm:
 before_install:
   - sh travis-scripts/prepare-ubuntu.sh
   - mkdir -p $HOME/bin
-  - curl -s https://SmartPy.io/SmartPyBasic/SmartPy.sh > SmartPy.sh
+  - curl -s https://smartpy.io/dev-20200912-bbb4b34cb579f3d52320c3d2aed8ebcef04429b0/cli/SmartPy.sh > SmartPy.sh
   - chmod +x ./SmartPy.sh
-  - ./SmartPy.sh local-install $HOME/bin/smartpy
+  - ./SmartPy.sh local-install-auto $HOME/bin/smartpy/cli
   - rm ./SmartPy.sh
-  - export PATH="$PATH:$HOME/bin/:$HOME/bin/smartpy/SmartPyBasic/"
+  - export PATH="$PATH:$HOME/bin/:$HOME/bin/smartpy/cli/"
   - npm link michelson-to-micheline
   - gem install bundler -v 1.16.3
 script:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tezos_client (1.2.1)
+    tezos_client (1.3.2)
       active_interaction (~> 3.7)
       activesupport (~> 6.0.0)
       base58 (~> 0.2.3)
@@ -14,29 +14,29 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.2.2)
-      actionview (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    actionpack (6.0.3.3)
+      actionview (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.2.2)
-      activesupport (= 6.0.2.2)
+    actionview (6.0.3.3)
+      activesupport (= 6.0.3.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    active_interaction (3.8.0)
+    active_interaction (3.8.3)
       activemodel (>= 4, < 7)
-    activemodel (6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activesupport (6.0.2.2)
+    activemodel (6.0.3.3)
+      activesupport (= 6.0.3.3)
+    activesupport (6.0.3.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
@@ -44,7 +44,7 @@ GEM
     bip_mnemonic (0.0.4)
     builder (3.2.4)
     coderay (1.1.2)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.7)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     crass (1.0.6)
@@ -52,30 +52,30 @@ GEM
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     erubi (1.9.0)
-    ffi (1.12.2)
+    ffi (1.13.1)
     hashdiff (1.0.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     httparty (0.17.3)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    i18n (1.8.2)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.3)
-    loofah (2.4.0)
+    loofah (2.7.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (0.9.2)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
+    mime-types-data (3.2020.0512)
     mini_portile2 (2.4.0)
-    minitest (5.14.0)
+    minitest (5.14.2)
     money-tree (0.10.0)
       ffi
     multi_xml (0.6.0)
     netrc (0.11.0)
-    nokogiri (1.10.9)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
     parallel (1.18.0)
     parser (2.6.5.0)
@@ -84,7 +84,7 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     public_suffix (4.0.1)
-    rack (2.2.2)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
@@ -92,9 +92,9 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    railties (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
@@ -140,18 +140,18 @@ GEM
     safe_yaml (1.0.5)
     thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.6)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.6)
+    unf_ext (0.0.7.7)
     unicode-display_width (1.6.0)
     vcr (4.0.0)
     webmock (3.7.6)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.3.0)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -27,7 +27,8 @@ need the tezos version (not Dune version)
 [SmartPy](https://smartpy.io/)
 
 ```bash
-sh <(curl -s https://SmartPy.io/SmartPyBasic/SmartPy.sh) local-install /
+sh <(curl -s https://smartpy.io/dev-20200924-23b26494361d96abf034bdbb1ad1af396f95fd61/cli/SmartPy.sh) local-install-auto
+export PATH=$PATH:$HOME/smartpy-cli/
 ```
 
 ### TypeScript (for dev)

data/lib/tezos_client.rb

@@ -36,6 +36,8 @@ require "tezos_client/smartpy_interface"
 
 require "tezos_client/tools/convert_to_hash"
 require "tezos_client/tools/find_big_maps_in_storage"
+require "tezos_client/tools/hash_to_micheline"
+require "tezos_client/tools/annots_to_type"
 
 class TezosClient
   using CurrencyUtils
@@ -163,14 +165,19 @@ class TezosClient
   end
 
   def call_contract(dry_run: false, entrypoint:, params:, params_type:, **args)
+    _entrypoint = select_entrypoint(
+      contract_address: args[:to],
+      entrypoint: entrypoint
+    )
+
     json_params = micheline_params(
       params: params,
-      entrypoint: entrypoint,
+      entrypoint: _entrypoint,
       params_type: params_type
     )
 
     transfer_args = args.merge(
-      entrypoint: entrypoint,
+      entrypoint: _entrypoint,
       parameters: json_params,
       dry_run: dry_run
     )
@@ -178,6 +185,18 @@ class TezosClient
     transfer(transfer_args)
   end
 
+  def select_entrypoint(contract_address:, entrypoint:)
+    entrypoints = entrypoints(contract_address)["entrypoints"].keys
+
+    if entrypoints.count == 0
+      "default"
+    elsif entrypoints.include?(entrypoint)
+      entrypoint
+    else
+      raise ::ArgumentError, "entrypoint #{entrypoint} not found in #{entrypoints}"
+    end
+  end
+
   def inject_raw_operations(secret_key:, raw_operations:, dry_run: false, **args)
     public_key = secret_key_to_public_key(secret_key)
     from = public_key_to_address(public_key)

data/lib/tezos_client/commands.rb

@@ -25,6 +25,8 @@ class TezosClient
                    :contract_big_maps,
                    :block_operations,
                    :contract_storage_type,
-                   :entrypoint
+                   :entrypoint,
+                   :entrypoints,
+                   :select_entrypoint
   end
 end

data/lib/tezos_client/crypto.rb

@@ -165,6 +165,22 @@ class TezosClient
       end
     end
 
+    # payload must be bytes
+    def check_signature(public_key:, signature:, payload:)
+      verify_key = RbNaCl::VerifyKey.new(decode_tz(public_key).to_bin)
+
+      bin_sig = decode_tz(signature).to_bin
+      payload_hash = RbNaCl::Hash::Blake2b.digest(ignore_0x(payload).to_bin, digest_size: 32)
+
+      verify_key.verify(bin_sig, payload_hash)
+    rescue RbNaCl::BadSignatureError
+      false
+    end
+
+    def check_signature!(public_key:, signature:, payload:)
+      check_signature(public_key: public_key, signature: signature, payload: payload) || raise(BadSignatureError)
+    end
+
     def operation_id(signed_operation_hex)
       hash = RbNaCl::Hash::Blake2b.digest(
         signed_operation_hex.to_bin,
@@ -220,5 +236,9 @@ class TezosClient
           RbNaCl::SigningKey.generate
         end
       end
+
+      def ignore_0x(payload)
+        payload.starts_with?("0x") ? payload[2..-1] : payload
+      end
   end
 end

data/lib/tezos_client/exceptions.rb

@@ -23,6 +23,9 @@ class TezosClient
   class SmartPyError < SysCallError
   end
 
+  class BadSignatureError < StandardError
+  end
+
   class InvalidActivation < RpcRequestFailure
     attr_reader :pkh
 

data/lib/tezos_client/operation_mgr.rb

@@ -202,40 +202,39 @@ class TezosClient
     end
 
     private
+      def ensure_applied!(rpc_responses)
+        metadatas = rpc_responses.map { |response| response[:metadata] }
+        operation_results = metadatas.map { |metadata| metadata[:operation_result] }
+        internal_operations = metadatas.map { |metadata| metadata[:internal_operation_results] }.flatten.compact
+        operation_results.concat(internal_operations.map { |internal_operation| internal_operation[:result] })
+
+        failed = operation_results.detect do |operation_result|
+          operation_result != nil && operation_result[:status] != "applied"
+        end
 
-    def ensure_applied!(rpc_responses)
-      metadatas = rpc_responses.map { |response| response[:metadata] }
-      operation_results = metadatas.map { |metadata| metadata[:operation_result] }
-      internal_operations = metadatas.map { |metadata| metadata[:internal_operation_results] }.flatten.compact
-      operation_results.concat(internal_operations.map { |internal_operation| internal_operation[:result] })
-
-      failed = operation_results.detect do |operation_result|
-        operation_result != nil && operation_result[:status] != "applied"
-      end
+        return metadatas if failed.nil?
 
-      return metadatas if failed.nil?
+        failed_operation_result = operation_results.detect do |operation_result|
+          operation_result[:status] == "failed"
+        end
 
-      failed_operation_result = operation_results.detect do |operation_result|
-        operation_result[:status] == "failed"
+        failed!("failed", failed_operation_result[:errors], operation_results)
       end
 
-      failed!("failed", failed_operation_result[:errors], operation_results)
-    end
-
-    def exception_klass(errors)
-      error = errors[0]
-      case error[:id]
-      when TezBalanceTooLow::FIRST_ERROR_REGEXP
-        TezBalanceTooLow
-      when ScriptRuntimeError::FIRST_ERROR_REGEXP
-        ScriptRuntimeError
-      else
-        OperationFailure
+      def exception_klass(errors)
+        error = errors[0]
+        case error[:id]
+        when TezBalanceTooLow::FIRST_ERROR_REGEXP
+          TezBalanceTooLow
+        when ScriptRuntimeError::FIRST_ERROR_REGEXP
+          ScriptRuntimeError
+        else
+          OperationFailure
+        end
       end
-    end
 
-    def failed!(status, errors, metadata)
-      raise exception_klass(errors).new(metadata: metadata, errors: errors, status: status)
-    end
+      def failed!(status, errors, metadata)
+        raise exception_klass(errors).new(metadata: metadata, errors: errors, status: status)
+      end
   end
-end
+end

data/lib/tezos_client/rpc_interface/contracts.rb

@@ -37,6 +37,10 @@ class TezosClient
         get "#{contract_link(contract_id)}/storage"
       end
 
+      def entrypoints(contract_id)
+        get("#{contract_link(contract_id)}/entrypoints")
+      end
+
       def entrypoint(contract_id, entrypoint)
         get("#{contract_link(contract_id)}/entrypoints/#{entrypoint}")
       end

data/lib/tezos_client/smartpy_interface.rb

@@ -30,16 +30,16 @@ class TezosClient
     end
 
     private
-      def compile_to_michelson(args)
-        Tools::TemporaryFile.with_file_copy(args[:script]) do |script_copy_path|
-          script_basename = script_copy_path.split("/").last.sub(/.py$/, "")
-          script_path = "/tmp/#{script_basename}/"
-          init_script_filename = "contractStorage.tz"
-          contract_script_filename = "contractCode.tz.json"
-          call_smartpy ["local-compile", script_copy_path, args[:init_params], script_path]
-
-          yield(script_path + contract_script_filename, script_path + init_script_filename)
-        end
+    def compile_to_michelson(args)
+      Tools::TemporaryFile.with_file_copy(args[:script]) do |script_copy_path|
+        script_basename = script_copy_path.split("/").last.sub(/.py$/, "")
+        script_path = "/tmp/#{script_basename}/"
+        init_script_filename = "#{script_basename}_storage_init.tz"
+        contract_script_filename = "#{script_basename}_compiled.json"
+        call_smartpy ["compile", script_copy_path, args[:init_params], script_path]
+
+        yield(script_path + contract_script_filename, script_path + init_script_filename)
       end
+    end
   end
 end

data/lib/tezos_client/tools/annots_to_type.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+class TezosClient::Tools::AnnotsToType < ActiveInteraction::Base
+  # example of typed_annots :
+  # {
+  #   spending_ref: "string",
+  #   remainder_amount: "nat",
+  #   expires_at: "timestamp"
+  # }
+  hash :typed_annots, strip: false
+
+  validate :validate_types
+
+  def execute
+    return { "prim" => typed_annots.values.first } if typed_annots.size == 1
+
+    { "prim" => "pair", "args" => generate_type_args(ordered_annots) }
+  end
+
+  private
+    def generate_type_args(annots)
+      annot = annots.pop
+      annot_type = typed_annots[annot]
+
+      unless annots.size == 1
+        return [
+          {
+            "prim" => annot_type,
+            "annots" => ["%#{annot}"]
+          },
+          {
+            "prim" => "pair",
+            "args" => generate_type_args(annots)
+          }
+        ]
+      end
+
+      generated_args = [{ "prim" => annot_type, "annots" => ["%#{annot}"] }]
+      annot = annots.pop
+      annot_type = typed_annots[annot]
+      generated_args.append({ "prim" => annot_type, "annots" => ["%#{annot}"] })
+
+      generated_args
+    end
+
+    def ordered_annots
+      @ordered_annots ||= typed_annots.keys.sort.reverse
+    end
+
+    def validate_types
+      allowed_types = TezosClient::Tools::HashToMicheline::TYPES_MAPPING.keys
+      return if typed_annots.values.map(&:to_sym).all? { |type| type.in? allowed_types }
+
+      errors.add(:base, "The allowed types are: #{allowed_types.join(', ')}")
+    end
+end

data/lib/tezos_client/tools/convert_to_hash/base.rb

@@ -22,7 +22,7 @@ class TezosClient
               type: type
             ).decode
 
-          rescue NameError => e
+          rescue NameError
             raise NotImplementedError, "type '#{type[:prim]}' not implemented"
           end
 

data/lib/tezos_client/tools/convert_to_hash/option.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class TezosClient
+  module Tools
+    class ConvertToHash < ActiveInteraction::Base
+      class Option < Base
+        def decode
+          if data[:prim] == "None"
+            return nil
+          elsif data[:prim] == "Some"
+            TezosClient::Tools::ConvertToHash::Base.new(
+              data: data[:args][0],
+              type: type[:args][0]
+            ).value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tezos_client/tools/hash_to_micheline.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+class TezosClient::Tools::HashToMicheline < ActiveInteraction::Base
+  # TODO: handle Arrays and Maps
+  TYPES_MAPPING = {
+    int: :int,
+    nat: :int,
+    string: :string,
+    signature: :string,
+    bytes: :bytes,
+    timestamp: :int,
+    key: :string,
+    address: :string
+  }.freeze
+
+  string :contract_address, default: nil
+  string :entrypoint, default: nil
+  # example of params:
+  # {
+  #   spending_ref: "toto",
+  #   expires_at: Time.now
+  # }
+  hash :params, strip: false
+  hash :storage_type, strip: false, default: {}
+  interface :blockchain_client, methods: %i[entrypoint entrypoints select_entrypoint], default: -> { TezosClient.new }
+
+  # if storage_type is not received, it is fetched from the blockchain using
+  # contract_address and entrypoint (that are mandatory in this case)
+  validate :storage_type_or_contract_address_presence
+
+  def execute
+    return hash_type_to_hash_data(_storage_type.fetch(:prim), params.values.first) if params.size == 1
+
+    { prim: "Pair", args: generate_micheline(_storage_type[:args]) }
+  end
+
+  private
+    def generate_micheline(remaining_storage_type)
+      remaining_storage_type.each_with_object([]) do |h, acc|
+        next acc << { prim: "Pair", args: generate_micheline(h[:args]) } if h[:prim] == "pair"
+
+        annot = h[:annots].first.slice(1..-1).to_sym # remove '%'
+
+        if h[:prim] == "option"
+          value = params.fetch(annot)
+          if value
+            acc << {
+              "prim": "Some",
+              "args": [
+                hash_type_to_hash_data(h[:args][0][:prim], params.fetch(annot))
+              ]
+            }
+          else
+            acc << {
+              "prim": "None"
+            }
+          end
+        else
+          acc << hash_type_to_hash_data(h[:prim], params.fetch(annot))
+        end
+      end
+    end
+
+    def convert_type(michelson_type)
+      TYPES_MAPPING.fetch(michelson_type.to_sym)
+    end
+
+    def hash_type_to_hash_data(michelson_type, value)
+      type = convert_type(michelson_type)
+
+      converted_value = case michelson_type.to_sym
+                        when :nat, :int
+                          value.to_s
+                        when :timestamp
+                          errors.add(:base, "timestamp input must be an instance of Time") unless value.is_a? Time
+
+                          value.to_i.to_s
+                        else
+                          value
+      end
+
+      { type => converted_value }
+    end
+
+    def _entrypoint
+      @_entrypoint ||= blockchain_client.select_entrypoint(
+        contract_address: contract_address,
+        entrypoint: entrypoint
+      )
+    end
+
+    def _storage_type
+      (storage_type.presence || blockchain_client.entrypoint(contract_address, _entrypoint)).deep_symbolize_keys
+    end
+
+    def storage_type_or_contract_address_presence
+      return if storage_type.present? ^ (contract_address.present?)
+
+      errors.add(:base,
+                 "You should provide the contract_address and the entrypoint only if storage_type is not provided")
+    end
+end

data/lib/tezos_client/tools/system_call.rb

@@ -5,10 +5,10 @@ class TezosClient
     module SystemCall
       def self.execute(cmd)
         Open3.popen3(*cmd) do |_stdin, stdout, stderr, wait_thr|
-          err = stderr.read
           status = wait_thr.value.exitstatus
 
           if status != 0
+            err  = stdout.read + stderr.read
             raise ::TezosClient::SysCallError, "command '#{cmd}' existed with status #{status}: #{err}"
           end
 

data/lib/tezos_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class TezosClient
-  VERSION = "1.2.1"
+  VERSION = "1.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tezos_client
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Pierre Michard
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2020-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -274,6 +274,7 @@ files:
 - lib/tezos_client/smartpy_inteface/smartpy_wrapper.rb
 - lib/tezos_client/smartpy_interface.rb
 - lib/tezos_client/string_utils.rb
+- lib/tezos_client/tools/annots_to_type.rb
 - lib/tezos_client/tools/convert_to_hash.rb
 - lib/tezos_client/tools/convert_to_hash/address.rb
 - lib/tezos_client/tools/convert_to_hash/base.rb
@@ -284,11 +285,13 @@ files:
 - lib/tezos_client/tools/convert_to_hash/list.rb
 - lib/tezos_client/tools/convert_to_hash/map.rb
 - lib/tezos_client/tools/convert_to_hash/nat.rb
+- lib/tezos_client/tools/convert_to_hash/option.rb
 - lib/tezos_client/tools/convert_to_hash/pair.rb
 - lib/tezos_client/tools/convert_to_hash/signature.rb
 - lib/tezos_client/tools/convert_to_hash/string.rb
 - lib/tezos_client/tools/convert_to_hash/timestamp.rb
 - lib/tezos_client/tools/find_big_maps_in_storage.rb
+- lib/tezos_client/tools/hash_to_micheline.rb
 - lib/tezos_client/tools/system_call.rb
 - lib/tezos_client/tools/temporary_file.rb
 - lib/tezos_client/version.rb
@@ -299,7 +302,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -314,8 +317,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Wrapper to the tezos client.
 test_files: []