chore(lib): allowlist helpers to allowlists lib

To gradually clean up the repo, we agreed on restructuring helpers from
utils to more cleanly scoped libs. Additionally, added some tests

Author: bitbeckers

pnpm-lock.yaml

@@ -9,7 +9,7 @@ import {
   Tags,
 } from "tsoa";
 import { StorageService } from "../services/StorageService.js";
-import { parseAndValidateMerkleTree } from "../utils/parseAndValidateMerkleTreeDump.js";
+import { parseAndValidateMerkleTree } from "../lib/allowlists/parseAndValidateMerkleTreeDump.js";
 import type {
   StorageResponse,
   StoreAllowListRequest,

src/controllers/AllowListController.ts

@@ -19,7 +19,7 @@ import type {
 } from "../types/api.js";
 import { validateMetadataAndClaimdata } from "../utils/validateMetadataAndClaimdata.js";
 import { validateRemoteAllowList } from "../utils/validateRemoteAllowList.js";
-import { parseAndValidateMerkleTree } from "../utils/parseAndValidateMerkleTreeDump.js";
+import { parseAndValidateMerkleTree } from "../lib/allowlists/parseAndValidateMerkleTreeDump.js";
 
 @Route("v1/metadata")
 @Tags("Metadata")

src/controllers/MetadataController.ts

@@ -0,0 +1,21 @@
+import { StandardMerkleTree } from "@openzeppelin/merkle-tree";
+
+export const tryParseMerkleTree = (allowList: unknown) => {
+  try {
+    StandardMerkleTree.load(JSON.parse(allowList as string));
+
+    return true;
+  } catch (e) {
+    console.warn("Error loading merkle tree as JSON", e);
+  }
+
+  try {
+    StandardMerkleTree.load(allowList as never);
+
+    return true;
+  } catch (e) {
+    console.warn("Error loading merkle tree from dump", e);
+  }
+
+  return false;
+};

src/lib/allowlists/isParsableToMerkleTree.ts

@@ -1,9 +1,10 @@
 import { validateAllowlist } from "@hypercerts-org/sdk";
 import { parseMerkleTree } from "./parseMerkleTree.js";
-import { parseEther } from "viem";
-import { ValidateAllowListRequest } from "../types/api.js";
+import { ValidateAllowListRequest } from "../../types/api.js";
 
-export const parseAndValidateMerkleTree = (request: ValidateAllowListRequest) => {
+export const parseAndValidateMerkleTree = (
+  request: ValidateAllowListRequest,
+) => {
   const { allowList, totalUnits } = request;
   const _merkleTree = parseMerkleTree(allowList);
 
@@ -12,17 +13,20 @@ export const parseAndValidateMerkleTree = (request: ValidateAllowListRequest) =>
       data: _merkleTree,
       valid: false,
       errors: {
-        allowListData: "Data could not be parsed to OpenZeppelin MerkleTree"
-      }
+        allowListData: "Data could not be parsed to OpenZeppelin MerkleTree",
+      },
     };
   }
 
-  const allowListEntries = Array.from(_merkleTree.entries()).map(entry => ({
+  const allowListEntries = Array.from(_merkleTree.entries()).map((entry) => ({
     address: entry[1][0],
-    units: BigInt(entry[1][1])
+    units: BigInt(entry[1][1]),
   }));
 
-  const totalUnitsInEntries = allowListEntries.reduce((acc, entry) => acc + entry.units, BigInt(0));
+  const totalUnitsInEntries = allowListEntries.reduce(
+    (acc, entry) => acc + entry.units,
+    BigInt(0),
+  );
 
   if (totalUnits) {
     if (totalUnitsInEntries !== BigInt(totalUnits)) {
@@ -31,8 +35,8 @@ export const parseAndValidateMerkleTree = (request: ValidateAllowListRequest) =>
         valid: false,
         errors: {
           totalUnits:
-            "Total units do not match the sum of units in the allowlist"
-        }
+            "Total units do not match the sum of units in the allowlist",
+        },
       };
     }
 
@@ -41,8 +45,8 @@ export const parseAndValidateMerkleTree = (request: ValidateAllowListRequest) =>
         data: _merkleTree,
         valid: false,
         errors: {
-          totalUnits: "Total units should amount to 100M (100_000_000) units"
-        }
+          totalUnits: "Total units should amount to 100M (100_000_000) units",
+        },
       };
     }
   }

…/utils/parseAndValidateMerkleTreeDump.ts …wlists/parseAndValidateMerkleTreeDump.tssrc/utils/parseAndValidateMerkleTreeDump.ts renamed to src/lib/allowlists/parseAndValidateMerkleTreeDump.ts src/utils/parseAndValidateMerkleTreeDump.ts renamed to src/lib/allowlists/parseAndValidateMerkleTreeDump.ts

@@ -0,0 +1,15 @@
+import { StandardMerkleTree } from "@openzeppelin/merkle-tree";
+
+export const parseMerkleTree = (allowList: string) => {
+  try {
+    return StandardMerkleTree.load(JSON.parse(allowList));
+  } catch (e) {
+    console.warn("Error loading merkle tree as JSON", e);
+  }
+
+  try {
+    return StandardMerkleTree.load(allowList as never);
+  } catch (e) {
+    console.warn("Error loading merkle tree from dump", e);
+  }
+};

src/lib/allowlists/parseMerkleTree.ts

@@ -1,31 +1,33 @@
 import { getFromIPFS } from "@hypercerts-org/sdk";
-import { tryParseMerkleTree } from "./isParsableToMerkleTree.js";
+import { tryParseMerkleTree } from "../lib/allowlists/isParsableToMerkleTree.js";
 import { ValidationResult } from "../types/api.js";
 
-export const validateRemoteAllowList = async (uri: string): Promise<ValidationResult<unknown>> => {
+export const validateRemoteAllowList = async (
+  uri: string,
+): Promise<ValidationResult<unknown>> => {
   try {
     const allowList = await getFromIPFS(uri, 30000);
 
     if (!allowList || typeof allowList !== "string") {
       return {
         valid: false,
         errors: {
-          message: "Allow list data not found or not of expected type"
-        }
+          message: "Allow list data not found or not of expected type",
+        },
       };
     }
 
     if (tryParseMerkleTree(allowList)) {
       return {
         valid: true,
-        data: allowList
+        data: allowList,
       };
     } else {
       return {
         valid: false,
         errors: {
-          message: `Allow list at ${uri} should be a valid openzeppelin merkle tree`
-        }
+          message: `Allow list at ${uri} should be a valid openzeppelin merkle tree`,
+        },
       };
     }
   } catch (e) {
@@ -34,11 +36,8 @@ export const validateRemoteAllowList = async (uri: string): Promise<ValidationRe
     return {
       valid: false,
       errors: {
-        message: error.message
-      }
+        message: error.message,
+      },
     };
-
   }
-
-
-};
+};