You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-10Lines changed: 18 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@
4
4
5
5
# Introduction
6
6
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.
8
8
9
-
## Related articles on medium
9
+
## Related articles
10
10
11
11
-[PoCo Series #1 — About Trust and Agents Incentives](https://medium.com/iex-ec/about-trust-and-agents-incentives-4651c138974c)
12
12
-[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
15
15
-[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)
16
16
-[PoCo Series #6 — Smart Contract Upgradeability and Governance](https://medium.com/iex-ec/poco-series-6-smart-contract-upgradeability-and-governance-68d2cdecd120)
17
17
-[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)
@@ -34,20 +39,23 @@ This repository contains the smart contract implementation of iExec's PoCo proto
34
39
-[iExec PoCo libraries](./docs/uml/class-uml-dir-libs.svg)
35
40
-[iExec PoCo modules (facets)](./docs/uml/class-uml-dir-facets.svg)
36
41
37
-
## Documentation
38
-
39
-
-[Solidity API documentation](./docs/solidity/index.md)
40
-
-[Full PoCo documentation](https://docs.iex.ec/protocol/proof-of-contribution)
41
-
42
42
## Audits
43
43
44
-
All contract audit files can be found in [audit/](./audit/) folder.
44
+
All contract audit files can be found in [audits/](./audits/) folder.
45
45
46
46
# How to?
47
47
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.
48
56
## Configure a deployment
49
57
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).
51
59
52
60
The configuration file is located in `./config/config.json`.
0 commit comments