ethmo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3586f58bafa8b9132b9455c1ba70c8fcf086eeb0
+  data.tar.gz: 15a1d3ae96e3a50e820cfaf1bf1ebde668bf187f
+SHA512:
+  metadata.gz: e0c0cbe4c22cc4f177b376aedd6b85e3530291188fd84d3412b296d892e5afd44e40f74d85e5e7fa142b1264bc1dcc4d9129cce02f718c30dca14391c33343c1
+  data.tar.gz: d571fa0d33759142060b25e27a079c2aa673d5280768e7c66586d2c9ad2494b4311dbefea682d1dbf9d38edd1828be5458c2db5dbf502dc8b2aebc72ae2c0433

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/.rubocop.yml

@@ -0,0 +1,3 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  DisplayCopNames: true

data/.travis.yml

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    ethmo (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    pry (0.11.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      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.0)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  ethmo!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.52.1)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,63 @@
+# Ethmo
+
+The Ethereum `geth` RCP tools for ruby developer
+
+## Requirement
+
+* Ruby 2.4+
+* Geth (or IPC capability client)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ethmo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ethmo
+
+## Usage
+
+Current is under development, only support minimal features I need.
+
+### Balance of Account
+
+```ruby
+account = Ethmo::Account.new('0x475AFd1a6F1D093263bE16948e1EcA6C4DC37Dcf')
+p account.balance
+```
+
+### Monitor New Blocks
+
+```ruby
+monitor = Ethmo::Monitor.new
+monitor.start
+
+# NOTE: It will blocking I/O until stop
+monitor.each do |event|
+  block = Ethmo::Block.new(event.hash)
+  block.transactions.each do |tx|
+    next unless tx.transfer?
+    puts "From: #{tx.from}"
+    puts "To: #{tx.to}"
+    puts "Value: #{tx.value} ETH"
+  end
+end
+```
+
+## 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/elct9620/ethmo.

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,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ethmo'
+
+# 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

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

@@ -0,0 +1,29 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ethmo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ethmo'
+  spec.version       = Ethmo::VERSION
+  spec.authors       = ['蒼時弦也']
+  spec.email         = ['elct9620@frost.tw']
+
+  spec.summary       = 'The ethereum monitor tool'
+  spec.description   = 'The ethereum monitor tool'
+  spec.homepage      = 'https://github.com/elct9620/ethmo'
+
+  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.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52.1'
+end

data/lib/ethmo.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'socket'
+require 'singleton'
+require 'json'
+
+require 'ethmo/version'
+
+# :nodoc
+module Ethmo
+  autoload :IPCSocket,   'ethmo/ipc_socket'
+  autoload :Config,      'ethmo/config'
+  autoload :Client,      'ethmo/client'
+  autoload :Account,     'ethmo/account'
+  autoload :Block,       'ethmo/block'
+  autoload :Transaction, 'ethmo/transaction'
+  autoload :Monitor,     'ethmo/monitor'
+
+  class << self
+    def config(&block)
+      Config.instance_exec(Config.instance, &block)
+    end
+  end
+end

data/lib/ethmo/account.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Ethmo
+  # :nodoc:
+  class Account
+    attr_reader :address
+
+    def initialize(address)
+      @address = address
+    end
+
+    def balance
+      # TODO: Add ETH value to Float Helper
+      Client
+        .balance_of(address, 'latest')
+        .fetch('result', '0x0')
+        .to_i(16)
+        .to_f / Config::WEI
+    end
+  end
+end

data/lib/ethmo/block.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Ethmo
+  # :nodoc:
+  class Block < Hash
+    def initialize(hash)
+      merge! Client.block_from(hash, true).dig('result')
+    end
+
+    def transactions
+      @transactions ||=
+        self['transactions']
+        .map { |tx| Transaction.new(tx) }
+    end
+  end
+end

data/lib/ethmo/client.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Ethmo
+  # :nodoc:
+  class Client
+    include Singleton
+
+    class << self
+      def respond_to_missing?(*args)
+        instance.respond_to_missing?(*args)
+      end
+
+      def method_missing(name, *args, &block)
+        return super unless instance.respond_to?(name)
+        instance.public_send(name, *args, &block)
+      end
+    end
+
+    AVAILABLE_METHOD = {
+      balance_of: 'eth_getBalance',
+      block_from: 'eth_getBlockByHash'
+    }.freeze
+
+    def initialize
+      # TODO: Add support for WebSocket and others
+      @conn = IPCSocket.new(Config.socket)
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      AVAILABLE_METHOD.keys.include?(name) || super
+    end
+
+    def method_missing(name, *args, &block)
+      return super unless AVAILABLE_METHOD.keys.include?(name)
+      @conn.exec(AVAILABLE_METHOD[name], *args)
+      JSON.parse(@conn.read)
+    end
+  end
+end

data/lib/ethmo/config.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Ethmo
+  # :nodoc:
+  class Config
+    include Singleton
+
+    WEI = 10**18 # 1 ETH = 10^18 Wei
+
+    class << self
+      def respond_to_missing?(*args)
+        instance.respond_to_missing?(*args)
+      end
+
+      def method_missing(name, *args, &block)
+        return super unless instance.respond_to?(name)
+        instance.public_send(name, *args, &block)
+      end
+    end
+
+    attr_accessor :socket
+  end
+end

data/lib/ethmo/ipc_socket.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Ethmo
+  # :nodoc;
+  class IPCSocket < UNIXSocket
+    class << self
+      def next_id
+        @id ||= 1
+        @id += 1
+      end
+    end
+
+    VERSION = '2.0'
+
+    attr_reader :id
+
+    def initialize(path)
+      @buffer = ''
+      @id = self.class.next_id
+      super
+    end
+
+    def exec(method, *params)
+      send({
+        id: id,
+        jsonrpc: VERSION,
+        method: method,
+        params: params
+      }.to_json, 0)
+    end
+
+    def read
+      @buffer = @buffer.to_s + recv(1024) until @buffer.to_s.include?("\n")
+      (_, @buffer = @buffer.to_s.split("\n", 2)).first
+    end
+  end
+end

data/lib/ethmo/monitor.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Ethmo
+  # :nodoc:
+  class Monitor
+    autoload :NewHead, 'ethmo/monitor/new_head'
+
+    include Enumerable
+
+    def initialize(type = 'newHeads')
+      @conn = IPCSocket.new(Config.socket)
+      @type = type
+      @thread = nil
+      @stop = false
+      @queue = Queue.new
+    end
+
+    def each(&_block)
+      yield @queue.pop until stop?
+    end
+
+    def start
+      return if @thread
+      subscribe!
+      @thread = Thread.new { process until stop? }
+    end
+
+    def stop?
+      @stop == true
+    end
+
+    def stop
+      @stop = true
+    end
+
+    protected
+
+    def process
+      event = @conn.read
+      return sleep 1 if event.nil?
+      @queue << NewHead.new(JSON.parse(event))
+    end
+
+    def subscribe!
+      # TODO: Add options support
+      @conn.exec('eth_subscribe', @type, {})
+      JSON.parse(@conn.read)
+    end
+  end
+end

data/lib/ethmo/monitor/new_head.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Ethmo
+  class Monitor
+    # :nodoc:
+    class NewHead < Hash
+      def initialize(event)
+        merge! event.dig('params', 'result')
+      end
+
+      # TODO: Add methods for others attribute
+
+      def hash
+        self['hash']
+      end
+    end
+  end
+end

data/lib/ethmo/transaction.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Ethmo
+  # :nodoc:
+  class Transaction < Hash
+    def initialize(hash)
+      # TODO: Add read transaction from hash support
+      # NOTE: Current only support direct merge transaction
+      merge! hash
+    end
+
+    def transfer?
+      value.positive?
+    end
+
+    def contract?
+      to.nil?
+    end
+
+    def from
+      self['from']
+    end
+
+    def to
+      self['to']
+    end
+
+    def value
+      @value ||=
+        fetch('value', '0x0')
+        .to_i(16)
+        .to_f / Config::WEI
+    end
+  end
+end

data/lib/ethmo/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ethmo
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: ethmo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- 蒼時弦也
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-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.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+description: The ethereum monitor tool
+email:
+- elct9620@frost.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ethmo.gemspec
+- lib/ethmo.rb
+- lib/ethmo/account.rb
+- lib/ethmo/block.rb
+- lib/ethmo/client.rb
+- lib/ethmo/config.rb
+- lib/ethmo/ipc_socket.rb
+- lib/ethmo/monitor.rb
+- lib/ethmo/monitor/new_head.rb
+- lib/ethmo/transaction.rb
+- lib/ethmo/version.rb
+homepage: https://github.com/elct9620/ethmo
+licenses: []
+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.14
+signing_key: 
+specification_version: 4
+summary: The ethereum monitor tool
+test_files: []