web3-eth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f7893df18e36c16067fa42bddf10427099c9696
+  data.tar.gz: '0805e5a0a3ab5eaab92ab9407b72793f5373b1b8'
+SHA512:
+  metadata.gz: c4d866889983b9bf6da84bfa32b0ef4a7faa6f1dd24735248151239e9ec5c0061ddf4dd9db5b119dd5ceb2dfaaf0f085109e8534419ce55d56b498437873f172
+  data.tar.gz: 047b409c3530c5bdcdf957184cf7960e65363020e2707b1baeb1ded9073bed09ab71b54a581d93178e849e113b9dde8e50233edf29495be5a18b422c59fa584b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

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 aleksey@wondersoft.ru. 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in web3-eth.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 astudnev
+
+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,79 @@
+# Web3 RPC client for Ethereum node
+
+This Ruby Gem is used to connect and communicate with Ethereum node ( geth, parity, etc),
+having RPC interface. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'web3-eth'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install web3-eth
+
+## Usage
+
+Connecting to local node ( or by SSH Tunnel )
+
+```ruby
+web3 = Web3::Eth::Rpc.new
+```
+
+To connect to remote Ethereum node, follow instructions: https://github.com/paritytech/parity/wiki/Wallet-Remote-Access
+
+If you need to connect to remote host, you can specify host, port and HTTP connection options:
+
+```ruby
+web3 = Web3::Eth::Rpc.new 'node.host.com', 8545, { use_ssl: true, read_timeout: 120 } 
+```
+
+Calling eth interface:
+
+```
+>> web3.eth.blockNumber
+4376369
+
+>> web3.eth.getBalance '0x829BD824B016326A401d083B33D092293333A830'
+3916.6597314456685
+
+>> block = web3.eth.getBlockByNumber 4376369
+#<Web3::Eth::Block:0x007f844d6f1138 @block_data={"author"=>"0x829bd824b016326a401d083b33d092293333a830", ...
+
+>> block.timestamp_time
+2017-10-17 12:51:36 +0300
+
+>> block.transactions.count
+129
+
+>> block.transactions[0].from
+"0xb2930b35844a230f00e51431acae96fe543a0347"
+
+>> block.transactions[0].value_eth
+0.51896811
+
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/izetex/web3-eth. 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](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "web3/eth"
+
+# 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/web3/eth.rb

@@ -0,0 +1,7 @@
+require "web3/eth/version"
+require "web3/eth/utility"
+require "web3/eth/block"
+require "web3/eth/transaction"
+require "web3/eth/transaction_receipt"
+require "web3/eth/ethereum"
+require "web3/eth/rpc"

data/lib/web3/eth/block.rb

@@ -0,0 +1,35 @@
+module Web3
+  module Eth
+
+    class Block
+
+      include Web3::Eth::Utility
+
+      attr_reader :raw_data
+
+      def initialize block_data
+        @raw_data = block_data
+
+        block_data.each do |k, v|
+          self.instance_variable_set("@#{k}", v)
+          self.class.send(:define_method, k, proc {self.instance_variable_get("@#{k}")})
+        end
+
+        @transactions = block_data['transactions'].collect {|t|
+          Transaction.new t
+        }
+
+      end
+
+      def timestamp_time
+        Time.at from_hex timestamp
+      end
+
+      def block_number
+        from_hex number
+      end
+
+    end
+
+  end
+end

data/lib/web3/eth/ethereum.rb

@@ -0,0 +1,43 @@
+module Web3
+  module Eth
+
+    class Ethereum
+
+      include Web3::Eth::Utility
+
+      PREFIX = 'eth_'
+
+      def initialize web3_rpc
+        @web3_rpc = web3_rpc
+      end
+
+      def getBalance address, block = 'latest', convert_to_eth = true
+        wei = @web3_rpc.request("#{PREFIX}#{__method__}", [address, block]).to_i 16
+        convert_to_eth ? wei_to_ether(wei) : wei
+      end
+
+      def getBlockByNumber block, full = true, convert_to_object = true
+        resp = @web3_rpc.request("#{PREFIX}#{__method__}", [hex(block), full])
+        convert_to_object ? Block.new(resp) : resp
+      end
+
+      def blockNumber
+        from_hex @web3_rpc.request("#{PREFIX}#{__method__}")
+      end
+
+      def getTransactionByHash tx_hash
+        Transaction.new @web3_rpc.request("#{PREFIX}#{__method__}", [tx_hash])
+      end
+
+      def getTransactionReceipt tx_hash
+        TransactionReceipt.new @web3_rpc.request("#{PREFIX}#{__method__}", [tx_hash])
+      end
+
+      def method_missing m, *args
+        @web3_rpc.request "#{PREFIX}#{m}", args[0]
+      end
+
+
+    end
+  end
+end

data/lib/web3/eth/rpc.rb

@@ -0,0 +1,59 @@
+module Web3
+  module Eth
+
+    class Rpc
+
+      require 'json'
+      require 'net/http'
+
+      JSON_RPC_VERSION = '2.0'
+
+      DEFAULT_CONNECT_OPTIONS = {
+          use_ssl: false,
+          open_timeout: 10,
+          read_timeout: 70
+      }
+
+      DEFAULT_HOST = 'localhost'
+      DEFAULT_PORT = 8545
+
+      def initialize host: DEFAULT_HOST, port: DEFAULT_PORT, connect_options: DEFAULT_CONNECT_OPTIONS
+
+        @client_id = Random.rand 10000000
+
+        @uri = URI((connect_options[:use_ssl] ? 'https' : 'http')+ "://#{host}:#{port}")
+        @connect_options = connect_options
+
+        @eth = Ethereum.new self
+      end
+
+
+      def eth
+        @eth
+      end
+
+
+      def request method, params = nil
+
+
+        Net::HTTP.start(@uri.host, @uri.port, @connect_options) do |http|
+
+          request = Net::HTTP::Post.new @uri, {"Content-Type" => "application/json"}
+          request.body = {:jsonrpc => JSON_RPC_VERSION, method: method, params: params, id: @client_id}.compact.to_json
+          response = http.request request
+
+          raise "Error code #{response.code} on request #{@uri.to_s} #{request.body}" unless response.kind_of? Net::HTTPOK
+
+          json = JSON.parse(response.body)['result']
+          raise "No response on request #{@uri.to_s} #{request.body}" unless json
+
+          json
+
+        end
+
+      end
+
+
+    end
+  end
+end

data/lib/web3/eth/transaction.rb

@@ -0,0 +1,39 @@
+module Web3
+  module Eth
+
+    class Transaction
+
+      include Web3::Eth::Utility
+
+      attr_reader :raw_data
+
+      def initialize transaction_data
+        @raw_data = transaction_data
+
+        transaction_data.each do |k, v|
+          self.instance_variable_set("@#{k}", v)
+          self.class.send(:define_method, k, proc {self.instance_variable_get("@#{k}")})
+        end
+
+
+      end
+
+      def block_number
+        from_hex blockNumber
+      end
+
+      def value_eth
+        wei_to_ether from_hex value
+      end
+
+      def gas_eth
+        wei_to_ether from_hex gas
+      end
+
+      def gasPrice_eth
+        wei_to_ether from_hex gasPrice
+      end
+
+    end
+  end
+end

data/lib/web3/eth/transaction_receipt.rb

@@ -0,0 +1,39 @@
+module Web3
+  module Eth
+
+    class TransactionReceipt
+
+      include Web3::Eth::Utility
+
+      attr_reader :raw_data
+
+      def initialize transaction_data
+        @raw_data = transaction_data
+
+        transaction_data.each do |k, v|
+          self.instance_variable_set("@#{k}", v)
+          self.class.send(:define_method, k, proc {self.instance_variable_get("@#{k}")})
+        end
+
+      end
+
+      def block_number
+        from_hex blockNumber
+      end
+
+      def success?
+         status==1 || status.nil?
+      end
+
+      def gas_used_eth
+        wei_to_ether from_hex gasUsed
+      end
+
+
+      def cumulative_gas_used_eth
+        wei_to_ether from_hex cumulativeGasUsed
+      end
+
+    end
+  end
+end

data/lib/web3/eth/utility.rb

@@ -0,0 +1,21 @@
+module Web3
+  module Eth
+
+    module Utility
+
+      def hex num
+        '0x' + num.to_s(16)
+      end
+
+      def wei_to_ether(wei)
+        1.0 * wei / 10**18
+      end
+
+      def from_hex h
+        h.to_i 16
+      end
+
+
+    end
+  end
+end

data/lib/web3/eth/version.rb

@@ -0,0 +1,5 @@
+module Web3
+  module Eth
+    VERSION = "0.1.0"
+  end
+end

data/web3-eth.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'web3/eth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "web3-eth"
+  spec.version       = Web3::Eth::VERSION
+  spec.authors       = ["studnev"]
+  spec.email         = ["studnev@izx.io"]
+
+  spec.summary       = %q{Web3 client to connect to Ethereum node by RPC.}
+  spec.description   = %q{Calling RPC methods of Ethereum node with Ruby.}
+  spec.homepage      = "https://github.com/izetex/web3-eth"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: web3-eth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- studnev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Calling RPC methods of Ethereum node with Ruby.
+email:
+- studnev@izx.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/workspace.xml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/web3/eth.rb
+- lib/web3/eth/block.rb
+- lib/web3/eth/ethereum.rb
+- lib/web3/eth/rpc.rb
+- lib/web3/eth/transaction.rb
+- lib/web3/eth/transaction_receipt.rb
+- lib/web3/eth/utility.rb
+- lib/web3/eth/version.rb
+- web3-eth.gemspec
+homepage: https://github.com/izetex/web3-eth
+licenses:
+- MIT
+metadata: {}
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Web3 client to connect to Ethereum node by RPC.
+test_files: []