jeth 0.0.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aaf74976d7f6689c2ef9001ed0465b0de8f82a96
+  data.tar.gz: 9d0d91f68aa668bcd1abd50ebb1e5a8bcebc2d6d
+SHA512:
+  metadata.gz: 1130904dc15fceea008ecd106014b71636c364e1e6bf130aad201169a74c13792026ccafacdadddd05f17f2f9668b0b6f8dfafd627ba1e0f5f0772b3f00138d2
+  data.tar.gz: a5055ceafefbe1a5f1242ff471d519fae220b79027219e9d61b839e4cc209fdfb65b29e93879679f1fb438c1f3b80c7a72dc1b06252affdacd7ccfabf9534985

data/.gitignore

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at alexander.hanhikoski@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alexander Hanhikoski
+
+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,66 @@
+# Jeth
+
+Jeth is a Ethereum JSON RPC client. It supports the IPC and HTTP protocols.
+
+## Installation
+
+```ruby
+gem 'jeth'
+```
+
+Start your Ethereum node with the desired endpoints (IPC, HTTP and/or WS). For example with Geth:
+
+    $ geth --rpc --rpcapi "admin,debug,eth,miner,net,personal,shh,txpool,web3"
+
+## Usage
+
+```ruby
+client = Jeth.create
+client = Jeth::IpcClient.create
+client = Jeth::HttpClient.create('http://foo.bar:8545')
+
+client.eth_gas_price
+ => {"jsonrpc"=>"2.0", "id"=>1, "result"=>"0x4a817c800"} 
+```
+
+`Jeth.create(host_or_ipcpath)` automatically detects if you want HTTP or IPC and will initiate the appropriate client. It will default to IPC if nothing is specified. You can also use protocol clients explicitly:
+
+### Batching
+
+```ruby
+client.batch do
+  client.eth_get_balance('0x407d73d8a49eeb85d32cf465507dd71d507100c1', 'latest')
+  client.eth_get_balance('0x407d73d8a49eeb85d32cf465507dd71d507100c1', 'pending')
+end
+
+ => [{"jsonrpc"=>"2.0", "id"=>1, "result"=>"0x0"}, {"jsonrpc"=>"2.0", "id"=>2, "result"=>"0x0"}]
+```
+
+The response array is guaranteed to hold the responses in the same order as their corresponding requests were called.
+
+## Methods
+
+Jeth supports all methods from https://github.com/ethereum/wiki/wiki/JSON-RPC and https://github.com/ethereum/go-ethereum/wiki/Management-APIs. Method names are downcased, so for example `eth_getBlockByNumber` becomes `eth_get_block_by_number`.
+
+## Parameters
+
+Jeth will automagically encode integer parameters as hex. That is `client.eth_get_block_by_number(0, false)` will be sent as `{"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["0x0",false],"id":1}`.
+
+You are free to use hex encoded parameters too `client.eth_get_block_by_number('0x0', false)`.
+
+Note that Jeth won't prefix with '0x' if the user supplied hex encoded parameter is missing the prefix. However, at least Geth seems to tolerate unprefixed hex parameters.
+
+## 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/alexhanh/jeth.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

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

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/jeth.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jeth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jeth"
+  spec.version       = Jeth::VERSION
+  spec.authors       = ["Alexander Hanhikoski"]
+  spec.email         = ["alexander.hanhikoski@gmail.com"]
+
+  spec.summary       = "Simple Ethereum JSON RPC client."
+  spec.description   = "Simple Ethereum JSON RPC client. Supports IPC/HTTP and JSON RPC 2.0."
+  spec.homepage      = "https://github.com/alexhanh/jeth"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/jeth.rb

@@ -0,0 +1,15 @@
+require 'jeth/version'
+require 'jeth/util'
+require 'jeth/client'
+require 'jeth/http_client'
+require 'jeth/ipc_client'
+
+module Jeth
+  def self.create(host_or_ipcpath = nil)
+    return IpcClient.new if host_or_ipcpath.nil?
+    return IpcClient.new(host_or_ipcpath) if host_or_ipcpath.end_with? '.ipc'
+    return HttpClient.new(host_or_ipcpath) if host_or_ipcpath.start_with? 'http'
+    
+    raise ArgumentError.new('Unable to detect client type. Please use "http://host:port" or "/path/to/geth.ipc".')
+  end
+end

data/lib/jeth/client.rb

@@ -0,0 +1,76 @@
+require 'json'
+
+module Jeth
+  class Client
+    # https://github.com/ethereum/wiki/wiki/JSON-RPC
+    RPC_COMMANDS = %w(web3_clientVersion web3_sha3 net_version net_peerCount net_listening eth_protocolVersion eth_syncing eth_coinbase eth_mining eth_hashrate eth_gasPrice eth_accounts eth_blockNumber eth_getBalance eth_getStorageAt eth_getTransactionCount eth_getBlockTransactionCountByHash eth_getBlockTransactionCountByNumber eth_getUncleCountByBlockHash eth_getUncleCountByBlockNumber eth_getCode eth_sign eth_sendTransaction eth_sendRawTransaction eth_call eth_estimateGas eth_getBlockByHash eth_getBlockByNumber eth_getTransactionByHash eth_getTransactionByBlockHashAndIndex eth_getTransactionByBlockNumberAndIndex eth_getTransactionReceipt eth_getUncleByBlockHashAndIndex eth_getUncleByBlockNumberAndIndex eth_getCompilers eth_compileLLL eth_compileSolidity eth_compileSerpent eth_newFilter eth_newBlockFilter eth_newPendingTransactionFilter eth_uninstallFilter eth_getFilterChanges eth_getFilterLogs eth_getLogs eth_getWork eth_submitWork eth_submitHashrate db_putString db_getString db_putHex db_getHex shh_post shh_version shh_newIdentity shh_hasIdentity shh_newGroup shh_addToGroup shh_newFilter shh_uninstallFilter shh_getFilterChanges shh_getMessages)
+    
+    # https://github.com/ethereum/go-ethereum/wiki/Management-APIs
+    RPC_MANAGEMENT_COMMANDS = %w(admin_addPeer admin_datadir admin_nodeInfo admin_peers admin_setSolc admin_startRPC admin_startWS admin_stopRPC admin_stopWS debug_backtraceAt debug_blockProfile debug_cpuProfile debug_dumpBlock debug_gcStats debug_getBlockRlp debug_goTrace debug_memStats debug_seedHash debug_setHead debug_setBlockProfileRate debug_stacks debug_startCPUProfile debug_startGoTrace debug_stopCPUProfile debug_stopGoTrace debug_traceBlock debug_traceBlockByNumber debug_traceBlockByHash debug_traceBlockFromFile debug_traceTransaction debug_verbosity debug_vmodule debug_writeBlockProfile debug_writeMemProfile miner_hashrate miner_makeDAG miner_setExtra miner_setGasPrice miner_start miner_startAutoDAG miner_stop miner_stopAutoDAG personal_importRawKey personal_listAccounts personal_lockAccount personal_newAccount personal_unlockAccount personal_sendTransaction txpool_content txpool_inspect txpool_status)
+
+    def initialize
+      @id = 0
+      @batch = nil
+    end
+
+    def batch
+      @batch = []
+
+      yield
+      result = send_batch(@batch)
+
+      @batch = nil
+      reset_id
+
+      return result
+    end
+
+    def send_batch(batch)
+      result = send_single(batch.to_json)
+      result = JSON.parse(result)
+
+      # Make sure the order is the same as it was when batching calls
+      # See 6 Batch here http://www.jsonrpc.org/specification
+      return result.sort_by! { |c| c['id'] }
+    end
+
+    def get_id
+      return @id += 1
+    end
+
+    def reset_id
+      @id = 0
+    end
+
+    # https://github.com/ethereum/wiki/wiki/JSON-RPC#output-hex-values
+    def encode_params(params)
+      return params.map do |p|
+        if p.is_a?(Integer)
+          Util.int_to_hex(p)
+        else
+          p
+        end
+      end
+    end
+
+    (RPC_COMMANDS + RPC_MANAGEMENT_COMMANDS).each do |rpc_command|
+      method_name = "#{Util.underscore(rpc_command)}"
+      define_method method_name do |*args|
+        payload = { jsonrpc: "2.0", method: rpc_command, params: encode_params(args), id: get_id }
+
+        if @batch
+          @batch << payload
+          return true
+        else
+          read = send_single(payload.to_json)
+          output = JSON.parse(read)
+          reset_id
+          return output
+        end
+      end
+    end
+
+  end
+
+end
+

data/lib/jeth/http_client.rb

@@ -0,0 +1,33 @@
+require 'net/http'
+
+module Jeth
+  class HttpClient < Client
+    def initialize(host = 'http://localhost:8545')
+      super()
+      uri = URI.parse(host)
+      raise ArgumentError unless ['http', 'https'].include? uri.scheme
+      @host = uri.host
+      @port = uri.port
+      
+      @ssl = uri.scheme == 'https'
+      if @ssl
+        @uri = URI("https://#{@host}:#{@port}")
+      else
+        @uri = URI("http://#{@host}:#{@port}")
+      end
+    end
+
+    def send_single(payload)
+      http = ::Net::HTTP.new(@host, @port)
+      if @ssl
+        http.use_ssl = true
+      end
+      header = {'Content-Type' => 'application/json'}
+      request = ::Net::HTTP::Post.new(@uri, header)
+      request.body = payload
+      response = http.request(request)
+      return response.body
+    end
+  end
+
+end

data/lib/jeth/ipc_client.rb

@@ -0,0 +1,24 @@
+require 'socket'
+
+module Jeth
+  class IpcClient < Client
+    def initialize(ipcpath = default_path)
+      super()
+      @ipcpath = ipcpath 
+    end
+
+    def send_single(payload)
+      socket = UNIXSocket.new(@ipcpath)
+      socket.puts(payload)
+      read = socket.gets
+      socket.close
+      return read
+    end
+
+    def default_path
+      ["#{ENV['HOME']}/.ethereum/geth.ipc", "#{ENV['HOME']}/Library/Ethereum/geth.ipc"].each do |path|
+        return path if File.exists?(path)
+      end
+    end
+  end
+end

data/lib/jeth/util.rb

@@ -0,0 +1,15 @@
+module Jeth
+  class Util
+    def self.underscore(s)
+      s.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+
+    def self.int_to_hex(n)
+      "0x#{n.to_s(16)}"
+    end
+  end
+end

data/lib/jeth/version.rb

@@ -0,0 +1,3 @@
+module Jeth
+  VERSION = "0.0.11"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: jeth
+version: !ruby/object:Gem::Version
+  version: 0.0.11
+platform: ruby
+authors:
+- Alexander Hanhikoski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: Simple Ethereum JSON RPC client. Supports IPC/HTTP and JSON RPC 2.0.
+email:
+- alexander.hanhikoski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jeth.gemspec
+- lib/jeth.rb
+- lib/jeth/client.rb
+- lib/jeth/http_client.rb
+- lib/jeth/ipc_client.rb
+- lib/jeth/util.rb
+- lib/jeth/version.rb
+homepage: https://github.com/alexhanh/jeth
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Simple Ethereum JSON RPC client.
+test_files: []
+has_rdoc: