ethereum-tx 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd0ee3551841f532a5ecc0dfc7524205f09e269c
-  data.tar.gz: 9f088bb9d3999be31aaf706bd8164555cd9d11f8
+  metadata.gz: fc27033601f87178ca950deac60cf55e4423993a
+  data.tar.gz: cce917c5ee1aba95dc0e0ac70293193c5acda069
 SHA512:
-  metadata.gz: 1ac7d61b2b9d4e85c7da5c741e69a387dd8ef90d886ddbaa473bbf389400e124b160e0c45af90adebb2840f3275645e82b71920ecd5614d2791d53837a0eef95
-  data.tar.gz: 776246ca9d84893139a8f1567fdd3f217e4532ff992e0ad84da2266203181a5f3adb607804b57a6c8714b99ff734aa9df40e6b2fab75353d19150577f03d36aa
+  metadata.gz: 0489c124c62a0fd46dbd6094d0428773e419f38b91402aafe4e40be7b4a8c89e7bf42e14f0da0bdd817e8aa34ae768bc4317b59142148b9ff6a8cfbd7decb122
+  data.tar.gz: bd089946955e17cadd852f8561a0a8bf84cc66c448d67589197b90c0dbe0d563a08be22034edb205e0945a07c64e79a88f0118b26fcd67a17c9093a0fdaf42e6

data/README.md

@@ -1,8 +1,6 @@
 # Ethereum::Tx
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ethereum/tx`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A simple, light weight, library to build and sign Ethereum transactions.
 
 ## Installation
 
@@ -22,20 +20,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Keys
+Create a new key:
+```
+key = Ethereum::Key.new
+```
+Or import and existing one:
+```
+old_key = Ethereum::Key.new private_key
+```
+
+### Transactions
 
-## Development
+Build a transaction from scratch:
+```
+tx = Ethereum::Tx.new to: key.address, gas_price: 25_000, gas_limit: 25_000
+tx.data = 'abcdef' #optional
+tx.value = 1_000_000_000_000 #optional
+```
+Or decode an encoded raw transaction:
+```
+tx = Ethereum::Tx.decode hex
+```
 
-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.
+Then sign the transaction:
+```
+tx.sign key
+```
+Finally you can broadcast the raw transaction, `tx.encoded`, to your Ethereum node.
 
-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/[USERNAME]/ethereum-tx.
+Bug reports and pull requests are welcome on GitHub at https://github.com/se3000/ethereum-tx.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+## TODO
+- Better test suite.
+- Expose API for HD keys.
+- Separate out code pulled from [bitcoin-ruby](https://github.com/lian/bitcoin-ruby) and [ruby-ethereum](github.com/janx/ruby-ethereum) into their own gems to eliminate duplication.
+- Support signing with [libsecp256k1](https://github.com/bitcoin-core/secp256k1).

data/ethereum-tx.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ethereum/tx/version'
+require 'ethereum'
 
 Gem::Specification.new do |spec|
   spec.name          = "ethereum-tx"
-  spec.version       = Ethereum::Tx::VERSION
+  spec.version       = '0.2.0'
   spec.authors       = ["Steve Ellis"]
   spec.email         = ["email@steveell.is"]
 
@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency('digest-sha3', '~> 1.1')
+  spec.add_dependency "digest-sha3", "~> 1.1"
   spec.add_dependency "ffi", "~> 1.0"
   spec.add_dependency "money-tree", "~> 0.9"
   spec.add_dependency "rlp", "~> 0.7"

data/lib/ethereum.rb

@@ -17,7 +17,6 @@ module Ethereum
   autoload :Sedes, 'ethereum/sedes'
   autoload :Tx, 'ethereum/tx'
   autoload :Utils, 'ethereum/utils'
-  autoload :VERSION, 'ethereum/version'
 
   class ValidationError < StandardError; end
   class InvalidTransaction < ValidationError; end

data/lib/ethereum/tx.rb

@@ -19,7 +19,12 @@ module Ethereum
       s: big_endian_int
     })
 
-    attr_reader :signature
+    attr_writer :signature
+
+    def self.decode(data)
+      data = Utils.hex_to_bin(data) if data.match(/\A\h+\Z/)
+      deserialize(RLP.decode data)
+    end
 
     def initialize(*args)
       fields = {v: 0, r: 0, s: 0}.merge parse_field_args(args)
@@ -45,10 +50,27 @@ module Ethereum
       self
     end
 
+    def to_h
+      self.class.serializable_fields.keys.inject({}) do |hash, field|
+        hash[field] = send field
+        hash
+      end
+    end
 
-    private
+    def from
+      return @from if @from
+      @from ||= OpenSsl.recover_compact(signature_hash, signature) if signature
+    end
 
-    attr_writer :signature
+    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?
+    end
+
+
+    private
 
     def check_transaction_validity
       if [gas_price, gas_limit, value, nonce].max > UINT_MAX
@@ -72,5 +94,9 @@ module Ethereum
         GTXDATANONZERO * num_non_zero_bytes
     end
 
+    def signature_hash
+      Utils.keccak256 unsigned_encoded
+    end
+
   end
 end

data/lib/ethereum/utils.rb

@@ -34,6 +34,15 @@ module Ethereum
       end
     end
 
+    def int_to_base256(int)
+      bytes = []
+      while int > 0 do
+        bytes.unshift(int % 256)
+        int /= 256
+      end
+      bytes.pack('C*')
+    end
+
     def v_r_s_for(signature)
       [
         signature[0].bytes[0],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ethereum-tx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Steve Ellis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-19 00:00:00.000000000 Z
+date: 2016-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: digest-sha3
@@ -144,7 +144,6 @@ files:
 - lib/ethereum/open_ssl.rb
 - lib/ethereum/sedes.rb
 - lib/ethereum/tx.rb
-- lib/ethereum/tx/version.rb
 - lib/ethereum/utils.rb
 homepage: https://github.com/se3000/ethereum-tx
 licenses:

data/lib/ethereum/tx/version.rb

@@ -1,5 +0,0 @@
-module Ethereum
-  class Tx
-    VERSION = "0.1.0"
-  end
-end