ethereum.rb 1.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 847343b8aaa240f07a46b58d0423fdc1ac3e368b
+  data.tar.gz: 8610cf63893eaf0686cd5230156bc6e29c020d1f
+SHA512:
+  metadata.gz: a0b703025e50dacbf4448209709563e4075ff4176d6d01129925f975b9e9f3b68c1dcf1e6febe21bee10ef885814844273a593ac39533ce4561f0baad63e480e
+  data.tar.gz: 149a4faa03278bbed430632dba56ed4ef8d1b5ca84440244af1caadfe2cae17ecfc3f51f4fd8a69894eebee6f10c983946dfdeddd60d67d9d32fd4ab8cc52fcf

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.*.swp
+/**/.*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+rubythereum

data/.travis.yml

@@ -0,0 +1,26 @@
+dist: trusty
+language: ruby
+rvm:
+  - 2.3.1
+cache:
+  bundler: true
+  directories:
+  - ~/.parity
+before_install:
+  - sudo bin/install_parity
+  - gem install bundler -v 1.11.2
+before_script:
+  - parity --chain ~/.parity/ropsten.json --warp --password ~/.parity/pass --unlock 21e72c12878136d9349c77c1645deef121ee8926 --author 21e72c12878136d9349c77c1645deef121ee8926 daemon ~/.parity.pid --log-file ~/.parity.log
+  - sleep 5
+  - parity --chain ~/.parity/ropsten.json account list
+  - cat ~/.parity.log
+  - bundle exec rake ethereum:node:waitforsync
+  - bundle exec rake ethereum:test:setup
+script:
+  - bundle exec rspec --tag ~slow
+  - bundle exec rspec --tag slow
+before_cache:
+  - killall parity
+  - sleep 3
+after_script:
+  - cat /tmp/ethereum_ruby_http.log

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ethereum.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 DigixGlobal Pte Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 DigixGlobal Pte Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,183 @@
+# Ethereum.rb
+
+[![Build Status](https://travis-ci.org/marekkirejczyk/ethereum.rb.svg?branch=master)](https://travis-ci.org/marekkirejczyk/ethereum.rb) [![security](https://hakiri.io/github/NullVoxPopuli/MetaHash/master.svg)](https://hakiri.io/github/NullVoxPopuli/MetaHash/master) [![Dependency Status](https://gemnasium.com/marekkirejczyk/ethereum.rb.svg)](https://gemnasium.com/marekkirejczyk/ethereum.rb)
+
+A simple library for Ethereum.
+
+## Highlights
+
+* Pure Ruby implementation
+* IPC & HTTP Client with batch calls support
+* Compile Solidity contracts with solc compiler
+* Deploy and call contracts methods
+* Contract events
+
+## Compatibility and requirements
+
+* Tested with parity 1.4.8, might work with geth
+* Tested with solc 0.4.8
+* Ruby 2.x
+* UNIX/Linux or OS X environment
+
+## Prerequisites
+
+Ethereum.rb requires installation of ethereum node and solidity compiler.
+
+### Ethereum node
+
+Currently the lib supports only [parity](https://ethcore.io/parity.html). It might work with [geth](https://github.com/ethereum/go-ethereum/wiki/geth) as well, but this configuration is not tested. Library assumes that you have at least one wallet configured.
+
+### Solidity complier
+
+To be able to compile [solidity](https://github.com/ethereum/solidity) contracts you need to install solc compiler. Installation instructions are available [here](http://solidity.readthedocs.io/en/latest/installing-solidity.html).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ethereum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ethereum
+
+## Basic Usage
+
+### IPC Client Connection
+
+To create client instance simply create Ethereum::IpcClient:
+
+```ruby
+client = Ethereum::IpcClient.new
+```
+
+You can also customize it with path to ipc file path and logging flag:
+
+```ruby
+client = Ethereum::IpcClient.new("~/.parity/mycustom.ipc", false)
+```
+
+If no ipc file path given, IpcClient looks for ipc file in default locations for parity and geth.
+By default logging is on and logs are saved in "/tmp/ethereum_ruby_http.log".
+
+
+### Solidity contract compilation and deployment
+
+You can create contract from solidity source and deploy it to the blockchain.
+
+```ruby
+contract = Ethereum::Contract.from_file("mycontract.sol", client)
+contract_instance = contract.deploy_and_wait
+```
+
+Deployment may take up to couple minutes.
+Or with more complex syntax (might be useful if you want to complie multiple contracts at once):
+
+```ruby
+init = Ethereum::Initializer.new("mycontract.sol", client)
+init.build_all
+contract = MyContract.new
+contract_instance = contract.deploy_and_wait(60)
+```
+
+Note that contract variable holds the reference to contract code, while contract_instance holds refernce to contract deployed to the blockchain. You can call contract functions on contract_instance as described in sections "Transacting and Calling Solidity Functions".
+
+All names used to name contract in solidity source will transalte to name of classes in ruby (camelized).
+If class of given name exist it will be undefined first to avoid name collision. 
+
+### Get contract from blockchain
+
+The other way to obtain contract instance is get one form the blockchain. To do so you need a contract name, contract address and ABI definition.
+
+```ruby
+contract_instance = Ethereum::Contract.from_blockchain("MyContract", "0x01a4d1A62F01ED966646acBfA8BB0b59960D06dd ", abi, client)
+
+```
+
+Note that you need to specify contract name, that will be used to define new class in ruby, as it is not a part of ABI definition.
+
+### Transacting and Calling Solidity Functions
+
+Solidity functions are exposed using the following conventions: 
+
+```
+transact_[function_name](params) 
+transact_and_wait_[function_name](params)  
+call_[function_name](params)
+```
+
+**Example Contract in Solidity**
+```
+contract SimpleNameRegistry {
+
+  mapping (address => bool) public myMapping;
+
+  function register(address _a, bytes32 _b) {
+  }
+
+  function getSomeValue(address _x) public constant returns(bool b, address b) {
+  }
+
+}
+```
+
+```ruby
+simple_name_registry_instance.transact_and_wait_register("0x5b6cb65d40b0e27fab87a2180abcab22174a2d45", "minter.contract.dgx")
+simple_name_registry_instance.transact_register("0x385acafdb80b71ae001f1dbd0d65e62ec2fff055", "anthony@eufemio.dgx")
+simple_name_registry_instance.call_get_some_value("0x385acafdb80b71ae001f1dbd0d65e62ec2fff055")
+simple_name_registry_instance.call_my_mapping("0x385acafdb80b71ae001f1dbd0d65e62ec2fff055")
+```
+
+### Run contracts using a different address
+
+```ruby
+simple_name_registry_instance.as("0x0c0d99d3608a2d1d38bb1b28025e970d3910b1e1")
+```
+
+### Point contract instance to a previously deployed contract
+
+```ruby
+simple_name_registry_instance.at("0x734533083b5fc0cd14b7cb8c8eb6ed0c9bd184d3")
+```
+
+## Utils rake tasks
+
+```ruby
+rake ethereum:contract:compile[path]            # Compile a contract / Compile and deploy contract
+rake ethereum:node:mine                         # Mine ethereum testing environment for ethereum node
+rake ethereum:node:run                          # Run morden (production) node
+rake ethereum:node:test                         # Run testnet node
+rake ethereum:test:setup                        # Setup testing environment for ethereum node
+rake ethereum:transaction:byhash[id]            # Get info about transaction
+rake ethereum:transaction:send[address,amount]  # Send [amount of] ether to an account
+
+```
+
+## Debbuging
+Logs from communication with node are available under following path:
+```
+/tmp/ethereum_ruby_http.log
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 
+Make sure `rake ethereum:test:setup` passes before running tests.
+Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Ethereum ruby
+
+This library has been forked from [ethereum-ruby](https://github.com/DigixGlobal/ethereum-ruby) by DigixGlobal Pte Ltd (https://dgx.io).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+import "./lib/tasks/ethereum_test.rake"
+import "./lib/tasks/ethereum_node.rake"
+import "./lib/tasks/ethereum_contract.rake"
+import "./lib/tasks/ethereum_transaction.rake"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ethereum"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/install_parity

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+install_parity () {
+  sudo add-apt-repository ppa:ethereum/ethereum -y
+  sudo apt-get update
+  sudo apt-get install solc
+  wget http://d1h4xl4cr1h0mo.cloudfront.net/v1.4.8/x86_64-unknown-linux-gnu/parity_1.4.8_amd64.deb
+  sudo dpkg -i parity_1.4.8_amd64.deb
+}
+
+
+
+echo "Installing parity..."
+
+if [ `which parity` ]; then
+  echo "Parity cached, skipping"
+  install_parity
+else
+  echo "Settuping parity..."
+  install_parity
+  mkdir -p ~/.parity
+  wget https://raw.githubusercontent.com/ethcore/parity/master/ethcore/res/ethereum/ropsten.json --output-document ~/.parity/ropsten.json
+  echo $pass > ~/.parity/pass
+  mkdir -p ~/.parity/keys  
+  echo $wallet > ~/.parity/keys/10890ad6-5171-4945-be95-984d83394120
+  chown -R travis:travis ~/.parity
+fi
+
+ls -la ~/.parity

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/contracts/AccountingLib.sol

@@ -0,0 +1,112 @@
+// Accounting v0.1
+
+/// @title Accounting Lib - Accounting utilities
+/// @author Piper Merriam - <pipermerriam@gmail.com>
+library AccountingLib {
+        struct Bank {
+            mapping (address => uint) accountBalances;
+        }
+
+        /// @dev Low level method for adding funds to an account.  Protects against overflow.
+        /// @param self The Bank instance to operate on.
+        /// @param accountAddress The address of the account the funds should be added to.
+        /// @param value The amount that should be added to the account.
+        function addFunds(Bank storage self, address accountAddress, uint value) public {
+                /*
+                 *  Helper function that should be used for any addition of
+                 *  account funds.  It has error checking to prevent
+                 *  overflowing the account balance.
+                 */
+                if (self.accountBalances[accountAddress] + value < self.accountBalances[accountAddress]) {
+                        // Prevent Overflow.
+                        throw;
+                }
+                self.accountBalances[accountAddress] += value;
+        }
+
+        event _Deposit(address indexed _from, address indexed accountAddress, uint value);
+
+        /// @dev Function wrapper around the _Deposit event so that it can be used by contracts.  Can be used to log a deposit to an account.
+        /// @param _from The address that deposited the funds.
+        /// @param accountAddress The address of the account the funds were added to.
+        /// @param value The amount that was added to the account.
+        function Deposit(address _from, address accountAddress, uint value) public {
+            _Deposit(_from, accountAddress, value);
+        }
+
+        /// @dev Safe function for depositing funds.  Returns boolean for whether the deposit was successful
+        /// @param self The Bank instance to operate on.
+        /// @param accountAddress The address of the account the funds should be added to.
+        /// @param value The amount that should be added to the account.
+        function deposit(Bank storage self, address accountAddress, uint value) public returns (bool) {
+                /*
+                 *  Public API for depositing funds in a specified account.
+                 */
+                if (self.accountBalances[accountAddress] + value < self.accountBalances[accountAddress]) {
+                        return false;
+                }
+                addFunds(self, accountAddress, value);
+                return true;
+        }
+
+        event _Withdrawal(address indexed accountAddress, uint value);
+
+        /// @dev Function wrapper around the _Withdrawal event so that it can be used by contracts.  Can be used to log a withdrawl from an account.
+        /// @param accountAddress The address of the account the funds were withdrawn from.
+        /// @param value The amount that was withdrawn to the account.
+        function Withdrawal(address accountAddress, uint value) public {
+            _Withdrawal(accountAddress, value);
+        }
+
+        event _InsufficientFunds(address indexed accountAddress, uint value, uint balance);
+
+        /// @dev Function wrapper around the _InsufficientFunds event so that it can be used by contracts.  Can be used to log a failed withdrawl from an account.
+        /// @param accountAddress The address of the account the funds were to be withdrawn from.
+        /// @param value The amount that was attempted to be withdrawn from the account.
+        /// @param balance The current balance of the account.
+        function InsufficientFunds(address accountAddress, uint value, uint balance) public {
+            _InsufficientFunds(accountAddress, value, balance);
+        }
+
+        /// @dev Low level method for removing funds from an account.  Protects against underflow.
+        /// @param self The Bank instance to operate on.
+        /// @param accountAddress The address of the account the funds should be deducted from.
+        /// @param value The amount that should be deducted from the account.
+        function deductFunds(Bank storage self, address accountAddress, uint value) public {
+                /*
+                 *  Helper function that should be used for any reduction of
+                 *  account funds.  It has error checking to prevent
+                 *  underflowing the account balance which would be REALLY bad.
+                 */
+                if (value > self.accountBalances[accountAddress]) {
+                        // Prevent Underflow.
+                        throw;
+                }
+                self.accountBalances[accountAddress] -= value;
+        }
+
+        /// @dev Safe function for withdrawing funds.  Returns boolean for whether the deposit was successful as well as sending the amount in ether to the account address.
+        /// @param self The Bank instance to operate on.
+        /// @param accountAddress The address of the account the funds should be withdrawn from.
+        /// @param value The amount that should be withdrawn from the account.
+        function withdraw(Bank storage self, address accountAddress, uint value) public returns (bool) {
+                /*
+                 *  Public API for withdrawing funds.
+                 */
+                if (self.accountBalances[accountAddress] >= value) {
+                        deductFunds(self, accountAddress, value);
+                        if (!accountAddress.send(value)) {
+                                // Potentially sending money to a contract that
+                                // has a fallback function.  So instead, try
+                                // tranferring the funds with the call api.
+                                if (!accountAddress.call.value(value)()) {
+                                        // Revert the entire transaction.  No
+                                        // need to destroy the funds.
+                                        //throw;
+                                }
+                        }
+                        return true;
+                }
+                return false;
+        }
+}