Skip to content

Commit 2aa93e7

Browse files
committed
docs: Update readme & clean
1 parent 0663e7c commit 2aa93e7

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ This repository contains the smart contract implementation of iExec's PoCo proto
3737
## Documentation
3838

3939
- [Solidity API documentation](./docs/solidity/index.md)
40+
<!-- TODO update with new documentation URL -->
4041
- [Full PoCo documentation](https://protocol.docs.iex.ec/key-concepts/proof-of-contribution)
4142

4243
## Audits
@@ -71,15 +72,15 @@ If you want to deploy the iExec PoCo V5 smart contracts on a new blockchain, the
7172
## Additional configuration & environment variables
7273

7374
Environment variable can be used to alter the configuration of a deployment:
74-
- **SALT**: if set, the `SALT` envvar will overwrite the salt parameter from the config. This can be useful to distinguish different deployments without modifying the config.
75+
- **SALT**: if set, the `SALT` env var will overwrite the salt parameter from the config. This can be useful to distinguish different deployments without modifying the config.
7576

7677
Additionally, the migration process will look for some smart contracts before deploying new instances. This is true of the application, dataset and workerpool registries. Thus, if different marketplaces are deployed to the same network, they will share these registries.
7778

7879
# Development
7980

8081
## Build
8182

82-
The PoCo smart contracts are in the `./contracts` folder. Json artifacts, containing the contracts bytecode and ABI can be found in the `./build` folder. In case you need to regenerate them, you can use the following command:
83+
The PoCo smart contracts are in the `contracts/` folder. Json artifacts, containing the contracts bytecode and ABI can be found in the `artifacts/` folder. In case you need to regenerate them, you can use the following command:
8384
```
8485
npm install
8586
npm run build
@@ -116,7 +117,7 @@ The automatic testing command uses the Hardhat network by default to run the tes
116117
If your blockchain listen to a port that is not 8545, or if the blockchain is on a different node, update the `hardhat.config.ts` configuration (network ports, accounts with mnemonic, ..) accordingly to the [Hardhat Configuration](https://hardhat.org/hardhat-runner/docs/config) documentation.
117118
3. Run tests
118119
```
119-
npm run test
120+
npm run test -- --network <networkUrl>
120121
```
121122
122123
## Deploy
@@ -125,7 +126,7 @@ The iExec PoCo contracts support automated deployment through both command-line
125126
126127
### Command Line Deployment
127128
128-
You can deploy the smart contracts according to the [deploy/0_deploy.ts](./deploy/0_deploy.ts) content. This will automatically save some addresses of the deployed artifacts to the `./deployments` folder.
129+
You can deploy the smart contracts according to the [deploy/0_deploy.ts](./deploy/0_deploy.ts) content. This will automatically save addresses of the deployed artifacts to `deployments/` folder.
129130
130131
To deploy using the CLI:
131132
@@ -134,7 +135,7 @@ To deploy using the CLI:
134135
3. Run the deployment using:
135136
136137
```
137-
npx hardhat deploy --network <your network name>
138+
npm run deploy -- --network <your network name>
138139
```
139140
140141
Example with custom salt:
@@ -144,12 +145,12 @@ SALT=0x0000000000000000000000000000000000000000000000000000000000000001 npx hard
144145
```
145146
146147
147-
### Manual Verification
148+
### Verification
148149
149-
To manually verify contracts:
150+
To verify contracts:
150151
151152
```
152-
npx hardhat run ./scripts/verify.ts --network <your network name>
153+
npm run verify:all -- --network <your network name> # e.g. arbitrum
153154
```
154155
155156
This script automatically reads all deployed contract addresses and their constructor arguments from the deployment artifacts and verifies them on the relevant block explorer.
@@ -169,19 +170,19 @@ To render all UML diagrams:
169170
npm run uml
170171
```
171172
172-
### Render only class diagrams
173+
To render only class diagrams:
173174
174175
```
175176
npm run sol-to-uml
176177
```
177178
178-
### Render only .puml files
179+
To render only .puml files:
179180
180181
```
181182
npm run puml-to-links
182183
```
183184
184-
### Render only storage diagrams
185+
To render only storage diagrams:
185186
186187
```
187188
npm run storage-to-diagrams

hardhat.config.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -265,9 +265,9 @@ const config: HardhatUserConfig = {
265265
'external',
266266
'facets/FacetBase.sol', // duplicated in FacetBase.v8.sol
267267
'facets/IexecAccessorsABILegacyFacet.sol', // not relevant
268-
// 'facets/IexecERC20Core.sol', // contains only internal/private but kept for events.
268+
// kept for events 'facets/IexecERC20Core.sol', // contains only internal/private
269269
'facets/IexecEscrowTokenSwapFacet.sol', // not relevant
270-
// 'facets/IexecEscrow.v8.sol', // contains only internal/private but kept for events.
270+
// kept for events 'facets/IexecEscrow.v8.sol', // contains only internal/private
271271
'facets/IexecPocoCommon.sol', // contains only internal/private
272272
'facets/SignatureVerifier.sol', // contains only internal/private
273273
'facets/SignatureVerifier.v8.sol',

0 commit comments

Comments
 (0)