Merge branch 'develop'

Author: iurimatias

Gruntfile.coffee

@@ -23,7 +23,7 @@ module.exports = (grunt) ->
         src: ['test/**/*.js']
 
   grunt.loadTasks "tasks"
-  require('matchdep').filterAll('grunt-*').forEach(grunt.loadNpmTasks)
+  require('matchdep').filterAll(['grunt-*','!grunt-cli']).forEach(grunt.loadNpmTasks)
 
   grunt.registerTask 'default', ['clean']
   grunt.registerTask 'build', ['clean', 'coffee']

README.md

@@ -7,15 +7,17 @@ Embark is a framework that allows you to easily develop and deploy DApps.
 
 With Embark you can:
 * Automatically deploy contracts and make them available in your JS code. Embark watches for changes, and if you update a contract, Embark will automatically redeploy the contracts (if needed) and the dapp.
+* Use any build pipeline or tool you wish, including grunt and meteor.
 * Do Test Driven Development with Contracts using Javascript.
 * Easily deploy to & use decentralized systems such as IPFS.
+* Keep track of deployed contracts, deploy only when truly needed.
 * Quickly create advanced DApps using multiple contracts.
 
 See the [Wiki](https://github.com/iurimatias/embark-framework/wiki) for more details.
 
 Installation
 ======
-Requirements: geth (1.0.0), solc (0.9.23), node (0.12.2) and npm
+Requirements: geth (1.0.0), solc (0.1.0) or serpent (develop), node (0.12.2) and npm
 
 For specs: pyethereum, ethertdd.py
 
@@ -49,6 +51,8 @@ This will automatically deploy the contracts, update their JS bindings and deplo
 
 Note that if you update your code it will automatically be re-deployed, contracts included. There is no need to restart embark, refreshing the page on the browser will do.
 
+note: for a demo using meteor do ```embark meteor_demo``` followed by ```embark deploy``` then ```meteor```
+
 Creating a new DApp
 ======
 
@@ -62,7 +66,7 @@ DApp Structure
 
 ```Bash
   app/
-    |___ contracts/ #solidity contracts
+    |___ contracts/ #solidity or serpent contracts
     |___ html/
     |___ css/
     |___ js/
@@ -74,7 +78,7 @@ DApp Structure
     |___ contracts/ #contracts tests
 ```
 
-Solidity files in the contracts directory will automatically be deployed with embark run. Changes in any files will automatically be reflected in app, changes to contracts will result in a redeployment and update of their JS Bindings
+Solidity/Serpent files in the contracts directory will automatically be deployed with embark run. Changes in any files will automatically be reflected in app, changes to contracts will result in a redeployment and update of their JS Bindings
 
 Using Contracts
 ======
@@ -145,6 +149,7 @@ You can now deploy many instances of the same contract. e.g
 # config/contracts.yml
   development:
     Currency:
+      deploy: false
       args:
         - 100
     Usd:
@@ -171,16 +176,44 @@ Contracts addresses can be defined, If an address is defined the contract wouldn
   ...
 ```
 
+You can also define contract interfaces (Stubs) and actions to do on deployment
+
+```Yaml
+  development:
+    DataSource:
+      args:
+    MyDataSource:
+      args:
+      instanceOf: DataSource
+    Manager:
+      stubs:
+        - DataSource
+      args:
+        - $MyDataSource
+      onDeploy:
+        - Manager.updateStorage($MyDataSource)
+        - MyDataSource.set(5)
+  ...
+```
+
 Tests
 ======
 
 You can run specs with ```embark spec```, it will run any files ending *_spec.js under ```spec/```.
 
-Embark includes a testing lib to fastly run & test your contracts in a EVM. 
+Embark includes a testing lib to fastly run & test your contracts in a EVM.
 
 ```Javascript
 # spec/contracts/simple_storage_spec.js
-EmbarkSpec = require('embark-framework').Tests;
+Embark = require('embark-framework');
+Embark.init();
+Embark.blockchainConfig.loadConfigFile('config/blockchain.yml');
+Embark.contractsConfig.loadConfigFile('config/contracts.yml');
+
+var files = ['app/contracts/simpleStorage.sol'];
+Embark.contractsConfig.init(files, 'development');
+
+var EmbarkSpec = Embark.tests(files);
 
 describe("SimpleStorage", function() {
   beforeAll(function() {
@@ -222,6 +255,7 @@ The environment is a specific blockchain configuration that can be managed at co
     rpc_port: 8101
     rpc_whitelist: "*"
     datadir: default
+    chains: chains_staging.json
     network_id: 0
     console: true
     account:
@@ -231,7 +265,6 @@ The environment is a specific blockchain configuration that can be managed at co
 
 See [Configuration](https://github.com/iurimatias/embark-framework/wiki/Configuration).
 
-
 Deploying only contracts
 ======
 Although embark run will automatically deploy contracts, you can choose to only deploy the contracts to a specific environment
@@ -242,6 +275,26 @@ $ embark deploy privatenet
 
 embark deploy will deploy all contracts at app/contracts and return the resulting addresses
 
+Structuring Application
+======
+
+Embark is quite flexible and you can configure you're own directory structure using ```embark.yml```
+
+```Yaml
+# embark.yml
+  type: "manual" #other options: meteor, grunt
+  contracts: ["app/contracts/**/*.sol", "app/contracts/**/*.se"] # contracts files
+  output: "src/embark.js" # resulting javascript interface
+  blockchainConfig: "config/blockchain.yml" # blockchain config
+  contractsConfig: "config/contracts.yml" # contracts config
+```
+
+Deploying to IPFS
+======
+
+To deploy a dapp to IPFS, all you need to do is run a local IPFS node and then run ```embark ipfs```.
+If you want to deploy to the live net then after configuring you account on ```config/blockchain.yml``` on the ```production``` environment then you can deploy to that chain by specifying the environment ```embark ipfs production```.
+
 LiveReload Plugin
 ======
 
@@ -255,5 +308,19 @@ Because embark is internally using grunt tasks, debugging is not straightforward
 - normally you would write something like `node-debug -p 7000 embark -- deploy`
 - This gives you nothing with embark. If you look at `deploy` command in [`./bin/embark`](https://github.com/iurimatias/embark-framework/blob/develop/bin/embark#L32-L35) you will notice that it internally runs grunt task `grunt deploy_contracts:[env]`
 - with this knowledge we can prepare proper command to start debugging
-- `node-debug -p 7000 grunt -- deploy_contracts:development`
-- [here](https://github.com/iurimatias/embark-framework/blob/develop/tasks/tasks.coffee) is list of all debuggable grunt tasks
+- ```node-debug -p 7000 grunt -- deploy_contracts:development```
+
+
+[here](https://github.com/iurimatias/embark-framework/blob/develop/tasks/tasks.coffee) is list of all debuggable grunt tasks
+
+EACCESS Error
+======
+If you get EACCES (access denied) errors, don't use sudo, try this:
+
+```Bash
+$ mkdir ~/npm-global
+$ npm config set prefix ~/npm-global
+$ echo 'export PATH="$PATH:$HOME/npm-global/bin"' >>~/.bashrc
+$ source ~/.bashrc
+$ npm install -g embark-framework grunt-cli
+```

bin/embark

@@ -6,7 +6,7 @@ var wrench = require('wrench');
 var grunt = require('grunt');
 require('shelljs/global');
 var readYaml = require('read-yaml');
-var Embark = require('embark-framework');
+var Embark = require('..');
 
 var run = function(cmd) {
   if (exec(cmd).code != 0) {
@@ -17,22 +17,19 @@ var run = function(cmd) {
 var deploy = function(env, embarkConfig) {
   var contractFiles = grunt.file.expand(embarkConfig.contracts);
   var destFile = embarkConfig.output;
-  var chainFile = embarkConfig.chains;
 
   Embark.init();
   Embark.blockchainConfig.loadConfigFile(embarkConfig.blockchainConfig);
   Embark.contractsConfig.loadConfigFile(embarkConfig.contractsConfig);
 
-  if (chainFile === undefined) {
-    chainFile = './chains.json';
-  }
+  var chainFile = Embark.blockchainConfig.blockchainConfig[env].chains || embarkConfig.chains || './chains.json';
 
   abi = Embark.deployContracts(env, contractFiles, destFile, chainFile);
   grunt.file.write(destFile, abi);
 }
 
 program
-  .version('0.8.4')
+  .version('0.9.1')
 
 program.command('new [name]').description('New application').action(function(name) {
   if (name === undefined) {
@@ -132,13 +129,24 @@ program.command('blockchain [env]').description('run blockchain').action(functio
     Embark.blockchainConfig.loadConfigFile(embarkConfig.blockchainConfig)
     Embark.contractsConfig.loadConfigFile(embarkConfig.contractsConfig)
 
-    //TODO: better with --exec, but need to fix console bug first
-    wrench.copyDirSyncRecursive(__dirname + "/../js", "/tmp/js", {forceDelete: true});
+    Embark.copyMinerJavascriptToTemp();
 
     Embark.startBlockchain(env, true);
   }
 });
 
+program.command('geth <env> [args...]').description('run geth with specified arguments').action(function(env_, args_) {
+  var env = env_ || 'development';
+  var embarkConfig = readYaml.sync("./embark.yml");
+  var args = args_.join(' ');
+
+  Embark.init()
+  Embark.blockchainConfig.loadConfigFile(embarkConfig.blockchainConfig)
+  Embark.contractsConfig.loadConfigFile(embarkConfig.contractsConfig)
+
+  Embark.geth(env, args);
+});
+
 program.command('demo').description('create a working dapp with a SimpleStorage contract').action(function() {
   var boilerPath = path.join(__dirname + '/../boilerplate');
   var demoPath   = path.join(__dirname + '/../demo');
@@ -169,4 +177,3 @@ if (!process.argv.slice(2).length) {
 }
 
 exit();
-

boilerplate/.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+chains/development.json

boilerplate/Gruntfile.coffee

@@ -33,6 +33,7 @@ module.exports = (grunt) ->
       contracts:
         src: [
           "app/contracts/**/*.sol"
+          "app/contracts/**/*.se"
         ]
 
     coffee:

boilerplate/config/blockchain.yml

@@ -5,6 +5,7 @@ development:
   minerthreads: 1
   genesis_block: config/genesis/dev_genesis.json
   datadir: /tmp/embark
+  chains: config/chains/development.json
   mine_when_needed: true
   max_peers: 0
   gas_limit: 500000

boilerplate/config/chains/development.json

@@ -0,0 +1 @@
+{}

boilerplate/config/genesis/dev_genesis.json

@@ -1,10 +1,11 @@
 {
     "nonce": "0x0000000000000042",
-    "difficulty": "0x40000",
+    "difficulty": "0x0",
     "alloc": {
+        "0x3333333333333333333333333333333333333333": {"balance": "15000000000000000000"}
     },
     "mixhash": "0x0000000000000000000000000000000000000000000000000000000000000000",
-    "coinbase": "0x0000000000000000000000000000000000000000",
+    "coinbase": "0x3333333333333333333333333333333333333333",
     "timestamp": "0x00",
     "parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
     "extraData": "0x",

boilerplate/embark.yml

@@ -1,5 +1,5 @@
 type: "grunt" #other options: meteor, manual
-#contracts: ["app/contracts/**/*.sol"]
+#contracts: ["app/contracts/**/*.sol", "app/contracts/**/*.se"]
 #output: "src/embark.js"
 #blockchainConfig: "config/blockchain.yml"
 #contractsConfig: "config/contracts.yml"

boilerplate/package.json

@@ -10,8 +10,8 @@
   "license": "ISC",
   "homepage": "",
   "devDependencies": {
-    "embark-framework": "^0.8.4",
-    "grunt-embark": "^0.3.0",
+    "embark-framework": "^0.9.1",
+    "grunt-embark": "^0.4.1",
     "grunt-contrib-clean": "^0.6.0",
     "grunt-contrib-coffee": "^0.13.0",
     "grunt-contrib-concat": "^0.5.1",