tezos_client 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 996f52ab508d2c26e7fc291462f8758b0dd30db32415f657cc050b89cacc272e
+  data.tar.gz: 20138f2fd23c49133d839fa0963c1c0920f4525eee31d8d39a62d1afebeec1ac
+SHA512:
+  metadata.gz: 287af23b98733a8b8411e8ec85eccdd5b797f74189fd2e88aabc34fb98d997c74f52e163a7eee54611c5de7b67ea124f297b2697fd4e90f3b6c62728ab869428
+  data.tar.gz: 0d73408994a10d1d8906308faf8f5d19995e7d2cd759abe1c520c7aa1577812a55b8490a6a727afe426d7c47837fa77fd47b760b2b53b5f2f5be40bd643185f8

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Rubymine configuration file
+.idea/*

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,9 @@
+inherit_gem:
+  rubocop-rails_config:
+  - config/rails.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+Metrics/MethodLength:
+  Max: 25

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -0,0 +1,21 @@
+---
+dist: trusty
+sudo: required
+language: ruby
+cache:
+  bundler: true
+  directories:
+  - $HOME/.opam
+  - liquidity
+rvm:
+  - 2.5.1
+env:
+  - OPAMYES=1
+before_install:
+  - sh travis-scripts/prepare-trusty.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 exec rake

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in tezos_client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,147 @@
+PATH
+  remote: .
+  specs:
+    tezos_client (0.2.0)
+      activesupport (~> 5.2.0)
+      base58 (~> 0.2.3)
+      httparty (~> 0.16.2)
+      rbnacl (~> 5.0.0)
+      rest-client (~> 2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.1)
+      actionview (= 5.2.1)
+      activesupport (= 5.2.1)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    base58 (0.2.3)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    erubi (1.7.1)
+    ffi (1.9.25)
+    hashdiff (0.3.7)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    httparty (0.16.2)
+      multi_xml (>= 0.5.2)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.1)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    multi_xml (0.6.0)
+    netrc (0.11.0)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    public_suffix (3.0.3)
+    rack (2.0.5)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.1)
+      actionpack (= 5.2.1)
+      activesupport (= 5.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rbnacl (5.0.0)
+      ffi
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.58.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rails_config (0.2.3)
+      railties (>= 3.0)
+      rubocop (~> 0.56)
+    ruby-progressbar (1.10.0)
+    safe_yaml (1.0.4)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    unicode-display_width (1.4.0)
+    vcr (4.0.0)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop-rails_config
+  tezos_client!
+  vcr (~> 4.0.0)
+  webmock
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TODO: Write your name
+
+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,107 @@
+# TezosClient
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/54ab3bbbdc10c1faf933/maintainability)](https://codeclimate.com/github/moneytrackio/tezos_client/maintainability)
+
+[![Build Status](https://travis-ci.org/moneytrackio/tezos_client.svg?branch=master)](https://travis-ci.org/moneytrackio/tezos_client)
+
+Tezos Client interracts with tezos nodes using RPC commands. 
+
+## Requirements:
+Tezos client requires liquidity to be installed in order to work properly.
+For installing on linux, you can basically follow the steps coded in travis-script folder. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tezos_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tezos_client
+
+## Usage
+
+### Transfer funds
+
+```ruby 
+client = TezosClient.new 
+
+client.transfer(
+    amount: 1,
+    from: "tz1ZWiiPXowuhN1UqNGVTrgNyf5tdxp4XUUq",
+    to: "tz1ZWiiPXowuhN1UqNGVTrgNyf5tdxp4XUUq",
+    secret_key: "edsk4EcqupPmaebat5mP57ZQ3zo8NDkwv8vQmafdYZyeXxrSc72pjN"
+)
+```
+
+### Call a contract
+
+```ruby
+client = TezosClient.new  
+client.transfer(
+    amount: 5,
+    from: "tz1ZWiiPXowuhN1UqNGVTrgNyf5tdxp4XUUq",
+    to: "KT1MZTrMDPB42P9yvjf7Cy8Lkjxjj4jetbCt",
+    secret_key: "edsk4EcqupPmaebat5mP57ZQ3zo8NDkwv8vQmafdYZyeXxrSc72pjN",
+    parameters: '"pro"'
+)
+```
+
+### Originate a contract written in liquidity
+
+```ruby
+script = File.expand_path("./spec/fixtures/demo.liq")
+source = "tz1ZWiiPXowuhN1UqNGVTrgNyf5tdxp4XUUq"
+secret_key = "edsk4EcqupPmaebat5mP57ZQ3zo8NDkwv8vQmafdYZyeXxrSc72pjN"
+amount =  0
+init_params = '"test"'
+client = TezosClient.new
+
+res = client.originate_contract(
+    from: source,
+    amount: amount,
+    script: script,
+    secret_key: secret_key,
+    init_params: init_params
+)
+
+puts "Origination operation: #{res[:operation_id]}"
+puts "Contract address: #{res[:originated_contract]}"
+```
+
+### Call a contract written in liquidity
+```ruby
+TezosClient.new.call_contract(
+  from: "tz1ZWiiPXowuhN1UqNGVTrgNyf5tdxp4XUUq",
+  amount: 0,
+  script: File.expand_path("./spec/fixtures/demo.liq"),
+  secret_key: "edsk4EcqupPmaebat5mP57ZQ3zo8NDkwv8vQmafdYZyeXxrSc72pjN",
+  to: "KT1STzq9p2tfW3K4RdoM9iYd1htJ4QcJ8Njs",
+  parameters: [ "manage", "(Some { destination = tz1YLtLqD1fWHthSVHPD116oYvsd4PTAHUoc; amount = 1tz })" ]
+)
+```
+
+## 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/[USERNAME]/tezos_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TezosClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tezos_client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "tezos_client"
+
+# 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/lib/tezos_client/client_interface/block_contextual.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class TezosClient
+  class ClientInterface
+    # Commands managing keys and accounts
+    module BlockContextual
+      def transfer(quantity:, from:, to:, dry_run: false, arg: nil)
+        cmd = "transfer #{quantity} from #{from} to #{to}"
+        cmd = "#{cmd} --dry-run" if dry_run
+        cmd = "#{cmd} --arg #{arg}" unless arg.nil?
+
+        res = call_client(cmd)
+      end
+    end
+  end
+end

data/lib/tezos_client/client_interface/client_wrapper.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+class TezosClient
+  class ClientInterface
+    # Wrapper used to call the tezos-client binary
+    module ClientWrapper
+      def call_client(command)
+        cmd = "#{client_cmd} #{command}"
+        Open3.popen3(cmd) do |_stdin, stdout, stderr, wait_thr|
+          err = stderr.read
+          status = wait_thr.value.exitstatus
+
+          if status != 0
+            raise "command '#{cmd}' existed with status #{status}: #{err}"
+          end
+
+          log err
+          output = stdout.read
+
+          if block_given?
+            yield(output)
+          else
+            output
+          end
+        end
+      end
+
+      def client_cmd
+        res = "tezos-client -l"
+        if config_file
+          res = "#{res} -c #{config_file}"
+        end
+        res
+      end
+    end
+  end
+end

data/lib/tezos_client/client_interface/contract.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class TezosClient
+  class ClientInterface
+    # Commands managing keys and accounts
+    module Contract
+      def known_contracts
+        res = call_client("list known contracts")
+        res.lines.reduce({}) do |acc, contract_output|
+          address_format = /([^:]+): (\w+)/
+          res = address_format.match(contract_output)
+          acc.merge(res[1] => res[2])
+        end
+      end
+    end
+  end
+end

data/lib/tezos_client/client_interface/key.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class TezosClient
+  class ClientInterface
+    # Commands managing keys and accounts
+    module Key
+      def gen_keys(name)
+        call_client("gen keys #{name}")
+      end
+
+      def addresses
+        output = call_client("list known addresses")
+        output.lines.reduce({}) do |acc, address_output|
+          address_format = /([^:]+): (\w+) /
+          res = address_format.match(address_output)
+          acc.merge(res[1] => res[2])
+        end
+      end
+
+      def import_public_key(name, public_key, force: false)
+        cmd = "import public key #{name} #{public_key}"
+        cmd = "#{cmd} --force" if force
+
+        call_client(cmd)
+      end
+
+      def import_secret_key(name, secret_key, force: false)
+        cmd = "import secret key #{name} #{secret_key}"
+        cmd = "#{cmd} --force" if force
+
+        call_client(cmd)
+      end
+    end
+  end
+end

data/lib/tezos_client/client_interface/misc.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "open3"
+require "date"
+
+class TezosClient
+  class ClientInterface
+    module Misc
+      def bootstrapped
+        call_client("bootstrapped") do |output|
+          output_format = /Current head: ([^ ]+) \(timestamp: ([^,]+), validation: (.+)\)/
+          res = output_format.match(output)
+          head = res[1]
+          timestamp = DateTime.parse(res[2])
+          validation = DateTime.parse(res[3])
+
+          {
+              "block" => head,
+              "timestamp" => timestamp,
+              "validated_at" => validation
+          }
+        end
+      end
+    end
+  end
+end

data/lib/tezos_client/client_interface.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "client_interface/client_wrapper"
+require_relative "client_interface/misc"
+require_relative "client_interface/key"
+require_relative "client_interface/contract"
+require_relative "client_interface/block_contextual"
+
+class TezosClient
+  class ClientInterface
+    attr_reader :config_file
+
+    include Logger
+
+    include ClientWrapper
+    include Misc
+    include Key
+    include Contract
+    include BlockContextual
+
+    def initialize(config_file: nil)
+      @config_file = config_file
+    end
+  end
+end

data/lib/tezos_client/commands.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+class TezosClient
+  module Commands
+    extend Forwardable
+
+    def_delegators :rpc_interface,
+                   :bootstrapped,
+                   :monitor_block,
+                   :head_hash,
+                   :contract_counter,
+                   :block_header,
+                   :block_operations,
+                   :block_operation_hashes,
+                   :blocks,
+                   :balance
+
+    def_delegators :client_interface,
+                   :gen_keys,
+                   :addresses,
+                   :import_public_key,
+                   :import_secret_key,
+                   :known_contracts,
+                   :transfer
+  end
+end