infura_ruby 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bec78f6153262da586b44f024f9247c7508af7c7
-  data.tar.gz: cb2f8572bec68b2a76817af04e4645fd2e823cb3
+  metadata.gz: 2cab21eb980c99eb83827f434ed6f742e858e37a
+  data.tar.gz: 2b5fe568f354d5009e3fafe26cf75d812575902e
 SHA512:
-  metadata.gz: a3f091c2737ec85074f1b0659661ad27d35e0b0ba1208066f9f21be7224bc52f885507b0f6f9a2116e7c0b44f6c53ee599ce4161b30213ef63240628cee98397
-  data.tar.gz: 82edfdc537ea144ecff266f6d1273e74d31e493b41fbf14bfc8780aa1548a4381a1abc4ed5554cf77ad8724fdf9361ceb54adc6eb8ae6f07410061074d16acb5
+  metadata.gz: 553ba0800d07eb6e324de103c5ed8ab72104eea4f3c190486b4f9e49c88eb2101ba02e79fc0a6ae8781d5abb53cf35b6f0fda0d56f807240f6fcd968764634e1
+  data.tar.gz: 8b00a4adc2230efe369783de5077f4f031649620d997de79322e11f5b21f792fc28d9cd6ebd0207f9eb6537d62f50674af1a1568541a2c52803b561b81d318c6

data/README.md

@@ -1,8 +1,8 @@
 # InfuraRuby
 
-Ruby gem to wrap the [INFURA](https://github.com/ethereum/wiki/wiki/JSON-RPC() API which gives HTTP API access to ethereum and IPFS nodes. The API uses the same format as the [JSON RPC spec](https://github.com/ethereum/wiki/wiki/JSON-RPCi) for normal ethereum nodes.
+Ruby gem to wrap the [INFURA](https://github.com/ethereum/wiki/wiki/JSON-RPC) API which gives HTTP API access to ethereum and IPFS nodes. The API uses the same format as the [JSON RPC spec](https://github.com/ethereum/wiki/wiki/JSON-RPC) for normal ethereum nodes.
 
-For now, I only need the `getBalance` call an so that is all I will build. Feel free to add the rest of the functionality or I may get to it over time...
+For now, I only need the `getBalance` call and so that is all I have built. Feel free to add the rest of the functionality or I may get to it over time...
 
 ## Usage
 
@@ -19,4 +19,13 @@ infura = InfuraRuby.client(api_key: key)
 
 # get the balance (in wei) of an address
 infura.get_balance('0x81F631b8615EaB75d38DaC4d4bce4A5b63e10310') #=> 591686024850016
+
+# This can be qualified with 4 different tags to get the balance at the tag's time.
+# 'latest'   - latest balance (default) with at least 1 confirmation
+# 'pending'  - balance including pending transactions
+# 'earliest' - balance at the time of the genesis block or earliest known block
+# '0x123'    - balance at the time of chain height `0x123` (hex string)
+
+# balance including unconfirmed transactions
+infura.get_balance('0x81F631b8615EaB75d38DaC4d4bce4A5b63e10310', tag: 'pending')
 ```

data/lib/infura_ruby.rb

@@ -1,5 +1,5 @@
-require 'infura_ruby/version'
-require 'infura_ruby/client'
+require_relative 'infura_ruby/version'
+require_relative 'infura_ruby/client'
 
 module InfuraRuby
   class InvalidApiKeyError < StandardError; end

data/lib/infura_ruby/client.rb

@@ -3,6 +3,11 @@ require 'json'
 
 module InfuraRuby
   class Client
+    class InfuraCallError < StandardError; end
+    class InvalidEthereumAddressError < StandardError; end
+
+    ETHEREUM_ADDRESS_REGEX = /^0x[0-9a-fA-F]{40}$/
+
     # Infura URLs for each network.
     NETWORK_URLS = {
       main:      'https://mainnet.infura.io',
@@ -14,6 +19,13 @@ module InfuraRuby
       'eth_getBalance'
     ].freeze
 
+    BLOCK_PARAMETERS = [
+      /^0x[0-9a-fA-F]{1,}$/, # an integer block number (hex string)
+      /^earliest$/,          # for the earliest/genesis block
+      /^latest$/,            # for the latest mined block
+      /^pending$/            # for the pending state/transactions
+    ].freeze
+
     def initialize(api_key:, network: :main)
       validate_api_key(api_key)
       validate_network(network)
@@ -22,16 +34,27 @@ module InfuraRuby
       @network = network
     end
 
+    # TODO: move calls out of client - worth doing when we have > 1.
     # Returns balance of address in wei as integer.
-    def get_balance(address)
+    def get_balance(address, tag: 'latest')
+      validate_address(address)
+      validate_block_tag(tag)
+
       resp = conn.post do |req|
         req.headers['Content-Type'] = 'application/json'
-        req.body = json_rpc(method: 'eth_getBalance', params: [address, 'latest']).to_json
+        req.body = json_rpc(method: 'eth_getBalance', params: [address, tag]).to_json
       end
-
       resp_body  = JSON.parse(resp.body)
-      wei_amount_hex_string = resp_body['result']
-      wei_amount_hex_string.to_i(16)
+
+      if resp_body['error']
+        raise InfuraCallError.new(
+          "Error (#{resp_body['error']['code']}): Infura API call "\
+          "eth_getBalance gave message: '#{resp_body['error']['message']}'"
+        )
+      else
+        wei_amount_hex_string = resp_body['result']
+        wei_amount_hex_string.to_i(16)
+      end
     end
 
     private
@@ -39,7 +62,7 @@ module InfuraRuby
     # TODO: this JSON RPC object should be a whole object / gem.
     def json_rpc(method:, params:)
       validate_json_rpc_method(method)
-      
+
       {
         "jsonrpc" => "2.0",
         "method"  => method,
@@ -48,8 +71,22 @@ module InfuraRuby
       }
     end
 
+    def validate_block_tag(tag)
+      if BLOCK_PARAMETERS.none? { |regex| regex =~ tag.to_s }
+        raise NotImplementedError.new("Block parameter tag '#{tag}' does not exist.")
+      end
+    end
+
+    def validate_address(address)
+      if ETHEREUM_ADDRESS_REGEX !~ address
+        raise InvalidEthereumAddressError.new("'#{address}' is not a valid ethereum address.")
+      end
+    end
+
     def validate_json_rpc_method(method)
-      raise NotImplementedError unless JSON_RPC_METHODS.include?(method)
+      if !JSON_RPC_METHODS.include?(method)
+        raise NotImplementedError.new("JSON RPC method '#{method}' does not exist.")
+      end
     end
 
     def conn

data/lib/infura_ruby/version.rb

@@ -1,3 +1,3 @@
 module InfuraRuby
-  VERSION = '1.1.0'
+  VERSION = '1.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: infura_ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Julian Borrey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-25 00:00:00.000000000 Z
+date: 2017-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.9
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Library for the INFURA API.