Project

moac_eth

0.0
No commit activity in last 3 years
No release in over 3 years
Library to build, parse, and sign Ethereum transactions.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 1.12
~> 0.1
~> 10.0
~> 3.0

Runtime

~> 1.0
~> 0.7.3
~> 3.0.5
 Project Readme

Moac Travis-CI Code Climate Gitter

Forking from ruby-eth, I'll really have to thank him.

A simple library to build and sign Ethereum transactions. Allows separation of key and node management. Sign transactions and handle keys anywhere you can run ruby, broadcast transactions through any node.

Installation

Add this line to your application's Gemfile:

gem 'moac'

And then execute:

$ bundle

Or install it yourself as:

$ gem install moac_eth

Usage

Keys

Create a new public/private key and get its address:

key = Moac::Key.new
key.private_hex
key.public_hex
key.address # EIP55 checksummed address

Import an existing key:

old_key = Moac::Key.new priv: private_key

Or decrypt an encrypted key:

decrypted_key = Moac::Key.decrypt File.read('./some/path.json'), 'p455w0rD'

You can also encrypt your keys for use with other ethereum libraries:

encrypted_key_info = Moac::Key.encrypt key, 'p455w0rD'

Transactions

Build a transaction from scratch:

tx = Moac::Tx.new({
  data: hex_data,
  gas_limit: 21_000,
  gas_price: 3_141_592,
  nonce: 1,
  to: key2.address,
  value: 1_000_000_000_000,
})

Or decode an encoded raw transaction:

tx = Moac::Tx.decode hex

Then sign the transaction:

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 checksummed address:

Moac::Utils.valid_address? address

Or add a checksum to an existing address:

Moac::Utils.format_address "0x4bc787699093f11316e819b5692be04a712c4e69" # => "0x4bc787699093f11316e819B5692be04A712C4E69"

Configure

In order to prevent replay attacks, you must specify which Ethereum chain your transactions are created for. See EIP 155 for more detail.

Moac.configure do |config|
  config.chain_id = 1 # nil by default, meaning valid on any chain
end

Contributing

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:

git submodule update --init

Then run the associated tests:

rspec

License

The gem is available as open source under the terms of the MIT License.

TODO

  • Better test suite.
  • Expose API for HD keys.
  • Support signing with libsecp256k1.