ether-fly 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 265d020e75eee2fd6b4cf9f5a46cd6da896d1f31
-  data.tar.gz: 4bfdfa91dfd05eb816dea169f0d3bba2f8d28ecd
+  metadata.gz: 3df64de010310a17c6c11e09a1a2136cf3e84fca
+  data.tar.gz: 78f72289d962e0347d334982757718dbbae7fe05
 SHA512:
-  metadata.gz: bcf213765e38178af13a7fd015e8da963cee22a3299a289016b88b46ff011a6a88022cfa43e1237d7673179eb93affd4ff3c018fe85c945f4c7c94f453405673
-  data.tar.gz: 35bc1001e740579782fe76be69f127d64ee083e48b89f8d645e21d6053585b58c8e8565586e138b7231a91705b68b5d9c74e5946c82f11ec3262c3cc7d48dec9
+  metadata.gz: 22bb02684234b2b97e0b5ab24670e7ffe9bacd49501b3ce3ae2e7572dab5bc91242d607fe62790897e27b15ce6975792f8b99c8af44f7e2ae44ece8392fe0a7f
+  data.tar.gz: 3e00e49cce5219cd77c88e5a6385c0440b0c406f1715acd76dbe4971449f704f87525822020439f953a380d1cfa539241f871ba3102a9bfff0c6606be06e4d21

data/README.md

@@ -1,7 +1,11 @@
+## Introduction
+EtherFly is a Ethereum smart contract test framework in ruby.It provides two testing environments: testing in ruby EVM and testing in geth.You don't need to understand ruby grammar, just enjoy syntactic sugar.
+
 ## Install
 ```shell
 bundle install ether-fly
 ```
+
 ## How to use
 
 Help command:
@@ -21,3 +25,48 @@ Run tests
 ```
 $ ether-fly t game
 ```
+
+## Unit tests
+You can wirte fast, simple tests.
+```ruby
+class TokenTest < Minitest::Test
+  include Ethereum
+
+  def setup
+    @state = Tester::State.new
+    @solidity_code = File.read('./contracts/Token.sol')
+    @c = @state.abi_contract @solidity_code, language: :solidity
+  end
+
+  def test_issue_balance
+    assert_equal 0, @c.getBalance(Tester::Fixture.accounts[2])
+    @c.issue Tester::Fixture.accounts[2], 100
+    assert_equal 100, @c.getBalance(Tester::Fixture.accounts[2])
+  end
+
+  def test_issue_exception
+    assert_raises(TransactionFailed) { @c.issue Tester::Fixture.accounts[3], 100, sender: Tester::Fixture.keys[4] }
+    assert_equal 0, @c.getBalance(Tester::Fixture.accounts[3])
+  end
+
+  def test_token_transfer
+    @c.issue Tester::Fixture.accounts[2], 100
+    @c.transfer Tester::Fixture.accounts[3], 90, sender: Tester::Fixture.keys[2]
+    assert_equal 90, @c.getBalance(Tester::Fixture.accounts[3])
+
+    assert_raises(TransactionFailed) { @c.transfer Tester::Fixture.accounts[3], 90, sender: Tester::Fixture.keys[2] }
+  end
+end
+
+```
+More details:
+https://github.com/seattlerb/minitest
+
+## TODO
+- Extract test file require and others
+- Save migrate address
+- Migrate ARGV
+- Script for preload
+- Easy way to load contract on chain
+- Easy way to test on chain
+- ES6

data/bin/ether-fly

@@ -1,13 +1,21 @@
 #!/usr/bin/env ruby
 
 require 'erb'
+require 'json'
 
 ARGV << "--help" if ARGV.empty?
 
 aliases = {
+  "n"  => "new",
   "g"  => "generate",
   "t"  => "test",
-  "n"  => "new"
+  "i"  => "init",
+  "ik" => "import_keys",
+  "b"  => "build",
+  "m"  => "migrate",
+  "s"  => "server",
+  "c"  => "console",
+  "gt" => "geth_test"
 }
 
 command = ARGV.shift
@@ -16,14 +24,21 @@ command = aliases[command] || command
 HELP_MESSAGE = <<-EOF
 Usage: eth-fly COMMAND [ARGS]
 The most common eth-fly commands are:
- generate    Generate new Smart Contract and test file (short-cut alias: "g")
- test        Run tests (short-cut alias: "t")
- new         Create a new Smart Contract application. "eth-fly new my_app" creates a
-             new application called MyApp in "./my_app"
+  new         Create a new Smart Contract application. "eth-fly new my_app" creates a
+              new application called MyApp in "./my_app" (short-cut alias: "n")
+  generate    Generate new Smart Contract and test file (short-cut alias: "g")
+  test        Run tests (short-cut alias: "t")
+  init        Init private geth chain (short-cut alias: "i")
+  import_keys Import keys to chain (short-cut alias: "ik")
+  build       Build contract (short-cut alias: "b")
+  migrate     Deploy contract on chain (short-cut alias: "m")
+  server      Start chain (short-cut alias: "s")
+  console     Open Chain console (short-cut alias: "c")
+  geth_test   Test on chain (short-cut alias: "gt")
 All commands can be run with -h (or --help) for more information.
 EOF
 
-COMMAND_WHITELIST = %w(generate new help test)
+COMMAND_WHITELIST = %w(new generate test init import_keys build migrate server console geth_test)
 
 CONTRACT_TEMPLATE = ERB.new <<-EOF
 contract <%= name.capitalize %> {
@@ -50,24 +65,257 @@ GEMFILE_TEMPLATE = ERB.new <<-EOF
 gem 'ether-fly', '>= 0.0.1'
 EOF
 
-def run_command!(command)
-  command = parse_command(command)
+GENESIS_TEMPLATE = <<-EOF
+{
+  "nonce": "0x0000000000000042",
+  "difficulty": "0x020000",
+  "mixhash": "0x0000000000000000000000000000000000000000000000000000000000000000",
+  "coinbase": "0x0000000000000000000000000000000000000000",
+  "timestamp": "0x00",
+  "parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
+  "extraData": "0x11bbe8db4e347b4e8c937c1c8370e4b5ed33adb3db69cbdb7a38e1e50b1b82fa",
+  "gasLimit": "0x4c4b40"
+}
+EOF
 
-  if COMMAND_WHITELIST.include?(command)
-    send(command)
-  else
-    help
+KEYS_TEMPLATE = {
+  "3ae88fe370c39384fc16da2c9e768cf5d2495b48" => "095e53c9c20e23fd01eaad953c01da9e9d3ed9bebcfed8e5b2c2fce94037d963",
+  "81063419f13cab5ac090cd8329d8fff9feead4a0" => "5bc505a123a695176a9688ffe22798cfd40424c5b91c818e985574ea8ebda167",
+  "9da26fc2e1d6ad9fdd46138906b0104ae68a65d8" => "b6a03207128827eaae0d31d97a7a6243de31f2baf99eabd764e33389ecf436fc",
+  "bd2d69e3e68e1ab3944a865b3e566ca5c48740da" => "b35b8064c5c373629a05cc3ef39789ba4dacd404e6e864214ade934c198b636f",
+  "ca9f427df31a1f5862968fad1fe98c0a9ee068c4" => "9e35c48588711469e13c9a594f9f6d81491ce44ff1e8c5d968fcbd17168088a4"
+}
+
+SOLC_HELPER_TEMPLATE = %q{#!/usr/bin/env ruby
+
+require 'json'
+def library_code
+  'function create(abiDefinition) {  return web3.eth.contract(abiDefinition);}/*function deploy(account, value, gas, contract, code, input) */function deploy() {  var account = arguments[0];  var value = arguments[1];  var gas = arguments[2];  var contract = arguments[3];  var code = arguments[4];  var codeString = "contract.new(inputMarker,{from:\'accountMarker\', value: valueMarker,  data: \'codeMarker\', gas: gasMarker}, function (e, contract) {    if(!e) {      if(!contract.address) {        console.log(\"Contract transaction send: TransactionHash: \" + contract.transactionHash + \" waiting to be mined...\");      } else {        console.log(\"Contract mined! Address: \" + contract.address);      }    } else {      console.log(e)    }  })";  codeString = codeString.replace("accountMarker", account);  codeString = codeString.replace("valueMarker", value);  codeString = codeString.replace("codeMarker", code);  codeString = codeString.replace("gasMarker", gas);  input = "null";  if (arguments.length > 5) {    if (arguments[5] != null) {      var args = [];      for (var i = 5;i < arguments.length; i++) {        var val = arguments[i];        if (typeof(val) === \'string\') {          val = "\"" + val + "\"";        }        args.push(val);      }      input = args.join(",");    }  }  codeString = codeString.replace("inputMarker", input);  console.log(input);  var instance = eval(codeString);  return instance;}function watcher(error, result) {  if (!error) {    console.log("Result");    console.log(JSON.stringify(result));    return;  }  console.log("Error" + error);}/*function call(account, gas, func, input) */function call() {  var account = "eth.accounts["+arguments[0]+"]";  var gas = arguments[1];  var func = arguments[2];  input = "null";  if (arguments.length > 3) {    if (arguments[3] != null) {      var args = Array.prototype.slice.call(arguments, 3);      input = args.join(",");    }  }  codeString = "func.sendTransaction(inputMarker, gasMarker, {from:accountMarker}, watcher);";  codeString = codeString.replace("accountMarker",account);  codeString = codeString.replace("gasMarker",gas);  codeString = codeString.replace("inputMarker",input);  eval(codeString);}function send(from_index, to, value, gas){ return eth.sendTransaction({from:eth.accounts[from_index], to:to, value:web3.toWei(value,\'ether\'), gas:gas});}function bal() {  for (var i = 0; i < eth.accounts.length; i++) {    account = eth.accounts[i];    balance = web3.fromWei(eth.getBalance(eth.accounts[i]), \'ether\');    console.log("Index : " + i);    console.log("Account : "+ account);    console.log("Balance : "+ balance);    console.log("\n");  }}'
+end
+
+def compile_solidity(file)
+  json_string = `solc --add-std --optimize --combined-json abi,bin,userdoc,devdoc #{file}`
+  json_string = json_string.gsub("\\n","")
+  begin
+    json_object = JSON.parse(json_string)
+    throw if json_object.nil?
+    puts `solc --optimize --gas #{file}`
+    puts "\n\n"
+    puts "-------------------------------------"
+    json_object["contracts"]
+  rescue
+    puts "Failed to Compile."
+    abort
+  end
+end
+
+def process_code(contracts)
+  contracts.keys.each.with_index do |key, i|
+    contracts[key]["bin"] = "0x" + contracts[key]["bin"]
+    contracts[key]["abi"] = JSON.parse(contracts[key]["abi"])
+    contracts[key]["devdoc"] = JSON.parse(contracts[key]["devdoc"])
+    contracts[key]["userdoc"] = JSON.parse(contracts[key]["userdoc"])
+  end
+  return contracts
+end
+
+
+def javascript_file_name(file_name)
+  file_name = file_name.split('/')[-1]
+  file_name.split('.')[0] + '_compiled.js'
+end
+
+def get_contract_to_deploy(compiled_object)
+  return compiled_object.keys[0] if compiled_object.keys.count == 1
+  puts "Which contract do you want to deploy?"
+  choice = 0
+  while choice <= 0 || choice > compiled_object.keys.count
+    compiled_object.keys.each.with_index do |key, i|
+      puts "#{(i+1)}. "+key
+    end
+    choice = $stdin.gets.to_i
   end
+  return compiled_object.keys[choice - 1]
 end
 
+def get_input
+  puts "Enter Input: "
+  input = $stdin.gets
+  input.strip.chomp == "" ? "null" : input
+end
+
+def get_gas
+  gas = 0
+  while gas == 0
+    puts "Enter Gas: "
+    gas = $stdin.gets.to_i
+  end
+  gas
+end
+
+def get_value
+  gas = -1
+  while gas < 0
+    puts "Enter Value To Be Transferred: "
+    gas = $stdin.gets.to_i
+  end
+  gas
+end
+
+file_name = ARGV[0]
+
+compiled_object = compile_solidity(file_name)
+compiled_object = process_code(compiled_object)
+javascript_file_name = javascript_file_name(file_name)
+
+current_contract = get_contract_to_deploy(compiled_object)
+
+compiled_variable_name = "#{current_contract}Compiled"
+contract_variable_name = "#{current_contract}Contract"
+contract_instance_variable_name = "#{current_contract}"
+
+gas = get_gas
+value = get_value
+input = get_input
+
+File.open(javascript_file_name, 'w') do |f|
+  f.write("#{library_code};\nvar #{compiled_variable_name} = #{compiled_object.to_json};")
+  f.write("#{contract_variable_name} = create(#{compiled_variable_name}.#{current_contract}.abi);")
+  f.write("#{contract_instance_variable_name} = deploy(eth.coinbase,#{value},#{gas},#{contract_variable_name},#{compiled_variable_name}.#{current_contract}.bin,#{input});")
+  f.write("console.log('Compiled Object : #{compiled_variable_name}');")
+  f.write("console.log('Contract : #{contract_variable_name}');")
+  f.write("console.log('Contract Instance : #{contract_instance_variable_name}');")
+end
+}
+
+ATTACH_SH = <<-EOF
+#!/bin/bash
+
+geth=${GETH:-geth}
+$geth attach ipc:data/geth.ipc
+EOF
+
+BUILD_SH = <<-EOF
+#!/bin/bash
+for sol in `find ./contracts -name '*.sol'`
+do
+  filename="${sol}"
+  echo $filename
+  let len=${#filename}-16
+  # echo $len
+  jsfile="${filename:12:len}_compiled.js"
+  echo $jsfile
+  ./bin/solc_helper.rb $sol $jsfile
+  mv $jsfile builds/
+done
+EOF
+
+IMPORT_KEYS_SH = <<-EOF
+#!/bin/sh
+
+geth=${GETH:-geth}
+echo "***** Using geth at: $geth"
+
+echo "***** Import all pre-funded private keys"
+
+for key in `find ./private_keys -name '*.key'`
+do
+  ./private_keys/import.sh $key $geth
+done
+
+echo "***** Done."
+EOF
+
+INIT_SH = <<-EOF
+#! /bin/bash
+geth --datadir `pwd`/data init genesis.json
+EOF
+
+PRIVATE_BLOCKCHAIN_SH = <<-EOF
+#!/bin/bash
+
+geth=${GETH:-geth}
+
+$geth --datadir data --networkid 31415926 --rpc --rpccorsdomain "*" --nodiscover --unlock 3ae88fe370c39384fc16da2c9e768cf5d2495b48 --password <(echo -n 123456)
+EOF
+
+TEST_SH = <<-EOF
+#!/bin/bash
+
+geth=${GETH:-geth}
+
+scripts=""
+
+for file in `find ./builds -name '*compiled.js'`
+do
+  scripts="${scripts};loadScript('$file')"
+done
+
+for file in `find ./test -name '*.js'`
+do
+  scripts="${scripts};loadScript('$file');"
+done
+
+echo $scripts
+$geth --datadir data --networkid 31415926 --rpc --rpccorsdomain "*" --nodiscover --unlock 3ae88fe370c39384fc16da2c9e768cf5d2495b48 --password <(echo -n 123456) --exec "$scripts" console 2>> ./logfile
+EOF
+
+IMPORT_SH = <<-EOF
+#!/usr/bin/expect -f
+
+set key [lindex $argv 0];
+set geth [lindex $argv 1];
+
+spawn $geth --datadir data account import $key
+expect "Passphrase:"
+send "123456\r"
+expect "Repeat Passphrase:"
+send "123456\r"
+interact
+EOF
+
+RAKE_FILE = <<-EOF
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs += %w(lib test)
+  t.test_files = FileList['tests/**/*_test.rb']
+  t.verbose = true
+end
+
+task default: [:test]
+EOF
+
 def new
   name = ARGV.shift
   if name
     puts "Creating project #{name}..."
-    system("mkdir #{name}")
+    system("mkdir #{name} && cd #{name} && mkdir private_keys && mkdir builds && mkdir contracts && mkdir bin && mkdir tests")
     gemfile = GEMFILE_TEMPLATE.result(binding)
-    File.open("#{name}/Gemfile", "w+") {|f| f.write(gemfile) }
-    system("cd #{name} && mkdir contracts && mkdir tests && bundle install")
+    File.open("#{name}/Gemfile", "w+") { |f| f.write(gemfile) }
+    system("cd #{name} && bundle install")
+    File.open("#{name}/genesis.json", "w+") { |f| f.write(GENESIS_TEMPLATE) }
+
+    KEYS_TEMPLATE.each do |k, v|
+      File.open("#{name}/private_keys/#{k}.key", "w+") { |f| f.write(v) }
+    end
+    File.open("#{name}/rakefile", "w+") { |f| f.write(RAKE_FILE) }
+
+    File.open("#{name}/bin/attach.sh", "w+", 0777) { |f| f.write(ATTACH_SH) }
+
+    File.open("#{name}/bin/build.sh", "w+", 0777) { |f| f.write(BUILD_SH) }
+
+    File.open("#{name}/bin/import_keys.sh", "w+", 0777) { |f| f.write(IMPORT_KEYS_SH) }
+
+    File.open("#{name}/bin/init.sh", "w+", 0777) { |f| f.write(INIT_SH) }
+
+    File.open("#{name}/bin/private_blockchain.sh", "w+", 0777) { |f| f.write(PRIVATE_BLOCKCHAIN_SH) }
+
+    File.open("#{name}/bin/test.sh", "w+", 0777) { |f| f.write(TEST_SH) }
+
+    File.open("#{name}/private_keys/import.sh", "w+", 0777) { |f| f.write(IMPORT_SH) }
+
+    File.open("#{name}/bin/solc_helper.rb", "w+", 0777) { |f| f.write(SOLC_HELPER_TEMPLATE) }
     puts "You are flying..."
   else
     puts "Need project name"
@@ -79,10 +327,10 @@ def generate
   if name
     contract = CONTRACT_TEMPLATE.result(binding)
     puts "Create #{name.capitalize}.sol contract file..."
-    File.open("contracts/#{name.capitalize}.sol", "w+") {|f| f.write(contract) }
+    File.open("contracts/#{name.capitalize}.sol", "w+") { |f| f.write(contract) }
     test = TEST_TEMPLATE.result(binding)
     puts "Create #{name}_test.rb test file..."
-    File.open("tests/#{name.capitalize}_test.rb", "w+") {|f| f.write(test) }
+    File.open("tests/#{name.capitalize}_test.rb", "w+") { |f| f.write(test) }
     puts "You are flying..."
   else
     puts "Need contract name!"
@@ -91,9 +339,40 @@ end
 
 def test
   name = ARGV.shift
-  puts "Test #{name.capitalize} contract..."
-  system("bundle exec ruby -Ilib:test tests/#{name}_test.rb")
-  puts "You are flying..."
+  if name
+    puts "Test #{name.capitalize} contract..."
+    system("bundle exec ruby -Ilib:test tests/#{name}_test.rb")
+  else
+    puts "Test all contracts..."
+    system("bundle exec rake")
+  end
+end
+
+def init
+  system("./bin/init.sh")
+end
+
+def import_keys
+  system("./bin/import_keys.sh")
+end
+
+def build
+  system("./bin/build.sh")
+end
+
+def server
+  system("./bin/private_blockchain.sh")
+end
+
+def migrate
+end
+
+def console
+  system("./bin/attach.sh")
+end
+
+def geth_test
+  system("./bin/test.sh")
 end
 
 def help
@@ -113,4 +392,14 @@ def parse_command(command)
   end
 end
 
+def run_command!(command)
+  command = parse_command(command)
+
+  if COMMAND_WHITELIST.include?(command)
+    send(command)
+  else
+    help
+  end
+end
+
 run_command!(command)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ether-fly
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Zhang YaNing
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-13 00:00:00.000000000 Z
+date: 2016-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-ethereum
@@ -38,8 +38,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.8'
-description: EtherFly is a Ethereum smart contract test framework in ruby.I provide
-  test in ruby EVM and geth test two styles.
+description: 'EtherFly is a Ethereum smart contract test framework in ruby.It provides
+  two testing environments: testing in ruby EVM and testing in geth.You don''t need
+  to understand ruby grammar, just enjoy syntactic sugar.'
 email:
 - zhangyaning1985@gmail.com
 executables: