eth 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44e92871d81caa7588db650518e11a2ba2901d5d
-  data.tar.gz: 2d5bc29ed89cb39d9a204095472842ad06d2b140
+  metadata.gz: c7f1809a30053f40f6c3c5682eeb7e95be171c56
+  data.tar.gz: 9f521ec59a2069fe3f0786181d03ec41ae8622dd
 SHA512:
-  metadata.gz: 903c267557fbe7eaf3f46bc95069df9d86a1385e2e12f1fc84826bd7a5fc12b25f337fe7790b5f76a8758ed657c0b00b3382ed57333d8ac039bc0740bcebc161
-  data.tar.gz: 91e7c9fcde5106ab9e919fb0de40aa399f3def20275b7d14075213d24b618289d51f90c9c861a78bfa7e7d41f81a1cf9ea02aa0511c1c4367eb146f744e90fc2
+  metadata.gz: 0b1802ce64192a04eee29893fce5e4da2bb30ebff491ae5ec5a8e6d71324d28e6b899b88b88bf502d56cdc159e29c38cbcbc04aeebf04fe8242b2282c1e5dc35
+  data.tar.gz: 469313348eadc5fac799fe9364f7a1be450a7cc30cc3e105da8574c249022d5190f7d7d36852c31bd95617133b64e2fc7fdf4d310b6d5617639f23c8061b68b1

data/CHANGELOG.md

@@ -6,6 +6,20 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.4.2]
+
+### Added
+- Address#valid? to validate EIP55 checksums.
+- Address#checksummed to generate EIP55 checksums.
+- Utils.valid_address? to easily validate EIP55 checksums.
+- Utils.format_address to easily convert an address to EIP55 checksummed.
+
+### Changed
+- Dependencies no longer include Ethereum::Base. Eth now implements those helpers directly and includes ffi, digest-sha3, and rlp directly.
+
+
+## [0.4.1]
+
 ### Changed
 - Tx#hash includes the '0x' hex prefix.
 

data/README.md

@@ -21,9 +21,12 @@ Or install it yourself as:
 ## Usage
 
 ### Keys
-Create a new key:
+Create a new public/private key and get its address:
 ```ruby
 key = Eth::Key.new
+key.private_hex
+key.public_hex
+key.address # EIP55 checksummed address
 ```
 Or import and existing one:
 ```ruby
@@ -48,6 +51,24 @@ Or decode an encoded raw transaction:
 tx = Eth::Tx.decode hex
 ```
 
+Then sign the transaction:
+```ruby
+tx.sign key
+```
+Get the raw transaction with `tx.hex`, and broadcast it through any Ethereum node. Or, just get the TXID with `tx.hash`.
+
+### Utils
+
+Validate an [EIP55](https://github.com/ethereum/EIPs/issues/55) checksummed address:
+```ruby
+Eth::Utils.valid_address? address
+```
+
+Or add a checksum to an existing address:
+```ruby
+Eth::Utils.valid_address? "0x4bc787699093f11316e819b5692be04a712c4e69" # => "0x4bc787699093f11316e819B5692be04A712C4E69"
+```
+
 ### Configure
 In order to prevent replay attacks, you must specify which Ethereum chain your transactions are created for. See [EIP 155](https://github.com/ethereum/EIPs/issues/155) for more detail.
 ```ruby
@@ -56,13 +77,6 @@ Eth.configure do |config|
 end
 ```
 
-Then sign the transaction:
-```ruby
-tx.sign key
-```
-Get the raw transaction with `tx.hex`, and broadcast it through any Ethereum node. Or, just get the TXID with `tx.hash`.
-
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/se3000/ethereum-tx. Tests are encouraged.

data/lib/eth.rb

@@ -7,6 +7,7 @@ module Eth
   BYTE_ZERO = "\x00".freeze
   UINT_MAX = 2**256 - 1
 
+  autoload :Address, 'eth/address'
   autoload :Gas, 'eth/gas'
   autoload :Key, 'eth/key'
   autoload :OpenSsl, 'eth/open_ssl'

data/lib/eth/address.rb

@@ -0,0 +1,62 @@
+module Eth
+  class Address
+
+    def initialize(address)
+      @address = Utils.prefix_hex(address)
+    end
+
+    def valid?
+      if !matches_any_format?
+        false
+      elsif not_checksummed?
+        true
+      else
+        checksum_matches?
+      end
+    end
+
+    def checksummed
+      raise "Invalid address: #{address}" unless matches_any_format?
+
+      cased = unprefixed.chars.zip(checksum.chars).map do |char, check|
+        check.match(/[0-7]/) ? char.downcase : char.upcase
+      end
+
+      Utils.prefix_hex(cased.join)
+    end
+
+
+    private
+
+    attr_reader :address
+
+    def checksum_matches?
+      address == checksummed
+    end
+
+    def not_checksummed?
+      all_uppercase? || all_lowercase?
+    end
+
+    def all_uppercase?
+      address.match(/(?:0[xX])[A-F0-9]{40}/)
+    end
+
+    def all_lowercase?
+      address.match(/(?:0[xX])[a-f0-9]{40}/)
+    end
+
+    def matches_any_format?
+      address.match(/\A(?:0[xX])[a-fA-F0-9]{40}\z/)
+    end
+
+    def checksum
+      Utils.bin_to_hex(Utils.keccak256 unprefixed.downcase)
+    end
+
+    def unprefixed
+      Utils.remove_hex_prefix address
+    end
+
+  end
+end

data/lib/eth/utils.rb

@@ -54,7 +54,7 @@ module Eth
     def public_key_to_address(hex)
       bytes = hex_to_bin(hex)
       address_bytes = Utils.keccak256(bytes[1..-1])[-20..-1]
-      bin_to_prefixed_hex address_bytes
+      format_address bin_to_prefixed_hex(address_bytes)
     end
 
     def sha256(x)
@@ -97,6 +97,15 @@ module Eth
       zpad decode_hex(s), l
     end
 
+    def valid_address?(address)
+      Address.new(address).valid?
+    end
+
+    def format_address(address)
+      Address.new(address).checksummed
+    end
+
+
 
     private
 

data/lib/eth/version.rb

@@ -1,3 +1,3 @@
 module Eth
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eth
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Steve Ellis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-12 00:00:00.000000000 Z
+date: 2017-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: digest-sha3
@@ -142,6 +142,7 @@ files:
 - bin/setup
 - eth.gemspec
 - lib/eth.rb
+- lib/eth/address.rb
 - lib/eth/gas.rb
 - lib/eth/key.rb
 - lib/eth/open_ssl.rb