Skip to content

Latest commit

 

History

History
82 lines (57 loc) · 1.9 KB

README.md

File metadata and controls

82 lines (57 loc) · 1.9 KB
Raw

Paleth

Build Status Yard Docs License

Paleth (Opal + Ethereum) is a simple wrapper around ethereum's web3.js DApp libray, that provide a Ruby friendly API while staying as close as possible to the orignal web3.js API.

It was initially developped for the Mist client, which only supports asynchronous calls. Paleth hence only support async calls variants and returns Opal's Promises for most of its calls

Installation

Add this line to your application's Gemfile:

gem 'paleth'

And then execute:

$ bundle

Or install it yourself as:

$ gem install paleth

Usage

require 'paleth'

#
# Initialize a Paleth::Web3 instance (main object)
#

# Use the global web3.currentProvider (Mist)
w3 = Paleth.make
# Specifically provide a Web3 instance
w3 = Paleth.make(web3: `window.Web3`)
# Provide an RPC address
w3 = Paleth.make(http: 'http://localhost:8545')

#
# Use it
#
w3.eth.coinbase.then do |coinbase|
  puts coinbase
end.fail do |error|
  puts "Unable to get Coinbase: #{error}"
end

TODO

  • All basic API
    • web3.net
    • web3.eth (everything except filters)
    • web3.db
    • web3.personal (partial, only newAccount/listAccounts/unlock/sign)
  • Filter
  • Contract support
    • Instantiated wrapper with call() and sendTransaction()
    • Events
    • Contract creation via Paleth::Contract

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/elthariel/paleth.

License

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