Skip to content

Commit d34e91f

Browse files
committed
refactor(docs): update DataProtector and iApp types documentation for clarity and consistency
1 parent c838c64 commit d34e91f

File tree

2 files changed

+25
-25
lines changed

2 files changed

+25
-25
lines changed

src/references/dataProtector/types.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,11 @@ Types in DataProtector.
2222

2323
### volume: <span class="text-yellow">`string`</span>
2424

25-
- Number of authorized uses of this `protectedData`; each use decrements this
26-
counter
25+
- Total number of authorized accesses for processing a Protected Data when the access was signed and published
26+
27+
### remainingAccess: <span class="text-yellow">`number`</span>
28+
29+
- Number of remaining authorized accesses for processing a protected data; each use decrements this counter
2730

2831
### tag: <span class="text-yellow">`string`</span>
2932

@@ -120,6 +123,3 @@ You can read more about the
120123
<!-- prettier-ignore-start -->
121124
_Hash example:_ `0xc9c2d58fc01fe54149b7daf49a0026d4ab1fdd3d10fb7c76350790fff03fe24d`
122125
<!-- prettier-ignore-end -->
123-
124-
You can read more about the [iExec Explorer]
125-
(/get-started/tooling-and-explorers/iexec-explorer).

src/references/iapp-generator/sdk/types.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Types
33
description:
4-
Complete reference for DataProtector types including GrantedAccess,
4+
Complete reference for iApp types including GrantedAccess,
55
ProtectedData, Collection, and other essential data structures.
66
---
77

@@ -11,33 +11,36 @@ Types in DataProtector.
1111

1212
## 🔑 GrantedAccess
1313

14-
### dataset: <span class="text-yellow">`string`</span>
14+
### app: <span class="text-yellow">`string`</span>
1515

16-
- Address of the `protectedData` containing user data
16+
- Address of the iExec Tee application (IApp)
1717

18-
### datasetprice: <span class="text-yellow">`string`</span>
18+
### appprice: <span class="text-yellow">`string`</span>
1919

2020
- Price (in nRLC) to charge the user specified in `requesterrestrict` for each
21-
use of this `protectedData`
21+
use of this `iapp`
2222

2323
### volume: <span class="text-yellow">`string`</span>
2424

25-
- Number of authorized uses of this `protectedData`; each use decrements this
26-
counter
25+
- Total number of authorized accesses for running an iApp when the access was signed and published
26+
27+
### remainingAccess: <span class="text-yellow">`number`</span>
28+
29+
- Number of remaining authorized accesses for running an iApp; each use decrements this counter
2730

2831
### tag: <span class="text-yellow">`string`</span>
2932

3033
- Defines whether a `protectedData` is usable in a TEE environment; `0x00` is
3134
TEE while `0x03` is non-TEE
3235

33-
### apprestrict: <span class="text-yellow">`string`</span>
36+
### datasetrestrict: <span class="text-yellow">`string`</span>
3437

35-
- Address of the authorized application; a value of 0x0 indicates any
36-
application may access this data
38+
- Address of the authorized protected data; a value of 0x0 indicates any
39+
protected data may run with this iapp
3740

3841
### requesterrestrict: <span class="text-yellow">`string`</span>
3942

40-
- Address of the requester authorized to use this `protectedData` in workloads;
43+
- Address of the requester authorized to run this `iapp` in workloads;
4144
a value of 0x0 indicates any requester may use this data
4245

4346
### workerpoolrestrict: <span class="text-yellow">`string`</span>
@@ -55,31 +58,31 @@ Types in DataProtector.
5558

5659
- Order signature of all the `grantedAccess` fields
5760

58-
## 🔐 ProtectedData
61+
## 🔐 IApp
5962

6063
### name: <span class="text-yellow">`string`</span>
6164

62-
- Name specified when the protected data was created. This piece of information
65+
- Name specified when the iApp was created. This piece of information
6366
is public and visible on-chain.
6467

6568
### address: <span class="text-yellow">`Address`</span>
6669

67-
- Ethereum address of the protected data.
70+
- Ethereum address of the iapp.
6871

6972
### owner: <span class="text-yellow">`Address`</span>
7073

71-
- Ethereum address of the protected data owner.
74+
- Ethereum address of the iapp owner.
7275

7376
### creationTimestamp: <span class="text-yellow">`number`</span>
7477

75-
- Timestamp specifying when the protected data was created, expressed in
78+
- Timestamp specifying when the iapp was created, expressed in
7679
milliseconds since the epoch. This timestamp provides precise information
7780
about the moment of creation and can be used for chronological ordering or
7881
time-based operations.
7982

8083
### multiaddr: <span class="text-yellow">`string` | `undefined`</span>
8184

82-
- The multiaddr field is the IPFS path of your encrypted data.
85+
- The multiaddr field is the IPFS path of iapp published on Dockerhub.
8386

8487
## ❌ RevokedAccess
8588

@@ -111,6 +114,3 @@ You can read more about the
111114
<!-- prettier-ignore-start -->
112115
_Hash example:_ `0xc9c2d58fc01fe54149b7daf49a0026d4ab1fdd3d10fb7c76350790fff03fe24d`
113116
<!-- prettier-ignore-end -->
114-
115-
You can read more about the [iExec Explorer]
116-
(/get-started/tooling-and-explorers/iexec-explorer).

0 commit comments

Comments
 (0)