Improve deployment to ease verification and documentation (#439)

* Implement deployment logger helper

* Flatten contracts on deployment for verification

* Deploy bases individually to avoid problems when submitting many txs

* Rename calldata variable name as it makes solidity-parser-antlr crash

* Await on logDeploy

* Prepare for production: rename scripts and clean up old addresses

* Update readme

* Use provider account as the default owner

* Address review comments

* Update readme

* Revert path.resolve

Author: izqui

.gitignore

@@ -17,3 +17,4 @@ abi/
 build/
 bytecode/
 bytecode_new/
+flattened_contracts/

contracts/evmscript/EVMScriptRunner.sol

@@ -34,8 +34,8 @@ contract EVMScriptRunner is AppStorage, Initializable, EVMScriptRegistryConstant
         require(address(executor) != address(0), ERROR_EXECUTOR_UNAVAILABLE);
 
         bytes4 sig = executor.execScript.selector;
-        bytes memory calldata = abi.encodeWithSelector(sig, _script, _input, _blacklist);
-        require(address(executor).delegatecall(calldata), ERROR_EXECUTION_REVERTED);
+        bytes memory data = abi.encodeWithSelector(sig, _script, _input, _blacklist);
+        require(address(executor).delegatecall(data), ERROR_EXECUTION_REVERTED);
 
         bytes memory output = returnedDataDecoded();
 

package.json

@@ -47,6 +47,8 @@
     "web3-utils": "1.0.0-beta.33"
   },
   "dependencies": {
+    "mkdirp": "^0.5.1",
+    "truffle-flattener": "^1.2.9",
     "homedir": "^0.6.0",
     "truffle-hdwallet-provider": "0.0.3",
     "truffle-hdwallet-provider-privkey": "0.3.0"

readme.md

@@ -1,19 +1,16 @@
 # aragonOS <img align="right" src="https://raw.githubusercontent.com/aragon/design/master/readme-logo.png" height="80px" /> [![Travis branch](https://img.shields.io/travis/aragon/aragonOS/master.svg?style=for-the-badge)](https://travis-ci.org/aragon/aragonOS) [![Coveralls branch](https://img.shields.io/coveralls/aragon/aragonOS/master.svg?style=for-the-badge)](https://coveralls.io/github/aragon/aragonOS?branch=master) [![npm](https://img.shields.io/npm/v/@aragon/os.svg?style=for-the-badge)](https://www.npmjs.com/package/@aragon/os)
 
-This repo contains Aragon's reference implementation for [aragonOS](https://wiki.aragon.one/dev/aragonOS_index/).
+This repo contains Aragon's reference implementation for [aragonOS](https://hack.aragon.org/docs/aragonos-intro.html).
 
-#### 🚨 Everything in this repo is highly experimental software.
-It is not secure to use any of this code in production (mainnet) until proper security audits have been conducted. It can result in irreversible loss of funds.
+#### 🚨 Security review status: bug bounty
+aragonOS 4 has undergone two independent professional security reviews, and the issues raised have been resolved. However there is a [bug bounty program](https://wiki.aragon.org/dev/bug_bounty/) for rewarding hackers who find security vulnerabilities. There is a bounty pool of $250,000 USD, you can find more information [here](https://wiki.aragon.org/dev/bug_bounty/).
 
-#### 🦋 We are using [Status Open Bounty](http://openbounty.status.im/app) to reward open source contributions with Aragon Tokens (ANT)
-All issues tagged with **[bounty](https://github.com/aragon/aragonOS/labels/bounty)** are eligible for a bounty on a successfully merged Pull Request that solves the issue. Even if the bounty says 0 ANT, if it has the **bounty** label, it will always be higher than 0 ANT (until we automate it, we may take a bit to fund the bounties manually).
-
-#### 👋 We are tagging tasks that are [good first issues](https://github.com/aragon/aragonOS/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) so you can get started contributing to Aragon Core.
+#### 👋 Get started contributing with a [good first issue](https://github.com/aragon/aragonOS/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
 Don't be shy to contribute even the smallest tweak. Everyone will be especially nice and helpful to beginners to help you get started!
 
 ## Documentation
 
-Visit the [Aragon wiki](https://wiki.aragon.one/dev/aragonOS_index/) for in depth documentation on the [architecture](https://wiki.aragon.one/documentation/aragonOS/) and different parts of the system.
+Visit the [Aragon Developer Portal](https://hack.aragon.org/docs/aragonos-intro.html) for in depth documentation on the [architecture](https://hack.aragon.org/docs/aragonos-ref.html) and different parts of the system.
 
 ## Installing aragonOS
 
@@ -25,13 +22,23 @@ npm test
 npm run lint
 ```
 
+## Deploying
+
+### APM
+```sh
+OWNER=[APM owner address] ENS=[ENS registry address] npx truffle exec --network [network] scripts/deploy-apm.js
+```
+
+- `ENS`: If no ENS registry address is provided, it will deploy a dummy ENS instance to the network. If the ENS registry is provided, the name `aragonpm.eth` must be owned by the deployer account.
+- `OWNER`: The account that will be the initial owner of the APM registry
+
 ## Using aragonOS for making Aragon apps
 
 ```
 npm i --save-dev @aragon/os
 ```
 
-(section under construction)
+Check the [Aragon Developer Portal](https://hack.aragon.org) for detailed documentation and tutorials on how to use aragonOS.
 
 ## Contributing
 

scripts/deploy-beta-apm.js scripts/deploy-apm.jsscripts/deploy-beta-apm.js renamed to scripts/deploy-apm.js

@@ -1,22 +1,19 @@
 const namehash = require('eth-ens-namehash').hash
 const keccak256 = require('js-sha3').keccak_256
+const { promisify } = require('util')
 
-const deployENS = require('./deploy-beta-ens')
+const deployENS = require('./deploy-test-ens')
 const deployDaoFactory = require('./deploy-daofactory')
+const logDeploy = require('./helpers/deploy-logger')
 
 const globalArtifacts = this.artifacts // Not injected unless called directly via truffle
 
 const ZERO_ADDR = '0x0000000000000000000000000000000000000000'
 
-const defaultOwner = process.env.OWNER || '0x4cb3fd420555a09ba98845f0b816e45cfb230983'
+const defaultOwner = process.env.OWNER
 const defaultDaoFactoryAddress = process.env.DAO_FACTORY
 const defaultENSAddress = process.env.ENS
 
-const deployBases = async baseContracts => {
-  const deployedContracts = await Promise.all(baseContracts.map(c => c.new()))
-  return deployedContracts.map(c => c.address)
-}
-
 module.exports = async (
   truffleExecCallback,
   {
@@ -47,6 +44,12 @@ module.exports = async (
   let ens
 
   log('Deploying APM...')
+
+  if (!owner) {
+    const accounts = await promisify(web3.eth.getAccounts)()
+    owner = accounts[0]
+    log('OWNER env variable not found, setting APM owner to the provider\'s first account')
+  }
   log('Owner:', owner)
 
   if (!ensAddress) {
@@ -64,8 +67,13 @@ module.exports = async (
 
   log('=========')
   log('Deploying APM bases...')
-  const apmBases = await deployBases([APMRegistry, Repo, ENSSubdomainRegistrar])
-  log('Deployed APM bases:', apmBases)
+
+  const apmRegistryBase = await APMRegistry.new()
+  await logDeploy(apmRegistryBase, { verbose })
+  const apmRepoBase = await Repo.new()
+  await logDeploy(apmRepoBase, { verbose })
+  const ensSubdomainRegistrarBase = await ENSSubdomainRegistrar.new()
+  await logDeploy(ensSubdomainRegistrarBase, { verbose })
 
   let daoFactory
   if (daoFactoryAddress) {
@@ -76,12 +84,18 @@ module.exports = async (
   } else {
     log('Deploying DAOFactory with EVMScripts...')
     daoFactory = (await deployDaoFactory(null, { artifacts, withEvmScriptRegistryFactory: true, verbose: false })).daoFactory
-    log('Deployed DAOFactory:', daoFactory.address)
   }
 
   log('Deploying APMRegistryFactory...')
-  const apmFactory = await APMRegistryFactory.new(daoFactory.address, ...apmBases, ensAddress, '0x00')
-  log('Deployed APMRegistryFactory:', apmFactory.address)
+  const apmFactory = await APMRegistryFactory.new(
+    daoFactory.address,
+    apmRegistryBase.address,
+    apmRepoBase.address,
+    ensSubdomainRegistrarBase.address,
+    ensAddress,
+    '0x00'
+  )
+  await logDeploy(apmFactory, { verbose })
 
   log(`Assigning ENS name (${labelName}.${tldName}) to factory...`)
   try {
@@ -99,8 +113,10 @@ module.exports = async (
 
   log('=========')
   const apmAddr = receipt.logs.filter(l => l.event == 'DeployAPM')[0].args.apm
-  log('Deployed APM:', apmAddr)
-  log(apmAddr)
+  log('# APM:')
+  log('Address:', apmAddr)
+  log('Transaction hash:', receipt.tx)
+  log('=========')
 
   if (typeof truffleExecCallback === 'function') {
     // Called directly via `truffle exec`
@@ -113,5 +129,3 @@ module.exports = async (
     }
   }
 }
-
-// Rinkeby APM: 0x700569b6c99b8b5fa17b7976a26ae2f0d5fd145c

scripts/deploy-daofactory.js

@@ -1,3 +1,5 @@
+const logDeploy = require('./helpers/deploy-logger')
+
 const globalArtifacts = this.artifacts // Not injected unless called directly via truffle
 
 const ZERO_ADDR = '0x0000000000000000000000000000000000000000'
@@ -10,31 +12,30 @@ module.exports = async (
     verbose = true
   } = {}
 ) => {
-  const log = (...args) => {
-    if (verbose) { console.log(...args) }
-  }
-
   const ACL = artifacts.require('ACL')
   const Kernel = artifacts.require('Kernel')
 
   const DAOFactory = artifacts.require('DAOFactory')
 
-  log('Deploying DAOFactory with bases...')
   const kernelBase = await Kernel.new(true) // immediately petrify
+  await logDeploy(kernelBase, { verbose })
+
   const aclBase = await ACL.new()
+  await logDeploy(aclBase, { verbose })
 
   let evmScriptRegistryFactory
   if (withEvmScriptRegistryFactory) {
     const EVMScriptRegistryFactory = artifacts.require('EVMScriptRegistryFactory')
     evmScriptRegistryFactory = await EVMScriptRegistryFactory.new()
+    await logDeploy(evmScriptRegistryFactory, { verbose })
   }
   const daoFactory = await DAOFactory.new(
     kernelBase.address,
     aclBase.address,
     evmScriptRegistryFactory ? evmScriptRegistryFactory.address : ZERO_ADDR
   )
 
-  log('DAOFactory deployed:', daoFactory.address)
+  await logDeploy(daoFactory, { verbose })
 
   if (typeof truffleExecCallback === 'function') {
     // Called directly via `truffle exec`

scripts/deploy-beta-ens.js scripts/deploy-test-ens.jsscripts/deploy-beta-ens.js renamed to scripts/deploy-test-ens.js

@@ -1,18 +1,27 @@
+const logDeploy = require('./helpers/deploy-logger')
+const { promisify } = require('util')
+
 const globalArtifacts = this.artifacts // Not injected unless called directly via truffle
 
-const defaultOwner = process.env.OWNER || '0x4cb3fd420555a09ba98845f0b816e45cfb230983'
+const defaultOwner = process.env.OWNER
 
 module.exports = async (truffleExecCallback, { artifacts = globalArtifacts, owner = defaultOwner, verbose = true } = {}) => {
   const log = (...args) => {
     if (verbose) { console.log(...args) }
   }
 
+  if (!owner) {
+    const accounts = await promisify(web3.eth.getAccounts)()
+    owner = accounts[0]
+    log(`No OWNER environment variable passed, setting ENS owner to provider's account: ${owner}`)
+  }
+
   const ENS = artifacts.require('ENS')
   const ENSFactory = artifacts.require('ENSFactory')
 
   log('Deploying ENSFactory...')
   const factory = await ENSFactory.new()
-  log('ENSFactory deployed:', factory.address)
+  await logDeploy(factory, { verbose })
   const receipt = await factory.newENS(owner)
 
   const ensAddr = receipt.logs.filter(l => l.event == 'DeployENS')[0].args.ens
@@ -32,4 +41,3 @@ module.exports = async (truffleExecCallback, { artifacts = globalArtifacts, owne
   }
 }
 
-// Rinkeby ENS: 0xfbae32d1cde62858bc45f51efc8cc4fa1415447e

scripts/helpers/deploy-logger.js

@@ -0,0 +1,39 @@
+const flatten = require('truffle-flattener')
+const mkdirp = require('mkdirp')
+const fs = require('fs')
+const path = require('path')
+
+const truffleConfig = require('../../truffle-config')
+
+const FLATTEN_DIR = './flattened_contracts'
+
+module.exports = async (instance, { verbose = true, flattenContracts = true } = {}) => {
+  const {
+    contractName,
+    sourcePath,
+    updatedAt: compiledAt,
+    compiler: { name: compilerName, version: compilerVersion }
+  } = instance.constructor._json
+
+  if (flattenContracts) {
+    const flattenedCode = await flatten([ sourcePath ])
+    mkdirp.sync(FLATTEN_DIR)
+    const savePath = path.join(FLATTEN_DIR, `${contractName}.sol`)
+    fs.writeFileSync(savePath, flattenedCode)
+  }
+
+  const optimizer = truffleConfig.solc.optimizer || null
+  const optimizerStatus = optimizer && optimizer.enabled ? `${optimizer.runs} runs`: 'Disabled'
+
+  if (!verbose) {
+    console.log(`Deployed ${contractName}: ${instance.address}`)
+  } else {
+    console.log('=========')
+    console.log(`# ${contractName}:`)
+    console.log(`Address: ${instance.address}`)
+    console.log(`Transaction hash: ${instance.transactionHash}`)
+    console.log(`Compiler: ${compilerName}@${compilerVersion} (Optimizer: ${optimizerStatus})`)
+    console.log(`Compiled at: ${compiledAt}`)
+    console.log('=========')
+  }
+}