Skip to content

Commit 031c48c

Browse files
committed
Add data protection methods to iExec DataProtector
- Implement `processProtectedData` method for secure processing of encrypted datasets. - Introduce `protectData` method for client-side encryption of user data. - Add `revokeAllAccess` method to manage access permissions for protected data. - Create `revokeOneAccess` method for targeted revocation of access permissions. - Implement `transferOwnership` method to transfer ownership of protected data securely.
1 parent 9771f75 commit 031c48c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+12
-3371
lines changed

.vitepress/sidebar.ts

Lines changed: 12 additions & 172 deletions
Original file line numberDiff line numberDiff line change
@@ -223,179 +223,44 @@ export function getSidebar() {
223223
},
224224
{
225225
text: 'DataProtector Core',
226-
link: '/references/dataProtector/dataProtectorCore',
226+
link: '/references/dataProtector/methods',
227227
collapsed: true,
228228
items: [
229229
{
230230
text: 'protectData',
231-
link: '/references/dataProtector/dataProtectorCore/protectData',
231+
link: '/references/dataProtector/methods/protectData',
232232
},
233233
{
234234
text: 'getProtectedData',
235-
link: '/references/dataProtector/dataProtectorCore/getProtectedData',
235+
link: '/references/dataProtector/methods/getProtectedData',
236236
},
237237
{
238238
text: 'transferOwnership',
239-
link: '/references/dataProtector/dataProtectorCore/transferOwnership',
239+
link: '/references/dataProtector/methods/transferOwnership',
240240
},
241241
{
242242
text: 'grantAccess',
243-
link: '/references/dataProtector/dataProtectorCore/grantAccess',
243+
link: '/references/dataProtector/methods/grantAccess',
244244
},
245245
{
246246
text: 'getGrantedAccess',
247-
link: '/references/dataProtector/dataProtectorCore/getGrantedAccess',
247+
link: '/references/dataProtector/methods/getGrantedAccess',
248248
},
249249
{
250250
text: 'revokeOneAccess',
251-
link: '/references/dataProtector/dataProtectorCore/revokeOneAccess',
251+
link: '/references/dataProtector/methods/revokeOneAccess',
252252
},
253253
{
254254
text: 'revokeAllAccess',
255-
link: '/references/dataProtector/dataProtectorCore/revokeAllAccess',
255+
link: '/references/dataProtector/methods/revokeAllAccess',
256256
},
257257
{
258258
text: 'processProtectedData',
259-
link: '/references/dataProtector/dataProtectorCore/processProtectedData',
259+
link: '/references/dataProtector/methods/processProtectedData',
260260
},
261261
{
262262
text: 'getResultFromCompletedTask',
263-
link: '/references/dataProtector/dataProtectorCore/getResultFromCompletedTask',
264-
},
265-
],
266-
},
267-
{
268-
text: 'DataProtector Sharing',
269-
link: '/references/dataProtector/dataProtectorSharing',
270-
collapsed: true,
271-
items: [
272-
{
273-
text: 'Collection',
274-
link: '/references/dataProtector/dataProtectorSharing/collection',
275-
collapsed: true,
276-
items: [
277-
{
278-
text: 'createCollection',
279-
link: '/references/dataProtector/dataProtectorSharing/collection/createCollection',
280-
},
281-
{
282-
text: 'removeCollection',
283-
link: '/references/dataProtector/dataProtectorSharing/collection/removeCollection',
284-
},
285-
{
286-
text: 'addToCollection',
287-
link: '/references/dataProtector/dataProtectorSharing/collection/addToCollection',
288-
},
289-
{
290-
text: 'removeProtectedDataFromCollection',
291-
link: '/references/dataProtector/dataProtectorSharing/collection/removeProtectedDataFromCollection',
292-
},
293-
],
294-
},
295-
{
296-
text: 'Renting',
297-
link: '/references/dataProtector/dataProtectorSharing/renting',
298-
collapsed: true,
299-
items: [
300-
{
301-
text: 'setProtectedDataToRenting',
302-
link: '/references/dataProtector/dataProtectorSharing/renting/setProtectedDataToRenting',
303-
},
304-
{
305-
text: 'setProtectedDataRentingParams',
306-
link: '/references/dataProtector/dataProtectorSharing/renting/setProtectedDataRentingParams',
307-
},
308-
{
309-
text: 'rentProtectedData',
310-
link: '/references/dataProtector/dataProtectorSharing/renting/rentProtectedData',
311-
},
312-
{
313-
text: 'removeProtectedDataFromRenting',
314-
link: '/references/dataProtector/dataProtectorSharing/renting/removeProtectedDataFromRenting',
315-
},
316-
],
317-
},
318-
{
319-
text: 'Selling',
320-
link: '/references/dataProtector/dataProtectorSharing/selling',
321-
collapsed: true,
322-
items: [
323-
{
324-
text: 'setProtectedDataForSale',
325-
link: '/references/dataProtector/dataProtectorSharing/selling/setProtectedDataForSale',
326-
},
327-
{
328-
text: 'buyProtectedData',
329-
link: '/references/dataProtector/dataProtectorSharing/selling/buyProtectedData',
330-
},
331-
{
332-
text: 'removeProtectedDataForSale',
333-
link: '/references/dataProtector/dataProtectorSharing/selling/removeProtectedDataForSale',
334-
},
335-
],
336-
},
337-
{
338-
text: 'Subscription',
339-
link: '/references/dataProtector/dataProtectorSharing/subscription',
340-
collapsed: true,
341-
items: [
342-
{
343-
text: 'setProtectedDataToSubscription',
344-
link: '/references/dataProtector/dataProtectorSharing/subscription/setProtectedDataToSubscription',
345-
},
346-
{
347-
text: 'setSubscriptionParams',
348-
link: '/references/dataProtector/dataProtectorSharing/subscription/setSubscriptionParams',
349-
},
350-
{
351-
text: 'subscribeToCollection',
352-
link: '/references/dataProtector/dataProtectorSharing/subscription/subscribeToCollection',
353-
},
354-
{
355-
text: 'removeProtectedDataFromSubscription',
356-
link: '/references/dataProtector/dataProtectorSharing/subscription/removeProtectedDataFromSubscription',
357-
},
358-
],
359-
},
360-
{
361-
text: 'Consume',
362-
collapsed: true,
363-
items: [
364-
{
365-
text: 'consumeProtectedData',
366-
link: '/references/dataProtector/dataProtectorSharing/consume/consumeProtectedData',
367-
},
368-
],
369-
},
370-
{
371-
text: 'Read Data',
372-
collapsed: true,
373-
items: [
374-
{
375-
text: 'getProtectedDataInCollections',
376-
link: '/references/dataProtector/dataProtectorSharing/read/getProtectedDataInCollections',
377-
},
378-
{
379-
text: 'getProtectedDataPricingParams',
380-
link: '/references/dataProtector/dataProtectorSharing/read/getProtectedDataPricingParams',
381-
},
382-
{
383-
text: 'getCollectionOwners',
384-
link: '/references/dataProtector/dataProtectorSharing/read/getCollectionOwners',
385-
},
386-
{
387-
text: 'getCollectionsByOwner',
388-
link: '/references/dataProtector/dataProtectorSharing/read/getCollectionsByOwner',
389-
},
390-
{
391-
text: 'getCollectionSubscriptions',
392-
link: '/references/dataProtector/dataProtectorSharing/read/getCollectionSubscriptions',
393-
},
394-
{
395-
text: 'getRentals',
396-
link: '/references/dataProtector/dataProtectorSharing/read/getRentals',
397-
},
398-
],
263+
link: '/references/dataProtector/methods/getResultFromCompletedTask',
399264
},
400265
],
401266
},
@@ -404,33 +269,8 @@ export function getSidebar() {
404269
link: '/references/dataProtector/types',
405270
},
406271
{
407-
text: 'Advanced',
408-
collapsed: true,
409-
items: [
410-
{
411-
text: 'Advanced Configuration',
412-
link: '/references/dataProtector/advanced/advanced-configuration',
413-
},
414-
{
415-
text: 'Apps whitelist',
416-
link: '/references/dataProtector/advanced/apps-whitelist',
417-
collapsed: true,
418-
items: [
419-
{
420-
text: 'createAddOnlyAppWhitelist',
421-
link: '/references/dataProtector/advanced/apps-whitelist/createAddOnlyAppWhitelist',
422-
},
423-
{
424-
text: 'addAppToAddOnlyAppWhitelist',
425-
link: '/references/dataProtector/advanced/apps-whitelist/addAppToAddOnlyAppWhitelist',
426-
},
427-
{
428-
text: 'getUserAddOnlyAppWhitelist',
429-
link: '/references/dataProtector/advanced/apps-whitelist/getUserAddOnlyAppWhitelist',
430-
},
431-
],
432-
},
433-
],
272+
text: 'Advanced Configuration',
273+
link: '/references/dataProtector/advanced-configuration',
434274
},
435275
],
436276
},

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

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -41,24 +41,6 @@ const dataProtector = new IExecDataProtector(web3Provider, {
4141
});
4242
```
4343

44-
### sharingContractAddress
45-
46-
`AddressOrENS`
47-
48-
The Ethereum contract address or ENS (Ethereum Name Service) for dataProtector
49-
sharing smart contract. If not provided, the default dataProtector sharing
50-
contract address will be used.
51-
52-
```ts twoslash
53-
import { IExecDataProtector, getWeb3Provider } from '@iexec/dataprotector';
54-
55-
const web3Provider = getWeb3Provider('PRIVATE_KEY');
56-
// ---cut---
57-
const dataProtector = new IExecDataProtector(web3Provider, {
58-
sharingContractAddress: '0x123abc...', // [!code focus]
59-
});
60-
```
61-
6244
### subgraphUrl
6345

6446
`string`

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

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

0 commit comments

Comments
 (0)