From b8d4782a216684dad10d728d33940464d110d6d8 Mon Sep 17 00:00:00 2001
From: Chirag <ckotian117@gmail.com>
Date: Fri, 8 Nov 2024 22:41:14 +0530
Subject: [PATCH] Refactor PortalDataMapper: add customAbi, update
 simulateAttest, remove attestV2

---
 sdk/src/dataMapper/PortalDataMapper.test.ts |  12 +-
 sdk/src/dataMapper/PortalDataMapper.ts      | 190 ++++++--------------
 2 files changed, 70 insertions(+), 132 deletions(-)

diff --git a/sdk/src/dataMapper/PortalDataMapper.test.ts b/sdk/src/dataMapper/PortalDataMapper.test.ts
index d97d6fb2..d3539669 100644
--- a/sdk/src/dataMapper/PortalDataMapper.test.ts
+++ b/sdk/src/dataMapper/PortalDataMapper.test.ts
@@ -20,11 +20,21 @@ describe("PortalDataMapper", () => {
     attestationRegistryAddress: "0x4",
   };
   const mockWeb3Client = {} as PublicClient;
-  const mockVeraxSdk = {} as VeraxSdk;
   const mockWalletClient = {} as WalletClient;
+  const mockVeraxSdk = {
+    schema: {
+      findOneById: jest.fn(),
+    },
+  } as unknown as VeraxSdk;
 
   beforeEach(() => {
     portalDataMapper = new PortalDataMapper(mockConf, mockWeb3Client, mockVeraxSdk, mockWalletClient);
+
+    // Setup a default mock return value for findOneById
+    (mockVeraxSdk.schema.findOneById as jest.Mock).mockResolvedValue({
+      id: "123",
+      name: "Sample Schema",
+    });
   });
 
   afterEach(() => {
diff --git a/sdk/src/dataMapper/PortalDataMapper.ts b/sdk/src/dataMapper/PortalDataMapper.ts
index 3af7a5e2..62ee378d 100644
--- a/sdk/src/dataMapper/PortalDataMapper.ts
+++ b/sdk/src/dataMapper/PortalDataMapper.ts
@@ -27,6 +27,7 @@ export default class PortalDataMapper extends BaseDataMapper<Portal, Portal_filt
     attestationPayload: AttestationPayload,
     validationPayloads: string[],
     value: bigint = 0n,
+    customAbi?: any,
   ) {
     const matchingSchema = await this.veraxSdk.schema.findOneById(attestationPayload.schemaId);
     if (!matchingSchema) {
@@ -41,6 +42,7 @@ export default class PortalDataMapper extends BaseDataMapper<Portal, Portal_filt
         validationPayloads,
       ],
       value,
+      customAbi,
     );
   }
 
@@ -50,8 +52,9 @@ export default class PortalDataMapper extends BaseDataMapper<Portal, Portal_filt
     validationPayloads: string[],
     waitForConfirmation: boolean = false,
     value: bigint = 0n,
+    customAbi?: any,
   ) {
-    const request = await this.simulateAttest(portalAddress, attestationPayload, validationPayloads, value);
+    const request = await this.simulateAttest(portalAddress, attestationPayload, validationPayloads, value, customAbi);
     return executeTransaction(request, this.web3Client, this.walletClient, waitForConfirmation);
   }
 
@@ -59,6 +62,7 @@ export default class PortalDataMapper extends BaseDataMapper<Portal, Portal_filt
     portalAddress: Address,
     attestationPayloads: AttestationPayload[],
     validationPayloads: string[][],
+    customAbi?: any,
   ) {
     const attestationPayloadsArg = [];
 
@@ -76,67 +80,46 @@ export default class PortalDataMapper extends BaseDataMapper<Portal, Portal_filt
         attestationData,
       ]);
     }
-    return this.simulatePortalContract(portalAddress, "bulkAttest", [attestationPayloadsArg, validationPayloads]);
-  }
-
-  async simulateAttestV2(
-    portalAddress: Address,
-    attestationPayload: AttestationPayload,
-    validationPayloads: string[],
-    value: bigint = 0n,
-  ) {
-    const matchingSchema = await this.veraxSdk.schema.findOneById(attestationPayload.schemaId);
-    if (!matchingSchema) {
-      throw new Error("No matching Schema");
-    }
-    const attestationData = encode(matchingSchema.schema, attestationPayload.attestationData);
     return this.simulatePortalContract(
       portalAddress,
-      "attestV2",
-      [
-        [attestationPayload.schemaId, attestationPayload.expirationDate, attestationPayload.subject, attestationData],
-        validationPayloads,
-      ],
-      value,
+      "bulkAttest",
+      [attestationPayloadsArg, validationPayloads],
+      0n,
+      customAbi,
     );
   }
 
-  async attestV2(
-    portalAddress: Address,
-    attestationPayload: AttestationPayload,
-    validationPayloads: string[],
-    waitForConfirmation: boolean = false,
-    value: bigint = 0n,
-  ) {
-    const request = await this.simulateAttestV2(portalAddress, attestationPayload, validationPayloads, value);
-    return executeTransaction(request, this.web3Client, this.walletClient, waitForConfirmation);
-  }
-
   async bulkAttest(
     portalAddress: Address,
     attestationPayloads: AttestationPayload[],
     validationPayloads: string[][],
     waitForConfirmation: boolean = false,
+    customAbi?: any,
   ) {
-    const request = await this.simulateBulkAttest(portalAddress, attestationPayloads, validationPayloads);
+    const request = await this.simulateBulkAttest(portalAddress, attestationPayloads, validationPayloads, customAbi);
     return executeTransaction(request, this.web3Client, this.walletClient, waitForConfirmation);
   }
 
-  async simulateRevoke(portalAddress: Address, attestationId: string) {
-    return this.simulatePortalContract(portalAddress, "revoke", [attestationId]);
+  async simulateRevoke(portalAddress: Address, attestationId: string, customAbi?: any) {
+    return this.simulatePortalContract(portalAddress, "revoke", [attestationId], 0n, customAbi);
   }
 
-  async revoke(portalAddress: Address, attestationId: string, waitForConfirmation: boolean = false) {
-    const request = await this.simulateRevoke(portalAddress, attestationId);
+  async revoke(portalAddress: Address, attestationId: string, waitForConfirmation: boolean = false, customAbi?: any) {
+    const request = await this.simulateRevoke(portalAddress, attestationId, customAbi);
     return executeTransaction(request, this.web3Client, this.walletClient, waitForConfirmation);
   }
 
-  async simulateBulkRevoke(portalAddress: Address, attestationIds: string[]) {
-    return this.simulatePortalContract(portalAddress, "bulkRevoke", [attestationIds]);
+  async simulateBulkRevoke(portalAddress: Address, attestationIds: string[], customAbi?: any) {
+    return this.simulatePortalContract(portalAddress, "bulkRevoke", [attestationIds], 0n, customAbi);
   }
 
-  async bulkRevoke(portalAddress: Address, attestationIds: string[], waitForConfirmation: boolean = false) {
-    const request = await this.simulateBulkRevoke(portalAddress, attestationIds);
+  async bulkRevoke(
+    portalAddress: Address,
+    attestationIds: string[],
+    waitForConfirmation: boolean = false,
+    customAbi?: any,
+  ) {
+    const request = await this.simulateBulkRevoke(portalAddress, attestationIds, customAbi);
     return executeTransaction(request, this.web3Client, this.walletClient, waitForConfirmation);
   }
 
@@ -145,17 +128,24 @@ export default class PortalDataMapper extends BaseDataMapper<Portal, Portal_filt
     attestationId: string,
     attestationPayload: AttestationPayload,
     validationPayloads: string[],
+    customAbi?: any,
   ) {
     const matchingSchema = await this.veraxSdk.schema.findOneById(attestationPayload.schemaId);
     if (!matchingSchema) {
       throw new Error("No matching Schema");
     }
     const attestationData = encode(matchingSchema.schema, attestationPayload.attestationData);
-    return this.simulatePortalContract(portalAddress, "replace", [
-      attestationId,
-      [attestationPayload.schemaId, attestationPayload.expirationDate, attestationPayload.subject, attestationData],
-      validationPayloads,
-    ]);
+    return this.simulatePortalContract(
+      portalAddress,
+      "replace",
+      [
+        attestationId,
+        [attestationPayload.schemaId, attestationPayload.expirationDate, attestationPayload.subject, attestationData],
+        validationPayloads,
+      ],
+      0n,
+      customAbi,
+    );
   }
 
   async replace(
@@ -164,8 +154,15 @@ export default class PortalDataMapper extends BaseDataMapper<Portal, Portal_filt
     attestationPayload: AttestationPayload,
     validationPayloads: string[],
     waitForConfirmation: boolean = false,
+    customAbi?: any,
   ) {
-    const request = await this.simulateReplace(portalAddress, attestationId, attestationPayload, validationPayloads);
+    const request = await this.simulateReplace(
+      portalAddress,
+      attestationId,
+      attestationPayload,
+      validationPayloads,
+      customAbi,
+    );
     return executeTransaction(request, this.web3Client, this.walletClient, waitForConfirmation);
   }
 
@@ -174,6 +171,7 @@ export default class PortalDataMapper extends BaseDataMapper<Portal, Portal_filt
     attestationIds: string[],
     attestationPayloads: AttestationPayload[],
     validationPayloads: string[][],
+    customAbi?: any,
   ) {
     const attestationPayloadsArg = [];
 
@@ -190,11 +188,13 @@ export default class PortalDataMapper extends BaseDataMapper<Portal, Portal_filt
         attestationData,
       ]);
     }
-    return this.simulatePortalContract(portalAddress, "bulkReplace", [
-      attestationIds,
-      attestationPayloadsArg,
-      validationPayloads,
-    ]);
+    return this.simulatePortalContract(
+      portalAddress,
+      "bulkReplace",
+      [attestationIds, attestationPayloadsArg, validationPayloads],
+      0n,
+      customAbi,
+    );
   }
 
   async bulkReplace(
@@ -203,105 +203,33 @@ export default class PortalDataMapper extends BaseDataMapper<Portal, Portal_filt
     attestationPayloads: AttestationPayload[],
     validationPayloads: string[][],
     waitForConfirmation: boolean = false,
+    customAbi?: any,
   ) {
     const request = await this.simulateBulkReplace(
       portalAddress,
       attestationIds,
       attestationPayloads,
       validationPayloads,
+      customAbi,
     );
     return executeTransaction(request, this.web3Client, this.walletClient, waitForConfirmation);
   }
 
-  async simulateRegister(id: Address, name: string, description: string, isRevocable: boolean, ownerName: string) {
-    return this.simulatePortalRegistryContract("register", [id, name, description, isRevocable, ownerName]);
-  }
-
-  async register(
-    id: Address,
-    name: string,
-    description: string,
-    isRevocable: boolean,
-    ownerName: string,
-    waitForConfirmation: boolean = false,
-  ) {
-    const request = await this.simulateRegister(id, name, description, isRevocable, ownerName);
-    return executeTransaction(request, this.web3Client, this.walletClient, waitForConfirmation);
-  }
-
-  async simulateDeployDefaultPortal(
-    modules: Address[],
-    name: string,
-    description: string,
-    isRevocable: boolean,
-    ownerName: string,
-  ) {
-    return this.simulatePortalRegistryContract("deployDefaultPortal", [
-      modules,
-      name,
-      description,
-      isRevocable,
-      ownerName,
-    ]);
-  }
-
-  async deployDefaultPortal(
-    modules: Address[],
-    name: string,
-    description: string,
-    isRevocable: boolean,
-    ownerName: string,
-    waitForConfirmation: boolean = false,
-  ) {
-    const request = await this.simulateDeployDefaultPortal(modules, name, description, isRevocable, ownerName);
-    return executeTransaction(request, this.web3Client, this.walletClient, waitForConfirmation);
-  }
-
-  async getPortalByAddress(id: Address) {
-    return this.executePortalRegistryReadMethod("getPortalByAddress", [id]);
-  }
-
-  async isPortalRegistered(id: Address) {
-    return this.executePortalRegistryReadMethod("isRegistered", [id]);
-  }
-
-  private async executePortalRegistryReadMethod(functionName: string, args: unknown[]) {
-    return this.web3Client.readContract({
-      abi: abiPortalRegistry,
-      address: this.conf.portalRegistryAddress,
-      functionName,
-      args,
-    });
-  }
-
-  private async simulatePortalRegistryContract(functionName: string, args: unknown[]) {
-    if (!this.walletClient) throw new Error("VeraxSDK - Wallet not available");
-    try {
-      const { request } = await this.web3Client.simulateContract({
-        address: this.conf.portalRegistryAddress,
-        abi: abiPortalRegistry,
-        functionName,
-        account: this.walletClient.account,
-        args,
-      });
-
-      return request;
-    } catch (err) {
-      handleError(ActionType.Simulation, err);
-    }
-  }
-
   private async simulatePortalContract(
     portalAddress: Address,
     functionName: string,
     args: unknown[],
     value: bigint = 0n,
+    customAbi?: any,
   ) {
     if (!this.walletClient) throw new Error("VeraxSDK - Wallet not available");
+
+    const abi = customAbi ? [...abiDefaultPortal, ...customAbi] : abiDefaultPortal;
+
     try {
       const { request } = await this.web3Client.simulateContract({
         address: portalAddress,
-        abi: abiDefaultPortal,
+        abi: abi,
         functionName,
         account: this.walletClient.account,
         args,