Refactor/type-validation (#951)

* chore(data): add @zk-kit/utils dependency

* refactor(data): refactor parameter validation using @zk-kit/utils

Author: FaezehShakouri

packages/data/package.json

@@ -38,6 +38,7 @@
     },
     "dependencies": {
         "@semaphore-protocol/utils": "4.8.2",
+        "@zk-kit/utils": "1.3.0",
         "axios": "1.6.6",
         "ethers": "6.13.4"
     }

packages/data/src/checkParameter.ts

@@ -17,8 +17,8 @@ import {
     Provider
 } from "ethers/providers"
 import { SemaphoreABI } from "@semaphore-protocol/utils/constants"
+import { requireString } from "@zk-kit/utils/error-handlers"
 import { EthersNetwork, EthersOptions, GroupResponse } from "./types"
-import checkParameter from "./checkParameter"
 import getEvents from "./getEvents"
 
 /**
@@ -40,16 +40,16 @@ export default class SemaphoreEthers {
      * @param options Configuration options for the ethers provider and the Semaphore contract.
      */
     constructor(networkOrEthereumURL: EthersNetwork | string = defaultNetwork, options: EthersOptions = {}) {
-        checkParameter(networkOrEthereumURL, "networkOrEthereumURL", "string")
+        requireString(networkOrEthereumURL, "networkOrEthereumURL")
 
         if (options.provider) {
-            checkParameter(options.provider, "provider", "string")
+            requireString(options.provider, "provider")
         } else if (!networkOrEthereumURL.startsWith("http")) {
             options.provider = "infura"
         }
 
         if (options.apiKey) {
-            checkParameter(options.apiKey, "apiKey", "string")
+            requireString(options.apiKey, "apiKey")
         }
 
         if (isSupportedNetwork(networkOrEthereumURL)) {
@@ -140,7 +140,7 @@ export default class SemaphoreEthers {
      * @returns A promise that resolves to a GroupResponse object.
      */
     async getGroup(groupId: string): Promise<GroupResponse> {
-        checkParameter(groupId, "groupId", "string")
+        requireString(groupId, "groupId")
 
         const groupAdmin = await this._contract.getGroupAdmin(groupId)
 
@@ -172,7 +172,7 @@ export default class SemaphoreEthers {
      * @returns A promise that resolves to an array of member identity commitments as strings.
      */
     async getGroupMembers(groupId: string): Promise<string[]> {
-        checkParameter(groupId, "groupId", "string")
+        requireString(groupId, "groupId")
 
         const groupAdmin = await this._contract.getGroupAdmin(groupId)
 
@@ -257,7 +257,7 @@ export default class SemaphoreEthers {
      * @returns A promise that resolves to an array of validated proofs.
      */
     async getGroupValidatedProofs(groupId: string): Promise<any> {
-        checkParameter(groupId, "groupId", "string")
+        requireString(groupId, "groupId")
 
         const groupAdmin = await this._contract.getGroupAdmin(groupId)
 
@@ -290,8 +290,8 @@ export default class SemaphoreEthers {
      * @returns A promise that resolves to true if the member is part of the group, otherwise false.
      */
     async isGroupMember(groupId: string, member: string): Promise<boolean> {
-        checkParameter(groupId, "groupId", "string")
-        checkParameter(member, "member", "string")
+        requireString(groupId, "groupId")
+        requireString(member, "member")
 
         return this._contract.hasMember(groupId, member)
     }

packages/data/src/ethers.ts

@@ -1,6 +1,6 @@
 import { defaultNetwork, SupportedNetwork } from "@semaphore-protocol/utils/networks"
 import { AxiosRequestConfig } from "axios"
-import checkParameter from "./checkParameter"
+import { requireString, requireObject, requireBoolean } from "@zk-kit/utils/error-handlers"
 import getURL from "./getURL"
 import request from "./request"
 import { GroupOptions, GroupResponse } from "./types"
@@ -24,7 +24,7 @@ export default class SemaphoreSubgraph {
      * @param networkOrSubgraphURL Either a supported network identifier or a direct URL to the subgraph.
      */
     constructor(networkOrSubgraphURL: SupportedNetwork | string = defaultNetwork) {
-        checkParameter(networkOrSubgraphURL, "networkOrSubgraphURL", "string")
+        requireString(networkOrSubgraphURL, "networkOrSubgraphURL")
 
         if (typeof networkOrSubgraphURL === "string" && networkOrSubgraphURL.startsWith("http")) {
             this._url = networkOrSubgraphURL
@@ -73,12 +73,12 @@ export default class SemaphoreSubgraph {
      * @returns A promise that resolves to an array of group details.
      */
     async getGroups(options: GroupOptions = {}): Promise<GroupResponse[]> {
-        checkParameter(options, "options", "object")
+        requireObject(options, "options")
 
         const { members = false, validatedProofs = false } = options
 
-        checkParameter(members, "members", "boolean")
-        checkParameter(validatedProofs, "validatedProofs", "boolean")
+        requireBoolean(members, "members")
+        requireBoolean(validatedProofs, "validatedProofs")
 
         let filtersQuery = ""
 
@@ -164,13 +164,13 @@ export default class SemaphoreSubgraph {
      * @returns A promise that resolves to the details of the specified group.
      */
     async getGroup(groupId: string, options: Omit<GroupOptions, "filters"> = {}): Promise<GroupResponse> {
-        checkParameter(groupId, "groupId", "string")
-        checkParameter(options, "options", "object")
+        requireString(groupId, "groupId")
+        requireObject(options, "options")
 
         const { members = false, validatedProofs = false } = options
 
-        checkParameter(members, "members", "boolean")
-        checkParameter(validatedProofs, "validatedProofs", "boolean")
+        requireBoolean(members, "members")
+        requireBoolean(validatedProofs, "validatedProofs")
 
         const config: AxiosRequestConfig = {
             method: "post",
@@ -247,8 +247,8 @@ export default class SemaphoreSubgraph {
      * @returns A promise that resolves to true if the member is part of the group, otherwise false.
      */
     async isGroupMember(groupId: string, member: string): Promise<boolean> {
-        checkParameter(groupId, "groupId", "string")
-        checkParameter(member, "member", "string")
+        requireString(groupId, "groupId")
+        requireString(member, "member")
 
         const config: AxiosRequestConfig = {
             method: "post",

packages/data/src/subgraph.ts

@@ -7624,6 +7624,7 @@ __metadata:
     "@rollup/plugin-json": "npm:^6.1.0"
     "@rollup/plugin-typescript": "npm:^11.1.6"
     "@semaphore-protocol/utils": "npm:4.8.2"
+    "@zk-kit/utils": "npm:1.3.0"
     axios: "npm:1.6.6"
     ethers: "npm:6.13.4"
     rimraf: "npm:^5.0.5"
@@ -9778,6 +9779,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@zk-kit/utils@npm:1.3.0":
+  version: 1.3.0
+  resolution: "@zk-kit/utils@npm:1.3.0"
+  dependencies:
+    buffer: "npm:^6.0.3"
+  checksum: 10/cfeb48687486034250f2878db115a54b02d3dca8a10d372e861bc6825e23dc1add5497e512adf4ed39706c62f4841384e138db1fbec3320af87deeabaf428063
+  languageName: node
+  linkType: hard
+
 "JSONStream@npm:^1.3.5":
   version: 1.3.5
   resolution: "JSONStream@npm:1.3.5"