Skip to content

Commit 51bb5f6

Browse files
committed
docs: integrate ChainNotSupportedBadge across data protector documentation
Added ChainNotSupportedBadge to various sections of the data protector documentation, including sharing, renting, and subscription methods, to indicate unsupported chains. Removed the obsolete dps-smart-contract documentation and updated the README with a new development workflow section. Enhanced clarity by importing the badge component in relevant script sections.
1 parent fb5b1c3 commit 51bb5f6

36 files changed

+105
-174
lines changed

.vitepress/sidebar.ts

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -429,10 +429,6 @@ export function getSidebar() {
429429
text: 'Advanced Configuration',
430430
link: '/references/dataProtector/advanced/advanced-configuration',
431431
},
432-
{
433-
text: 'Sharing smart contract',
434-
link: '/references/dataProtector/advanced/dps-smart-contract',
435-
},
436432
{
437433
text: 'Apps whitelist',
438434
link: '/references/dataProtector/advanced/apps-whitelist',

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -168,19 +168,15 @@ for input parameters:
168168
## TODO
169169

170170
- Add an audit section for smart contracts
171-
- Add Arbitrum support
172171
- On arbitrum hide : DataProtector Sharing ??
173172
- Adapt hardcoded address to feat with new contracts deployed on arbitrum
174173
- Add link to the new explorer feature Asset_Types in the guide =>
175174
`handle-schemas-dataset-types`
176175
- Add link to remix for deploying whitelist
177-
- complete `use-iapp` section
178-
- Maybe split input and output in two diff sub section in build your iapp guide
179176
- SGX vs TDX need review
180177
- Explorer l'intégration de codeSpace
181-
- complete `Protocol`section
182-
- Add a Development workflow
183-
- Update context7 when doc will be deployed
178+
- Add a Development workflow pahe (1 - ProtectData, 2- ...)
179+
- Update context7 when doc will be deployed (Martin)
184180
- Check theGraph Images with design Team
185181
- Update the Dune Dashboard to the final version
186182
- Add new section in `iexec-explorer.md` file to talk about: available chain on
@@ -189,7 +185,7 @@ for input parameters:
189185
- Check how to pay guide to update with the launch on Arbitrum (RLC vs xRLC)
190186
- framework AI supporté TDX vs SGX
191187
- check glossary
192-
- migrate github SDK doc here
188+
- migrate github iexec SDK doc here
193189
- migrate pay-per-task page into a guide
194190
- check pages (introduction & getting-started) for use-iapp guide
195191
- explain TDX vs SGX

src/references/dataProtector/advanced/advanced-configuration.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ section.
2222
import { type DataProtectorConfigOptions } from '@iexec/dataprotector';
2323
```
2424

25-
### dataprotectorContractAddress
25+
### dataprotectorContractAddress <ChainNotSupportedBadge />
2626

2727
`AddressOrENS`
2828

@@ -164,3 +164,7 @@ const dataProtector = new IExecDataProtector(web3Provider, {
164164
discontinuity.
165165

166166
:::
167+
168+
<script setup>
169+
import ChainNotSupportedBadge from '@/components/ChainNotSupportedBadge.vue'
170+
</script>

src/references/dataProtector/advanced/apps-whitelist.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description:
66
Environment (TEE) dApp and whitelist usage for secure data delivery.
77
---
88

9-
# Apps Whitelist
9+
# Apps Whitelist <ChainNotSupportedBadge />
1010

1111
In order to consume a protected data, an iExec TEE dApp needs to be provided.
1212

@@ -78,3 +78,7 @@ See it in
7878

7979
See it in
8080
[https://blockscout-bellecour.iex.ec/](https://blockscout-bellecour.iex.ec/address/0x1cb7D4F3FFa203F211e57357D759321C6CE49921)
81+
82+
<script setup>
83+
import ChainNotSupportedBadge from '@/components/ChainNotSupportedBadge.vue'
84+
</script>

src/references/dataProtector/advanced/apps-whitelist/addAppToAddOnlyAppWhitelist.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description:
55
data access control.
66
---
77

8-
# addAppToAddOnlyAppWhitelist
8+
# addAppToAddOnlyAppWhitelist <ChainNotSupportedBadge />
99

1010
Method to add an app (iExec TEE dApp) into the `AddOnlyAppWhitelist`.
1111

@@ -99,4 +99,5 @@ See [`SuccessWithTransactionHash`](../../types.md#successwithtransactionhash)
9999

100100
<script setup>
101101
import RequiredBadge from '@/components/RequiredBadge.vue'
102+
import ChainNotSupportedBadge from '@/components/ChainNotSupportedBadge.vue'
102103
</script>

src/references/dataProtector/advanced/apps-whitelist/createAddOnlyAppWhitelist.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description:
55
becomes the owner by default, with transferable ownership as an ERC721.
66
---
77

8-
# createAddOnlyAppWhitelist
8+
# createAddOnlyAppWhitelist <ChainNotSupportedBadge />
99

1010
Method to create an `AddOnlyAppWhitelist`. By default, the owner will be the
1111
caller of the `createAddOnlyAppWhitelist` method, but as the
@@ -31,3 +31,7 @@ const isAddedToAddAppToAddOnlyAppWhitelist =
3131
```ts twoslash
3232
import { type CreateAppWhitelistResponse } from '@iexec/dataprotector';
3333
```
34+
35+
<script setup>
36+
import ChainNotSupportedBadge from '@/components/ChainNotSupportedBadge.vue'
37+
</script>

src/references/dataProtector/advanced/apps-whitelist/getUserAddOnlyAppWhitelist.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description:
55
app access control management.
66
---
77

8-
# getUserAddOnlyAppWhitelist
8+
# getUserAddOnlyAppWhitelist <ChainNotSupportedBadge />
99

1010
Method to get `AddOnlyAppWhitelist`, you can filter by user ethereum address.
1111

@@ -62,4 +62,5 @@ import { type AddOnlyAppWhitelist } from '@iexec/dataprotector';
6262

6363
<script setup>
6464
import OptionalBadge from '@/components/OptionalBadge.vue'
65+
import ChainNotSupportedBadge from '@/components/ChainNotSupportedBadge.vue'
6566
</script>

src/references/dataProtector/advanced/dps-smart-contract.md

Lines changed: 0 additions & 123 deletions
This file was deleted.

src/references/dataProtector/dataProtectorCore/processProtectedData.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ sufficient funds for this transfer to proceed.
160160

161161
:::
162162

163-
### voucherOwner <OptionalBadge />
163+
### voucherOwner <ChainNotSupportedBadge /> <OptionalBadge />
164164

165165
**Type:** `Address`
166166

src/references/dataProtector/dataProtectorSharing.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description:
66
maintaining control and privacy.
77
---
88

9-
# DataProtector Sharing
9+
# DataProtector Sharing <ChainNotSupportedBadge />
1010

1111
The DataProtector Sharing module includes a set of methods for distributing and
1212
monetizing your protected data. These work seamlessly in your own applications
@@ -63,3 +63,7 @@ additional activity from the data owner. This has several key benefits
6363
distribution, only the consumer of the data signs their transaction
6464
- The data owner doesn't manage access, the Data Sharing smart contract
6565
automatically enforces the distribution and monetization choices
66+
67+
<script setup>
68+
import ChainNotSupportedBadge from '@/components/ChainNotSupportedBadge.vue'
69+
</script>

0 commit comments

Comments
 (0)