Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ConsenSys/aragraph
Visualize your Aragon DAO Templates
https://github.com/ConsenSys/aragraph
aragon blockchain dao ethereum organizations security-tools
Last synced: 3 months ago
JSON representation
Visualize your Aragon DAO Templates
- Host: GitHub
- URL: https://github.com/ConsenSys/aragraph
- Owner: Consensys
- License: mit
- Created: 2019-09-09T10:59:49.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-24T13:22:55.000Z (4 months ago)
- Last Synced: 2024-07-10T12:47:41.346Z (4 months ago)
- Topics: aragon, blockchain, dao, ethereum, organizations, security-tools
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/aragraph
- Size: 843 KB
- Stars: 29
- Watchers: 5
- Forks: 13
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-dao-zh - AraGraph - Aragon DAO 權限關係視覺化 (DAO 工具)
- awesome-hacking-lists - ConsenSys/aragraph - Visualize your Aragon DAO Templates (JavaScript)
README
[
](https://diligence.consensys.net)
[[ 🌐 ](https://diligence.consensys.net) [ 📩 ](mailto:[email protected]) [ 🔥 ](https://consensys.github.io/diligence/)]
# AraGraph
[This blog post](https://diligence.consensys.net/blog/2019/11/aragraph-dao-permissions-visualized/) is a good introduction to AraGraph.
AraGraph is a tool to generate nice looking permission graphs for Aragon DAOs. It can take the following inputs:
- The address and chain-ID of a live DAO.
- A DAO template description file (`yaml`).
- A specification in Markdown table format.
The tool generates an UML description for the DAO. Use [Plantuml](http://plantuml.com/) to render it.
**install**
`$ npm install -g aragraph`
## CLI
**generate for a live DAO on mainnet**
`$ aragraph 0x2dE83b50Af29678774D5AbC4a7Cb2a588762f28C --chain-id 1 > dao.plantuml `
**generate from yaml description**
`$ aragraph ./examples/company.yaml > dao.plantuml `
**generate from markdown**
`$ aragraph ./examples/aragon_company_README.md > dao.plantuml `
**Render**
`$ java -jar plantuml.jar dao.plantuml`
or open with [vscode-PlantUML](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml)
### Config / Templating
AraGraph allows you to template certain apps to enrich them with even more context like available Roles, Methods, static security information. See [templates/config.json](https://github.com/ConsenSys/aragraph/blob/master/templates/config.json) for details.
You can either provide you own `config.json`:
`$ aragraph 0x2dE83b50Af29678774D5AbC4a7Cb2a588762f28C --config config.json `
Or use the [config.json](https://github.com/ConsenSys/aragraph/blob/master/templates/config.json) provided with this package:
`$ aragraph 0x2dE83b50Af29678774D5AbC4a7Cb2a588762f28C --default-config `
## Library
### for a live DAO on mainnet
[Example: DAO-Kernel on mainnet](https://etherscan.io/address/0x2dE83b50Af29678774D5AbC4a7Cb2a588762f28C#code)
```js
new AragonPermissions().fromDAO(address, chainId).then((aragaph) => {
console.log(aragaph.uml())
process.exit(0)
})
```
### from DAO description files (yaml)
[Specification: DAO-Templates/Descriptor](https://github.com/aragon/dao-templates/tree/master/descriptor)
[Example: Company.yaml](https://github.com/aragon/dao-templates/blob/cc1eb1174a13c6d5ed0fcc1bbcc9d21bf9137a84/descriptor/examples/company.yaml)
```js
const AragonPermissions = require("./AragonPermissions.js");
console.log(new AragonPermissions().fromYaml('./examples/company.yaml').uml())
```
### from markdown table
[Example: Readme.md](https://github.com/aragon/dao-templates/blob/master/templates/company/README.md)
```js
const AragonPermissions = require("./AragonPermissions.js");
const input = `
| App | Permission | Grantee | Manager |
|-------------------|-----------------------|---------------|---------|
| Kernel | APP_MANAGER | Voting | Voting |
| ACL | CREATE_PERMISSIONS | Voting | Voting |
| EVMScriptRegistry | REGISTRY_MANAGER | Voting | Voting |
| EVMScriptRegistry | REGISTRY_ADD_EXECUTOR | Voting | Voting |
| Voting | CREATE_VOTES | Token Manager | Voting |
| Voting | MODIFY_QUORUM | Voting | Voting |
| Voting | MODIFY_SUPPORT | Voting | Voting |
| Agent or Vault | TRANSFER | Finance | Voting |
| Finance | CREATE_PAYMENTS | Voting | Voting |
| Finance | EXECUTE_PAYMENTS | Voting | Voting |
| Finance | MANAGE_PAYMENTS | Voting | Voting |
| Token Manager | MINT | Voting | Voting |
| Token Manager | BURN | Voting | Voting |
| Agent | RUN_SCRIPT | Voting | Voting |
| Agent | EXECUTE | Voting | Voting |
| Finance | CREATE_PAYMENTS | Payroll | Voting |
| Payroll | ADD_BONUS_ROLE | EOA or Voting | Voting |
| Payroll | ADD_EMPLOYEE_ROLE | EOA or Voting | Voting |
| Payroll | ADD_REIMBURSEMENT_ROLE | EOA or Voting | Voting |
| Payroll | TERMINATE_EMPLOYEE_ROLE | EOA or Voting | Voting |
| Payroll | SET_EMPLOYEE_SALARY_ROLE | EOA or voting | Voting |
| Payroll | MODIFY_PRICE_FEED_ROLE | Voting | Voting |
| Payroll | MODIFY_RATE_EXPIRY_ROLE | Voting | Voting |
| Payroll | MANAGE_ALLOWED_TOKENS_ROLE | Voting | Voting |
`;
console.log(new AragonPermissions().fromMarkdownTable(input).uml())
```
# Contributors 🤗
* [Kirill Goncharov](https://github.com/xuhcc) - [#1 (generate from mainnet)](https://github.com/ConsenSys/aragraph/pull/1)