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

44
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
@ -26,20 +27,20 @@ You can use `npm run install-all` to install all app dependencies at once.
### Local development chain ### Local development chain
For local development it is recommended to use For local development it is recommended to use
[ganache](http://truffleframework.com/ganache/) to run a local development [ganache](http://truffleframework.com/ganache/) to run a local development
chain. Using the ganache simulator no full Ethereum node is required. chain. Using the ganache simulator no full Ethereum node is required.
We use the default aragon-cli devchain command to confgure and run a local We use the default aragon-cli devchain command to confgure and run a local
development ganache. development ganache.
$ npm run devchain (or aragon devchain --port 7545) $ npm run devchain (or aragon devchain --port 7545)
To clear/reset the chain use: To clear/reset the chain use:
$ npm run devchain -- --reset (or aragon devchain --port 7545 --reset) $ npm run devchain -- --reset (or aragon devchain --port 7545 --reset)
We default to port 7545 for development to not get in conflict with the default We default to port 7545 for development to not get in conflict with the default
Ethereum RPC port. Ethereum RPC port.
### Bootstrap ### Bootstrap
@ -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)
@ -60,7 +60,7 @@ Ethereum RPC port.
$ npm run deploy:kit $ npm run deploy:kit
$ npm run deploy:dao $ npm run deploy:dao
4. Execute seeds to create demo contributors, contributons, etc. (optional) 4. Execute seeds to create demo contributors, contributons, etc. (optional)
$ npm run seeds $ npm run seeds
@ -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.
@ -163,7 +163,7 @@ Creates and configures a new DAO instance.
or or
$ npm run deploy:dao $ npm run deploy:dao
KreditsKit address is load from `lib/addresses/KreditsKit.json` or can be KreditsKit address is load from `lib/addresses/KreditsKit.json` or can be
configured through the `KREDITS_KIT` environment variable. configured through the `KREDITS_KIT` environment variable.
### deploy-apps.sh ### deploy-apps.sh
@ -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