Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
1a4107b
feat: Update documentation and guides for DataProtector
Le-Caignec Aug 2, 2025
71eaa82
refactor: enhance documentation for guides and improve visibility of …
Le-Caignec Aug 2, 2025
705456f
refactor: rename and update links for data monetization guides, remov…
Le-Caignec Aug 3, 2025
9224606
feat: add check-format script to package.json for code formatting checks
Le-Caignec Aug 3, 2025
a9f63d6
Update src/manage-data/guides/monetize-protected-data.md
Le-Caignec Aug 4, 2025
3e3b598
refactor: remove deprecated guides and update sidebar links
Le-Caignec Aug 4, 2025
d1ac3ec
refactor: improve formatting and readability of schema documentation
Le-Caignec Aug 4, 2025
4b540d9
refactor: enhance section headers with emojis for better visual disti…
Le-Caignec Aug 4, 2025
e9950ad
refactor: enhance 'What Is Protected Data?' documentation with improv…
akugone Aug 4, 2025
e62d754
refactor: simplify and enhance 'What Is Protected Data?' section for …
akugone Aug 4, 2025
8edf3be
refactor: remove promotional content from 'What Is Protected Data?' s…
akugone Aug 4, 2025
b795fdf
refactor: clarify data protection and schema documentation for improv…
akugone Aug 4, 2025
013a196
refactor: streamline DataProtector types documentation with enhanced …
akugone Aug 4, 2025
52bf30d
refactor: enhance clarity and conciseness in DataProtector access man…
akugone Aug 4, 2025
41c4016
Update src/manage-data/guides/create-and-share-access.md
Le-Caignec Aug 4, 2025
b789253
Update src/manage-data/what-is-protected-data.md
Le-Caignec Aug 4, 2025
fc3d438
refactor: swap headings in DataProtector documentation for improved c…
akugone Aug 5, 2025
c178798
Merge branch 'feature/protect-and-manage-data-martin' of https://gith…
akugone Aug 5, 2025
712bcf5
Apply suggestions from code review
akugone Aug 5, 2025
350c31b
Update src/manage-data/what-is-protected-data.md
akugone Aug 5, 2025
e18c3a0
fix: update link in 'What Is Protected Data?' section to direct users…
akugone Aug 5, 2025
ce4f7b9
refactor: update terminology in 'What Is Protected Data?' section to …
akugone Aug 5, 2025
d7c6ea8
fix: update link in 'RevokedAccess' section to correctly reference 'G…
Le-Caignec Aug 5, 2025
fd963a6
Feature/protect and manage data martin (#12)
akugone Aug 5, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ export default defineConfig({
{ text: 'Core Concept', link: '/core-concept/glossary' },
],
outline: {
level: [2, 3],
level: [2, 4],
},

sidebar: getSidebar(),
Expand Down
10 changes: 2 additions & 8 deletions .vitepress/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@ export function getSidebar() {
},
{
text: '📖 Guides',
link: '/manage-data/guides',
items: [
{
text: 'Create and Share Access to Protected Data',
Expand All @@ -76,24 +75,19 @@ export function getSidebar() {
link: '/manage-data/guides/handle-schemas-dataset-types',
},
{
text: 'Manage Data Monetization',
link: '/manage-data/guides/manage-data-monetization',
text: 'Monetize Protected Data',
link: '/manage-data/guides/monetize-protected-data',
},
],
},
{
text: '🔐 DataProtector',
link: '/manage-data/dataProtector',
collapsed: true,
items: [
{
text: 'Getting Started',
link: '/manage-data/dataProtector/getting-started',
},
{
text: 'Guides',
link: '/manage-data/dataProtector/guides',
},
{
text: 'DataProtector Core',
link: '/manage-data/dataProtector/dataProtectorCore',
Expand Down
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ Fork this repository and ensure you're working on the `main` branch:
```

3. Start the development server:

```bash
npm run dev
```
Expand Down Expand Up @@ -138,14 +139,24 @@ Fork this repository and ensure you're working on the `main` branch:
> - All pull requests are reviewed by our team before being merged
> - Feel free to ask questions in the pull request if you need clarification

## 📄 License

This project is part of the iExec ecosystem. Please refer to the main iExec
repositories for licensing information.

## 🆘 Support

- 📖 [Documentation](https://docs.iex.ec)
- 💬 [Discord Community](https://discord.com/invite/pbt9m98wnU)
- 🐛
[Issue Tracker](https://github.com/iExecBlockchainComputing/documentation/issues)

## TODO

- Add Arbitrum support
- On arbitrum hide : Oracle Factory ? , DataProtector Sharing ??
- Adapt hardcoded address to feat with new contracts deployed on arbitrum
- Add link to the new explorer feature Asset_Types in the guide =>
`handle-schemas-dataset-types`
- Add link to remix for deploying whitelist
- Move `manage-data/dataProtector/advanced/iApp` (Deserializer doc) in an other
way to be more visible (may in build-iApp section)
- complete `use-iapp` section
- complete `explorer` section
- complete `build-iapp` section
- complete `deep-dive`section
6 changes: 4 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ features:
details:
Secure your data with advanced encryption and control access while
maintaining privacy using DataProtector
link: /manage-data/dataProtector/what-is-protected-data
link: /manage-data/what-is-protected-data
- icon: 🤖
title: Build iApps
details:
Expand All @@ -43,7 +43,7 @@ features:
details:
Create revenue streams from your data while maintaining full control and
privacy
link: /manage-data/guides/manage-data-monetization
link: /manage-data/guides/monetize-protected-data
- icon: 🧠
title: Core Concepts
details:
Expand Down
19 changes: 11 additions & 8 deletions src/manage-data/dataProtector/dataProtectorCore/grantAccess.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ import { type GrantAccessParams } from '@iexec/dataprotector';

**Type:** `AddressOrENS`

The ethereum address of the protected data supplied by the user.
The ethereum address of the protected data supplied by the user (returned when
you created it). **You must own this data** to grant access.

```ts twoslash
import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector';
Expand All @@ -68,9 +69,9 @@ The address of the application you wish to authorize to process the
single application or an application whitelist. To specify a whitelist, you
provide the ETH address of an
[iExec Whitelist Smart Contract](https://github.com/iExecBlockchainComputing/whitelist-smart-contract/tree/main).
This smart contract aggregates multiple application versions. This allows you to
introduce new versions of your application without needing to grant access for
the `protectedData` each time you do so.
This smart contract should aggregates multiple application versions. This allows
you to introduce new versions of your application without needing to grant
access for the `protectedData` each time you do so.

```ts twoslash
import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector';
Expand Down Expand Up @@ -180,12 +181,14 @@ used.
It is not technically possible to set an unlimited number of accesses, but you
can set `numberOfAccess` to `10000` for example.

::: info Important Notes: If you attempt to process the protected data more
times than specified in `numberOfAccess`, you will encounter a **"no dataset
orders"** error.
::: info

If you attempt to process the protected data more times than specified in
`numberOfAccess`, you will encounter a **"no dataset orders"** error.

To prevent this error, ensure the `numberOfAccess` is properly set when calling
the `grantAccess` method.
the `grantAccess` method.

:::

```ts twoslash
Expand Down
Loading