feat: add remainingAccess field to GrantedAccess and update related functions

Author: ErwanDecoster

packages/sdk/src/lib/dataProtectorCore/getGrantedAccess.ts

@@ -52,7 +52,7 @@ export const getGrantedAccess = async ({
       }
     );
     const grantedAccess = orders?.map((order) =>
-      formatGrantedAccess(order.order)
+      formatGrantedAccess(order.order, order.remaining)
     );
     return { count, grantedAccess };
   } catch (e) {

packages/sdk/src/lib/dataProtectorCore/grantAccess.ts

@@ -166,5 +166,5 @@ export const grantAccess = async ({
     isDone: true,
   });
 
-  return formatGrantedAccess(datasetorder);
+  return formatGrantedAccess(datasetorder, parseInt(datasetorder.volume));
 };

packages/sdk/src/lib/dataProtectorCore/revokeOneAccess.ts

@@ -13,7 +13,8 @@ export const revokeOneAccess = async ({
       Object.keys(grantedAccess).length === 0 ? undefined : grantedAccess // pass undefined if rest operator returns an empty object to trigger the 'required' check
     ) as GrantedAccess;
   try {
-    const { txHash } = await iexec.order.cancelDatasetorder(vGrantedAccess);
+    const { remainingAccess, ...datasetOrder } = vGrantedAccess;
+    const { txHash } = await iexec.order.cancelDatasetorder(datasetOrder);
     return { access: vGrantedAccess, txHash };
   } catch (e) {
     throw new WorkflowError({

packages/sdk/src/lib/types/coreTypes.ts

@@ -211,6 +211,7 @@ export type GrantedAccess = {
   requesterrestrict: string;
   salt: string;
   sign: string;
+  remainingAccess: number;
 };
 
 export type GrantedAccessResponse = {

packages/sdk/src/utils/formatGrantedAccess.ts

@@ -1,6 +1,7 @@
 import { GrantedAccess } from '../lib/types/index.js';
 
 export const formatGrantedAccess = (order: {
+  dataset: string;
   datasetprice: number | string;
   volume: number | string;
   tag: string;
@@ -9,10 +10,16 @@ export const formatGrantedAccess = (order: {
   requesterrestrict: string;
   salt: string;
   sign: string;
-}): GrantedAccess =>
-  Object.fromEntries(
+}, remaining?: number): GrantedAccess => {
+  const formattedOrder = Object.fromEntries(
     Object.entries(order).map(([key, val]) => [
       key,
       val.toString().toLowerCase(),
     ]) // stringify numbers and lowercase addresses to return a clean GrantedAccess
-  ) as GrantedAccess;
+  ) as Omit<GrantedAccess, 'remainingAccess'>;
+  
+  return {
+    ...formattedOrder,
+    remainingAccess: remaining || 0,
+  };
+};

packages/sdk/src/utils/validators.ts

@@ -93,6 +93,7 @@ export const grantedAccessSchema = () =>
     requesterrestrict: addressSchema().required(),
     salt: stringSchema().required(),
     sign: stringSchema().required(),
+    remainingAccess: number().integer().min(0).required(),
   })
     .noUnknown()
     .default(undefined);

packages/sdk/tests/unit/dataProtectorCore/getGrantedAccess.test.ts

@@ -258,6 +258,7 @@ describe('getGrantedAccess', () => {
           requesterrestrict: '0x0000000000000000000000000000000000000000',
           salt: '0x2a366726dc6321e78bba6697102f5953ceccfe6c0ddf9499dbb49c99bac1c16d',
           sign: '0xb00707c4be504e6e07d20bd2e52babd72cbd26f064ec7648c6b684578232bee255a9c98aa2e9b18b4088602967d4f0641d52c0fbb3d5c00304a1f6d3c19eaf4f1c',
+          remainingAccess: 10,
         },
       ]);
     });

packages/sdk/tests/unit/dataProtectorCore/grantAccess.test.ts

@@ -297,7 +297,8 @@ describe('dataProtectorCore.grantAccess()', () => {
           getDatasetOrderObject({
             withDataset: protectedDataAddress,
             withApp: authorizedAppAddress,
-          })
+          }),
+          10 // volume from getDatasetOrderObject
         )
       );
     });

packages/sdk/tests/unit/dataProtectorCore/revokeAllAccess.test.ts

@@ -150,8 +150,10 @@ describe('dataProtectorCore.revokeAllAccess()', () => {
       });
 
       // --- THEN
+      const expectedDatasetOrder = formatGrantedAccess(oneDatasetOrder.order, oneDatasetOrder.remaining);
+      const { remainingAccess, ...datasetOrderForCancel } = expectedDatasetOrder;
       expect(cancelDatasetorderMock).toHaveBeenCalledWith(
-        formatGrantedAccess(oneDatasetOrder.order)
+        datasetOrderForCancel
       );
       expect(onStatusUpdateMock).toHaveBeenCalledTimes(4);
       expect(onStatusUpdateMock).toHaveBeenNthCalledWith(1, {

packages/sdk/tests/unit/utils/formatGrantedAccess.test.ts

@@ -17,7 +17,7 @@ describe('formatGrantedAccess', () => {
       };
 
       // --- WHEN
-      const formattedOrder = formatGrantedAccess(order);
+      const formattedOrder = formatGrantedAccess(order, 5);
 
       // --- THEN
       expect(formattedOrder).toEqual({
@@ -30,6 +30,7 @@ describe('formatGrantedAccess', () => {
         requesterrestrict: '0x0000000000000000000000000000000000000000',
         salt: '0x2a366726dc6321e78bba6697102f5953ceccfe6c0ddf9499dbb49c99bac1c16d',
         sign: '0xb00707c4be504e6e07d20bd2e52babd72cbd26f064ec7648c6b684578232bee255a9c98aa2e9b18b4088602967d4f0641d52c0fbb3d5c00304a1f6d3c19eaf4f1c',
+        remainingAccess: 5,
       });
     });
   });