From a911a9c7c0a1e0f94cfde1acc533024576db36a8 Mon Sep 17 00:00:00 2001 From: Pierre Jeanjacquot <26487010+PierreJeanjacquot@users.noreply.github.com> Date: Wed, 29 Apr 2026 16:43:43 +0200 Subject: [PATCH] feat: update doc for dataprotector@2.0.0-beta.27 Co-authored-by: Copilot --- package-lock.json | 138 +----------------- package.json | 2 +- src/get-started/helloWorld/2-protectData.md | 4 +- .../helloWorld/4-manageDataAccess.md | 2 +- src/guides/build-iapp/debugging.md | 2 +- src/guides/build-iapp/inputs.md | 14 +- .../handle-schemas-dataset-types.md | 10 +- src/guides/manage-data/manage-access.md | 4 +- .../manage-data/monetize-protected-data.md | 2 +- src/guides/use-iapp/how-to-pay-executions.md | 2 +- .../use-iapp/integrate-web3-messaging.md | 12 +- .../use-iapp/run-iapp-with-ProtectedData.md | 10 +- .../dataProtector/advanced-configuration.md | 10 +- .../dataProtector/getting-started.md | 6 +- .../dataProtector/methods/getGrantedAccess.md | 16 +- .../dataProtector/methods/getProtectedData.md | 16 +- .../methods/getResultFromCompletedTask.md | 10 +- .../dataProtector/methods/grantAccess.md | 16 +- .../methods/prepareBulkRequest.md | 4 +- .../methods/processBulkRequest.md | 4 +- .../methods/processProtectedData.md | 30 ++-- .../dataProtector/methods/protectData.md | 14 +- .../dataProtector/methods/revokeAllAccess.md | 10 +- .../dataProtector/methods/revokeOneAccess.md | 4 +- .../methods/transferOwnership.md | 6 +- 25 files changed, 110 insertions(+), 238 deletions(-) diff --git a/package-lock.json b/package-lock.json index 713bd05f..0142dbe3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -8,7 +8,7 @@ "name": "iexec-documentation", "version": "0.0.0", "dependencies": { - "@iexec/dataprotector": "^2.0.0-beta.23", + "@iexec/dataprotector": "^2.0.0-beta.27", "@iexec/dataprotector-deserializer": "^0.1.1", "@iexec/web3mail": "^1.7.1", "@iexec/web3telegram": "^0.1.0-alpha.9", @@ -1208,9 +1208,9 @@ } }, "node_modules/@iexec/dataprotector": { - "version": "2.0.0-beta.23", - "resolved": "https://registry.npmjs.org/@iexec/dataprotector/-/dataprotector-2.0.0-beta.23.tgz", - "integrity": "sha512-Gy690wcMyxMcQE7kWEeEHQg8q2FWTRi28RoNpwGmwBYo1JV3UXjkfuRuOgFAoMRqEKEW+NkdmRvgkpjwQFEfdg==", + "version": "2.0.0-beta.27", + "resolved": "https://registry.npmjs.org/@iexec/dataprotector/-/dataprotector-2.0.0-beta.27.tgz", + "integrity": "sha512-t5+e/XBCq7L7ztMkRb2I5WYqo6pWuXKqMeilQb+SGPPgk7rFTIMhex6d/MJl7peTTAvWKeLU+WNVPY5aXjc+BA==", "license": "Apache-2.0", "dependencies": { "@ethersproject/bytes": "^5.7.0", @@ -1222,7 +1222,7 @@ "debug": "^4.3.4", "ethers": "^6.13.2", "graphql-request": "^6.0.0", - "iexec": "^8.22.4", + "iexec": "^9.0.0", "jszip": "^3.7.1", "kubo-rpc-client": "^5.4.1", "magic-bytes.js": "^1.0.15", @@ -1240,134 +1240,6 @@ "jszip": "^3.10.1" } }, - "node_modules/@iexec/dataprotector/node_modules/commander": { - "version": "13.1.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-13.1.0.tgz", - "integrity": "sha512-/rFeCpNJQbhSZjGVwO9RFV3xPqbnERS8MmIQzCtD/zl6gpJuV/bMLuN92oG3F7d8oDEHHRrujSXNUr8fpjntKw==", - "license": "MIT", - "engines": { - "node": ">=18" - } - }, - "node_modules/@iexec/dataprotector/node_modules/decode-uri-component": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.4.1.tgz", - "integrity": "sha512-+8VxcR21HhTy8nOt6jf20w0c9CADrw1O8d+VZ/YzzCt4bJ3uBjw+D1q2osAB8RnpwwaeYBxy0HyKQxD5JBMuuQ==", - "license": "MIT", - "engines": { - "node": ">=14.16" - } - }, - "node_modules/@iexec/dataprotector/node_modules/filter-obj": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/filter-obj/-/filter-obj-5.1.0.tgz", - "integrity": "sha512-qWeTREPoT7I0bifpPUXtxkZJ1XJzxWtfoWWkdVGqa+eCr3SHW/Ocp89o8vLvbUuQnadybJpjOKu4V+RwO6sGng==", - "license": "MIT", - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/@iexec/dataprotector/node_modules/iexec": { - "version": "8.24.0", - "resolved": "https://registry.npmjs.org/iexec/-/iexec-8.24.0.tgz", - "integrity": "sha512-XMi+kZlRHPB5prubA7PQvhEmKxENN/5P0+gfe96eKKUWZSb3qllzi14btRE/MEmUXwsQok9kpIOq9IajUY8VQQ==", - "license": "Apache-2.0", - "dependencies": { - "@multiformats/multiaddr": "^13.0.1", - "@types/bn.js": "^5.2.0", - "bn.js": "^5.2.2", - "buffer": "^6.0.3", - "commander": "^13.1.0", - "debug": "^4.4.3", - "ethers": "^6.13.5", - "fs-extra": "^11.3.0", - "graphql-request": "^7.3.5", - "inquirer": "^13.1.0", - "is-docker": "^3.0.0", - "jszip": "^3.10.1", - "kubo-rpc-client": "^5.3.0", - "multiformats": "^13.4.2", - "node-forge": "^1.3.2", - "ora": "^9.0.0", - "prettyjson": "^1.2.5", - "query-string": "^9.1.1", - "rlc-faucet-contract": "^1.0.10", - "semver": "^7.7.3", - "update-check": "^1.5.4", - "yup": "^1.6.1" - }, - "bin": { - "iexec": "dist/esm/cli/cmd/iexec.js" - } - }, - "node_modules/@iexec/dataprotector/node_modules/iexec/node_modules/@multiformats/multiaddr": { - "version": "13.0.1", - "resolved": "https://registry.npmjs.org/@multiformats/multiaddr/-/multiaddr-13.0.1.tgz", - "integrity": "sha512-XToN915cnfr6Lr9EdGWakGJbPT0ghpg/850HvdC+zFX8XvpLZElwa8synCiwa8TuvKNnny6m8j8NVBNCxhIO3g==", - "license": "Apache-2.0 OR MIT", - "dependencies": { - "@chainsafe/is-ip": "^2.0.1", - "multiformats": "^13.0.0", - "uint8-varint": "^2.0.1", - "uint8arrays": "^5.0.0" - } - }, - "node_modules/@iexec/dataprotector/node_modules/iexec/node_modules/graphql-request": { - "version": "7.4.0", - "resolved": "https://registry.npmjs.org/graphql-request/-/graphql-request-7.4.0.tgz", - "integrity": "sha512-xfr+zFb/QYbs4l4ty0dltqiXIp07U6sl+tOKAb0t50/EnQek6CVVBLjETXi+FghElytvgaAWtIOt3EV7zLzIAQ==", - "license": "MIT", - "dependencies": { - "@graphql-typed-document-node/core": "^3.2.0" - }, - "peerDependencies": { - "graphql": "14 - 16" - } - }, - "node_modules/@iexec/dataprotector/node_modules/query-string": { - "version": "9.3.1", - "resolved": "https://registry.npmjs.org/query-string/-/query-string-9.3.1.tgz", - "integrity": "sha512-5fBfMOcDi5SA9qj5jZhWAcTtDfKF5WFdd2uD9nVNlbxVv1baq65aALy6qofpNEGELHvisjjasxQp7BlM9gvMzw==", - "license": "MIT", - "dependencies": { - "decode-uri-component": "^0.4.1", - "filter-obj": "^5.1.0", - "split-on-first": "^3.0.0" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/@iexec/dataprotector/node_modules/semver": { - "version": "7.7.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.4.tgz", - "integrity": "sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA==", - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/@iexec/dataprotector/node_modules/split-on-first": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/split-on-first/-/split-on-first-3.0.0.tgz", - "integrity": "sha512-qxQJTx2ryR0Dw0ITYyekNQWpz6f8dGd7vffGNflQQ3Iqj9NJ6qiZ7ELpZsJ/QBhIVAiDfXdag3+Gp8RvWa62AA==", - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/@iexec/web3mail": { "version": "1.7.1", "resolved": "https://registry.npmjs.org/@iexec/web3mail/-/web3mail-1.7.1.tgz", diff --git a/package.json b/package.json index 7a0a6f94..1edad711 100644 --- a/package.json +++ b/package.json @@ -11,7 +11,7 @@ "format": "prettier --ignore-path .gitignore --write ." }, "dependencies": { - "@iexec/dataprotector": "^2.0.0-beta.23", + "@iexec/dataprotector": "^2.0.0-beta.27", "@iexec/dataprotector-deserializer": "^0.1.1", "@iexec/web3mail": "^1.7.1", "@iexec/web3telegram": "^0.1.0-alpha.9", diff --git a/src/get-started/helloWorld/2-protectData.md b/src/get-started/helloWorld/2-protectData.md index 527ccdb4..3481a6bd 100644 --- a/src/get-started/helloWorld/2-protectData.md +++ b/src/get-started/helloWorld/2-protectData.md @@ -75,7 +75,7 @@ with two arguments. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const { address: protectedDataAddress } = await dataProtectorCore.protectData({ @@ -169,7 +169,7 @@ Create a new instance and call the methods you need. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const { address: protectedDataAddress } = await dataProtectorCore.protectData({ diff --git a/src/get-started/helloWorld/4-manageDataAccess.md b/src/get-started/helloWorld/4-manageDataAccess.md index 3f227642..2b90f197 100644 --- a/src/get-started/helloWorld/4-manageDataAccess.md +++ b/src/get-started/helloWorld/4-manageDataAccess.md @@ -68,7 +68,7 @@ it now to grant access to your protected data. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const grantedAccess = await dataProtectorCore.grantAccess({ diff --git a/src/guides/build-iapp/debugging.md b/src/guides/build-iapp/debugging.md index cbff3255..3328e7eb 100644 --- a/src/guides/build-iapp/debugging.md +++ b/src/guides/build-iapp/debugging.md @@ -39,7 +39,7 @@ Track your tasks at [iExec Explorer](https://explorer.iex.ec): ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const response = await dataProtectorCore.processProtectedData({ diff --git a/src/guides/build-iapp/inputs.md b/src/guides/build-iapp/inputs.md index 1c33de1f..30357237 100644 --- a/src/guides/build-iapp/inputs.md +++ b/src/guides/build-iapp/inputs.md @@ -116,7 +116,7 @@ Users specify the protected data address when executing your iApp: ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- // User provides the protected data they want to use for processing @@ -186,7 +186,7 @@ Users pass args through the DataProtector `processProtectedData()` call: ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- // User provides args when executing your iApp @@ -258,7 +258,7 @@ Users specify input files when executing your iApp: ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- // User provides input files via DataProtector @@ -341,7 +341,7 @@ Users provide all Requester Secrets when executing your iApp via DataProtector: ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- // Example: User executes your iApp with all input types @@ -473,7 +473,7 @@ iapp test --protectedData "mock_name" ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- // User runs your data analysis iApp @@ -505,7 +505,7 @@ save_results(results) ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- // User runs your AI model with their data @@ -540,7 +540,7 @@ save_encrypted_results(predictions) ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- // User generates a report from their business data diff --git a/src/guides/manage-data/handle-schemas-dataset-types.md b/src/guides/manage-data/handle-schemas-dataset-types.md index 566674b5..1ea81107 100644 --- a/src/guides/manage-data/handle-schemas-dataset-types.md +++ b/src/guides/manage-data/handle-schemas-dataset-types.md @@ -30,7 +30,7 @@ it's all handled for you. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const protectedData = await dataProtectorCore.protectData({ @@ -124,7 +124,7 @@ Users can find relevant protected data without seeing the actual content: ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const listProtectedData = await dataProtectorCore.getProtectedData({ @@ -145,7 +145,7 @@ are used in production environments. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const userData = await dataProtectorCore.protectData({ @@ -172,7 +172,7 @@ const userData = await dataProtectorCore.protectData({ ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const contactData = await dataProtectorCore.protectData({ @@ -225,7 +225,7 @@ function createArrayBufferFromFile(file: File): Promise { // Get file from input element const file = new File([''], 'example.jpg', { type: 'image/jpeg' }); -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const fileBuffer = await createArrayBufferFromFile(file); diff --git a/src/guides/manage-data/manage-access.md b/src/guides/manage-data/manage-access.md index d7f8e5c7..124ce6c1 100644 --- a/src/guides/manage-data/manage-access.md +++ b/src/guides/manage-data/manage-access.md @@ -47,7 +47,7 @@ NFT. Only you control who can decrypt and use it. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const protectedData = await dataProtectorCore.protectData({ @@ -96,7 +96,7 @@ your data. Here's how to set it up: ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- diff --git a/src/guides/manage-data/monetize-protected-data.md b/src/guides/manage-data/monetize-protected-data.md index 69c61617..2694b22a 100644 --- a/src/guides/manage-data/monetize-protected-data.md +++ b/src/guides/manage-data/monetize-protected-data.md @@ -37,7 +37,7 @@ conditions for accessing your protected data. Each order defines: ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- // Create a signed order with specific conditions diff --git a/src/guides/use-iapp/how-to-pay-executions.md b/src/guides/use-iapp/how-to-pay-executions.md index f2970080..1b127000 100644 --- a/src/guides/use-iapp/how-to-pay-executions.md +++ b/src/guides/use-iapp/how-to-pay-executions.md @@ -63,7 +63,7 @@ You can control costs by setting maximum prices for each component: ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const result = await dataProtectorCore.processProtectedData({ diff --git a/src/guides/use-iapp/integrate-web3-messaging.md b/src/guides/use-iapp/integrate-web3-messaging.md index 91169bb7..958ddd7b 100644 --- a/src/guides/use-iapp/integrate-web3-messaging.md +++ b/src/guides/use-iapp/integrate-web3-messaging.md @@ -47,7 +47,7 @@ Protect the email address or Chat ID using DataProtector Core. ```ts twoslash [Web3Mail] import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); const protectedData = await dataProtectorCore.protectData({ @@ -59,7 +59,7 @@ const protectedData = await dataProtectorCore.protectData({ ```ts twoslash [Web3Telegram] import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); const protectedData = await dataProtectorCore.protectData({ @@ -81,7 +81,7 @@ based on your use case: use **Single Message** mode for individual messages, or ```ts twoslash [Single Message] import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); const grantedAccess = await dataProtectorCore.grantAccess({ @@ -95,7 +95,7 @@ const grantedAccess = await dataProtectorCore.grantAccess({ ```ts twoslash [Bulk Campaigns] import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- // allowBulk: true automatically sets pricePerAccess to 0 and numberOfAccess to unlimited @@ -175,7 +175,7 @@ Before using bulk processing, ensure that recipients have granted access with import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; import { IExecWeb3mail } from '@iexec/web3mail'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); const web3mail = new IExecWeb3mail(web3Provider); @@ -218,7 +218,7 @@ const { tasks } = await web3mail.sendEmailCampaign({ import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; import { IExecWeb3telegram } from '@iexec/web3telegram'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); const web3telegram = new IExecWeb3telegram(web3Provider); diff --git a/src/guides/use-iapp/run-iapp-with-ProtectedData.md b/src/guides/use-iapp/run-iapp-with-ProtectedData.md index aa6536ee..4204ea56 100644 --- a/src/guides/use-iapp/run-iapp-with-ProtectedData.md +++ b/src/guides/use-iapp/run-iapp-with-ProtectedData.md @@ -47,7 +47,7 @@ which file to process. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- // Process protected data with specific path @@ -65,7 +65,7 @@ task, you can do so as follows: ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); const taskId = '0x7ac398...'; @@ -84,7 +84,7 @@ blockchain. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- // Process protected data with arguments @@ -103,7 +103,7 @@ execution. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- // Process protected data with input files @@ -125,7 +125,7 @@ securely and made available to the iApp as environment variables. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- // Process protected data with secrets diff --git a/src/references/dataProtector/advanced-configuration.md b/src/references/dataProtector/advanced-configuration.md index 1bb40184..ff26d0b0 100644 --- a/src/references/dataProtector/advanced-configuration.md +++ b/src/references/dataProtector/advanced-configuration.md @@ -34,7 +34,7 @@ be used. ```ts twoslash import { IExecDataProtector, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); // ---cut--- const dataProtector = new IExecDataProtector(web3Provider, { dataprotectorContractAddress: '0x123abc...', // [!code focus] @@ -53,7 +53,7 @@ used. ```ts twoslash import { IExecDataProtector, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); // ---cut--- const dataProtector = new IExecDataProtector(web3Provider, { subgraphUrl: 'subgraph-url', // [!code focus] @@ -72,7 +72,7 @@ If not provided, the default IPFS node provided by iExec will be used. ```ts twoslash import { IExecDataProtector, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); // ---cut--- const dataProtector = new IExecDataProtector(web3Provider, { ipfsNode: 'ipfs-node-url', // [!code focus] @@ -92,7 +92,7 @@ If not provided, the default IPFS gateway provided by iExec will be used. ```ts twoslash import { IExecDataProtector, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); // ---cut--- const dataProtector = new IExecDataProtector(web3Provider, { ipfsGateway: 'ipfs-gateway-url', // [!code focus] @@ -108,7 +108,7 @@ for more details. ```ts twoslash import { IExecDataProtector, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); // ---cut--- const dataProtector = new IExecDataProtector(web3Provider, { iexecOptions: { smsURL: 'sms-url' }, // [!code focus] diff --git a/src/references/dataProtector/getting-started.md b/src/references/dataProtector/getting-started.md index 509dd575..cc8f291f 100644 --- a/src/references/dataProtector/getting-started.md +++ b/src/references/dataProtector/getting-started.md @@ -72,7 +72,7 @@ const dataProtectorCore = new IExecDataProtectorCore(web3Provider); import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; // Get Web3 provider from a private key -const web3Provider = getWeb3Provider('YOUR_PRIVATE_KEY'); +const web3Provider = getWeb3Provider('YOUR_PRIVATE_KEY', 'RPC_URL'); // Instantiate the Core module const dataProtectorCore = new IExecDataProtectorCore(web3Provider); @@ -91,14 +91,14 @@ without a Web3 provider. import { IExecDataProtectorCore } from '@iexec/dataprotector'; // Instantiate only the Core module for read-only core methods -const dataProtectorCore = new IExecDataProtectorCore(); +const dataProtectorCore = new IExecDataProtectorCore('RPC_URL'); ``` ```ts twoslash [Umbrella Module] import { IExecDataProtector } from '@iexec/dataprotector'; // Instantiate using the umbrella module for read-only functions -const dataProtector = new IExecDataProtector(); +const dataProtector = new IExecDataProtector('RPC_URL'); // Access to read-only core methods const dataProtectorCore = dataProtector.core; diff --git a/src/references/dataProtector/methods/getGrantedAccess.md b/src/references/dataProtector/methods/getGrantedAccess.md index 184e74e4..d43e39e4 100644 --- a/src/references/dataProtector/methods/getGrantedAccess.md +++ b/src/references/dataProtector/methods/getGrantedAccess.md @@ -21,7 +21,7 @@ the object is a string representation of an ethereum address or ENS name ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const listGrantedAccess = await dataProtectorCore.getGrantedAccess({ @@ -53,7 +53,7 @@ access for any protected data. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const listGrantedAccess = await dataProtectorCore.getGrantedAccess({ @@ -75,7 +75,7 @@ access for any application. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const listGrantedAccess = await dataProtectorCore.getGrantedAccess({ @@ -109,7 +109,7 @@ access for any user. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const listGrantedAccess = await dataProtectorCore.getGrantedAccess({ @@ -128,7 +128,7 @@ specified user. Authorizations made for `any` user are not returned. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- @@ -156,7 +156,7 @@ first page (page 0) containing `20` elements. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const listGrantedAccess = await dataProtectorCore.getGrantedAccess({ @@ -181,7 +181,7 @@ each page. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const listGrantedAccess = await dataProtectorCore.getGrantedAccess({ @@ -207,7 +207,7 @@ useful when preparing bulk requests using ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const { grantedAccess } = await dataProtectorCore.getGrantedAccess({ diff --git a/src/references/dataProtector/methods/getProtectedData.md b/src/references/dataProtector/methods/getProtectedData.md index 5a89b95c..cc960b41 100644 --- a/src/references/dataProtector/methods/getProtectedData.md +++ b/src/references/dataProtector/methods/getProtectedData.md @@ -26,7 +26,7 @@ method invocation. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const listProtectedData = await dataProtectorCore.getProtectedData({ @@ -53,7 +53,7 @@ Returns an empty array if the protected data is not found. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const oneProtectedData = await dataProtectorCore.getProtectedData({ @@ -71,7 +71,7 @@ Provides a list of protected data objects matching this schema. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const listProtectedData = await dataProtectorCore.getProtectedData({ @@ -88,7 +88,7 @@ It's also possible to provide a list of accepted types for one schema field: ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const listProtectedData = await dataProtectorCore.getProtectedData({ @@ -112,7 +112,7 @@ address. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const listProtectedData = await dataProtectorCore.getProtectedData({ @@ -130,7 +130,7 @@ The provided value should be in seconds. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const listProtectedData = await dataProtectorCore.getProtectedData({ @@ -151,7 +151,7 @@ results. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const listProtectedData = await dataProtectorCore.getProtectedData({ @@ -174,7 +174,7 @@ result. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const listProtectedData = await dataProtectorCore.getProtectedData({ diff --git a/src/references/dataProtector/methods/getResultFromCompletedTask.md b/src/references/dataProtector/methods/getResultFromCompletedTask.md index ee783620..02b399ec 100644 --- a/src/references/dataProtector/methods/getResultFromCompletedTask.md +++ b/src/references/dataProtector/methods/getResultFromCompletedTask.md @@ -15,7 +15,7 @@ Method to get the result of a completed task. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const completedTaskResult = await dataProtectorCore.getResultFromCompletedTask({ @@ -38,7 +38,7 @@ Address of the task ID data you'd like to get the result from. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const completedTaskResult = await dataProtectorCore.getResultFromCompletedTask({ @@ -57,7 +57,7 @@ you, and only the desired file will be given as the `result`. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const completedTaskResult = await dataProtectorCore.getResultFromCompletedTask({ @@ -79,7 +79,7 @@ encrypt the protected data. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const completedTaskResult = await dataProtectorCore.getResultFromCompletedTask({ @@ -101,7 +101,7 @@ import { getWeb3Provider, } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const completedTaskResult = diff --git a/src/references/dataProtector/methods/grantAccess.md b/src/references/dataProtector/methods/grantAccess.md index d16da286..f37984cb 100644 --- a/src/references/dataProtector/methods/grantAccess.md +++ b/src/references/dataProtector/methods/grantAccess.md @@ -20,7 +20,7 @@ application (or a designated list of applications). ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const grantedAccess = await dataProtectorCore.grantAccess({ @@ -51,7 +51,7 @@ you created it). **You must own this data** to grant access. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const grantedAccess = await dataProtectorCore.grantAccess({ @@ -77,7 +77,7 @@ access for the `protectedData` each time you do so. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const grantedAccess = await dataProtectorCore.grantAccess({ @@ -113,7 +113,7 @@ permission for the user to submit the data to an iExec application. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const grantedAccess = await dataProtectorCore.grantAccess({ @@ -149,7 +149,7 @@ The fee is paid to the owner of the protected data. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const grantedAccess = await dataProtectorCore.grantAccess({ @@ -194,7 +194,7 @@ the `grantAccess` method. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const grantedAccess = await dataProtectorCore.grantAccess({ @@ -221,7 +221,7 @@ and the number of accesses is unlimited. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const grantedAccess = await dataProtectorCore.grantAccess({ @@ -242,7 +242,7 @@ Callback function to be notified at intermediate steps. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const grantedAccess = await dataProtectorCore.grantAccess({ diff --git a/src/references/dataProtector/methods/prepareBulkRequest.md b/src/references/dataProtector/methods/prepareBulkRequest.md index 37523a4c..ecd02c75 100644 --- a/src/references/dataProtector/methods/prepareBulkRequest.md +++ b/src/references/dataProtector/methods/prepareBulkRequest.md @@ -57,7 +57,7 @@ const { bulkRequest } = await dataProtectorCore.prepareBulkRequest({ ```ts twoslash [NodeJS] import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // Get granted accesses with bulk capability @@ -443,7 +443,7 @@ results. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- // Get granted accesses with bulk capability diff --git a/src/references/dataProtector/methods/processBulkRequest.md b/src/references/dataProtector/methods/processBulkRequest.md index d49b21b5..02d30b4a 100644 --- a/src/references/dataProtector/methods/processBulkRequest.md +++ b/src/references/dataProtector/methods/processBulkRequest.md @@ -65,7 +65,7 @@ const { tasks } = await dataProtectorCore.processBulkRequest({ ```ts twoslash [NodeJS] import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // Get granted accesses with bulk capability @@ -108,7 +108,7 @@ import { getWeb3Provider, type BulkRequest, } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); const bulkRequest = {} as BulkRequest; // ---cut--- diff --git a/src/references/dataProtector/methods/processProtectedData.md b/src/references/dataProtector/methods/processProtectedData.md index 4b088ae8..fbd658f5 100644 --- a/src/references/dataProtector/methods/processProtectedData.md +++ b/src/references/dataProtector/methods/processProtectedData.md @@ -22,7 +22,7 @@ application. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const processProtectedDataResponse = @@ -54,7 +54,7 @@ you wish the `app` to process. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const processProtectedDataResponse = @@ -74,7 +74,7 @@ to process the protected data. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const processProtectedDataResponse = @@ -95,7 +95,7 @@ you, and only the desired file will be given as the `result`. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const processProtectedDataResponse = @@ -117,7 +117,7 @@ whitelist contract address that has access to the protected data. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const processProtectedDataResponse = @@ -146,7 +146,7 @@ result later. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const processProtectedDataResponse = @@ -183,7 +183,7 @@ for you to store securely. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const processProtectedDataResponse = @@ -223,7 +223,7 @@ Set of execution arguments for the application. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const processProtectedDataResponse = @@ -251,7 +251,7 @@ A set of URLs representing the input files required for application execution. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const processProtectedDataResponse = @@ -278,7 +278,7 @@ variables. For more details, see ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const processProtectedDataResponse = await dataProtectorCore.processProtectedData({ @@ -342,7 +342,7 @@ const processProtectedDataResponse = ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const processProtectedDataResponse = @@ -365,7 +365,7 @@ receives this as a payment for sharing their data. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const processProtectedDataResponse = @@ -387,7 +387,7 @@ provider for using the deployed application. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const processProtectedDataResponse = @@ -409,7 +409,7 @@ using their infrastructure to run the iApp in nRLC. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const processProtectedDataResponse = @@ -430,7 +430,7 @@ Callback function to be notified at intermediate steps. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const processProtectedDataResponse = await dataProtectorCore.processProtectedData({ diff --git a/src/references/dataProtector/methods/protectData.md b/src/references/dataProtector/methods/protectData.md index d032efe0..771ef925 100644 --- a/src/references/dataProtector/methods/protectData.md +++ b/src/references/dataProtector/methods/protectData.md @@ -26,7 +26,7 @@ An email address, for example, may be submitted as: ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const protectedData = await dataProtectorCore.protectData({ @@ -42,7 +42,7 @@ illustrates protection of multiple categories of data within one object: ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const protectedData = await dataProtectorCore.protectData({ @@ -109,7 +109,7 @@ any number of custom keys. The data is encrypted and stored as an NFT. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const protectedData = await dataProtectorCore.protectData({ @@ -144,7 +144,7 @@ implemented in this example. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const reduceArray = (array: Array): Record => @@ -190,7 +190,7 @@ public metadata, describing the protected data. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const protectedData = await dataProtectorCore.protectData({ @@ -218,7 +218,7 @@ hosting. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const protectedData = await dataProtectorCore.protectData({ @@ -240,7 +240,7 @@ Callback function to be notified at intermediate steps. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const protectedData = await dataProtectorCore.protectData({ diff --git a/src/references/dataProtector/methods/revokeAllAccess.md b/src/references/dataProtector/methods/revokeAllAccess.md index 55e4977d..4071abbc 100644 --- a/src/references/dataProtector/methods/revokeAllAccess.md +++ b/src/references/dataProtector/methods/revokeAllAccess.md @@ -26,7 +26,7 @@ all done. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const revokeAllAccessResult = await dataProtectorCore.revokeAllAccess({ @@ -51,7 +51,7 @@ The address of the `protectedData` subject to access revocation. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const revokeAllAccessResult = await dataProtectorCore.revokeAllAccess({ @@ -70,7 +70,7 @@ from the protected data, regardless of the app. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const revokeAllAccessResult = await dataProtectorCore.revokeAllAccess({ @@ -91,7 +91,7 @@ protected data, regardless of the authorized user. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const revokeAllAccessResult = await dataProtectorCore.revokeAllAccess({ @@ -111,7 +111,7 @@ Callback function to be notified at intermediate steps. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const revokeAllAccessResult = await dataProtectorCore.revokeAllAccess({ diff --git a/src/references/dataProtector/methods/revokeOneAccess.md b/src/references/dataProtector/methods/revokeOneAccess.md index 778e30f2..69ec2182 100644 --- a/src/references/dataProtector/methods/revokeOneAccess.md +++ b/src/references/dataProtector/methods/revokeOneAccess.md @@ -25,7 +25,7 @@ parameter. This object is retrieved from the ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const revokeAccess = await dataProtectorCore.revokeOneAccess({ @@ -58,7 +58,7 @@ This is the complete `granted access` object retrieved from an invocation of ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const revokeAccess = await dataProtectorCore.revokeOneAccess({ diff --git a/src/references/dataProtector/methods/transferOwnership.md b/src/references/dataProtector/methods/transferOwnership.md index 41d89eed..db21e659 100644 --- a/src/references/dataProtector/methods/transferOwnership.md +++ b/src/references/dataProtector/methods/transferOwnership.md @@ -24,7 +24,7 @@ address `0x000000000000000000000000000000000000dEaD`. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const transferResponse = await dataProtectorCore.transferOwnership({ @@ -49,7 +49,7 @@ new owner. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const transferResponse = await dataProtectorCore.transferOwnership({ @@ -67,7 +67,7 @@ ETH address for the new owner for the `protectedData`. ```ts twoslash import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector'; -const web3Provider = getWeb3Provider('PRIVATE_KEY'); +const web3Provider = getWeb3Provider('PRIVATE_KEY', 'RPC_URL'); const dataProtectorCore = new IExecDataProtectorCore(web3Provider); // ---cut--- const transferResponse = await dataProtectorCore.transferOwnership({