eth 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3920e84b3cefbb7da9607e92c438654b016a7712
-  data.tar.gz: 751fa67b78a3082ae3b3afdb9f7ed0f135c7217c
+  metadata.gz: 3634eb14f8b7215034c3d182aaa6f1617062e723
+  data.tar.gz: abf2f132aa8eb36db20498fa762543ec5d243d81
 SHA512:
-  metadata.gz: d967fb582e3d63a94a5fdca95eebffb8a0462e4e1a1aadab65e6df2cc11bd0e552d39f687b047a430dc24e204021aab0e3dd59eecb88c31b56843d6603e04ba9
-  data.tar.gz: d61baf72a91f9d7836609f0d50c030128202a40abf4e25092b5ff9d1c6f3ca3a8be1357621bbff0c8b62d5d1a953e0ef3a73bef3bdc5c409bb0773619d49c213
+  metadata.gz: cfc6c93a18eb92381052080ecdfffeaf017cb119954642dba89d8dcf3fe8ee0f505f652c979c4a9b2067375acb4625a29b130b517f5dfaff0e76a8ea459dc4ab
+  data.tar.gz: 36b54f235dc2256dbd705c3cd7ea235095f9323f09b32f36903712363d687b21de4d553a74b4b92071898c1daf81a1459cd60d0c2675e403dbe03b034e381237

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "spec/fixtures/ethereum_tests"]
+	path = spec/fixtures/ethereum_tests
+	url = git@github.com:ethereum/tests.git

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.4.0]
+
+### Added
+- Tx#data_bin returns the data field of a transaction in binary.
+- Tx#data_hex returns the data field of a transaction as a hexadecimal string.
+- Tx#id is an alias of Tx#hash
+
+### Changed
+- Tx#data is configurable to return either hex or binary: `config.tx_data_hex = true`.
+- Tx#hash includes the '0x' hex prefix.
+- Tx#hex includes the '0x' hex prefix.
+- Key#address getter is prepended by '0x'.
+- Extract public key to address method into Utils.public_key_to_address.
+- Tx#from returns an address instead of a public key.
+- Chain ID is updated to the later version of the spec.

data/README.md

@@ -35,11 +35,11 @@ old_key = Eth::Key.new priv: private_key
 Build a transaction from scratch:
 ```ruby
 tx = Eth::Tx.new({
-  data: 'abcdef',
-  gas_limit: 3_141_592,
-  gas_price: 20_000_000_000,
-  nonce: 0,
-  to: key.address,
+  data: hex_data,
+  gas_limit: 21_000,
+  gas_price: 3_141_592,
+  nonce: 1,
+  to: key2.address,
   value: 1_000_000_000_000,
 })
 ```
@@ -50,9 +50,9 @@ tx = Eth::Tx.decode hex
 
 ### 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
 Eth.configure do |config|
-  config.chain_id = 18 #defaults to 13
+  config.chain_id = 1 # nil by default, meaning valid on any chain
 end
 ```
 
@@ -65,7 +65,19 @@ Get the raw transaction with `tx.hex`, and broadcast it through any Ethereum nod
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/se3000/ethereum-tx.
+Bug reports and pull requests are welcome on GitHub at https://github.com/se3000/ethereum-tx. Tests are encouraged.
+
+### Tests
+
+First install the [Ethereum common tests](https://github.com/ethereum/tests):
+```shell
+git submodule update --init
+```
+
+Then run the associated tests:
+```shell
+rspec
+```
 
 
 ## License

data/lib/eth.rb

@@ -5,8 +5,6 @@ require 'money-tree'
 require 'rlp'
 
 module Eth
-  REPLAYABLE_CHAIN_ID = 13
-
   autoload :Key, 'eth/key'
   autoload :OpenSsl, 'eth/open_ssl'
   autoload :Sedes, 'eth/sedes'
@@ -18,24 +16,32 @@ module Eth
       yield(configuration)
     end
 
-    def chain_id
-      (configuration.chain_id || REPLAYABLE_CHAIN_ID).to_i
+    def replayable_chain_id
+      27
     end
 
-    def v_base
-      (chain_id * 2) + 1
+    def chain_id
+      configuration.chain_id
     end
 
-    def replayable_v_base
-      (REPLAYABLE_CHAIN_ID * 2) + 1
+    def v_base
+      if chain_id
+        (chain_id * 2) + 35
+      else
+        replayable_chain_id
+      end
     end
 
     def prevent_replays?
-      chain_id != REPLAYABLE_CHAIN_ID
+      !chain_id.nil?
     end
 
     def replayable_v?(v)
-      [replayable_v_base, replayable_v_base + 1].include? v
+      [replayable_chain_id, replayable_chain_id + 1].include? v
+    end
+
+    def tx_data_hex?
+      !!configuration.tx_data_hex
     end
 
 
@@ -47,6 +53,10 @@ module Eth
   end
 
   class Configuration
-    attr_accessor :chain_id
+    attr_accessor :chain_id, :tx_data_hex
+
+    def initialize
+      self.tx_data_hex = true
+    end
   end
 end

data/lib/eth/key.rb

@@ -21,12 +21,9 @@ module Eth
     end
 
     def address
-      Utils.bin_to_hex(Utils.keccak256(public_bytes[1..-1])[-20..-1])
-    end
-
-    def to_address
-      address
+      Utils.public_key_to_address public_hex
     end
+    alias_method :to_address, :address
 
     def sign(message)
       sign_hash message_hash(message)

data/lib/eth/open_ssl.rb

@@ -163,7 +163,7 @@ module Eth
       return false if signature.bytesize != 65
 
       version = signature.unpack('C')[0]
-      v_base = Eth.replayable_v?(version) ? Eth.replayable_v_base : Eth.v_base
+      v_base = Eth.replayable_v?(version) ? Eth.replayable_chain_id : Eth.v_base
       return false if version < v_base
 
       compressed = false

data/lib/eth/tx.rb

@@ -10,7 +10,7 @@ module Eth
       gas_limit: big_endian_int,
       to: address,
       value: big_endian_int,
-      data: binary,
+      data_bin: binary,
       v: big_endian_int,
       r: big_endian_int,
       s: big_endian_int
@@ -19,14 +19,18 @@ module Eth
     attr_writer :signature
 
     def self.decode(data)
-      data = Utils.hex_to_bin(data) if data.match(/\A\h+\Z/)
+      data = Utils.hex_to_bin(data) if data.match(/\A(?:0x)?\h+\Z/)
       deserialize(RLP.decode data)
     end
 
-    def initialize(*args)
-      fields = {v: 0, r: 0, s: 0}.merge parse_field_args(args)
+    def initialize(params)
+      fields = {v: 0, r: 0, s: 0}.merge params
       fields[:to] = Utils.normalize_address(fields[:to])
 
+      if params[:data]
+        self.data = params.delete(:data)
+        fields[:data_bin] = data_bin
+      end
       serializable_initialize fields
 
       check_transaction_validity
@@ -37,7 +41,7 @@ module Eth
     end
 
     def signing_data
-      Utils.bin_to_hex unsigned_encoded
+      Utils.bin_to_prefixed_hex unsigned_encoded
     end
 
     def encoded
@@ -45,42 +49,72 @@ module Eth
     end
 
     def hex
-      Utils.bin_to_hex encoded
+      Utils.bin_to_prefixed_hex encoded
     end
 
     def sign(key)
       self.signature = key.sign(unsigned_encoded)
-      self.vrs = Utils.v_r_s_for signature
+      vrs = Utils.v_r_s_for signature
+      self.v = vrs[0]
+      self.r = vrs[1]
+      self.s = vrs[2]
 
       self
     end
 
     def to_h
-      self.class.serializable_fields.keys.inject({}) do |hash, field|
+      hash_keys.inject({}) do |hash, field|
         hash[field] = send field
         hash
       end
     end
 
     def from
-      return @from if @from
-      @from ||= OpenSsl.recover_compact(signature_hash, signature) if signature
+      if signature
+        public_key = OpenSsl.recover_compact(signature_hash, signature)
+        Utils.public_key_to_address(public_key) if public_key
+      end
     end
 
     def signature
       return @signature if @signature
-      self.signature = [v, r, s].map do |integer|
-        Utils.int_to_base256 integer
-      end.join if [v, r, s].all?
+      self.signature = [
+        Utils.int_to_base256(v),
+        Utils.zpad_int(r),
+        Utils.zpad_int(s),
+      ].join if [v, r, s].all?
     end
 
     def hash
       Utils.bin_to_hex Utils.keccak256_rlp(self)
     end
+    alias_method :id, :hash
+
+    def data_hex
+      Utils.bin_to_prefixed_hex data_bin
+    end
+
+    def data_hex=(hex)
+      self.data_bin = Utils.hex_to_bin(hex)
+    end
+
+    def data
+      Eth.tx_data_hex? ? data_hex : data_bin
+    end
+
+    def data=(string)
+      Eth.tx_data_hex? ? self.data_hex=(string) : self.data_bin=(string)
+    end
 
 
     private
 
+    def hash_keys
+      keys = self.class.serializable_fields.keys
+      keys.delete(:data_bin)
+      keys + [:data]
+    end
+
     def check_transaction_validity
       if [gas_price, gas_limit, value, nonce].max > Ethereum::Base::UINT_MAX
         raise Ethereum::Base::InvalidTransaction, "Values way too high!"
@@ -89,15 +123,9 @@ module Eth
       end
     end
 
-    def vrs=(vrs)
-      self.v = vrs[0]
-      self.r = vrs[1]
-      self.s = vrs[2]
-    end
-
     def intrinsic_gas_used
-      num_zero_bytes = data.count(Ethereum::Base::BYTE_ZERO)
-      num_non_zero_bytes = data.size - num_zero_bytes
+      num_zero_bytes = data_bin.count(Ethereum::Base::BYTE_ZERO)
+      num_non_zero_bytes = data_bin.size - num_zero_bytes
 
       Ethereum::Base::GTXCOST +
         Ethereum::Base::GTXDATAZERO * num_zero_bytes +

data/lib/eth/utils.rb

@@ -1,5 +1,4 @@
 module Eth
-
   module Utils
 
     extend Ethereum::Base::Utils
@@ -22,7 +21,7 @@ module Eth
     end
 
     def hex_to_bin(string)
-      [string].pack("H*")
+      [string.sub(/\A0x/, '')].pack("H*")
     end
 
     def base256_to_int(string)
@@ -49,5 +48,27 @@ module Eth
       ]
     end
 
+    def prefix_hex(hex)
+      hex.match(/\A0x/) ? hex : "0x#{hex}"
+    end
+
+    def bin_to_prefixed_hex(binary)
+      prefix_hex bin_to_hex(binary)
+    end
+
+    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
+    end
+
+
+    private
+
+    def lpad(x, symbol, l)
+      return x if x.size >= l
+      symbol * (l - x.size) + x
+    end
+
   end
 end

data/lib/eth/version.rb

@@ -1,3 +1,3 @@
 module Eth
-  VERSION = "0.3.4"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eth
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Steve Ellis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-21 00:00:00.000000000 Z
+date: 2017-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ethereum-base
@@ -130,8 +130,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitmodules"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md