etherdev 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd7bd0d64b923a8a4ea59a6c7a900251ac5e39c2
+  data.tar.gz: e67ec6b68b67adb44a29d9e68c92b22442555d69
+SHA512:
+  metadata.gz: 82d2898e5906f563f0b660ad4429c37584507bef4b000de72c485e105debfa06710bcc65702934fd384becbbb63dc61b95d88e33641486f40f91c42230e65ea4
+  data.tar.gz: ad96e5ff8691137adc6f2731a64759277100746def29faadc29a52cf45bb4407c61dfc42a724630fe92f7260290cefb259485bd7cc03364a13fb424741c8ee82

data/README.md

@@ -0,0 +1,41 @@
+# Welcome to EtherDev
+
+EtherDev is an Ethereum blockchain development toolkit that includes everything you need to compile, test, and deploy Ethereum Smart Contracts.
+
+EtherDev lets you develop and test your Solidity Smart Contracts with your favorite language and testing framework: Ruby and MiniTest. Developing and testing your contracts will feel very similar as developing other Ruby frameworks and libraries, like for example Ruby on Rails.
+
+## Getting Started
+
+1. Install EtherDev at the command prompt if you haven't yet:
+
+    ```
+    $ gem install etherdev
+    ```
+
+2. At the command prompt, create a new EtherDev project:
+    ```
+    $ etherdev new myproject
+    ```
+
+    where "myproject" is your desired new project name.
+
+3. Install and run the Ganache personal development Ethereum blockchain
+
+    Go to http://truffleframework.com/ganache/ and install Ganache for your platform. Then run a personal blockchain on your machine for fast and easy
+  testing of your contracts.
+
+4. Change directory to `myproject` and run the sample contract:
+
+    ```
+    $ cd myproject
+    $ bin/rake
+    ```
+
+Congratulations! You've compiled, deploy and tested the functionality of the
+Greeter contract that's available by default in your project. You can now add
+your other contracts to the `contracts/` folder and add your tests for them to
+`tests/`.
+
+## License
+
+EtherDev is released under the [MIT License](https://opensource.org/licenses/MIT)

data/bin/etherdev

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require "thor"
+require "ether_dev"
+
+EtherDev::CLI.start(ARGV)

data/lib/ether_dev.rb

@@ -0,0 +1,7 @@
+require "eth"
+require "ethereum.rb"
+require "yaml"
+require "rake"
+require "thor"
+
+require "ether_dev/cli"

data/lib/ether_dev/cli.rb

@@ -0,0 +1,25 @@
+module EtherDev
+  class CLI < Thor
+    desc "deploy FILE [private key]", "compiles a contract via Solidity"
+    def deploy(filename, private_key = nil)
+      config = YAML.load(File.open("config.yml"))["development"] || {}
+
+      key = ::Eth::Key.new priv: (private_key || config["account_key"])
+      client = Ethereum::HttpClient.new(config["rpc"])
+
+      contract = Ethereum::Contract.create(file: "contracts/#{filename}", client: client)
+      contract.key = key
+      puts "Deploying contract..."
+      contract.deploy_and_wait()
+      puts "Deployed contract to #{contract.address}"
+    end
+
+    desc "new PROJECTNAME", "generates a new EtherDev project PROJECTNAME"
+    def new(project_name)
+      require "ether_dev/generators/project_generator"
+
+      generator = ProjectGenerator.new(project_name)
+      generator.generate
+    end
+  end
+end

data/lib/ether_dev/generators/project_generator.rb

@@ -0,0 +1,73 @@
+require "ether_dev/generators/project_templates"
+
+module EtherDev
+  class ProjectGenerator
+    include ProjectTemplates
+
+    def initialize(project_name)
+      @project_name = project_name
+    end
+
+    def generate
+      $stdout.sync = true
+      create_directory(@project_name)
+      create_file(project_templates["Gemfile"], @project_name, "Gemfile")
+      create_file(project_templates["Rakefile"], @project_name, "Rakefile")
+
+      create_directory(@project_name, "contracts")
+      create_file(project_templates["Greeter.sol"], @project_name, "contracts", "Greeter.sol")
+
+      create_directory(@project_name, "config")
+      create_file(project_templates["blockchain.yml"], @project_name, "config", "blockchain.yml")
+
+      create_directory(@project_name, "test")
+      create_file(project_templates["test_helper.rb"], @project_name, "test", "test_helper.rb")
+
+      create_directory(@project_name, "test", "contracts")
+      create_file(project_templates["greeter_test.rb"], @project_name, "test", "contracts", "greeter_test.rb")
+
+      run_bundler
+
+      puts
+      puts
+      puts <<~EOF
+        🎉🎉🎉 Get started with EtherDev\n
+
+        Your new EtherDev project is now generated. Now start Ganache and run
+        the following command to compile, deploy and test the example Greeter.sol
+        contract:
+
+        $ bundle exec rake
+
+        Check out the Wiki for next steps:
+        https://github.com/michiels/ruby-etherdev/wiki
+      EOF
+    end
+
+    private
+
+    def create_directory(directory_name, *args)
+      directory_path = File.join([directory_name] + args)
+      FileUtils.mkdir_p(directory_path)
+      puts "- Created #{directory_path}"
+    end
+
+    def create_file(template, directory_name, *args)
+      filepath = File.join([directory_name] + args)
+      File.open(filepath, "w+") do |f|
+        f.write template
+      end
+      puts "- Generated file #{filepath}"
+    end
+
+    def run_bundler
+      puts
+      puts "Running bundler..."
+      IO.popen("cd #{@project_name} && bundle install") do |io|
+        while (line = io.gets) do
+          puts line
+        end
+      end
+    end
+  end
+end

data/lib/ether_dev/generators/project_templates.rb

@@ -0,0 +1,77 @@
+module EtherDev
+  module ProjectTemplates
+    def project_templates
+      templates = {}
+      templates["Gemfile"] = <<~'EOS'
+        gem "etherdev"
+        gem "ethereum.rb", github: "michiels/ethereum.rb", branch: "fixes-for-etherdev"
+      EOS
+
+      templates["Rakefile"] = <<~'EOS'
+        spec = Gem::Specification.find_by_name 'etherdev'
+        load "#{spec.gem_dir}/lib/ether_dev/test_task.rake"
+      EOS
+
+      templates["blockchain.yml"] = <<~'EOS'
+        # You can use the Project Orca test Ethereum blockchain to easily
+        # test and stage your contracts and interact with them in your team
+        # or from other deployed apps.
+        #
+        # Sign up at https://projectorca.net and uncomment the following:
+        #
+        # development:
+        #  rpc: https://rpc.projectorca.net
+        #  # Put your private account key here:
+        #  account_key:  c38dbe6e3725e012ec5e1d114ccc9061bb02946e5efdd1b2c7e0856897cfa0ef
+        test:
+          rpc: http://localhost:7545
+      EOS
+
+      templates["Greeter.sol"] = <<~'EOS'
+        contract mortal {
+          /* Define variable owner of the type address */
+          address owner;
+
+          /* This function is executed at initialization and sets the owner of the contract */
+          function mortal() { owner = msg.sender; }
+
+          /* Function to recover the funds on the contract */
+          function kill() { if (msg.sender == owner) selfdestruct(owner); }
+        }
+
+        contract greeter is mortal {
+          /* Define variable greeting of the type string */
+          string greeting;
+
+          /* This runs when the contract is executed */
+          function greeter(string _greeting) public {
+              greeting = _greeting;
+          }
+
+          /* Main function */
+          function greet() constant returns (string) {
+              return greeting;
+          }
+        }
+      EOS
+
+      templates["test_helper.rb"] = <<~'EOS'
+        require "ether_dev/test_helper"
+      EOS
+
+      templates["greeter_test.rb"] = <<~'EOS'
+        require "test_helper"
+
+        class GreeterTest < EtherDev::TestCase
+          def test_greet
+            @contract.deploy_and_wait("Hello, World!")
+
+            assert_equal "Hello, World!", @contract.call.greet()
+          end
+        end
+      EOS
+
+      templates
+    end
+  end
+end

data/lib/ether_dev/rake_tasks.rb

@@ -0,0 +1 @@
+load "test_task.rake"

data/lib/ether_dev/test_case.rb

@@ -0,0 +1,34 @@
+module EtherDev
+  class TestCase < ::Minitest::Test
+    def setup
+      @formatter = Ethereum::Formatter.new
+      contract_name = self.class.name.dup
+      contract_name.slice!("Test")
+
+      @config = YAML.load(File.open("config/blockchain.yml"))[ENV["BLOCKCHAIN_ENV"] || "test"] || {}
+      @client = Ethereum::HttpClient.create(@config["rpc"], true)
+
+      @contract = Ethereum::Contract.create(file: "contracts/#{contract_name}.sol", client: @client)
+      Eth.configure { |c| c.chain_id = @client.net_version["result"].to_i }
+
+      @default_key = nil
+      @default_account = nil
+
+      if private_key = @config["account_key"]
+        @default_key = Eth::Key.new priv: private_key
+        @default_account = @default_key.address
+      else
+        @default_account = @client.default_account
+      end
+
+      @contract.key = @default_key if @default_key.present?
+      @contract.sender = @default_account
+    end
+
+    protected
+
+    def signing_account?
+      @default_key.present?
+    end
+  end
+end

data/lib/ether_dev/test_helper.rb

@@ -0,0 +1,6 @@
+require "minitest"
+require "minitest/autorun"
+require "ethereum.rb"
+require "eth"
+require "yaml"
+require "ether_dev/test_case"

data/lib/ether_dev/test_task.rake

@@ -0,0 +1,8 @@
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << %w(lib test)
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: etherdev
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Michiel Sikkes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ethereum.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: eth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+description: A clean and simple development framework for Ethereum development and
+  deployment
+email: michiel.sikkes@gmail.com
+executables:
+- etherdev
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/etherdev
+- lib/ether_dev.rb
+- lib/ether_dev/cli.rb
+- lib/ether_dev/generators/project_generator.rb
+- lib/ether_dev/generators/project_templates.rb
+- lib/ether_dev/rake_tasks.rb
+- lib/ether_dev/test_case.rb
+- lib/ether_dev/test_helper.rb
+- lib/ether_dev/test_task.rake
+homepage: https://github.com/michiels/etherdev
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A very simple development framework for Ethereum and Solidity smart contracts
+test_files: []