* Add build status badge * Add section about testing * Formatting
This commit is contained in:
parent
d6bbc441f8
commit
bb662e377c
21
README.md
21
README.md
@ -1,4 +1,5 @@
|
|||||||
[](https://www.npmjs.com/package/@kredits/contracts)
|
[](https://www.npmjs.com/package/@kredits/contracts)
|
||||||
|
[](https://drone.kosmos.org/kredits/contracts)
|
||||||
|
|
||||||
# Kredits Contracts
|
# Kredits Contracts
|
||||||
|
|
||||||
@ -26,27 +27,27 @@ To run a local development chain run:
|
|||||||
|
|
||||||
### Bootstrap
|
### Bootstrap
|
||||||
|
|
||||||
1. Run an EVM node and ipfs
|
1. Run an EVM node and ipfs
|
||||||
|
|
||||||
$ npm run devchain
|
$ npm run devchain
|
||||||
$ ipfs daemon
|
$ ipfs daemon
|
||||||
|
|
||||||
2. Compile contracts and build ABIs
|
2. Compile contracts and build ABIs
|
||||||
|
|
||||||
(compiled artifacts will be in `/artifacts`)
|
(compiled artifacts will be in `/artifacts`)
|
||||||
$ npm run build
|
$ npm run build
|
||||||
|
|
||||||
3. Deploy new upgradable contract proxies
|
3. Deploy new upgradable contract proxies
|
||||||
|
|
||||||
$ npm run deploy:dao
|
$ npm run deploy:dao
|
||||||
|
|
||||||
4. Execute seeds to create demo contributors, contributions, etc. (optional)
|
4. Execute seeds to create demo contributors, contributions, etc. (optional)
|
||||||
|
|
||||||
$ npm run seeds
|
$ npm run seeds
|
||||||
|
|
||||||
**Step 2-4 is also summarized in `npm run bootstrap`**
|
**Step 2-4 is also summarized in `npm run bootstrap`**
|
||||||
|
|
||||||
5. Show contract addresses
|
5. Show contract addresses
|
||||||
|
|
||||||
$ cat lib/addresses.json
|
$ cat lib/addresses.json
|
||||||
|
|
||||||
@ -56,6 +57,16 @@ If you need to fund development accounts with devchain coins:
|
|||||||
|
|
||||||
$ npm run fund # or hardhat fund --network localhost
|
$ npm run fund # or hardhat fund --network localhost
|
||||||
|
|
||||||
|
## Specs / Testing
|
||||||
|
|
||||||
|
With a local development chain running:
|
||||||
|
|
||||||
|
$ hardhat test
|
||||||
|
|
||||||
|
If you add or change contract code, please make sure to add and/or adapt tests
|
||||||
|
accordingly. Don't worry, it's easy! You can use existing tests as a template
|
||||||
|
for new ones.
|
||||||
|
|
||||||
## Contract architecture
|
## Contract architecture
|
||||||
|
|
||||||
We use the [OpenZeppelin hardhat
|
We use the [OpenZeppelin hardhat
|
||||||
|
Loading…
x
Reference in New Issue
Block a user