Skip to content

Commit e4c8460

Browse files
committed
Add Proof of Contribution documentation and worker management guides
- Introduced a comprehensive documentation for the Proof of Contribution (PoCo) protocol, detailing its objectives, workflow, and consensus mechanism. - Added a section on managing workerpool access, including how to deploy a workerpool, publish and remove orders, and manage monetization rules. - Created a quick start guide for workers, outlining the steps to connect to a workerpool, start a worker, and wallet restrictions.
1 parent 3828cb9 commit e4c8460

22 files changed

+1599
-108
lines changed

.vitepress/sidebar.ts

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -534,15 +534,39 @@ export function getSidebar() {
534534
text: 'PROTOCOL',
535535
items: [
536536
{
537-
text: '🔧  iExec SDK',
537+
text: '🔧 iExec SDK',
538538
link: '/documentation/protocol/sdk',
539539
},
540540
{
541-
text: '⚙️  Workers & Workerpools',
542-
link: '/documentation/protocol/workers',
541+
text: '⚙️ Workers & Workerpools',
542+
collapsed: true,
543+
items: [
544+
{
545+
text: '🚀 Worker Quick Start',
546+
link: '/documentation/protocol/worker/quick-start',
547+
},
548+
{
549+
text: '🔒 Manage Workerpool Access',
550+
link: '/documentation/protocol/worker/manage-access',
551+
},
552+
],
553+
},
554+
{
555+
text: '⚙️ PoCo',
556+
collapsed: true,
557+
items: [
558+
{
559+
text: '� Pay Per Task Model',
560+
link: '/documentation/protocol/poco/pay-per-task',
561+
},
562+
{
563+
text: '🛡️ Proof of Contribution',
564+
link: '/documentation/protocol/poco/proof-of-contribution',
565+
},
566+
],
543567
},
544568
{
545-
text: '📖  Glossary',
569+
text: '�📖 Glossary',
546570
link: '/documentation/protocol/glossary',
547571
},
548572
],

src/documentation/build-iapp/guides/debugging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ except Exception as e:
169169

170170
Continue improving your iApps:
171171

172-
- **[Inputs and Outputs](/documentation/build-iapp/guides/inputs-and-outputs)** - Handle data
173-
in TEE
172+
- **[Inputs and Outputs](/documentation/build-iapp/guides/inputs-and-outputs)** -
173+
Handle data in TEE
174174
- **[How to Get and Decrypt Results](/documentation/build-iapp/guides/how-to-get-and-decrypt-results)** -
175175
Retrieve results

src/documentation/build-iapp/guides/how-to-get-and-decrypt-results.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -300,15 +300,16 @@ iexec task show <taskId>
300300

301301
Integrate result handling into your applications:
302302

303-
- **[Inputs and Outputs](/documentation/build-iapp/guides/inputs-and-outputs)** - Understand
304-
what your iApp can output
303+
- **[Inputs and Outputs](/documentation/build-iapp/guides/inputs-and-outputs)** -
304+
Understand what your iApp can output
305305
- **[Debugging Your iApp](/documentation/build-iapp/guides/debugging)** -
306306
Troubleshoot execution issues
307-
- **[App Access Control and Pricing](/documentation/build-iapp/guides/manage-access)** - Control who
308-
can run your iApp
307+
- **[App Access Control and Pricing](/documentation/build-iapp/guides/manage-access)** -
308+
Control who can run your iApp
309309

310310
### Advanced Topics
311311

312-
- **[DataProtector SDK](/documentation/manage-data/dataProtector)** - Complete SDK
313-
documentation
314-
- **[SDK Deep Dive](/documentation/protocol/sdk)** - Advanced result handling techniques
312+
- **[DataProtector SDK](/documentation/manage-data/dataProtector)** - Complete
313+
SDK documentation
314+
- **[SDK Deep Dive](/documentation/protocol/sdk)** - Advanced result handling
315+
techniques

src/documentation/build-iapp/guides/index.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,39 @@ description: Complete guide collection for building privacy-first iApps on iExec
55

66
# 🛠️ Build iApp Guides
77

8-
Welcome to the complete collection of guides for building privacy-first applications on iExec. These guides will walk you through every aspect of creating, testing, and deploying confidential iApps.
8+
Welcome to the complete collection of guides for building privacy-first
9+
applications on iExec. These guides will walk you through every aspect of
10+
creating, testing, and deploying confidential iApps.
911

1012
## 🚀 Getting Started
1113

12-
- **[Build & Deploy](/documentation/build-iapp/guides/build-&-deploy)** - Your first iApp in 15 minutes
13-
- **[Inputs and Outputs](/documentation/build-iapp/guides/inputs-and-outputs)** - Handle data flow in TEE environment
14-
- **[Debugging](/documentation/build-iapp/guides/debugging)** - Troubleshoot execution issues
14+
- **[Build & Deploy](/documentation/build-iapp/guides/build-&-deploy)** - Your
15+
first iApp in 15 minutes
16+
- **[Inputs and Outputs](/documentation/build-iapp/guides/inputs-and-outputs)** -
17+
Handle data flow in TEE environment
18+
- **[Debugging](/documentation/build-iapp/guides/debugging)** - Troubleshoot
19+
execution issues
1520

1621
## 🔐 Access Control & Management
1722

18-
- **[Manage Access](/documentation/build-iapp/guides/manage-access)** - Control who can use your iApp
19-
- **[How to Get and Decrypt Results](/documentation/build-iapp/guides/how-to-get-and-decrypt-results)** - Retrieve and use outputs
23+
- **[Manage Access](/documentation/build-iapp/guides/manage-access)** - Control
24+
who can use your iApp
25+
- **[How to Get and Decrypt Results](/documentation/build-iapp/guides/how-to-get-and-decrypt-results)** -
26+
Retrieve and use outputs
2027

2128
## 🧪 Advanced Features
2229

23-
- **[Using TDX (Experimental)](/documentation/build-iapp/guides/using-tdx)** - Next-gen TEE technology
30+
- **[Using TDX (Experimental)](/documentation/build-iapp/guides/using-tdx)** -
31+
Next-gen TEE technology
2432

2533
## 📚 What's Next?
2634

2735
After mastering these guides, explore:
2836

29-
- **[iApp Generator](/documentation/build-iapp/iapp-generator)** - Complete development toolkit
30-
- **[What is an iApp?](/documentation/build-iapp/what-is-iapp)** - Core concepts and TEE overview
37+
- **[iApp Generator](/documentation/build-iapp/iapp-generator)** - Complete
38+
development toolkit
39+
- **[What is an iApp?](/documentation/build-iapp/what-is-iapp)** - Core concepts
40+
and TEE overview
3141

32-
Ready to build your first privacy-preserving application? Start with the [Build & Deploy](/documentation/build-iapp/guides/build-&-deploy) guide!
42+
Ready to build your first privacy-preserving application? Start with the
43+
[Build & Deploy](/documentation/build-iapp/guides/build-&-deploy) guide!

src/documentation/build-iapp/guides/inputs-and-outputs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -627,8 +627,8 @@ guide for the complete user workflow.
627627

628628
Continue building with these guides:
629629

630-
- **[App Access Control and Pricing](/documentation/build-iapp/guides/manage-access)** - Control who
631-
can use your iApp
630+
- **[App Access Control and Pricing](/documentation/build-iapp/guides/manage-access)** -
631+
Control who can use your iApp
632632
- **[Debugging Your iApp](/documentation/build-iapp/guides/debugging)** -
633633
Troubleshoot execution issues
634634
- **[How to Get and Decrypt Results](/documentation/build-iapp/guides/how-to-get-and-decrypt-results)** -

src/documentation/build-iapp/guides/using-tdx.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ EXPERIMENTAL_TDX_APP=true iapp run <app-address>
186186

187187
- **[Debugging Your iApp](/documentation/build-iapp/guides/debugging)** -
188188
Troubleshoot execution issues
189-
- **[Inputs and Outputs](/documentation/build-iapp/guides/inputs-and-outputs)** - Handle data
190-
in TEE environment
191-
- **[App Access Control and Pricing](/documentation/build-iapp/guides/manage-access)** - Deploy
192-
production-ready iApps
189+
- **[Inputs and Outputs](/documentation/build-iapp/guides/inputs-and-outputs)** -
190+
Handle data in TEE environment
191+
- **[App Access Control and Pricing](/documentation/build-iapp/guides/manage-access)** -
192+
Deploy production-ready iApps

src/documentation/build-iapp/iapp-generator.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -41,23 +41,23 @@ minutes, not months.
4141

4242
Start here to understand what iApps are and how they work:
4343

44-
- **[What Is an iApp?](/documentation/build-iapp/what-is-iapp)** - Core
45-
concepts and TEE overview
46-
- **[Getting Started](/documentation/build-iapp/iapp-generator/getting-started)** - Your first
47-
iApp in 15 minutes
44+
- **[What Is an iApp?](/documentation/build-iapp/what-is-iapp)** - Core concepts
45+
and TEE overview
46+
- **[Getting Started](/documentation/build-iapp/iapp-generator/getting-started)** -
47+
Your first iApp in 15 minutes
4848
- **[Building Your iApp](/documentation/build-iapp/iapp-generator/building-your-iexec-app)** -
4949
Complete development guide
5050

5151
### 2. **Master the Development Workflow**
5252

5353
Once you've built your first iApp, level up with these practical guides:
5454

55-
- **[Inputs and Outputs](/documentation/build-iapp/guides/inputs-and-outputs)** - Handle data
56-
flow in TEE environment
55+
- **[Inputs and Outputs](/documentation/build-iapp/guides/inputs-and-outputs)** -
56+
Handle data flow in TEE environment
5757
- **[Debugging Your iApp](/documentation/build-iapp/guides/debugging)** -
5858
Troubleshoot execution issues
59-
- **[App Access Control and Pricing](/documentation/build-iapp/guides/manage-access)** - Control who
60-
can use your iApp
59+
- **[App Access Control and Pricing](/documentation/build-iapp/guides/manage-access)** -
60+
Control who can use your iApp
6161
- **[How to Get and Decrypt Results](/documentation/build-iapp/guides/how-to-get-and-decrypt-results)** -
6262
Retrieve and use outputs
6363

@@ -67,8 +67,8 @@ Ready for production? Dive into specialized topics:
6767

6868
- **[Using TDX (Experimental)](/documentation/build-iapp/guides/using-tdx)** -
6969
Next-gen TEE technology
70-
- **[Complete Guides Overview](/documentation/build-iapp/guides/)** - All development guides in
71-
one place
70+
- **[Complete Guides Overview](/documentation/build-iapp/guides/)** - All
71+
development guides in one place
7272

7373
## Why Choose iApp Generator?
7474

@@ -99,16 +99,19 @@ applications:
9999

100100
::: tip Quick Path
101101

102-
1. **[Getting Started](/documentation/build-iapp/iapp-generator/getting-started)** - Build
103-
your first iApp (15 minutes)
104-
2. **[Inputs and Outputs](/documentation/build-iapp/guides/inputs-and-outputs)** - Handle data
105-
properly
106-
3. **[Debugging](/documentation/build-iapp/guides/debugging)** - Fix issues quickly
107-
4. **[App Access Control](/documentation/build-iapp/guides/manage-access)** - Go to production :::
102+
1. **[Getting Started](/documentation/build-iapp/iapp-generator/getting-started)** -
103+
Build your first iApp (15 minutes)
104+
2. **[Inputs and Outputs](/documentation/build-iapp/guides/inputs-and-outputs)** -
105+
Handle data properly
106+
3. **[Debugging](/documentation/build-iapp/guides/debugging)** - Fix issues
107+
quickly
108+
4. **[App Access Control](/documentation/build-iapp/guides/manage-access)** - Go
109+
to production :::
108110

109111
### Need Help?
110112

111-
- **[Complete Guides](/documentation/build-iapp/guides/)** - All development guides
113+
- **[Complete Guides](/documentation/build-iapp/guides/)** - All development
114+
guides
112115
- **[iExec Discord](https://discord.com/invite/pbt9m98wnU)** - Community support
113116
- **[Protocol Documentation](https://protocol.docs.iex.ec)** - Technical deep
114117
dive

src/documentation/build-iapp/what-is-iapp.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ description: Privacy-first applications that run on decentralized infrastructure
77

88
An iExec Application (iApp) is your regular application code (Python script, AI
99
model, data processor, ...) that can securely process protected data (created by
10-
[DataProtector](/documentation/manage-data/dataProtector)) inside a confidential computing
11-
environment called TEE (a Trusted Execution Environment).
10+
[DataProtector](/documentation/manage-data/dataProtector)) inside a confidential
11+
computing environment called TEE (a Trusted Execution Environment).
1212

1313
## Why iApps Matter ?
1414

@@ -161,7 +161,8 @@ iApp can't see what's happening inside the enclave.
161161
::: details 🚀 How do I deploy my first iApp?
162162

163163
Try our [Hello World](/documentation/helloWorld) for a quick start, or check the
164-
[iApp Generator](/documentation/build-iapp/iapp-generator) section for detailed instructions.
164+
[iApp Generator](/documentation/build-iapp/iapp-generator) section for detailed
165+
instructions.
165166

166167
:::
167168

src/documentation/manage-data/dataProtector/advanced/apps-whitelist.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ In order to consume a protected data, an iExec TEE dApp needs to be provided.
1212

1313
::: tip
1414

15-
**TEE** stands for Trusted Execution Environment. Find more details [here](https://protocol.docs.iex.ec/help/glossary#trusted-execution-environment-tee)
15+
**TEE** stands for Trusted Execution Environment. Find more details
16+
[here](https://protocol.docs.iex.ec/help/glossary#trusted-execution-environment-tee)
1617

1718
:::
1819

@@ -33,8 +34,8 @@ The story goes as follow:
3334
## Protected Data Delivery iApp
3435

3536
Built for the needs of
36-
[Content Creator use case](https://demo.iex.ec/content-creator/),
37-
this iExec TEE dApp is simple:
37+
[Content Creator use case](https://demo.iex.ec/content-creator/), this iExec TEE
38+
dApp is simple:
3839

3940
1. Download the protected data from IPFS. It expects to find a property named
4041
`file` in the protected data.

src/documentation/manage-data/dataProtector/advanced/dps-smart-contract.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ data, and their owners.
1616

1717
## Code
1818

19-
You can find the Solidity code [here](https://github.com/iExecBlockchainComputing/dataprotector-sdk/tree/main/packages/sharing-smart-contract)
19+
You can find the Solidity code
20+
[here](https://github.com/iExecBlockchainComputing/dataprotector-sdk/tree/main/packages/sharing-smart-contract)
2021

2122
## DataProtectorSharing
2223

0 commit comments

Comments
 (0)