lorentz-contract-originate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0eb208390f5ea68d13f6a00ccd468911d03aeacb
+  data.tar.gz: 7a7d5938a6f3b5507c5ddba458371f4ef3907dd0
+SHA512:
+  metadata.gz: 0cb92618633f87117303adad9b6516552be1a22e274ca70a8a1f9b95eca9b915f1c942b93d57a34900f683a1fde6fcee83d123ece239311cdecd5d2db376b64e
+  data.tar.gz: 435614b14377f93df2c982cc9e41efabfd38702e9e083a675138eef216557c988cd1260edd568821f53babc7eaaf6448e1bd22db3b29443f91ea624f377b2c16

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lorentz-contract-originate.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    lorentz-contract-originate (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  lorentz-contract-originate!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Michael J. Klein
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# Lorentz::Contract::Originate
+
+Use `.yaml` files to specify:
+- users
+- contract originations
+- transactions
+
+in a declarative manner, a la `Makefile`'s.
+
+For example:
+
+```yaml
+config:
+  base-config: &base-config
+    tezos_client_path:
+      "tezos-client -A rpcalpha.tzbeta.net -P 443 -S"
+    user_address:
+      tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr
+    param_path:
+      /Users/michaelklein/Coding/forwarder-contract
+    stack_path:
+      /Users/michaelklein/Coding/forwarder-contract/stack
+
+do:
+  - user:
+      name:
+        Alice
+      address:
+        tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr
+
+  - originate: &originate-forwarder
+      alias: ValidatedForwarder1
+      config: $base-config
+      command: dstoken-forwarder-contract print-validated-expiring --central-wallet tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr --dstoken-address tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr
+      storage_command: dstoken-forwarder-contract initial-storage-validated-expiring
+      initial_storage:
+        dstoken-address: $Alice
+        whitelisted-investors: '"[\"alice\"]"'
+        token-limit: 10
+        expiration-date: "$(date -u -d '9:00 next Fri' +%FT%T.%NZ)"
+      burn_cap: '1.644'
+
+  - run: &validate-forwarder
+      alias: RejectsNonWhitelistedUser
+      config: $base-config
+      contract: ValidatedForwarder1
+      command: dstoken-forwarder-contract validate-transfer
+      parameters:
+        received-amount: 3
+        from-user: "bob"
+      burn_cap: '0.000001'
+      expect_failure: true
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lorentz-contract-originate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lorentz-contract-originate
+
+
+## Usage
+
+```bash
+❯❯❯ bundle exec ruby exe/lorentz-contract-originate.rb test.yaml
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tqtezos/lorentz-contract-originate.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lorentz/contract/originate"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/lorentz-contract-originate.rb

@@ -0,0 +1,20 @@
+require 'lorentz/contract/param'
+require 'tezos/client'
+
+if __FILE__ == $0
+  if ARGV[1]&.strip == 'info'
+    file_path = ARGV[0]
+    originated_contracts_path = Lorentz::Contract::Param.originated_contracts_path(file_path)
+    originated_yaml = Lorentz::Contract::Param.recursive_yaml(originated_contracts_path)
+    # YAML.load(File.read(originated_contracts_path))
+    originated_yaml['originated'].each do |contract|
+      p contract
+      contract_address = contract[1]['address']
+      base_config = originated_yaml['config']['base-config']
+      tezos_client = Tezos::Client.new(base_config['tezos_client_path'], base_config['user_address'])
+      tezos_client.get_storage(contract_address).to_a
+    end
+  end
+
+  Lorentz::Contract::Param.from_yaml ARGV[0]
+end

data/lib/lorentz/contract/call.rb

@@ -0,0 +1,2 @@
+# require "lorentz/contract/param"
+

data/lib/lorentz/contract/enumerable.rb

@@ -0,0 +1,31 @@
+
+module Lorentz
+  module Contract
+    module Enumerable
+      def find_operation_hash
+        self.map do |line|
+          line.chomp
+        end.select do |line|
+          line.match /^Operation hash is '/
+        end.map do |line|
+          line.sub(/Operation hash is '(.*)'/, '\1')
+        end.first
+      end
+
+      def pairs(&block)
+        self.zip(self.drop(1), &block)
+      end
+
+      def find_originated_contract
+        self.map do |lines|
+          lines.chomp
+        end.pairs.select do |x,_|
+          x.match /^\s+Originated contracts:/
+        end.map do |_,y|
+          y.strip
+        end.first
+      end
+    end
+  end
+end
+

data/lib/lorentz/contract/kernel.rb

@@ -0,0 +1,64 @@
+require 'open3'
+require "lorentz/contract/enumerable"
+
+include Lorentz::Contract::Enumerable
+
+module Lorentz
+  module Contract
+    module Kernel
+      class SystemError < StandardError
+        attr_accessor :message_list
+
+        def initialize(msg)
+          super
+        end
+      end
+
+      def system_lines(cmd)
+        num_retries = 0
+        result_lines = []
+        begin
+          result_lines = []
+          puts cmd
+          Open3.popen2e(cmd) do |stdin, stdout, thread|
+            while line=stdout.gets do
+              puts(line)
+              result_lines << line
+            end
+            exit_status = thread.value
+            unless exit_status.success?
+              result_lines = result_lines.reject! do |line|
+                line.match /^\s+\d{3}:\s/
+              end.to_a
+              err = SystemError.new(result_lines.inspect)
+              err.message_list = result_lines
+              raise err
+            end
+          end
+          return result_lines.to_enum
+        rescue SystemError => e
+          if e.message_list.any?{|line|line.match(/Counter \d+ already used for contract/)}
+            num_retries += 1
+            puts
+            puts "Retry number: #{num_retries}"
+            retry
+          end
+          raise e
+        end
+      end
+
+      def system_line(cmd)
+        if result = system_lines(cmd)
+          result.first&.chomp
+        else
+          result
+        end
+      end
+
+      def system_operation_hash(cmd)
+        system_lines(cmd).find_operation_hash
+      end
+    end
+  end
+end
+

data/lib/lorentz/contract/originate/version.rb

@@ -0,0 +1,7 @@
+module Lorentz
+  module Contract
+    module Originate
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/lorentz/contract/param.rb

@@ -0,0 +1,348 @@
+require "tezos/client"
+require "lorentz/contract/kernel"
+require "yaml"
+
+module Lorentz
+  module Contract
+    class Param
+      include Lorentz::Contract::Kernel
+
+      @originated_contracts = {}
+      @ran_calls = {}
+      @users = {}
+
+      class << self
+        attr_accessor :originated_contracts, :ran_calls, :users
+      end
+
+      attr_accessor :config, :command, :storage_command, :storage_params, :burn_cap
+
+      def path
+        self.config['param_path']
+      end
+
+      def stack_path
+        self.config['stack_path']
+      end
+
+      def stack_exec
+        if self.stack_path.nil?
+          ""
+        else
+          "#{self.stack_path} exec -- "
+        end
+      end
+
+      def initialize(config, command, storage_command, storage_params, burn_cap)
+        @config = config
+        @command = command
+        @storage_command = storage_command
+        @storage_params = storage_params
+        @burn_cap = burn_cap
+      end
+
+      def self.originated_contracts_path(file_path)
+        File.basename(file_path, '.yaml') + ".originated.yaml"
+      end
+
+      def self.save_originated_contracts(file_path, yaml_configs)
+        File.write(self.originated_contracts_path(file_path), YAML.dump({'config' => yaml_configs, 'originated' => self.originated_contracts, 'ran' => self.ran_calls}))
+      end
+
+      def self.init_originated_contracts(file_path, yaml_configs)
+        originated_contracts_path = self.originated_contracts_path(file_path)
+        self.originated_contracts = if File.exist?(originated_contracts_path)
+          originated_yaml = self.recursive_yaml(originated_contracts_path)
+          originated_configs = originated_yaml['config']
+          unless originated_configs == yaml_configs
+            puts YAML.dump(yaml_configs)
+            puts("-" * 50)
+            puts YAML.dump(originated_configs)
+            raise "expected 'config' fields in #{file_path} and #{originated_contracts_path} to match"
+          end
+          self.ran_calls = originated_yaml['ran']
+          originated_yaml['originated']
+        else
+          self.save_originated_contracts file_path, yaml_configs
+          {}
+        end
+      end
+
+      def self.find_originated_contract(contract_alias, origination)
+        if self.originated_contracts.has_key?(contract_alias) &&
+           !self.originated_contracts[contract_alias].nil? &&
+           !self.originated_contracts[contract_alias]&.[]('address').nil?
+          puts "#{contract_alias} already originated: #{self.originated_contracts[contract_alias]}"
+          puts
+          existing_origination = self.originated_contracts[contract_alias]
+          unless origination['config'] == existing_origination['config']
+            raise "#{contract_alias} originated with:\n#{existing_origination} \nbut found #{origination}"
+          end
+          existing_origination
+        end
+      end
+
+      def self.find_ran_call(contract_call_alias, ran_call)
+        if self.ran_calls.has_key?(contract_call_alias) &&
+           !self.ran_calls[contract_call_alias].nil? &&
+           (!self.ran_calls[contract_call_alias]&.[]('operation_hash').nil? || !self.ran_calls[contract_call_alias]&.[]('error').nil?)
+          puts "#{contract_call_alias} already ran: #{self.ran_calls[contract_call_alias]}"
+          puts
+          existing_ran_call = self.ran_calls[contract_call_alias]
+          unless ran_call['config'] == existing_ran_call['config']
+            raise "#{contract_call_alias} ran with:\n#{existing_ran_call} \nbut found #{ran_call}"
+          end
+          existing_ran_call
+        end
+      end
+
+
+      def self.all_names()
+        self.originated_contracts.to_a.map do |k,originated_contract|
+          [k, originated_contract['address']]
+        end.to_h.merge(self.users) do |user,x,y|
+          if x == y
+            x
+          else
+            raise "redefined #{user} as a user"
+          end
+        end
+      end
+
+      def self.recursive_yaml(file_path) #, raw=false)
+        if file_path.nil? || File.extname(file_path).downcase != '.yaml'
+          raise "No path to a *.yaml file provided"
+        end
+        yaml = YAML.safe_load(File.read(file_path), [], [], true, file_path)
+        if yaml.has_key?('<<')
+          Dir.chdir("#{File.dirname(file_path)}") do
+            included = YAML.safe_load(File.read(yaml['<<']), [], [], true, yaml['<<'])
+            yaml = included.merge(yaml)
+          end
+        end
+        yaml
+        # if raw
+        #   yaml = YAML.load(File.read(file_path))
+        #   if contained_file_path = yaml['<<']
+        #     YAML.load(self.recursive_yaml(contained_file_path, raw=true) + "\n" + File.read(file_path))
+        #   else
+        #     yaml
+        #   end
+        # else
+        #   raw_file = File.read(file_path)
+        #   yaml = begin
+        #     YAML.load(raw_file)
+        #   rescue => e
+        #     {}
+        #   end
+        #
+        #   if contained_file_path = yaml['<<']
+        #     YAML.load(self.recursive_yaml(contained_file_path, raw=true) + "\n" + raw_file)
+        #   else
+        #     raw_file
+        #   end
+        # end
+      end
+
+      def self.from_yaml(file_path)
+        yaml = self.recursive_yaml(file_path)
+        yaml_configs = yaml['config']
+
+        yaml['do'].each do |action|
+          if action.is_a?(Hash) && action.has_key?('user')
+            new_user = action.delete 'user'
+            new_user_name = new_user.delete 'name'
+            new_user_address = new_user.delete 'address'
+            if self.users.has_key?(new_user_name)
+              unless self.users[new_user_name] == new_user_address
+                raise "user #{new_user_name} has two addresses: #{self.users[new_user_name]} #{new_user_address}"
+              end
+            else
+              self.users[new_user_name] = new_user_address
+            end
+          elsif action.is_a?(Hash) && action.has_key?('originate')
+            origination = action.delete 'originate'
+            unless origination.has_key?('alias')
+              raise "origination must have 'alias' key"
+            end
+            contract_alias = origination['alias']
+
+            self.init_originated_contracts file_path, yaml_configs
+            if !self.find_originated_contract(contract_alias, origination).nil?
+            else
+              origination_config = origination['config']
+              aliased_origination_config = origination_config
+              if origination_config.match(/^\$/)
+                aliased_origination_config = yaml_configs[origination_config[1..-1]]
+              end
+              begin_time = Time.now
+              tezos_client = Tezos::Client.new(aliased_origination_config['tezos_client_path'], aliased_origination_config['user_address'])
+              lorentz_contract =
+                Param.new(aliased_origination_config,
+                          origination['command'],
+                          origination['storage_command'],
+                          origination['initial_storage'],
+                          origination['burn_cap'])
+              result_address =
+                lorentz_contract.originate(tezos_client,
+                                           contract_alias,
+                                           self.all_names)
+              origination['address'] = result_address
+              self.originated_contracts[contract_alias] = {
+                'address' => result_address,
+                'config' => origination_config,
+                'duration' => Time.now - begin_time
+              }
+
+              # Commit ASAP to prevent the need to re-originate if some part fails
+              self.save_originated_contracts file_path, yaml_configs
+            end
+          elsif action.is_a?(Hash) && action.has_key?('run')
+            contract_call = action.delete 'run'
+            unless contract_call.has_key?('alias')
+              raise "contract_call must have 'alias' key"
+            end
+            contract_call_alias = contract_call['alias']
+
+            if !self.find_ran_call(contract_call_alias, contract_call).nil?
+            else
+              contract_call_config = contract_call['config']
+              aliased_contract_call_config = contract_call_config
+              if contract_call_config.match(/^\$/)
+                aliased_contract_call_config = yaml_configs[contract_call_config[1..-1]]
+              end
+              begin_time = Time.now
+              tezos_client = Tezos::Client.new(aliased_contract_call_config['tezos_client_path'], aliased_contract_call_config['user_address'])
+              lorentz_contract_call =
+                Call.new(aliased_contract_call_config,
+                         contract_call['contract'],
+                         contract_call['command'],
+                         contract_call['parameters'],
+                         contract_call['burn_cap'],
+                         contract_call['expect_failure'])
+
+              contract_call_result =
+                lorentz_contract_call.contract_call(tezos_client,
+                                                    contract_alias)
+              ran_call_hash = {
+                'contract' => contract_call['contract'],
+                'parameters' => contract_call['parameters'],
+                'config' => contract_call_config,
+                'duration' => Time.now - begin_time 
+              }
+              if contract_call_result.has_key?('operation_hash')
+                ran_call_hash['operation_hash'] = contract_call_result['operation_hash']
+              else
+                ran_call_hash['error'] = contract_call_result[:error_message]
+              end
+              self.ran_calls[contract_call_alias] = ran_call_hash
+
+              # Commit ASAP to prevent the need to re-run if some part fails
+              self.save_originated_contracts file_path, yaml_configs
+            end
+          else
+            raise "unexpected action: #{action.inspect}"
+          end
+        end
+      end
+
+      def in_path(&block)
+        Dir.chdir(self.path, &block)
+      end
+
+      def originate_cmd(tezos_client, contract_name, names)
+        tezos_client.originate_cmd(contract_name,
+                                   self.print(),
+                                   self.storage(names),
+                                   @burn_cap)
+      end
+
+      def originate(tezos_client, contract_name, names)
+        tezos_client.originate(contract_name,
+                               self.print(),
+                               self.storage(names),
+                               @burn_cap)
+      end
+
+      def print()
+        @contract_code || (@contract_code = self.in_path do
+          self.system_line "#{self.stack_exec}#{@command} --oneline"
+        end)
+      end
+
+      def storage(names)
+        @storage_code || (@storage_code =
+          storage_param_args = storage_params.to_a.map do |storage_param, storage_param_arg|
+            if storage_param_arg.to_s.match(/^\$/)
+              param_var = storage_param_arg.to_s[1..-1]
+              if names.has_key?(param_var) && !names[param_var].nil?
+                storage_param_arg = names[param_var]
+              end
+            end
+            "--#{storage_param} #{storage_param_arg}"
+          end.join(' ')
+
+          self.in_path do
+            self.system_line("#{self.stack_exec}#{@storage_command} " + storage_param_args)
+          end
+        )
+      end
+    end
+  end
+end
+
+# in same file as Lorentz::Contract::Param since they're mutually recursive
+module Lorentz
+  module Contract
+    class Call < Param
+      attr_accessor :config, :contract_address, :burn_cap, :expect_failure
+
+      def initialize(config, contract_address, command, parameters, burn_cap, expect_failure=false)
+        @config = config
+        @contract_address = contract_address
+        @storage_command = command
+        @storage_params = parameters
+        @burn_cap = burn_cap
+        @expect_failure = expect_failure.to_s.match(/t(rue)?/i)
+      end
+
+      def contract_address
+        if /^\$/ === @contract_address # === /^\$/
+          found_address = LorentzContractParam.all_names[@contract_address[1..-1]]
+          if !found_address.nil?
+            @contract_address = found_address
+          else
+            @contract_address
+          end
+        else
+          @contract_address
+        end
+      end
+
+      def michelson_parameters
+        Param.instance_method(:storage).bind(self).call(Param.all_names)
+      end
+
+      def contract_call_cmd(tezos_client, contract_call_alias)
+        tezos_client.contract_call_cmd(self.contract_address,
+                                       self.michelson_parameters,
+                                       self.burn_cap)
+      end
+
+      def contract_call(tezos_client, contract_call_alias)
+        begin
+          tezos_client.contract_call(self.contract_address,
+                                     self.michelson_parameters,
+                                     self.burn_cap)
+        rescue Lorentz::Contract::Kernel::SystemError => e
+          if self.expect_failure
+            return { 'error_message': e.message_list.map(&:chomp) }
+          else
+            raise e
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/tezos/client.rb

@@ -0,0 +1,73 @@
+require "lorentz/contract/enumerable"
+require "lorentz/contract/kernel"
+
+module Tezos
+  class Client
+    include Lorentz::Contract::Kernel
+
+    attr_accessor :tezos_client_path, :user_address
+
+    def initialize(tezos_client_path, user_address)
+      @tezos_client_path = tezos_client_path
+      @user_address = user_address
+    end
+
+    def get_receipt(operation_hash)
+      result = nil
+      while result.nil?
+        begin
+          result = if result_lines = self.system_lines("#{@tezos_client_path} get receipt for #{operation_hash}")
+            unless result_lines.any?{|line| line.match /Couldn't find operation/}
+              result_lines
+            end
+          end
+        rescue SystemError
+        end
+      end
+      result
+    end
+
+    def originate_cmd(contract_name, contract_code, initial_storage, burn_cap)
+      "#{self.tezos_client_path} --wait none originate contract #{contract_name}" +
+      [ "transferring 0 from #{self.user_address} running",
+        contract_code.inspect,
+        if initial_storage.nil? then "" else "--init #{initial_storage.inspect}" end,
+        "--burn-cap #{burn_cap}"
+      ].map do |line|
+        "  #{line} \\"
+      end.join("\n") + "\n  --force"
+    end
+
+    def originate(contract_name, contract_code, initial_storage, burn_cap)
+      if operation_hash = self.system_operation_hash(self.originate_cmd(contract_name, contract_code, initial_storage, burn_cap))
+        self.get_receipt(operation_hash).find_originated_contract
+      end
+    end
+
+    def contract_call_cmd(contract_address, parameter, burn_cap)
+      "#{self.tezos_client_path} --wait none transfer 0 from #{self.user_address} " +
+      [ "to #{contract_address}",
+        if parameter.nil? then "" else "--arg #{parameter.inspect}" end,
+        "--burn-cap #{burn_cap}"
+      ].map do |line|
+        "  #{line} \\"
+      end.join("\n")
+    end
+
+    def contract_call(contract_address, parameter, burn_cap)
+      if operation_hash = self.system_operation_hash(self.contract_call_cmd(contract_address, parameter, burn_cap))
+        { 'operation_hash' => operation_hash,
+          'receipt' => self.get_receipt(operation_hash) }
+      end
+    end
+
+    def get_storage_cmd(contract_address)
+      "#{self.tezos_client_path} get contract storage for  #{contract_address}"
+    end
+
+    def get_storage(contract_address)
+      self.system_lines(self.get_storage_cmd(contract_address))
+    end
+  end
+end
+

data/lorentz-contract-originate.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lorentz/contract/originate/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "lorentz-contract-originate"
+  spec.version       = Lorentz::Contract::Originate::VERSION
+  spec.authors       = ["Michael J. Klein"]
+  spec.email         = ["michael@tqgroup.io"]
+
+  spec.summary       = %q{Make-like YAML files for originating and calling lorentz contracts.}
+  spec.description   = %q{YAML specs for originating/calling lorentz contracts}
+  spec.homepage      = "https://github.com/tqtezos/lorentz-contract-originate"
+  spec.license       = "MIT"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/test_yaml/README.md

@@ -0,0 +1,4 @@
+
+These tests use the [prototype-forwarder-contract](https://github.com/tqtezos/prototype-forwarder-contract),
+specifically the [`whitelisted-expiring` branch](https://github.com/tqtezos/prototype-forwarder-contract/pull/2).
+

data/test_yaml/test.originated.yaml

@@ -0,0 +1,189 @@
+---
+config:
+  base-config:
+    tezos_client_path: tezos-client -A rpcalpha.tzbeta.net -P 443 -S
+    user_address: tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr
+    param_path: "/Users/michaelklein/Coding/forwarder-contract"
+    stack_path: "/Users/michaelklein/Coding/forwarder-contract/stack"
+originated:
+  ValidatedForwarder1:
+    address: KT1V1YYzcEtZywrQWsJyRPVMV3m9R6qwXRV1
+    config: "$base-config"
+    duration: 29.596708
+  ValidatedForwarderExpired:
+    address: KT1NQsAMoZKWzPA5CQdX3tEFeGekuHRGjfit
+    config: "$base-config"
+    duration: 57.594561
+ran:
+  RejectsNonWhitelistedUser:
+    contract: ValidatedForwarder1
+    parameters:
+      received-amount: 3
+      from-user: bob
+    config: "$base-config"
+    duration: 4.643017
+    error:
+    - 'Warning:'
+    - "  "
+    - "                 This is NOT the Tezos Mainnet."
+    - "  "
+    - "     The node you are connecting to claims to be running on the"
+    - "               Tezos Alphanet DEVELOPMENT NETWORK."
+    - "          Do NOT use your fundraiser keys on this network."
+    - "          Alphanet is a testing network, with free tokens."
+    - ''
+    - Waiting for the node to be bootstrapped before injection...
+    - 'Current head: BKu7pE9n6DPt (timestamp: 2020-01-07T21:53:28-00:00, validation:
+      2020-01-07T21:53:39-00:00)'
+    - Node is bootstrapped, ready for injecting operations.
+    - 'This simulation failed:'
+    - "  Manager signed operations:"
+    - "    From: tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr"
+    - "    Fee to the baker: ꜩ0"
+    - "    Expected counter: 71379"
+    - "    Gas limit: 800000"
+    - "    Storage limit: 60000 bytes"
+    - "    Transaction:"
+    - "      Amount: ꜩ0"
+    - "      From: tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr"
+    - "      To: KT1V1YYzcEtZywrQWsJyRPVMV3m9R6qwXRV1"
+    - '      Parameter: (Left (Right (Left (Left (Pair 3 "bob")))))'
+    - "      This operation FAILED."
+    - ''
+    - 'Runtime error in contract KT1V1YYzcEtZywrQWsJyRPVMV3m9R6qwXRV1:'
+    - At line 94 characters 84 to 92,
+    - script reached FAILWITH instruction
+    - with "not in whitelist"
+    - 'Fatal error:'
+    - "  transfer simulation failed"
+  RejectsTokenLimitExceeded:
+    contract: ValidatedForwarder1
+    parameters:
+      received-amount: 12
+      from-user: alice
+    config: "$base-config"
+    duration: 4.64943
+    error:
+    - 'Warning:'
+    - "  "
+    - "                 This is NOT the Tezos Mainnet."
+    - "  "
+    - "     The node you are connecting to claims to be running on the"
+    - "               Tezos Alphanet DEVELOPMENT NETWORK."
+    - "          Do NOT use your fundraiser keys on this network."
+    - "          Alphanet is a testing network, with free tokens."
+    - ''
+    - Waiting for the node to be bootstrapped before injection...
+    - 'Current head: BKu7pE9n6DPt (timestamp: 2020-01-07T21:53:28-00:00, validation:
+      2020-01-07T21:53:43-00:00)'
+    - Node is bootstrapped, ready for injecting operations.
+    - 'This simulation failed:'
+    - "  Manager signed operations:"
+    - "    From: tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr"
+    - "    Fee to the baker: ꜩ0"
+    - "    Expected counter: 71379"
+    - "    Gas limit: 800000"
+    - "    Storage limit: 60000 bytes"
+    - "    Transaction:"
+    - "      Amount: ꜩ0"
+    - "      From: tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr"
+    - "      To: KT1V1YYzcEtZywrQWsJyRPVMV3m9R6qwXRV1"
+    - '      Parameter: (Left (Right (Left (Left (Pair 12 "alice")))))'
+    - "      This operation FAILED."
+    - ''
+    - 'Runtime error in contract KT1V1YYzcEtZywrQWsJyRPVMV3m9R6qwXRV1:'
+    - At line 99 characters 84 to 92,
+    - script reached FAILWITH instruction
+    - with "token limit exceeded"
+    - 'Fatal error:'
+    - "  transfer simulation failed"
+  AcceptsNonExpiredWhitelistedWithinLimit:
+    contract: ValidatedForwarder1
+    parameters:
+      received-amount: 3
+      from-user: alice
+    config: "$base-config"
+    duration: 17.856266
+    operation_hash: oorKMKXFvtyYCxkFpnai6wVyozTPUC3snFHs1AhhibotvovAmxW
+  RejectsTokenLimitExceededAfterTransfer:
+    contract: ValidatedForwarder1
+    parameters:
+      received-amount: 8
+      from-user: alice
+    config: "$base-config"
+    duration: 4.603464
+    error:
+    - 'Warning:'
+    - "  "
+    - "                 This is NOT the Tezos Mainnet."
+    - "  "
+    - "     The node you are connecting to claims to be running on the"
+    - "               Tezos Alphanet DEVELOPMENT NETWORK."
+    - "          Do NOT use your fundraiser keys on this network."
+    - "          Alphanet is a testing network, with free tokens."
+    - ''
+    - Waiting for the node to be bootstrapped before injection...
+    - 'Current head: BLiw18sQReQQ (timestamp: 2020-01-07T21:53:58-00:00, validation:
+      2020-01-07T21:54:06-00:00)'
+    - Node is bootstrapped, ready for injecting operations.
+    - 'This simulation failed:'
+    - "  Manager signed operations:"
+    - "    From: tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr"
+    - "    Fee to the baker: ꜩ0"
+    - "    Expected counter: 71380"
+    - "    Gas limit: 800000"
+    - "    Storage limit: 60000 bytes"
+    - "    Transaction:"
+    - "      Amount: ꜩ0"
+    - "      From: tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr"
+    - "      To: KT1V1YYzcEtZywrQWsJyRPVMV3m9R6qwXRV1"
+    - '      Parameter: (Left (Right (Left (Left (Pair 8 "alice")))))'
+    - "      This operation FAILED."
+    - ''
+    - 'Runtime error in contract KT1V1YYzcEtZywrQWsJyRPVMV3m9R6qwXRV1:'
+    - At line 99 characters 84 to 92,
+    - script reached FAILWITH instruction
+    - with "token limit exceeded"
+    - 'Fatal error:'
+    - "  transfer simulation failed"
+  RejectsBecauseExpired:
+    contract: ValidatedForwarderExpired
+    parameters:
+      received-amount: 3
+      from-user: alice
+    config: "$base-config"
+    duration: 5.769269
+    error:
+    - 'Warning:'
+    - "  "
+    - "                 This is NOT the Tezos Mainnet."
+    - "  "
+    - "     The node you are connecting to claims to be running on the"
+    - "               Tezos Alphanet DEVELOPMENT NETWORK."
+    - "          Do NOT use your fundraiser keys on this network."
+    - "          Alphanet is a testing network, with free tokens."
+    - ''
+    - Waiting for the node to be bootstrapped before injection...
+    - 'Current head: BM71Mr9ozfXg (timestamp: 2020-01-07T21:54:58-00:00, validation:
+      2020-01-07T21:55:33-00:00)'
+    - Node is bootstrapped, ready for injecting operations.
+    - 'This simulation failed:'
+    - "  Manager signed operations:"
+    - "    From: tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr"
+    - "    Fee to the baker: ꜩ0"
+    - "    Expected counter: 71382"
+    - "    Gas limit: 800000"
+    - "    Storage limit: 60000 bytes"
+    - "    Transaction:"
+    - "      Amount: ꜩ0"
+    - "      From: tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr"
+    - "      To: KT1NQsAMoZKWzPA5CQdX3tEFeGekuHRGjfit"
+    - '      Parameter: (Left (Right (Left (Left (Pair 3 "alice")))))'
+    - "      This operation FAILED."
+    - ''
+    - 'Runtime error in contract KT1NQsAMoZKWzPA5CQdX3tEFeGekuHRGjfit:'
+    - At line 14 characters 84 to 92,
+    - script reached FAILWITH instruction
+    - with "expired"
+    - 'Fatal error:'
+    - "  transfer simulation failed"

data/test_yaml/test.yaml

@@ -0,0 +1,84 @@
+config:
+  base-config: &base-config
+    tezos_client_path:
+      "tezos-client -A rpcalpha.tzbeta.net -P 443 -S"
+    user_address:
+      tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr
+    param_path:
+      /Users/michaelklein/Coding/forwarder-contract
+    stack_path:
+      /Users/michaelklein/Coding/forwarder-contract/stack
+
+do:
+  - user:
+      name:
+        Alice
+      address:
+        tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr
+
+  - originate: &originate-forwarder
+      alias: ValidatedForwarder1
+      config: $base-config
+      command: dstoken-forwarder-contract print-validated-expiring --central-wallet tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr --dstoken-address tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr
+      storage_command: dstoken-forwarder-contract initial-storage-validated-expiring
+      initial_storage:
+        dstoken-address: $Alice
+        whitelisted-investors: '"[\"alice\"]"'
+        token-limit: 10
+        expiration-date: "$(date -u -d '9:00 next Fri' +%FT%T.%NZ)"
+      burn_cap: '1.644'
+
+  - run: &validate-forwarder
+      alias: RejectsNonWhitelistedUser
+      config: $base-config
+      contract: ValidatedForwarder1
+      command: dstoken-forwarder-contract validate-transfer
+      parameters:
+        received-amount: 3
+        from-user: "bob"
+      burn_cap: '0.000001'
+      expect_failure: true
+
+  - run:
+      <<: *validate-forwarder
+      alias: RejectsTokenLimitExceeded
+      parameters:
+        received-amount: 12
+        from-user: "alice"
+      burn_cap: '0.000001'
+      expect_failure: true
+
+  - run:
+      <<: *validate-forwarder
+      alias: AcceptsNonExpiredWhitelistedWithinLimit
+      parameters:
+        received-amount: 3
+        from-user: "alice"
+      expect_failure: false
+
+  - run:
+      <<: *validate-forwarder
+      alias: RejectsTokenLimitExceededAfterTransfer
+      parameters:
+        received-amount: 8
+        from-user: "alice"
+      expect_failure: true
+
+  - originate:
+      <<: *originate-forwarder
+      alias: ValidatedForwarderExpired
+      initial_storage:
+        dstoken-address: $Alice
+        whitelisted-investors: '"[\"alice\"]"'
+        token-limit: 10
+        expiration-date: "$(date -u -d '9:00 a week ago' +%FT%T.%NZ)" 
+
+  - run:
+      <<: *validate-forwarder
+      alias: RejectsBecauseExpired
+      contract: ValidatedForwarderExpired
+      parameters:
+        received-amount: 3
+        from-user: "alice"
+      expect_failure: true
+

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: lorentz-contract-originate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael J. Klein
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: YAML specs for originating/calling lorentz contracts
+email:
+- michael@tqgroup.io
+executables:
+- lorentz-contract-originate.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/lorentz-contract-originate.rb
+- lib/lorentz/contract/call.rb
+- lib/lorentz/contract/enumerable.rb
+- lib/lorentz/contract/kernel.rb
+- lib/lorentz/contract/originate/version.rb
+- lib/lorentz/contract/param.rb
+- lib/tezos/client.rb
+- lorentz-contract-originate.gemspec
+- test_yaml/README.md
+- test_yaml/test.originated.yaml
+- test_yaml/test.yaml
+homepage: https://github.com/tqtezos/lorentz-contract-originate
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tqtezos/lorentz-contract-originate
+  source_code_uri: https://github.com/tqtezos/lorentz-contract-originate
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Make-like YAML files for originating and calling lorentz contracts.
+test_files: []