From d93d73637095e87d775866bc2e3739d0c5d98105 Mon Sep 17 00:00:00 2001 From: Sebastian Kippe Date: Thu, 14 Jul 2022 14:06:08 +0200 Subject: [PATCH] Formatting --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 98fb617..6043ea1 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ # Kredits Contracts -This repository contains the Solidity smart contracts and the JavaScript API wrapper for [Kosmos -Kredits](https://wiki.kosmos.org/Kredits). +This repository contains the Solidity smart contracts and the JavaScript API +wrapper for [Kosmos Kredits](https://wiki.kosmos.org/Kredits). ## Development @@ -58,18 +58,23 @@ If you need to fund development accounts with devchain coins: ## Contract architecture -We use the [OpenZeppelin hardhat proxy](https://www.npmjs.com/package/@openzeppelin/hardhat-upgrades) for deploying and managing upgradeable contracts. (see `scripts/create-proxy.js`) +We use the [OpenZeppelin hardhat +proxy](https://www.npmjs.com/package/@openzeppelin/hardhat-upgrades) for +deploying and managing upgradeable contracts. (see `scripts/create-proxy.js`) -Each contract is independent and is connected to its dependencies by storing the addresses of the other contracts. +Each contract is independent and is connected to its dependencies by storing +the addresses of the other contracts. ## Helper scripts `scripts/` contains some helper scripts to interact with the contracts from the CLI. _At some point these should be moved into a real nice CLI._ -To run these scripts use `hardhat run`. For example: `hardhat run scripts/list-contributors.js --network localhost`. (NOTE: add `--network localhost` or the network you want to use) +To run these scripts use `hardhat run`. For example: `hardhat run +scripts/list-contributors.js --network localhost`. (NOTE: add `--network +localhost` or the network you want to use) -Some scripts are also defined as npm script, see package.json. +Some scripts are also defined as npm script, see `package.json`. ### repl/console @@ -104,7 +109,8 @@ All contract addresses are stored in `lib/addresses.json` ## Upgradeable contracts -We use OpenZeppelin for an upgradeable contracts: [https://www.npmjs.com/package/@openzeppelin/hardhat-upgrades](https://www.npmjs.com/package/@openzeppelin/hardhat-upgrades) +We use OpenZeppelin for an upgradeable contracts: +[https://www.npmjs.com/package/@openzeppelin/hardhat-upgrades](https://www.npmjs.com/package/@openzeppelin/hardhat-upgrades) Refer to the OpenZeppelin README and `scripts/create-proxy.js` @@ -112,7 +118,6 @@ Refer to the OpenZeppelin README and `scripts/create-proxy.js` For an upgrade example checkout `scripts/upgrade-example.js` - ## Known Issues When resetting ganache Metamask might have an invalid transaction nonce and