Merge pull request #2 from ConsenSys/feat/actors

tintinweb · web-flow · commit 6362c902587d · 2019-12-12T11:39:38.000+01:00
fromDAO: extract apps, distinguish apps from actors, fix name generation
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "aragraph",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Visualize your Aragon DAO Templates",
   "main": "index.js",
   "bin": "./src/index.js",
diff --git a/src/aragraph.js b/src/aragraph.js
@@ -10,10 +10,6 @@ const YAML = require('yaml');
 const fs = require('fs');
 const dao = require('./dao')
 
-const ARAAPPS = {
-    xvoting: "",
-}
-
 function graphNormalizeEntity(e){
     return e.trim().replace(/[-\s\`\[\]]+/g, '_').replace(/(^_)|(_$)/g, "");
 }
@@ -59,22 +55,23 @@ class AraApp {
         delete options.ref
         delete options.type
 
-
         this.options = options;
-        this.template = ARAAPPS[this.type];
-        if(!this.template){
-            this.template = `
+
+        this.template = `
 class %%ref%% {
-    {abstract}${this.type}
+    {abstract}%%type%%
 
     %%note%%
 }
-`;
-        }
+        `;
+    }
+    setTemplate(t){
+        this.template = t;
     }
     toString(){
         return this.template
             .replace("%%ref%%", graphNormalizeEntity(this.ref))
+            .replace("%%type%%", graphNormalizeEntity(this.type))
             .replace("%%note%%", Object.entries(this.options).map(([k,v]) => `\t**${k}** ${v}`).join('\n'));
     }
 }
@@ -105,10 +102,12 @@ package %%ref%% {
 }
 
 class AraGraph {
-    constructor(){
+    constructor(config){
         this.apps = {};
         this.tokens = {};
         this.permissionTuples = {};
+
+        this.config = config;
     }
 
     addPermission(p){
@@ -127,6 +126,9 @@ class AraGraph {
     addApp(a){
         let app = new AraApp(a.ref, a.type, a);
         this.apps[app.ref] = app; 
+        let template = this.config.plantuml.applicationTemplates[app.type ? graphNormalizeEntity(app.type.toLowerCase()) : "__default__"];
+        if(template)
+            app.setTemplate(template)
     }
 
     addToken(t){
@@ -152,16 +154,11 @@ class AraGraph {
                 uml.push(`${graphNormalizeEntity(a.ref)} <|-- ${graphNormalizeEntity(a.options.token)}`)
             }
         }
-
         
-
-        
-
         uml.push(`' -- permissions --`);
         for(let p of Object.values(this.permissionTuples)){
             uml.push(p.toString())
         }
-
         
         uml.push("\n@enduml")
         return uml.join('\n');
@@ -178,7 +175,10 @@ class AragonPermissions {
         let config_default = {
             plantuml : {
                 header: ["allowmixing", "skinparam handwritten true"],
-                applicationTemplates: {}
+                applicationTemplates: {
+                    _actor_: "actor %%ref%%",
+                    __default__: "class %%ref%% {\n    {abstract}%%type%%\n    ----\n    %%note%%\n}"
+                }
             }
         }
         
@@ -195,8 +195,14 @@ class AragonPermissions {
     }
 
     async fromDAO(daoAddress, chainId) {
-        const permissions = await dao.getPermissions(daoAddress, chainId)
-        this.data = {permissions: permissions, tokens: [], apps: [], actions: []}
+        const remoteDao = new dao.RemoteDao(daoAddress, chainId)
+
+        await remoteDao.load()
+
+        const permissions = remoteDao.getPermissions()
+        const apps = remoteDao.getApps()
+
+        this.data = {permissions: permissions, tokens: [], apps: apps, actions: []}
         return this;
     }
 
@@ -251,7 +257,7 @@ class AragonPermissions {
 
     uml(){
 
-        let g = new AraGraph();
+        let g = new AraGraph(this.config);
 
         for(let a of this.data.apps){
             g.addApp(a)
diff --git a/src/dao.js b/src/dao.js
@@ -1,3 +1,9 @@
+/** 
+ * @author github.com/tintinweb
+ * @license MIT
+ *
+ * */
+'use strict'
 const Web3 = require('web3')
 const Aragon = require('@aragon/wrapper').default
 const RxOp = require('rxjs/operators')
@@ -12,63 +18,104 @@ const ENS_REGISTRIES = {
 }
 const IPFS_GATEWAY_URL = 'https://ipfs.eth.aragon.network/ipfs'
 
-async function getPermissions(daoAddress, chainId) {
-    const dao = new Aragon(daoAddress, {
-        provider: new Web3.providers.WebsocketProvider(ETH_PROVIDERS[chainId]),
-        apm: {
-            ipfs: {
-                gateway: IPFS_GATEWAY_URL,
+class RemoteDao {
+
+    constructor(daoAddress, chainId){
+        this.daoAddress = daoAddress
+        this.chainId = chainId
+    }
+
+    async load(){
+        const dao = new Aragon(this.daoAddress, {
+            provider: new Web3.providers.WebsocketProvider(ETH_PROVIDERS[this.chainId]),
+            apm: {
+                ipfs: {
+                    gateway: IPFS_GATEWAY_URL,
+                },
+                ensRegistryAddress: ENS_REGISTRIES[this.chainId],
             },
-            ensRegistryAddress: ENS_REGISTRIES[chainId],
-        },
-    })
-    // Temporarily replace console.info
-    // to hide 'Redefining LocalForage driver: memoryStorageDriver' message
-    const consoleInfo = console.info
-    console.info = () => {}
-    await dao.init()
-    console.info = consoleInfo
+        })
+        // Temporarily replace console.info
+        // to hide 'Redefining LocalForage driver: memoryStorageDriver' message
+        const consoleInfo = console.info
+        console.info = () => {}
+        await dao.init()
+        console.info = consoleInfo
+
+        this.apps = await dao.apps
+            .pipe(RxOp.takeWhile((apps) => apps.length <= 1, true))
+            .toPromise()
+
+        this.permissions = await dao.permissions
+            .pipe(RxOp.takeWhile((permissions) => permissions.length <= 1, true))
+            .toPromise()
+
+        return this
+    }
 
-    // Get apps
-    const apps = await dao.apps
-        .pipe(RxOp.takeWhile((apps) => apps.length <= 1, true))
-        .toPromise()
-    const getAppName = (address) => {
-        const app = apps.find((app) => {
-            return address.toLowerCase() === app.proxyAddress
+    getApps(){
+        let apps = this.apps.map((app) => { 
+            return {ref: `${app.name} ${app.proxyAddress.toLowerCase().substring(0, 6)}`, type: app.name}
         })
-        const name = app ? app.name : 'Unknown'
-        return `${name} ${address.toLowerCase().substring(0, 6)}`
+        let appNamesRefs = apps.map(app => app.ref)
+
+        for(let p of this.getPermissions()){
+            if(appNamesRefs.indexOf(p.app) < 0){
+                apps.push({ref: p.app, type: '__actor__'})
+                appNamesRefs.push(p.app)
+            }
+            if(appNamesRefs.indexOf(p.grantee) < 0){
+                apps.push({ref: p.grantee, type: '__actor__'})
+                appNamesRefs.push(p.grantee)
+            }
+            if(appNamesRefs.indexOf(p.manager) < 0){
+                apps.push({ref: p.manager, type: '__actor__'})
+                appNamesRefs.push(p.manager)
+            }
+        }
+        return apps
     }
 
-    // Get roles
-    const allRoles = {}
-    apps.forEach((app) => {
-        app.roles.forEach((role) => {
-            allRoles[role.bytes] = role.id
+    getPermissions(){
+        // Get apps
+        const apps = this.apps
+        const getAppName = (address) => {
+            const app = apps.find((app) => {
+                return address.toLowerCase() === app.proxyAddress.toLowerCase()
+            })
+            const name = app ? app.name : 'Unknown'
+            return `${name} ${address.toLowerCase().substring(0, 6)}`
+        }
+
+        // Get roles
+        const allRoles = {}
+        apps.forEach((app) => {
+            app.roles.forEach((role) => {
+                allRoles[role.bytes] = role.id
+            })
         })
-    })
 
-    // Get permissions
-    const permissions = await dao.permissions
-        .pipe(RxOp.takeWhile((permissions) => permissions.length <= 1, true))
-        .toPromise()
+        // Get permissions
+        const permissions = this.permissions
 
-    const output = []
-    for (const [app, roles] of Object.entries(permissions)) {
-        for (const [roleHash, data] of Object.entries(roles)) {
-            const roleId = allRoles[roleHash] || 'Unknown'
-            data.allowedEntities.forEach((entity) => {
-                output.push({
-                    app: getAppName(app),
-                    role: roleId,
-                    grantee: getAppName(entity),
-                    manager: getAppName(data.manager),
+        const output = []
+        for (const [app, roles] of Object.entries(permissions)) {
+            for (const [roleHash, data] of Object.entries(roles)) {
+                const roleId = allRoles[roleHash] || 'Unknown'
+                data.allowedEntities.forEach((entity) => {
+                    output.push({
+                        app: getAppName(app),
+                        role: roleId,
+                        grantee: getAppName(entity),
+                        manager: getAppName(data.manager),
+                    })
                 })
-            })
+            }
         }
+        return output
     }
-    return output
+
+    
 }
 
-module.exports.getPermissions = getPermissions
+module.exports.RemoteDao = RemoteDao
diff --git a/src/index.js b/src/index.js
@@ -16,6 +16,11 @@ const argv = require('yargs') // eslint-disable-line
         default: 1,
         type: 'number',
     })
+    .option('t', {
+        alias: 'default-config',
+        default: false,
+        type: 'boolean',
+    })
     .demandCommand(1)
     .alias('c', 'config')
     .describe('c', 'path to configuration file')
@@ -29,15 +34,17 @@ let config = null;
 
 if(argv.config && argv.config.endsWith('.json')){
     config = JSON.parse(fs.readFileSync(argv.config));
+} else if (argv.defaultConfig) {
+    config = JSON.parse(fs.readFileSync(`${__dirname}/../templates/config.json`));
 }
 
 argv._.forEach(inp => {
     if(inp.endsWith(".yaml")){
-        console.log(new AragonPermissions().fromYaml(inp).uml());
+        console.log(new AragonPermissions(config).fromYaml(inp).uml());
     } else if(inp.endsWith(".md")){
-        console.log(new AragonPermissions().fromMarkdownTable(inp).uml())
+        console.log(new AragonPermissions(config).fromMarkdownTable(inp).uml())
     } else if(inp.startsWith('0x')){
-        new AragonPermissions().fromDAO(inp, argv.chainId).then((aragaph) => {
+        new AragonPermissions(config).fromDAO(inp, argv.chainId).then((aragaph) => {
             console.log(aragaph.uml())
             process.exit(0)
         })
diff --git a/templates/config.json b/templates/config.json
@@ -2,7 +2,19 @@
     "plantuml" : {
         "header": ["allowmixing", "skinparam handwritten true"],
         "applicationTemplates": {
-            "agent": ""
+            "_actor_": "actor %%ref%%",
+            "__default__": "class %%ref%% {\n    {abstract}%%type%%\n    ----\n    %%note%%\n}",
+            "acl": "class %%ref%% {\n    {abstract}%%type%%\n    ----\n    +{static}CREATE_PERMISSIONS\n    ----\n    %%note%%\n}",
+            "kernel": "class %%ref%% {\n    {abstract}%%type%%\n    ----\n    +{static}APP_MANAGER\n    ----\n    %%note%%\n}",
+            "evm_script_registry": "class %%ref%% {\n    {abstract}%%type%%\n    ----\n    +{static}REGISTRY_ADD_EXECUTOR\n    +{static}REGISTRY_MANAGER\n    ----\n    %%note%%\n}",
+            "agent": "class %%ref%% {\n    {abstract}%%type%%\n    ----\n    +{static}EXECUTE\n    +{static}SAFE_EXECUTE_ROLE\n    +{static}ADD_PROTECTED_TOKEN_ROLE\n    +{static}REMOVE_PROTECTED_TOKEN_ROLE\n    +{static}RUN_SCRIPT\n    +{static}ADD_PRESIGNED_HASH\n    +{static}DESIGNATE_SIGNER\n    ----\n    %%note%%\n}",
+            "finance": "class %%ref%% {\n    {abstract}%%type%%\n    ----\n    +{static}CREATE_PAYMENTS\n    +{static}CHANGE_PERIOD\n    +{static}CHANGE_BUDGETS\n    +{static}EXECUTE_PAYMENTS\n    +{static}MANAGE_PAYMENTS\n    ----\n    %%note%%\n}",
+            "voting": "class %%ref%% {\n    {abstract}%%type%%\n    ----\n    +{static}CREATE_VOTES\n    +{static}MODIFY_SUPPORT\n    +{static}MODIFY_QUORUM\n    ----\n    %%note%%\n}",
+            "token_manager": "class %%ref%% {\n    {abstract}%%type%%\n    ----\n    +{static}MINT\n    +{static}ISSUE\n    +{static}ASSIGN\n    +{static}REVOKE_VESTINGS\n    +{static}BURN\n    ----\n    %%note%%\n}",
+            "vault": "class %%ref%% {\n    {abstract}%%type%%\n    ----\n+{static}TRANSFER\n    ----\n    %%note%%\n}"
         }
     }
-}
+}
+
+
+

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "aragraph",`
`3`		`- "version": "0.0.4",`
	`3`	`+ "version": "0.0.5",`
`4`	`4`	`"description": "Visualize your Aragon DAO Templates",`
`5`	`5`	`"main": "index.js",`
`6`	`6`	`"bin": "./src/index.js",`