kredits/contracts
kredits/contracts
9
1
Fork 0
Code Issues 21 Pull Requests Actions Projects 1 Releases 8 Activity

Formatting, whitespace

Browse Source
This commit is contained in:
Basti 2019-04-09 12:45:20 +02:00
parent 096a9f3cea
commit f5564fa923
No known key found for this signature in database
GPG Key ID: BE4634D632D39B67
1 changed files with 21 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -2,12 +2,13 @@
# Kredits Contracts # Kredits Contracts
This repository contains the Solidity smart contracts organized as [Aragon](https://hack.aragon.org/) This repository contains the Solidity smart contracts organized as
apps and JavaScript API wrapper for [Kosmos Kredits](https://wiki.kosmos.org/Kredits). [Aragon](https://hack.aragon.org/) apps and JavaScript API wrapper for [Kosmos
Kredits](https://wiki.kosmos.org/Kredits).
It is based on [aragonOS](https://hack.aragon.org/docs/aragonos-intro.html) and It is based on [aragonOS](https://hack.aragon.org/docs/aragonos-intro.html) and
follows the aragonOS conventions. follows the aragonOS conventions. Aragon itself uses the [Truffle
Aragon itself uses the [Truffle framework](http://truffleframework.com/) for some things. framework](http://truffleframework.com/) for some things.
## Development ## Development
@ -49,7 +50,6 @@ Ethereum RPC port.
$ npm run devchain $ npm run devchain
$ ipfs daemon $ ipfs daemon
2. Deploy each app to the devchain 2. Deploy each app to the devchain
(make sure you've run `npm install` for every app - see installation) (make sure you've run `npm install` for every app - see installation)
@ -73,15 +73,15 @@ If you want to reset your local setup:
## Contract architecture ## Contract architecture
Contracts are organized in independent apps (see `/apps`) and are developed Contracts are organized in independent apps (see `/apps`) and are developed and
and deployed independently. Each app has a version and can be "installed" deployed independently. Each app has a version and can be "installed" on the
on the Kredits DAO independently. Kredits DAO independently.
![](docs/kredits-diagram.png) ![](docs/kredits-diagram.png)
A DAO can be deployed using the `scripts/deploy-kit.js` script or with the A DAO can be deployed using the `scripts/deploy-kit.js` script or with the `npm
`npm run deploy:dao` command. This deploys a new Kredits DAO, installs run deploy:dao` command. This deploys a new Kredits DAO, installs the latest
the latest app versions and sets the required permissions. app versions and sets the required permissions.
See each app in `/apps/*` for details. See each app in `/apps/*` for details.
@ -174,14 +174,12 @@ Runs `npm install` for each app and publishes a new version.
or or
$ npm run deploy:apps $ npm run deploy:apps
## ACL / Permissions ## ACL / Permissions
## Upgradeable contracts ## Upgradeable contracts
We use aragonOS for upgradeablity of the different contracts. We use aragonOS for upgradeablity of the different contracts. Refer to the
Refer to the [aragonOS upgradeablity documentation](https://hack.aragon.org/docs/upgradeability-intro) [aragonOS upgradeablity documentation](https://hack.aragon.org/docs/upgradeability-intro)
for more details. for more details.
### Example ### Example