Skip to content

Commit e1a9c1e

Browse files
author
gichiba
committed
amend docs with small requested changes
1 parent 1fb9ae3 commit e1a9c1e

File tree

4 files changed

+22
-18
lines changed

4 files changed

+22
-18
lines changed

docs/_Docs_GetStarted.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ It is possible to use `npm` instead of `yarn`, but you'll need to adapt any inst
3030

3131
In order to compile the colonyNetwork smart contracts, you will need to have Docker installed and running. We recommend using Docker Community Version `2.0.0.0`. You can find instructions for installing Docker here: [Docker Installation](https://docs.docker.com/install/).
3232

33-
The colonyNetwork smart contracts require the `ethereum/solc:0.5.6` Docker image, so we will need to pull it down before we can begin.
33+
The colonyNetwork smart contracts require the `ethereum/solc:0.5.8` Docker image, so we will need to pull it down before we can begin.
3434

3535
Make sure Docker is installed and then run the following command.
3636

@@ -94,12 +94,14 @@ Rather than import the entire set of contracts into remix, use the included `sol
9494
$ yarn flatten:contracts
9595
```
9696

97-
Alternatively, you can put them into the directory of your choice, e.g. `~/Downloads/`:
98-
```
99-
$ yarn steamroller /contracts/IColonyNetwork.sol > ~/Downloads/flatIColonyNetwork.sol
100-
```
97+
Navigate to `colonyNetwork/build/flattened/` to find the contracts you need to import to Remix.
98+
99+
In Remix, you'll need to instantiate `flatIColonyNetwork.sol` to the `ColonyNetwork` address `0x79073fc2117dD054FCEdaCad1E7018C9CbE3ec0B` in order to create a new colony.
100+
101+
Use the address of your existing ERC20 token contract to `createColony()`, then immidiately use `getColonyCount()` to get your colony's ID.
102+
103+
Call `getColony()` to get your colony's address from the ID, then instantiate `flatIColony.sol` to your colony's address in Remix.
101104

102-
Import the flattened contract into the remix IDE, and then call `createColony()`
103105

104106
### Access with the Truffle console
105107

@@ -120,17 +122,17 @@ $ yarn truffle console --network goerli
120122
```
121123
In the truffle console, instantiate the IColonyNetwork interface for `glider-rc.1`:
122124
```
123-
truffle(goerli)> let IColonyNetwork = await IColonyNetwork.at("0x79073fc2117dD054FCEdaCad1E7018C9CbE3ec0B")
125+
truffle(goerli)> let colonyNetwork = await IColonyNetwork.at("0x79073fc2117dD054FCEdaCad1E7018C9CbE3ec0B")
124126
125127
```
126128
From here, you can create a new colony (with an ERC20 token already deployed):
127129
```
128-
truffle(goerli)> IColonyNetwork.createColony("your-erc20-token-address")
130+
truffle(goerli)> await IColonyNetwork.createColony("your-erc20-token-address")
129131
```
130132
And find your colony's id (the newest created colony) after the transaction is mined:
131133
```
132134
133-
truffle(goerli)> IColonyNetwork.getColonyCount()
135+
truffle(goerli)> await IColonyNetwork.getColonyCount()
134136
```
135137
### Local Development and Testing
136138

@@ -139,13 +141,16 @@ You can start a local test node and deploy the contracts yourself using the loca
139141
```
140142
yarn run start:blockchain:client
141143
142-
./node_modules/.bin/truffle migrate --reset --compile-all
144+
yarn truffle migrate --reset --compile-all
143145
```
144146

145-
To deploy all contracts and run all tests, run the following command.
146-
147+
To deploy all contracts and run all contract tests:
148+
```
149+
yarn test:contracts
150+
```
151+
To deploy all contracts and run all reputation mining tests:
147152
```
148-
yarn run test:contracts
153+
yarn test:reputation
149154
```
150155

151156
For more detailed instructions, and additional steps required to set up an environment for use with [colonyJS](https://github.com/JoinColony/colonyJS), check out the colonyJS [Local Setup](/colonyjs/intro-local-setup/) documentation.

docs/_Docs_ReputationMining.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ section: Docs
44
order: 6
55
---
66

7-
The reputation mining client is usable for testing but it has limited functionality. Still, it is possible to run a single miner instance for usable reputation scores on a local test network.
7+
## Local Network
88

99
### Start Mining Client
1010

docs/_bug_rules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Once submitted, the issue will be responded to, verified, accepted, and rewarded
4444
### Submission Branches
4545
Participants in the program are free to submit bugs on two different branches in the colonyNetwork codebase:
4646
* the current testnet release (tagged on the `develop` branch) and deployed to Görli
47-
* against the `master` branch where we merge ongoing work
47+
* against the `master` branch which will be tagged as the mainnet release for deployment
4848

4949
### Bug Severity and Bounties
5050
In the same manner as the [Ethereum Bug Bounty Program](https://bounty.ethereum.org/), submissions will be evaluated by the Colony team according to the [OWASP risk rating methodology](https://www.owasp.org/index.php/OWASP_Risk_Rating_Methodology), which grades based on both _Impact_ and _Likelihood_.

package.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,8 @@
1818
"provision:token:contracts": "truffle compile && truffle compile --contracts_directory 'lib/dappsys/[!note][!stop][!proxy][!thing][!token]*.sol' && bash ./scripts/provision-token-contracts.sh",
1919
"start:blockchain:client": "bash ./scripts/start-blockchain-client.sh",
2020
"stop:blockchain:client": "bash ./scripts/stop-blockchain-client.sh",
21-
"test:contracts": "npm run start:blockchain:client & truffle migrate --reset --compile-all && truffle test ./test/contracts-network/* --network development",
22-
"test:reputation": "npm run start:blockchain:client & truffle migrate --reset --compile-all && nyc truffle test ./test/reputation-system/* --network development",
23-
"flatten:contracts": "mkdir -p ./build/flattened/ && steamroller contracts/IColonyNetwork.sol > build/flattened/flatIColonyNetwork.sol && steamroller contracts/IColony.sol > build/flattened/flatIColony.sol",
21+
"flatten:contracts": "mkdir -p ./build/flattened/ && steamroller contracts/IColonyNetwork.sol > build/flattened/flatIColonyNetwork.sol && steamroller contracts/IColony.sol > build/flattened/flatIColony.sol && steamroller contracts/IReputationMiningCycle.sol > build/flattened/flatIReputationMiningCycle.sol && steamroller contracts/IMetaColony.sol > build/flattened/flatIMetaColony.sol && steamroller contracts/IRecovery.sol > build/flattened/flatIRecovery.sol && steamroller contracts/IEtherRouter.sol > build/flattened/flatIEtherRouter.sol",
22+
"test:contracts": "npm run start:blockchain:client & truffle migrate --reset --compile-all && truffle test --network development",
2423
"test:contracts:upgrade:parity": "npm run start:blockchain:client parity & npm run generate:test:contracts && truffle migrate --reset --compile-all && truffle test ./test-upgrade/* --network integration",
2524
"test:contracts:upgrade:ganache": "npm run start:blockchain:client & npm run generate:test:contracts && truffle migrate --reset --compile-all && truffle test ./test-upgrade/* --network development",
2625
"test:contracts:gasCosts": "npm run start:blockchain:client & truffle migrate --reset --compile-all && truffle test test-gas-costs/gasCosts.js --network development",

0 commit comments

Comments
 (0)