tezos_client 0.3.9 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bf4544c54f90bdbafd3fed0e9ba139470ffc59c0925de1d388a290a40e15a90
-  data.tar.gz: 42ad8f061e34b90ef5c646b235794945456dc17b81b2e4914513f1a53fad250d
+  metadata.gz: 725a3f4be32e4f23f291c0abb15ad9671bff432a3b00f4f149fbad9c8cadf007
+  data.tar.gz: 21864905eeb5b701357551ee410c88f2e24832b31f53a1d811b0025f6410248d
 SHA512:
-  metadata.gz: dcd4257f68999a0ef7a88fdebdcb9b65d19704f963dba7723799e89e90567d513f479f10f5f3e2df4397231c3606e176c3ea07b6feec14dec3affda0c8cea343
-  data.tar.gz: e4afe38e6103582396862a447458fea502063fe8ef111ba5fd7b34fca9b2900b3764707a4be1943d204911224b0b5cab231de42399f10d67a9c193ea271a52b4
+  metadata.gz: 810cdd1ea762452c662bac91752c53b60756ad780989c58fa488fcb056d9907b4ac76e37907bbdb0fe7e40398badf686aa8f229033b5c53ec7a27bf07c389b9e
+  data.tar.gz: 39b1a9bfefda07893cab407b5abdd9835603473098e6db4828847c9265358b11833e3ed160c91db6f50d0f6d52a659f38242d243a1cbc2ea112f0fccab71683e

data/.travis.yml

@@ -1,8 +1,7 @@
 ---
-dist: trusty
+dist: xenial
+language: ruby
 sudo: required
-#language: ruby
-language: ocaml
 cache:
   bundler: true
   directories:
@@ -13,9 +12,11 @@ rvm:
 env:
   - OPAMYES=1
 before_install:
-  - sh travis-scripts/prepare-trusty.sh
+  - sh travis-scripts/prepare-ubuntu.sh
   - sh travis-scripts/install-opam.sh
   - sh travis-scripts/install-liquidity.sh
   - gem install bundler -v 1.16.3
 script:
+  - eval `opam config env`
+  - bundle install
   - bundle exec rake

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tezos_client (0.3.9)
+    tezos_client (0.4.0)
       activesupport (~> 5.2.0)
       base58 (~> 0.2.3)
       bip_mnemonic (~> 0.0.2)

data/lib/tezos_client.rb

@@ -3,6 +3,7 @@
 require "pp"
 require "active_support/core_ext/hash/indifferent_access"
 require "active_support/core_ext/string/inflections"
+require "active_support/core_ext/module/delegation"
 require "timeout"
 
 require "tezos_client/version"
@@ -11,13 +12,16 @@ require "tezos_client/currency_utils"
 require "tezos_client/crypto"
 require "tezos_client/commands"
 require "tezos_client/logger"
+require "tezos_client/exceptions"
 require "tezos_client/encode_utils"
-require "tezos_client/operation"
+require "tezos_client/operation_mgr"
+require "tezos_client/operations/operation"
 require "tezos_client/operations/origination_operation"
 require "tezos_client/operations/transaction_operation"
 require "tezos_client/operations/transactions_operation"
 require "tezos_client/operations/activate_account_operation"
 require "tezos_client/operations/reveal_operation"
+require "tezos_client/operations/operation_array"
 
 require "tezos_client/client_interface"
 require "tezos_client/rpc_interface"
@@ -72,17 +76,26 @@ class TezosClient
   #
   # @return [Hash] result of the origination containing :operation_id, :operation_result and :originated_contract
   #
-  def originate_contract(from:, amount:, secret_key:, **args)
-    res = OriginationOperation.new(
-      liquidity_interface: liquidity_interface,
+  def originate_contract(from:, amount:, secret_key:, script: nil, init_params: nil, **args)
+    origination_args = {
       rpc_interface: rpc_interface,
       from: from,
       secret_key: secret_key,
       amount: amount,
       **args
-    ).test_and_broadcast
+    }
+
+    if script != nil
+      origination_args[:script] = liquidity_interface.origination_script(
+        from: from,
+        script: script,
+        init_params: init_params
+      )
+    end
+
+    res = OriginationOperation.new(origination_args).test_and_broadcast
 
-    res.merge(originated_contract: res[:operation_result][:originated_contracts][0])
+    res.merge(originated_contract: res[:operations_result][0][:originated_contracts][0])
   end
 
   # Transfer funds to an account
@@ -97,7 +110,6 @@ class TezosClient
   #
   def transfer(from:, amount:, to:, secret_key:, **args)
     TransactionOperation.new(
-      liquidity_interface: liquidity_interface,
       rpc_interface: rpc_interface,
       from: from,
       to: to,
@@ -109,7 +121,6 @@ class TezosClient
 
   def activate_account(pkh:, secret:, **args)
     ActivateAccountOperation.new(
-      liquidity_interface: liquidity_interface,
       rpc_interface: rpc_interface,
       pkh: pkh,
       secret: secret,
@@ -119,7 +130,6 @@ class TezosClient
 
   def transfer_to_many(from:, amounts:, secret_key:, **args)
     TransactionsOperation.new(
-      liquidity_interface: liquidity_interface,
       rpc_interface: rpc_interface,
       from: from,
       amounts: amounts,
@@ -129,7 +139,6 @@ class TezosClient
   end
 
   def reveal_pubkey(secret_key:, **args)
-
     public_key = secret_key_to_public_key(secret_key)
     from = public_key_to_address(public_key)
 

data/lib/tezos_client/exceptions.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+class TezosClient
+  class RpcRequestFailure < Exception
+    include Logger
+
+    attr_reader :status_code
+    attr_reader :error
+    attr_reader :formatted_response
+
+    def initialize(error:, url:, status_code:)
+      @status_code = status_code
+      @error = error
+      @formatted_response = formatted_response
+
+      if @message.nil?
+        @message = "#{url} failed with status #{status_code}:\n #{tezos_contents_log(formatted_response)}"
+      end
+
+      super @message
+    end
+  end
+
+  class InvalidActivation < RpcRequestFailure
+    attr_reader :pkh
+
+    def initialize(error:, **_args)
+      @pkh = error[:pkh]
+      @message = "Invalid activation (pkh: #{pkh})"
+      super
+    end
+  end
+
+  class OperationFailure < Exception
+    include Logger
+
+    attr_reader :metadata
+    attr_reader :errors
+    attr_reader :status
+    attr_reader :message
+
+    def initialize(metadata:, errors:, status:)
+      @metadata = metadata
+      @errors = errors
+      @status = status
+
+      error = errors[0]
+
+      if @message.nil?
+        @message = "failure #{status}: #{tezos_contents_log(error).pretty_inspect}"
+      end
+
+      super(message)
+    end
+  end
+
+  class TezBalanceTooLow < OperationFailure
+    attr_reader :contract
+    attr_reader :balance
+    attr_reader :amount
+
+    def initialize(metadata:, errors:, status:)
+      error = errors[0]
+      @contract = error[:contract]
+      @balance = error[:balance]
+      @amount = error[:amount]
+
+      @message = "Tezos balance too low for address #{contract} (balance: #{balance}, amount #{amount})"
+
+      super
+    end
+  end
+
+  class ScriptRuntimeError < OperationFailure
+    attr_reader :location
+    attr_reader :with
+    attr_reader :contract
+
+    def initialize(metadata:, errors:, status:)
+      error = errors[0]
+      rejection_error = errors.detect { |error| error[:id] == "proto.003-PsddFKi3.scriptRejectedRuntimeError" }
+
+      @location = rejection_error[:location]
+      @contract =  error[:contractHandle]
+      @with = rejection_error[:with]
+      @message = "Script runtime Error when executing #{contract}: #{with} (location: #{location})"
+      super
+    end
+  end
+
+
+end

data/lib/tezos_client/liquidity_interface.rb

@@ -57,8 +57,10 @@ class TezosClient
 
     def json_scripts(args)
       with_file_copy(args[:script]) do |script_copy_path|
-        json_init_script_path = "#{script_copy_path}.initializer.tz.json"
-        json_contract_script_path = "#{script_copy_path}.tz.json"
+        script_basename = script_copy_path.sub(/.liq$/, "")
+
+        json_init_script_path = "#{script_basename}.initializer.tz.json"
+        json_contract_script_path = "#{script_basename}.tz.json"
 
         call_liquidity "--json #{script_copy_path}"
 

data/lib/tezos_client/logger.rb

@@ -12,6 +12,28 @@ class TezosClient
       self.class.logger << out + "\n"
     end
 
+    FILTERED_KEYS = [:code, :contractCode]
+    def tezos_contents_log_filter(content)
+      if content.is_a? Array
+        content.map { |el| tezos_contents_log_filter(el) }
+      elsif content.is_a? Hash
+        content.reduce({}) do |h, (k, v)|
+          value = if FILTERED_KEYS.include? k.to_sym
+            "#{v.to_s[0..30]}..."
+          else
+            tezos_contents_log_filter(v)
+          end
+          h.merge(k => value)
+        end
+      else
+        content
+      end
+    end
+
+    def tezos_contents_log(content)
+      tezos_contents_log_filter(content).pretty_inspect
+    end
+
     class_methods do
       # Setup the log for TezosClient calls.
       # Value should be a logger but can can be stdout, stderr, or a filename.

data/lib/tezos_client/operation_mgr.rb

@@ -0,0 +1,178 @@
+
+class TezosClient
+
+  class OperationMgr
+    include Crypto
+    using CurrencyUtils
+
+    attr_accessor :rpc_interface,
+                  :rpc_operation_args
+
+    def initialize(rpc_interface:, rpc_operation_args:, **args)
+      @rpc_interface = rpc_interface
+      @secret_key = args.fetch(:secret_key)
+      @multiple_operations = rpc_operation_args.is_a?(Array)
+      @rpc_operation_args = @multiple_operations ? rpc_operation_args : [rpc_operation_args]
+      @signed_operation_args_h = nil
+      @branch = args[:branch]
+      @protocol = args[:protocol]
+    end
+
+    def multiple_operations?
+      @multiple_operations
+    end
+
+    def single_operation?
+      !multiple_operations?
+    end
+
+    def branch
+      @branch ||= rpc_interface.head_hash
+    end
+
+    def protocol
+      @protocol ||= rpc_interface.protocol
+    end
+
+    def simulate_and_update_limits
+      run_result = run
+
+      run_result[:operations_result].zip(rpc_operation_args) do |operation_result, rpc_operation_args|
+        if rpc_operation_args.key?(:gas_limit)
+          rpc_operation_args[:gas_limit] = (operation_result[:consumed_gas].to_i + 0.001.to_satoshi).to_s
+        end
+      end
+
+      run_result
+    end
+
+    def to_hex
+      rpc_interface.forge_operations(operations: rpc_operation_args, branch: branch)
+    end
+
+    def sign
+      sign_operation(
+        secret_key: @secret_key,
+        operation_hex: to_hex
+      ) do |base_58_signature, signed_hex, _op_id|
+        @signed_operation_args_h = rpc_operation_args.hash
+        @base_58_signature = base_58_signature
+        @signed_hex = signed_hex
+      end
+    end
+
+    def signed?
+      @signed_operation_args_h == rpc_operation_args.hash
+    end
+
+    def base_58_signature
+      sign unless signed?
+      @base_58_signature
+    end
+
+    def signed_hex
+      sign unless signed?
+      @signed_hex
+    end
+
+    def test_and_broadcast
+      # simulate operations and adjust gas limits
+      simulate_and_update_limits
+      operations_result = preapply
+
+      op_id = broadcast
+      {
+        operation_id: op_id,
+        operations_result: operations_result,
+      }
+    end
+
+    def run
+      rpc_responses = rpc_interface.run_operations(
+        operations: rpc_operation_args,
+        signature: base_58_signature,
+        branch: branch)
+
+      consumed_storage = 0
+      consumed_gas = 0
+
+      operations_result = rpc_responses.map do |rpc_response|
+        metadata = rpc_response[:metadata]
+        ensure_applied!(metadata)
+        consumed_storage += compute_consumed_storage(metadata)
+        consumed_gas += compute_consumed_gas(metadata)
+        metadata[:operation_result]
+      end
+
+      {
+        status: :applied,
+        consumed_gas: consumed_gas,
+        consumed_storage: consumed_storage,
+        operations_result: operations_result
+      }
+    end
+
+    def compute_consumed_gas(metadata)
+      consumed_gas = (metadata.dig(:operation_result, :consumed_gas) || "0").to_i.from_satoshi
+
+      if metadata.key?(:internal_operation_results)
+        metadata[:internal_operation_results].each do |internal_operation_result|
+          consumed_gas += (internal_operation_result[:result][:consumed_gas] || "0").to_i.from_satoshi
+        end
+      end
+      consumed_gas
+    end
+
+    def compute_consumed_storage(metadata)
+      (metadata.dig(:operation_result, :paid_storage_size_diff) || "0").to_i.from_satoshi
+    end
+
+
+    def preapply
+      rpc_responses = rpc_interface.preapply_operations(
+        operations: rpc_operation_args,
+        signature: base_58_signature,
+        protocol: protocol,
+        branch: branch)
+
+      rpc_responses.map do |rpc_response|
+        ensure_applied!(rpc_response[:metadata])
+      end
+    end
+
+    def broadcast
+      rpc_interface.broadcast_operation(signed_hex)
+    end
+
+    private
+
+    def ensure_applied!(metadata)
+      operation_result = metadata[:operation_result]
+
+      unless operation_result.nil?
+        status = operation_result[:status]
+        if status != "applied"
+          failed!(status, operation_result[:errors], metadata)
+        end
+      end
+
+      operation_result
+    end
+
+    def exception_klass(errors)
+      error = errors[0]
+      case error[:id]
+      when "proto.003-PsddFKi3.contract.balance_too_low"
+        TezBalanceTooLow
+      when "proto.003-PsddFKi3.scriptRuntimeError"
+        ScriptRuntimeError
+      else
+        OperationFailure
+      end
+    end
+
+    def failed!(status, errors, metadata)
+      raise exception_klass(errors).new(metadata: metadata, errors: errors, status: status)
+    end
+  end
+end