Merge branch 'dev' into newstyle

* dev: Update rinkeby.md Update staging.md Update staging.md chore/add-prettier-eslint-plugin remove pre-push and post-checkout hooks add back in hooks update aragon-api dot-voting dep finishing touches upgrade aragon-api dep in allocations revert package.json changes upgrade aragon-api for address-book Removed design concepts Update README.md Cleaned up the readme
AutarkLabs · Aug 21, 2019 · 509fb28 · 509fb28
2 parents c50b0ae + 2ced247
commit 509fb28
Show file tree

Hide file tree

Showing 18 changed files with 109 additions and 97 deletions.
diff --git a/README.md b/README.md
@@ -1,17 +1,22 @@
-# That Planning Suite
+# Open Enterprise
+*Note: Open Enterprise is the new name of That Planning Suite. We still need to update the Github repo URL.*
 
 [![Build Status](https://img.shields.io/travis/AutarkLabs/planning-suite.svg?style=flat-square)](https://travis-ci.org/AutarkLabs/planning-suite) [![Coverage Status](https://img.shields.io/coveralls/github/AutarkLabs/planning-suite.svg?style=flat-square)](https://coveralls.io/github/AutarkLabs/planning-suite)
 
 <!-- markdownlint-disable MD033 -->
 <p align="center">
   <a href="#development-setup">Development Setup</a> •
-  <a href="#background">Background</a> •
-  <a href="#details">Details</a> •
-  <a href="#design-concepts">Design Concepts</a> •
+  <a href="#app-overview">App Overview</a> •
   <a href="#contact">Contact</a>
 </p>
 <!-- markdownlint-enable MD033 -->
 
+Open Enterprise is a collection of Aragon apps that enable organizations to curate issues, collectively budget, and design custom reward and bounty programs. If you are interested in viewing app demos or want to install them to your Rinkeby organizations, learn more here:
+https://www.autark.xyz/apps
+
+**Release status:** The apps are currently on Rinkeby and undergoing a security audit and UX enhancements. The apps will be released to mainnet in Q4 2019.
+
+
 ## Development Setup
 
 Node.js LTS or greater required.
@@ -43,13 +48,9 @@ $ npm run start:dot
 
 **Detailed information in the [DEVELOPMENT_NOTES.md](/docs/DEVELOPMENT_NOTES.md) document.**
 
-## Background
-
-The proposal for an Aragon [Planning Suite](https://github.com/aragon/nest/pull/24) was developed by members of [Autark](https://autark.xyz), and received funding via [Aragon's Nest program](https://blog.aragon.one/introducing-aragon-nest-1aa8c91c0566): an example of decentralization at it's finest. We are developing this app as a collaborative unit because it is a crucial building block for any organization that aims to coordinate work and streamline management duties, without traditional managers. These apps will work with MiniMe ERC-20 tokens or Aragon DAOs.
-
-## The Suite
+## App Overview
 
-The Planning Suite is a collection of five Aragon Apps that supports the following:
+Open Enterprise is a collection of five Aragon Apps that supports the following:
 
 - **Allocations:** The Allocations app is used to propose a financial allocation meant to be distributed to multiple parties. Allocation proposals are forwarded to the Dot Voting app. The percentage of the allocation amount distributed to each party is determined based on the results of the Dot Vote.
 - **Address Book:** Maintain a list of Ethereum addresses mapped to human-readable names. The Address Book will enable a more user-friendly way to access and review common addresses a DAO uses for Allocations and Dot Voting.
@@ -59,39 +60,13 @@ The Planning Suite is a collection of five Aragon Apps that supports the followi
 - **Dot Voting:** Dot Voting is used to cast votes for Allocation or Issue Curation proposals. Members can vote on how to distribute an allocation across distinct entities or prioritize a list of Github issues by specifying a percentage of votes per option.
 - **Rewards:** Distributes payments to token holders based on the number of tokens one has earned in a specific cycle of time (one-time reward) or based on the total tokens one holds (dividend).
 
-### Please review the [White Paper](http://goo.gl/eXAybm) for full details
-
-## Design Concepts
-
-These are some initial concepts. We expect to refine them and gather community feedback once approved.
-
-### Projects App
-
-![ara_planning1](docs/screenshots/Projects_app.jpg)
-
-#### Allocations App
-
-![ara_planning2](docs/screenshots/Allocations_app.jpg)
-
-#### Rewards App
-
-![ara_planning3](docs/screenshots/Rewards_app.jpg)
-
-#### Issue Curation using Dot Voting
-
-![ara_planning4](docs/screenshots/Dot_vote_issue.jpg)
-
-### Flow Diagram
-
-#### Financial Planning Toolkit
+### [Review more details](https://www.autark.xyz/apps)
 
-Hypothetical flow diagram. The components should be "plug and play" to design a rewards system tailored to an organization's unique needs.
-![image](https://user-images.githubusercontent.com/2584493/36970345-91ff7ee6-2068-11e8-94a6-968f055b7ebc.png)
 
 ## Contact
 
 We can be found in the [`autark.community` keybase channel](https://keybase.io/team/autark.community). If you have any questions or want to get involved in our development please drop in.
 
 ## Special Thanks
 
-Special thanks go to the Aragon team for much of the work this project is based on, as well as for allocating us this grant to build the tools we need to DAOify open source development!
+Special thanks to the Aragon Network for funding our work with three grants to date ([Nest](https://blog.aragon.one/introducing-aragon-nest-1aa8c91c0566), [AGP-19](https://github.com/aragon/AGPs/blob/master/AGPs/AGP-19.md), and [AGP-73](https://github.com/aragon/AGPs/blob/master/AGPs/AGP-73.md)).
diff --git a/apps/address-book/app/components/App/App.js b/apps/address-book/app/components/App/App.js
@@ -12,31 +12,33 @@ import NewEntity from '../Panel/NewEntity'
 const ASSETS_URL = './aragon-ui'
 
 const App = () => {
-  const [ panelVisible,setPanelVisible ] = useState(false)
+  const [ panelVisible, setPanelVisible ] = useState(false)
   const { api, appState = {}, displayMenuButton = false } = useAragonApi()
-  
+
   const { entries = [] } = appState
-  
+
   const createEntity = ({ address, name, type }) => {
-    api.addEntry(address, name, type)
+    api.addEntry(address, name, type).toPromise()
     closePanel()
   }
 
-  const removeEntity = (address) => {
-    api.removeEntry(address)
+  const removeEntity = address => {
+    api.removeEntry(address).toPromise()
   }
-  
+
   const newEntity = () => {
     setPanelVisible(true)
   }
-  
+
   const closePanel = () => {
     setPanelVisible(false)
   }
-
-  const handleResolveLocalIdentity = (address) => api.resolveAddressIdentity(address).toPromise()
 
-  const handleShowLocalIdentityModal = (address) => api.requestAddressIdentityModification(address).toPromise()
+  const handleResolveLocalIdentity = address =>
+    api.resolveAddressIdentity(address).toPromise()
+
+  const handleShowLocalIdentityModal = address =>
+    api.requestAddressIdentityModification(address).toPromise()
 
   return (
     <Main assetsUrl={ASSETS_URL}>

diff --git a/apps/address-book/package.json b/apps/address-book/package.json
@@ -29,8 +29,8 @@
     "test": "TRUFFLE_TEST=true npm run ganache-cli:test"
   },
   "dependencies": {
-    "@aragon/api": "1.1.0",
-    "@aragon/api-react": "1.0.0-beta.2",
+    "@aragon/api": "2.0.0-beta.5",
+    "@aragon/api-react": "2.0.0-beta.4",
     "@aragon/ui": "0.33.0",
     "@tps/ui": "^0.0.1",
     "prop-types": "^15.7.2",
@@ -40,18 +40,19 @@
     "web3-utils": "^1.0.0"
   },
   "devDependencies": {
-    "@tps/test-helpers": "^0.0.1",
     "@babel/core": "^7.4.5",
     "@babel/plugin-proposal-class-properties": "^7.4.4",
     "@babel/preset-env": "^7.4.5",
     "@babel/preset-react": "^7.0.0",
+    "@tps/test-helpers": "^0.0.1",
     "babel-eslint": "^10.0.1",
     "babel-plugin-styled-components": "^1.10.0",
     "eslint": "^5.16.0",
-    "eslint-plugin-jsx-a11y": "^6.2.1",
+    "eslint-config-prettier": "^6.0.0",
     "eslint-config-standard": "^12.0.0",
     "eslint-config-standard-react": "^7.0.2",
     "eslint-plugin-import": "^2.17.3",
+    "eslint-plugin-jsx-a11y": "^6.2.1",
     "eslint-plugin-node": "^9.1.0",
     "eslint-plugin-promise": "^4.1.1",
     "eslint-plugin-react": "^7.13.0",

diff --git a/apps/allocations/app/components/App/App.js b/apps/allocations/app/components/App/App.js
@@ -17,7 +17,7 @@ const App = () => {
   const { accounts = [], balances = [], entries = [], payouts = [] } = appState
 
   const onCreateAccount = ({ description }) => {
-    api.newAccount(description)
+    api.newAccount(description).toPromise()
     closePanel()
   }
 
@@ -36,12 +36,12 @@ const App = () => {
       period,
       balance,
       tokenAddress
-    )
+    ).toPromise()
     closePanel()
   }
 
   const onExecutePayout = (accountId, payoutId) => {
-    api.runPayout(accountId, payoutId)
+    api.runPayout(accountId, payoutId).toPromise()
   }
 
   const onNewAccount = () => {

diff --git a/apps/allocations/app/store/events.js b/apps/allocations/app/store/events.js
@@ -1,7 +1,6 @@
-import { initializeTokens, vaultLoadBalance } from './token'
+import { vaultLoadBalance } from './token'
 import { onFundedAccount, onNewAccount, onPayoutExecuted } from './account'
 import { onEntryAdded, onEntryRemoved } from './entry'
-import { INITIALIZATION_TRIGGER } from './'
 import { addressesEqual } from '../utils/web3-utils'
 
 export const handleEvent = async (state, event, settings) => {
@@ -11,9 +10,7 @@ export const handleEvent = async (state, event, settings) => {
 
   let nextAccounts, nextBoth
   let nextState = { ...state }
-  if (eventName === INITIALIZATION_TRIGGER) {
-    nextState = await initializeTokens(nextState, settings)
-  } else if (addressesEqual(eventAddress, vault.address)) {
+  if (addressesEqual(eventAddress, vault.address)) {
     // Vault event
     nextState = await vaultLoadBalance(nextState, event, settings)
   } else {

diff --git a/apps/allocations/app/store/index.js b/apps/allocations/app/store/index.js
@@ -1,4 +1,3 @@
 export { app } from './app'
 export { handleEvent } from './events'
 export { initialize } from './init'
-export const INITIALIZATION_TRIGGER = Symbol('INITIALIZATION_TRIGGER')
diff --git a/apps/allocations/app/store/init.js b/apps/allocations/app/store/init.js
@@ -1,8 +1,8 @@
 import AddressBookJSON from '../../../shared/json-abis/address-book.json'
-import { INITIALIZATION_TRIGGER, app, handleEvent } from './'
-import { of } from 'rxjs'
+import { app, handleEvent } from './'
 import { first } from 'rxjs/operators'
 
+import { initializeTokens } from './token'
 import vaultBalanceAbi from '../../../shared/json-abis/vault/vault-balance.json'
 import vaultGetInitializationBlockAbi from '../../../shared/json-abis/vault/vault-getinitializationblock.json'
 import vaultEventAbi from '../../../shared/json-abis/vault/vault-events.json'
@@ -73,13 +73,21 @@ const createStore = async settings => {
       // always return the state even unmodified
       return nextState
     },
-    [
-      of({ event: INITIALIZATION_TRIGGER }),
-      // handle address book events
-      // TODO: Start from AddrBook initialization block as Vault
-      settings.addressBook.contract.events(),
-      // handle vault events
-      settings.vault.contract.events(vaultInitializationBlock),
-    ]
+    {
+      externals: [
+        { contract: settings.addressBook.contract },
+        {
+          contract: settings.vault.contract,
+          initializationBlock: vaultInitializationBlock
+        },
+
+      ],
+      init: initState(settings)
+    }
   )
 }
+
+const initState = (settings) => async (cachedState) => {
+  const nextState = await initializeTokens(cachedState, settings)
+  return nextState
+}
diff --git a/apps/allocations/package.json b/apps/allocations/package.json
@@ -29,8 +29,8 @@
     "test": "TRUFFLE_TEST=true npm run ganache-cli:test"
   },
   "dependencies": {
-    "@aragon/api": "1.1.0",
-    "@aragon/api-react": "1.0.0-beta.2",
+    "@aragon/api": "2.0.0-beta.5",
+    "@aragon/api-react": "2.0.0-beta.4",
     "@aragon/apps-vault": "^4.1.0",
     "@aragon/ui": "0.33.0",
     "@babel/polyfill": "^7.2.5",
@@ -44,18 +44,19 @@
     "web3-utils": "^1.0.0"
   },
   "devDependencies": {
-    "@tps/test-helpers": "^0.0.1",
     "@babel/core": "^7.4.5",
     "@babel/plugin-proposal-class-properties": "^7.4.4",
     "@babel/preset-env": "^7.4.5",
     "@babel/preset-react": "^7.0.0",
+    "@tps/test-helpers": "^0.0.1",
     "babel-eslint": "^10.0.1",
     "babel-plugin-styled-components": "^1.10.0",
     "eslint": "^5.16.0",
-    "eslint-plugin-jsx-a11y": "^6.2.1",
+    "eslint-config-prettier": "^6.0.0",
     "eslint-config-standard": "^12.0.0",
     "eslint-config-standard-react": "^7.0.2",
     "eslint-plugin-import": "^2.17.3",
+    "eslint-plugin-jsx-a11y": "^6.2.1",
     "eslint-plugin-node": "^9.1.0",
     "eslint-plugin-promise": "^4.1.1",
     "eslint-plugin-react": "^7.13.0",

diff --git a/apps/dot-voting/app/Decisions.js b/apps/dot-voting/app/Decisions.js
@@ -73,7 +73,7 @@ class Decisions extends React.Component {
     return tokenAddress && this.props.app.external(tokenAddress, tokenAbi)
   }
   handleCreateVote = question => {
-    this.props.app.newVote(EMPTY_CALLSCRIPT, question)
+    this.props.app.newVote(EMPTY_CALLSCRIPT, question).toPromise()
     this.handleCreateVoteClose()
   }
   handleCreateVoteOpen = () => {
@@ -92,7 +92,7 @@ class Decisions extends React.Component {
     })
   }
   handleVote = (voteId, supports) => {
-    this.props.app.vote(voteId, supports)
+    this.props.app.vote(voteId, supports).toPromise()
     this.handleVoteClose()
   }
   handleVoteClose = () => {

diff --git a/apps/dot-voting/app/components/Panels/VotePanelContent.js b/apps/dot-voting/app/components/Panels/VotePanelContent.js
@@ -86,7 +86,7 @@ class VotePanelContent extends React.Component {
     this.props.onVote(this.props.vote.voteId, optionsArray)
   }
   executeVote = () => {
-    this.props.app.executeVote(this.props.vote.voteId)
+    this.props.app.executeVote(this.props.vote.voteId).toPromise()
     this.setState({ panel: { visible: false } })
   }
   loadUserBalance = () => {

diff --git a/apps/dot-voting/app/store/index.js b/apps/dot-voting/app/store/index.js
@@ -1,4 +1,3 @@
 export { app } from './app'
 export { handleEvent } from './events'
 export { initStore } from './init'
-export const INITIALIZATION_TRIGGER = Symbol('INITIALIZATION_TRIGGER')
diff --git a/apps/dot-voting/app/store/init.js b/apps/dot-voting/app/store/init.js
@@ -1,6 +1,5 @@
 import AddressBookJSON from '../../../shared/json-abis/address-book.json'
-import { INITIALIZATION_TRIGGER, app, handleEvent } from './'
-import { of } from 'rxjs'
+import { app, handleEvent } from './'
 
 export const initStore = addressBookAddress => {
   const addressBookApp = app.external(addressBookAddress, AddressBookJSON.abi)
@@ -30,10 +29,12 @@ export const initStore = addressBookAddress => {
       // always return the state even unmodified
       return state
     },
-    [
-      of({ event: INITIALIZATION_TRIGGER }),
-      // handle address book events
-      addressBookApp.events(),
-    ]
+    {
+      externals: [
+        {
+          contract: addressBookApp
+        }
+      ]
+    }
   )
 }
diff --git a/apps/dot-voting/package.json b/apps/dot-voting/package.json
@@ -29,8 +29,8 @@
     "test": "TRUFFLE_TEST=true npm run ganache-cli:test"
   },
   "dependencies": {
-    "@aragon/api": "1.1.0",
-    "@aragon/api-react": "1.0.0-beta.2",
+    "@aragon/api": "2.0.0-beta.5",
+    "@aragon/api-react": "2.0.0-beta.4",
     "@aragon/ui": "0.33.0",
     "@babel/polyfill": "^7.2.5",
     "@tps/apps-address-book": "^0.0.1",
@@ -45,18 +45,19 @@
     "web3-utils": "^1.0.0"
   },
   "devDependencies": {
-    "@tps/test-helpers": "^0.0.1",
     "@babel/core": "^7.4.5",
     "@babel/plugin-proposal-class-properties": "^7.4.4",
     "@babel/preset-env": "^7.4.5",
     "@babel/preset-react": "^7.0.0",
+    "@tps/test-helpers": "^0.0.1",
     "babel-eslint": "^10.0.1",
     "babel-plugin-styled-components": "^1.10.0",
     "eslint": "^5.16.0",
-    "eslint-plugin-jsx-a11y": "^6.2.1",
+    "eslint-config-prettier": "^6.0.0",
     "eslint-config-standard": "^12.0.0",
     "eslint-config-standard-react": "^7.0.2",
     "eslint-plugin-import": "^2.17.3",
+    "eslint-plugin-jsx-a11y": "^6.2.1",
     "eslint-plugin-node": "^9.1.0",
     "eslint-plugin-promise": "^4.1.1",
     "eslint-plugin-react": "^7.13.0",

diff --git a/apps/projects/package.json b/apps/projects/package.json
@@ -51,14 +51,15 @@
     "web3-utils": "^1.0.0"
   },
   "devDependencies": {
-    "@tps/test-helpers": "^0.0.1",
     "@babel/core": "^7.4.5",
     "@babel/plugin-proposal-class-properties": "^7.4.4",
     "@babel/preset-env": "^7.4.5",
     "@babel/preset-react": "^7.0.0",
+    "@tps/test-helpers": "^0.0.1",
     "babel-eslint": "^10.0.1",
     "babel-plugin-styled-components": "^1.10.0",
     "eslint": "^5.16.0",
+    "eslint-config-prettier": "^6.0.0",
     "eslint-config-standard": "^12.0.0",
     "eslint-config-standard-react": "^7.0.2",
     "eslint-plugin-import": "^2.17.3",