Skip to content

Commit 45e8e24

Browse files
authored
docs: Add resources section to README (#273)
1 parent d75e65e commit 45e8e24

File tree

6 files changed

+25
-12
lines changed

6 files changed

+25
-12
lines changed

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
# Introduction
66

7-
This repository contains the smart contract implementation of iExec's PoCo protocol.
7+
This repository contains the smart contract implementation of iExec's Proof of Contribution protocol.
88

9-
## Related articles on medium
9+
## Related articles
1010

1111
- [PoCo Series #1 — About Trust and Agents Incentives](https://medium.com/iex-ec/about-trust-and-agents-incentives-4651c138974c)
1212
- [PoCo Series #2 — On the use of staking to prevent attacks](https://medium.com/iex-ec/poco-series-2-on-the-use-of-staking-to-prevent-attacks-2a5c700558bd)
@@ -15,9 +15,14 @@ This repository contains the smart contract implementation of iExec's PoCo proto
1515
- [PoCo Series #5 — Open decentralized brokering on the iExec platform](https://medium.com/iex-ec/poco-series-5-open-decentralized-brokering-on-the-iexec-platform-67b266e330d8)
1616
- [PoCo Series #6 — Smart Contract Upgradeability and Governance](https://medium.com/iex-ec/poco-series-6-smart-contract-upgradeability-and-governance-68d2cdecd120)
1717
- [PoCo Series #8 — Future-proofing iExec - Smart Contract Interoperability and Modularity](https://medium.com/iex-ec/poco-series-8-future-proofing-iexec-smart-contract-interoperability-and-modularity-37a3d3613f11)
18+
- [iExec PoCo v6 — Building the diamond foundation](https://www.iex.ec/news/iexec-poco-v6-building-the-diamond-foundation)
1819

19-
## PoCo UMLs
20+
## Documentation
21+
22+
- [Protocol documentation](https://docs.iex.ec/protocol/proof-of-contribution)
23+
- [Solidity API documentation](./docs/solidity/index.md)
2024

25+
### UML and storage diagrams
2126
- [Contracts and Actors Architecture](./docs/README.md#contracts-and-actors-architecture)
2227
- [State diagrams](./docs/Statuses.md)
2328
- [Nominal workflow sequence](./docs/README.md#nominal)
@@ -34,20 +39,23 @@ This repository contains the smart contract implementation of iExec's PoCo proto
3439
- [iExec PoCo libraries](./docs/uml/class-uml-dir-libs.svg)
3540
- [iExec PoCo modules (facets)](./docs/uml/class-uml-dir-facets.svg)
3641

37-
## Documentation
38-
39-
- [Solidity API documentation](./docs/solidity/index.md)
40-
- [Full PoCo documentation](https://docs.iex.ec/protocol/proof-of-contribution)
41-
4242
## Audits
4343

44-
All contract audit files can be found in [audit/](./audit/) folder.
44+
All contract audit files can be found in [audits/](./audits/) folder.
4545

4646
# How to?
4747

48+
## Resources
49+
50+
* **NPM Package**: all contract ABIs, source code, and deployment artifacts (with addresses) are bundled in the [@iexec/poco](https://www.npmjs.com/package/@iexec/poco) package.
51+
* **ABIs**: available in the `abis/` folder of this repository and in the NPM package (`/abis`).
52+
* **Deployment addresses**: published in the `deployments/` folder of this repository and in the NPM package (`/deployments/<chain>`).
53+
* **Artifacts**: ⚠️ DEPRECATED and replaced by `abis`. This will be removed in future versions.
54+
55+
Note: `abis/` folder contains the most up to date version of the ABIs even before deployment on live networks.
4856
## Configure a deployment
4957

50-
Starting from version 5, the PoCo uses a modular design based on [ERC-2535](https://eips.ethereum.org/EIPS/eip-2535). The migration scripts and tests will use different modules (facets) and deployment process depending on the required configuration. In particular, the configuration can use a [create2 factory](https://github.com/iExecBlockchainComputing/iexec-solidity/blob/master/contracts/Factory/GenericFactory.sol) for the deployment, and enable native token or ERC20 token based escrow depending on the targeted blockchain. This means that the codebase is the same on public blockchains (ERC20 based RLC) and dedicated sidechains (Native token based RLC).
58+
Starting from version 5, the PoCo uses a modular design based on [ERC-2535](https://eips.ethereum.org/EIPS/eip-2535). Tests and deployment scripts will use different modules (facets) and deployment process depending on the required configuration. In particular, the configuration can use a [create2 factory](https://github.com/iExecBlockchainComputing/iexec-solidity/blob/master/contracts/Factory/GenericFactory.sol) for the deployment, and enable native token or ERC20 token based escrow depending on the targeted blockchain. This means that the codebase is the same on public blockchains (ERC20 based RLC) and dedicated sidechains (Native token based RLC).
5159

5260
The configuration file is located in `./config/config.json`.
5361

File renamed without changes.

audit/v5.5/Audit_Poco_and_Voucher_Contracts_2025-01.pdf renamed to audits/v5.5/Audit_Poco_and_Voucher_Contracts_2025-01.pdf

File renamed without changes.

package.json

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,14 @@
3333
"!/contracts/tools/testing/**/*",
3434
"!/contracts/tools/diagrams/**/*",
3535
"!/contracts/tools/TimelockController/**/*",
36-
"/deployments"
36+
"/deployments",
37+
"/artifacts/contracts",
38+
"!/artifacts/contracts/**/*.dbg.json"
39+
],
40+
"__filesComment": [
41+
"!!! @dev Update Hardhat `abis` task if this is updated",
42+
"TODO remove artifacts/ from NPM package when releasing a major version"
3743
],
38-
"__filesComment": "!!! @dev Update Hardhat `abis` task if this is updated",
3944
"lint-staged": {
4045
"*.{js,ts,sol,json,yml}": [
4146
"prettier --write"

0 commit comments

Comments
 (0)