feat: add remainingAccess support to getGrantedAccess function

feat: add remainingAccess support to getGrantedAccess function

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,18 +1,28 @@
 import { GrantedAccess } from '../lib/types/index.js';
 
-export const formatGrantedAccess = (order: {
-  datasetprice: number | string;
-  volume: number | string;
-  tag: string;
-  apprestrict: string;
-  workerpoolrestrict: string;
-  requesterrestrict: string;
-  salt: string;
-  sign: string;
-}): GrantedAccess =>
-  Object.fromEntries(
+export const formatGrantedAccess = (
+  order: {
+    dataset: string;
+    datasetprice: number | string;
+    volume: number | string;
+    tag: string;
+    apprestrict: string;
+    workerpoolrestrict: string;
+    requesterrestrict: string;
+    salt: string;
+    sign: string;
+  },
+  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);