[SDK] Implement preflight checks with SC #178

Le-Caignec · 2024-02-26T16:38:34Z

remove preflight checks that were made with the subgraph
fix unit tests

…mart contract

cedric25

Quite a lot of work 💪

First round of comments!

packages/sdk/src/lib/dataProtectorSharing/smartContract/getterForSharingContract.ts

packages/sdk/src/lib/dataProtectorSharing/DataProtectorSharing.ts

packages/sdk/src/lib/dataProtectorSharing/removeFromCollection.ts

packages/sdk/src/lib/dataProtectorSharing/buyProtectedData.ts

packages/sdk/src/lib/dataProtectorSharing/removeCollection.ts

packages/sdk/src/lib/dataProtectorSharing/removeFromCollection.ts

packages/sdk/src/lib/dataProtectorSharing/smartContract/preFlightCheck.ts

packages/sdk/tests/e2e/dataProtectorSharing/addToCollection.test.ts

Co-authored-by: Cedric Nicoloso <[email protected]>

…st.ts Co-authored-by: Cedric Nicoloso <[email protected]>

Co-authored-by: Cedric Nicoloso <[email protected]>

packages/sdk/src/lib/dataProtectorSharing/smartContract/sharingContract.reads.ts

packages/sdk/tests/e2e/dataProtectorSharing/setProtectedDataToRenting.test.ts

packages/sdk/tests/e2e/dataProtectorSharing/setProtectedDataForSale.test.ts

packages/sdk/tests/e2e/dataProtectorSharing/removeProtectedDataFromRenting.test.ts

packages/sdk/tests/e2e/dataProtectorSharing/removeProtectedDataForSale.test.ts

packages/sdk/src/lib/dataProtectorSharing/buyProtectedData.ts

packages/sdk/src/lib/dataProtectorSharing/removeFromCollection.ts

…gContract.reads.ts Co-authored-by: Cedric Nicoloso <[email protected]>

…om/iExecBlockchainComputing/dataprotector-sdk into feature/implement-pre-flight-check

cedric25 · 2024-03-04T09:58:31Z

packages/sdk/package.json

    "build:watch": "npm run build -- --watch",
    "check-types": "tsc --noEmit",
-    "test": "NODE_OPTIONS=--experimental-vm-modules jest --coverage",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest",


Any reason why you'd like to remove the coverage report?

cedric25 · 2024-03-04T09:59:01Z

packages/sdk/package.json

    "kubo-rpc-client": "^3.0.0",
    "magic-bytes.js": "^1.0.15",
-    "typescript": "^4.9.5",
+    "typechain": "^8.3.2",


Should be only a dev dependency I think?
Same for @typechain/ethers-v6

cedric25 · 2024-03-04T10:01:16Z

packages/sdk/.eslintignore

 **/node_modules/
-**/contracts/
+**/contracts/
+**/typechain/


What do we do with this new folder?
1️⃣ Commit these files?
2️⃣ gitignore them?
We need to choose :)

I'd choose 1️⃣

cedric25 · 2024-03-04T10:03:52Z

packages/sdk/package.json

    "format": "prettier --write \"(src|tests)/**/*.ts\"",
-    "check-format": "prettier --check \"(src|tests)/**/*.ts|tests/**/*.ts\""
+    "check-format": "prettier --check \"(src|tests)/**/*.ts|tests/**/*.ts\"",
+    "generate-types": "typechain --target=ethers-v6 --out-dir ./typechain '../sharing-smart-contract/artifacts/contracts/**/!(*.dbg).json' --node16-modules"


Might be safer to first remove entire folder, with rimraf for example.

npm i -D rimraf

Suggested change

"generate-types": "typechain --target=ethers-v6 --out-dir ./typechain '../sharing-smart-contract/artifacts/contracts/**/!(*.dbg).json' --node16-modules"

"generate-types": "rimraf typechain && typechain --target=ethers-v6 --out-dir ./typechain '../sharing-smart-contract/artifacts/contracts/**/!(*.dbg).json' --node16-modules"

Without that when re-running the script, I had both interface and interfaces in this generated folder.

cedric25 · 2024-03-04T10:46:28Z

packages/sdk/src/lib/dataProtectorSharing/smartContract/preflightChecks.ts

+  }
+};
+
+export const onlyProtectedDataCurrentlyForSubscription = (


A protected data is not for subscription, the collection is.

cedric25 · 2024-03-04T10:59:46Z

packages/sdk/src/lib/dataProtectorSharing/withdraw.ts

+  );
+
+  //---------- Smart Contract Call ----------
+  onlyBalanceNotEmpty({ sharingContract, userAddress });


Missing await?

Suggested change

onlyBalanceNotEmpty({ sharingContract, userAddress });

await onlyBalanceNotEmpty({ sharingContract, userAddress });

cedric25 · 2024-03-04T11:02:59Z

packages/sdk/src/lib/dataProtectorSharing/setSubscriptionParams.ts

-    const sharingContract = await getSharingContract(
-      iexec,
-      sharingContractAddress
+    const subscriptionParams: ISubscription.SubscriptionParamsStruct = {


Type not necessary here. If something's wrong here, calling setSubscriptionParams will complain.

cedric25 · 2024-03-04T11:04:13Z

packages/sdk/src/lib/dataProtectorSharing/smartContract/preflightChecks.ts

+  }
+};
+
+export const onlyCollectionCurrentlyForSubscription = (


I wonder if this "currently" term brings any value... Maybe we could remove it from all methods in this file.

cedric25 · 2024-03-04T11:08:24Z

packages/sdk/src/lib/dataProtectorSharing/smartContract/sharingContract.reads.ts

+  };
+};
+
+export const getProtectedDataDetails = async ({


If I counted well, this function calls the smart-contract 5 times.
We'll see later if this is really necessary for all getProtectedDataDetails callers.

cedric25 · 2024-03-04T11:09:34Z

packages/sdk/src/lib/dataProtectorSharing/smartContract/sharingContract.reads.ts

+  }
+
+  //TODO: implement multicall
+  const [collectionDetails, userRentalExpiration, userSubscriptionExpiration] =


It's weird that calling getProtectedDataRenter returns a result called userRentalExpiration.

Ok I get it, more explicitly this smart-contract method could be named getProtectedDataLatestRentalExpirationForUser.

Le-Caignec added 2 commits February 26, 2024 17:35

remove pre flight check with subgraph for pre flight check for with s…

7be2b59

…mart contract

fix units tests

3a99c82

Le-Caignec requested a review from cedric25 February 26, 2024 16:38

Le-Caignec self-assigned this Feb 26, 2024

Le-Caignec changed the base branch from v2 to feature/add-FetchProtectedDataByCollection-function February 26, 2024 16:38

Le-Caignec changed the title ~~Feature/implement pre flight check~~ [SDK] Implement pre flight check Feb 26, 2024

add more pre flight check to avoid end user for making redundant action

e19a2ad

cedric25 reviewed Feb 27, 2024

View reviewed changes

cedric25 added 2 commits February 27, 2024 13:01

Fix error message typo

508d87f

Rename to preflightChecks

8b3a8d1

Base automatically changed from feature/add-FetchProtectedDataByCollection-function to v2 February 27, 2024 13:43

Le-Caignec and others added 5 commits February 27, 2024 14:44

Update packages/sdk/src/lib/dataProtectorSharing/removeFromCollection.ts

fd6b253

Co-authored-by: Cedric Nicoloso <[email protected]>

Update packages/sdk/tests/e2e/dataProtectorSharing/addToCollection.te…

fdb1db0

…st.ts Co-authored-by: Cedric Nicoloso <[email protected]>

Update packages/sdk/tests/e2e/dataProtectorSharing/addToCollection.te…

8202825

…st.ts Co-authored-by: Cedric Nicoloso <[email protected]>

Update packages/sdk/src/lib/dataProtectorSharing/consumeProtectedData.ts

8831d66

Co-authored-by: Cedric Nicoloso <[email protected]>

Update packages/sdk/src/lib/dataProtectorSharing/consumeProtectedData.ts

e9d4a7a

Co-authored-by: Cedric Nicoloso <[email protected]>

cedric25 changed the title ~~[SDK] Implement pre flight check~~ [SDK] Implement preflight checks with SC Feb 27, 2024

Le-Caignec and others added 9 commits February 27, 2024 16:21

Merge branch 'v2' into feature/implement-pre-flight-check

0e0367e

fix upper case

d48a2d1

add new rules eslint config

08639fa

rename file

13631b9

change function naming

b3a5666

fix wrong param

73ffe6f

rename variable

63348cd

add new pre flight check

950a19c

remove useless pre flight check

2ac695e

Le-Caignec requested a review from cedric25 February 28, 2024 07:30

cedric25 reviewed Feb 28, 2024

View reviewed changes

Le-Caignec and others added 2 commits February 29, 2024 09:38

Update packages/sdk/src/lib/dataProtectorSharing/smartContract/sharin…

f319c87

…gContract.reads.ts Co-authored-by: Cedric Nicoloso <[email protected]>

Update packages/sdk/src/lib/dataProtectorSharing/smartContract/sharin…

814e943

…gContract.reads.ts Co-authored-by: Cedric Nicoloso <[email protected]>

Le-Caignec and others added 22 commits March 1, 2024 14:07

add explicit issue

270d2e5

remove number for bigIng because of typechain

71fabbf

format code

e86f032

fix typechecking

a026d0f

remove BigInt to return number

f1a0cdd

try to reduce number of call to the blockchain

58ea1f2

remove useless functions

6d6939d

Merge branch 'v2' into feature/implement-pre-flight-check

ecff2e3

reduce call number

71a16ae

Merge branch 'feature/implement-pre-flight-check' of https://github.c…

f295f03

…om/iExecBlockchainComputing/dataprotector-sdk into feature/implement-pre-flight-check

reduce call number

22448a6

update dependency

03d337a

batch rpc call

80d011d

Minor imports order

07270cd

Make sonar silent for one rule

d005833

Clean typechain folder before re-gen types

189a536

Some naming changes

860fc34

Clean unused import

054431c

Rename to "interfaces" to avoid TS problems

dcc10cc

No need to generate TS types in smart-contract?

9556952

Commit generated typechain

1b549a0

Change what's exported...

ed3b9cd

cedric25 reviewed Mar 4, 2024

View reviewed changes

cedric25 added 4 commits March 4, 2024 13:43

Need to await subgraph in one test

a672943

Add clear TODO before skipped test

89938ec

Clean unused method + some renamings

28b6758

Add missing waitForSubgraphIndexing()

00e01ab

cedric25 merged commit d24b02d into v2 Mar 4, 2024

cedric25 deleted the feature/implement-pre-flight-check branch March 4, 2024 13:55

cedric25 mentioned this pull request Mar 4, 2024

[SDK] WIP - Some TypeScript around smart-contract calls #183

Closed

	"generate-types": "typechain --target=ethers-v6 --out-dir ./typechain '../sharing-smart-contract/artifacts/contracts/*/!(.dbg).json' --node16-modules"
	"generate-types": "rimraf typechain && typechain --target=ethers-v6 --out-dir ./typechain '../sharing-smart-contract/artifacts/contracts/*/!(.dbg).json' --node16-modules"

	onlyBalanceNotEmpty({ sharingContract, userAddress });
	await onlyBalanceNotEmpty({ sharingContract, userAddress });

[SDK] Implement preflight checks with SC #178

[SDK] Implement preflight checks with SC #178

Uh oh!

Conversation

Le-Caignec commented Feb 26, 2024 • edited by cedric25 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cedric25 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Le-Caignec commented Feb 26, 2024 •

edited by cedric25

Loading