@semaphore-protocol/utils 4.0.0-beta.2 → 4.0.0-beta.4

package/dist/lib.esm/decode-message.js

@@ -0,0 +1,26 @@
+/**
+ * @module @semaphore-protocol/utils
+ * @version 4.0.0-beta.4
+ * @file A library to provide utility functions to the other Semaphore packages.
+ * @copyright Ethereum Foundation 2024
+ * @license MIT
+ * @see [Github]{@link https://github.com/semaphore-protocol/semaphore/tree/main/packages/utils}
+*/
+import { decodeBytes32String } from 'ethers/abi';
+import { toBeHex } from 'ethers/utils';
+
+/**
+ * Typically used for decoding on-chain Semaphore messages.
+ * When Semaphore messages are text they are converted to bigints before
+ * the proof is generated (and eventually sent on-chain).
+ * This function help devs converting bigint messages to text again.
+ * If the original message was not text the output of this
+ * function won't probably be human-readable text.
+ * @param message The Semaphore message as a bigint.
+ * @returns The Semaphore message as a text.
+ */
+function decodeMessage(message) {
+    return decodeBytes32String(toBeHex(message, 32));
+}
+
+export { decodeMessage as default };

package/dist/lib.esm/index.js

@@ -1,12 +1,12 @@
 /**
  * @module @semaphore-protocol/utils
- * @version 4.0.0-beta.2
+ * @version 4.0.0-beta.4
  * @file A library to provide utility functions to the other Semaphore packages.
  * @copyright Ethereum Foundation 2024
  * @license MIT
  * @see [Github]{@link https://github.com/semaphore-protocol/semaphore/tree/main/packages/utils}
 */
-import * as errors from './errors.js';
-export { errors };
-import * as types from './types.js';
-export { types };
+import * as constants from './constants.js';
+export { constants };
+export { default as decodeMessage } from './decode-message.js';
+export { default as supportedNetworks } from './supported-networks.js';

package/dist/lib.esm/supported-networks.js

@@ -0,0 +1,12 @@
+/**
+ * @module @semaphore-protocol/utils
+ * @version 4.0.0-beta.4
+ * @file A library to provide utility functions to the other Semaphore packages.
+ * @copyright Ethereum Foundation 2024
+ * @license MIT
+ * @see [Github]{@link https://github.com/semaphore-protocol/semaphore/tree/main/packages/utils}
+*/
+// List of Semaphore supported networks.
+var supportedNetwork = ["sepolia", "mumbai", "optimism-sepolia", "arbitrum-sepolia", "arbitrum"];
+
+export { supportedNetwork as default };

package/dist/types/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const MIN_DEPTH = 1;
+export declare const MAX_DEPTH = 12;

package/dist/types/decode-message.d.ts

@@ -0,0 +1,12 @@
+import type { BigNumberish } from "ethers";
+/**
+ * Typically used for decoding on-chain Semaphore messages.
+ * When Semaphore messages are text they are converted to bigints before
+ * the proof is generated (and eventually sent on-chain).
+ * This function help devs converting bigint messages to text again.
+ * If the original message was not text the output of this
+ * function won't probably be human-readable text.
+ * @param message The Semaphore message as a bigint.
+ * @returns The Semaphore message as a text.
+ */
+export default function decodeMessage(message: BigNumberish): string;

package/dist/types/index.d.ts

@@ -1,3 +1,5 @@
-import * as errors from "./errors";
-import * as types from "./types";
-export { errors, types };
+import * as constants from "./constants";
+import decodeMessage from "./decode-message";
+import supportedNetworks from "./supported-networks";
+export * from "./types";
+export { constants, decodeMessage, supportedNetworks };

package/dist/types/supported-networks.d.ts

@@ -0,0 +1,3 @@
+import { SupportedNetwork } from "./types";
+declare const supportedNetwork: SupportedNetwork[];
+export default supportedNetwork;

package/dist/types/types/index.d.ts

@@ -0,0 +1 @@
+export type SupportedNetwork = "sepolia" | "mumbai" | "optimism-sepolia" | "arbitrum-sepolia" | "arbitrum";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@semaphore-protocol/utils",
-  "version": "4.0.0-beta.2",
+  "version": "4.0.0-beta.4",
   "description": "A library to provide utility functions to the other Semaphore packages.",
   "type": "module",
   "license": "MIT",
@@ -12,15 +12,20 @@
       "require": "./dist/index.cjs",
       "default": "./dist/index.js"
     },
-    "./errors": {
-      "types": "./dist/types/errors.d.ts",
-      "require": "./dist/lib.commonjs/errors.cjs",
-      "default": "./dist/lib.esm/errors.js"
+    "./supported-networks": {
+      "types": "./dist/types/supported-networks.d.ts",
+      "require": "./dist/lib.commonjs/supported-networks.cjs",
+      "default": "./dist/lib.esm/supported-networks.js"
     },
-    "./types": {
-      "types": "./dist/types/types.d.ts",
-      "require": "./dist/lib.commonjs/types.cjs",
-      "default": "./dist/lib.esm/types.js"
+    "./constants": {
+      "types": "./dist/types/constants.d.ts",
+      "require": "./dist/lib.commonjs/constants.cjs",
+      "default": "./dist/lib.esm/constants.js"
+    },
+    "./decode-message": {
+      "types": "./dist/types/decode-message.d.ts",
+      "require": "./dist/lib.commonjs/decode-message.cjs",
+      "default": "./dist/lib.esm/decode-message.js"
     }
   },
   "files": [
@@ -42,9 +47,12 @@
     "access": "public"
   },
   "devDependencies": {
+    "@rollup/plugin-typescript": "^11.1.6",
     "rimraf": "^5.0.5",
-    "rollup": "^4.9.6",
-    "rollup-plugin-cleanup": "^3.2.1",
-    "rollup-plugin-typescript2": "^0.36.0"
+    "rollup": "^4.12.0",
+    "rollup-plugin-cleanup": "^3.2.1"
+  },
+  "dependencies": {
+    "ethers": "^6.11.1"
   }
 }

package/src/constants.ts

@@ -0,0 +1,5 @@
+// TODO: Support all tree depths after trusted-setup. MAX_DEPTH would be 32.
+
+export const MIN_DEPTH = 1
+
+export const MAX_DEPTH = 12

package/src/decode-message.ts

@@ -0,0 +1,17 @@
+import type { BigNumberish } from "ethers"
+import { decodeBytes32String } from "ethers/abi"
+import { toBeHex } from "ethers/utils"
+
+/**
+ * Typically used for decoding on-chain Semaphore messages.
+ * When Semaphore messages are text they are converted to bigints before
+ * the proof is generated (and eventually sent on-chain).
+ * This function help devs converting bigint messages to text again.
+ * If the original message was not text the output of this
+ * function won't probably be human-readable text.
+ * @param message The Semaphore message as a bigint.
+ * @returns The Semaphore message as a text.
+ */
+export default function decodeMessage(message: BigNumberish) {
+    return decodeBytes32String(toBeHex(message, 32))
+}

package/src/index.ts

@@ -1,4 +1,6 @@
-import * as errors from "./errors"
-import * as types from "./types"
+import * as constants from "./constants"
+import decodeMessage from "./decode-message"
+import supportedNetworks from "./supported-networks"
 
-export { errors, types }
+export * from "./types"
+export { constants, decodeMessage, supportedNetworks }

package/src/supported-networks.ts

@@ -0,0 +1,6 @@
+import { SupportedNetwork } from "./types"
+
+// List of Semaphore supported networks.
+const supportedNetwork: SupportedNetwork[] = ["sepolia", "mumbai", "optimism-sepolia", "arbitrum-sepolia", "arbitrum"]
+
+export default supportedNetwork

package/src/types/index.ts

@@ -0,0 +1 @@
+export type SupportedNetwork = "sepolia" | "mumbai" | "optimism-sepolia" | "arbitrum-sepolia" | "arbitrum"

package/dist/lib.commonjs/errors.cjs

@@ -1,131 +0,0 @@
-/**
- * @module @semaphore-protocol/utils
- * @version 4.0.0-beta.2
- * @file A library to provide utility functions to the other Semaphore packages.
- * @copyright Ethereum Foundation 2024
- * @license MIT
- * @see [Github]{@link https://github.com/semaphore-protocol/semaphore/tree/main/packages/utils}
-*/
-'use strict';
-
-var types = require('./types.cjs');
-
-/**
- * @module Errors
- * This module is designed to provide utility functions for validating
- * function parameters. It includes functions that throw type errors if
- * the parameters do not meet specified criteria, such as being defined,
- * a number, a string, a function, or an array. This module helps ensure
- * that functions receive the correct types of inputs, enhancing code
- * reliability and reducing runtime errors.
- */
-/**
- * It throws a type error if the parameter value has not been defined.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-function requireDefined(parameterValue, parameterName) {
-    if (!types.isDefined(parameterValue)) {
-        throw new TypeError("Parameter '".concat(parameterName, "' is not defined"));
-    }
-}
-/**
- * It throws a type error if the parameter value is not a number.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-function requireNumber(parameterValue, parameterName) {
-    if (!types.isNumber(parameterValue)) {
-        throw new TypeError("Parameter '".concat(parameterName, "' is not a number"));
-    }
-}
-/**
- * It throws a type error if the parameter value is not a string.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-function requireString(parameterValue, parameterName) {
-    if (!types.isString(parameterValue)) {
-        throw new TypeError("Parameter '".concat(parameterName, "' is not a string"));
-    }
-}
-/**
- * It throws a type error if the parameter value is not a function.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-function requireFunction(parameterValue, parameterName) {
-    if (!types.isFunction(parameterValue)) {
-        throw new TypeError("Parameter '".concat(parameterName, "' is not a function"));
-    }
-}
-/**
- * It throws a type error if the parameter value is not an array.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-function requireArray(parameterValue, parameterName) {
-    if (!types.isArray(parameterValue)) {
-        throw new TypeError("Parameter '".concat(parameterName, "' is not an array"));
-    }
-}
-/**
- * It throws a type error if the parameter value is not a uint8array.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-function requireUint8Array(parameterValue, parameterName) {
-    if (!types.isUint8Array(parameterValue)) {
-        throw new TypeError("Parameter '".concat(parameterName, "' is not a Uint8Array"));
-    }
-}
-/**
- * It throws a type error if the parameter value is not an object.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-function requireObject(parameterValue, parameterName) {
-    if (!types.isObject(parameterValue)) {
-        throw new TypeError("Parameter '".concat(parameterName, "' is not an object"));
-    }
-}
-/**
- * It throws a type error if the parameter value is not a bigint.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-function requireBigInt(parameterValue, parameterName) {
-    if (!types.isBigInt(parameterValue)) {
-        throw new TypeError("Parameter '".concat(parameterName, "' is not a bigint"));
-    }
-}
-/**
- * It throws a type error if the parameter value type is not part of the list of types.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-function requireTypes(parameterValue, parameterName, types$1) {
-    for (var _i = 0, types_1 = types$1; _i < types_1.length; _i++) {
-        var type = types_1[_i];
-        if (!types.isSupportedType(type)) {
-            throw new Error("Type '".concat(type, "' is not supported"));
-        }
-    }
-    for (var _a = 0, types_2 = types$1; _a < types_2.length; _a++) {
-        var type = types_2[_a];
-        if (types.isType(parameterValue, type)) {
-            return;
-        }
-    }
-    throw new TypeError("Parameter '".concat(parameterName, "' is none of the following types: ").concat(types$1.join(", ")));
-}
-
-exports.requireArray = requireArray;
-exports.requireBigInt = requireBigInt;
-exports.requireDefined = requireDefined;
-exports.requireFunction = requireFunction;
-exports.requireNumber = requireNumber;
-exports.requireObject = requireObject;
-exports.requireString = requireString;
-exports.requireTypes = requireTypes;
-exports.requireUint8Array = requireUint8Array;

package/dist/lib.commonjs/types.cjs

@@ -1,130 +0,0 @@
-/**
- * @module @semaphore-protocol/utils
- * @version 4.0.0-beta.2
- * @file A library to provide utility functions to the other Semaphore packages.
- * @copyright Ethereum Foundation 2024
- * @license MIT
- * @see [Github]{@link https://github.com/semaphore-protocol/semaphore/tree/main/packages/utils}
-*/
-'use strict';
-
-/**
- * @module Types
- * This module provides utility functions to check data types.
- * It defines a set of supported types and includes functions to check if
- * a value is defined and if it matches a supported type. These functions
- * are useful for type checking and validation in the other libraries,
- * enhancing code robustness and reliability.
- */
-// The list of types supported by this utility functions.
-var supportedTypes = ["number", "string", "function", "array", "uint8array", "object", "bigint"];
-/**
- * It returns true if the value is defined, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-function isDefined(value) {
-    return typeof value !== "undefined";
-}
-/**
- * It returns true if the value is a number, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-function isNumber(value) {
-    return typeof value === "number";
-}
-/**
- * It returns true if the value is a string, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-function isString(value) {
-    return typeof value === "string";
-}
-/**
- * It returns true if the value is a function, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-function isFunction(value) {
-    return typeof value === "function";
-}
-/**
- * It returns true if the value is an array, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-function isArray(value) {
-    return typeof value === "object" && Array.isArray(value);
-}
-/**
- * It returns true if the value is a uint8array, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-function isUint8Array(value) {
-    return value instanceof Uint8Array;
-}
-/**
- * It returns true if the value is an object, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-function isObject(value) {
-    return typeof value === "object";
-}
-/**
- * It returns true if the value is a bigint, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-function isBigInt(value) {
-    return typeof value === "bigint";
-}
-/**
- * It returns true if the value type is the same as the type passed
- * as the second parameter, false otherwise.
- * @param type The expected type.
- * @returns True or false.
- */
-function isType(value, type) {
-    switch (type) {
-        case "number":
-            return isNumber(value);
-        case "string":
-            return isString(value);
-        case "function":
-            return isFunction(value);
-        case "array":
-            return isArray(value);
-        case "uint8array":
-            return isUint8Array(value);
-        case "object":
-            return isObject(value);
-        case "bigint":
-            return isBigInt(value);
-        default:
-            return false;
-    }
-}
-/**
- * Return true if the type is being supported by this utility
- * functions, false otherwise.
- * @param type The type to be checked.
- * @returns True or false
- */
-function isSupportedType(type) {
-    return supportedTypes.includes(type);
-}
-
-exports.isArray = isArray;
-exports.isBigInt = isBigInt;
-exports.isDefined = isDefined;
-exports.isFunction = isFunction;
-exports.isNumber = isNumber;
-exports.isObject = isObject;
-exports.isString = isString;
-exports.isSupportedType = isSupportedType;
-exports.isType = isType;
-exports.isUint8Array = isUint8Array;

package/dist/lib.esm/errors.js

@@ -1,121 +0,0 @@
-/**
- * @module @semaphore-protocol/utils
- * @version 4.0.0-beta.2
- * @file A library to provide utility functions to the other Semaphore packages.
- * @copyright Ethereum Foundation 2024
- * @license MIT
- * @see [Github]{@link https://github.com/semaphore-protocol/semaphore/tree/main/packages/utils}
-*/
-import { isDefined, isNumber, isString, isFunction, isArray, isUint8Array, isObject, isBigInt, isSupportedType, isType } from './types.js';
-
-/**
- * @module Errors
- * This module is designed to provide utility functions for validating
- * function parameters. It includes functions that throw type errors if
- * the parameters do not meet specified criteria, such as being defined,
- * a number, a string, a function, or an array. This module helps ensure
- * that functions receive the correct types of inputs, enhancing code
- * reliability and reducing runtime errors.
- */
-/**
- * It throws a type error if the parameter value has not been defined.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-function requireDefined(parameterValue, parameterName) {
-    if (!isDefined(parameterValue)) {
-        throw new TypeError("Parameter '".concat(parameterName, "' is not defined"));
-    }
-}
-/**
- * It throws a type error if the parameter value is not a number.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-function requireNumber(parameterValue, parameterName) {
-    if (!isNumber(parameterValue)) {
-        throw new TypeError("Parameter '".concat(parameterName, "' is not a number"));
-    }
-}
-/**
- * It throws a type error if the parameter value is not a string.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-function requireString(parameterValue, parameterName) {
-    if (!isString(parameterValue)) {
-        throw new TypeError("Parameter '".concat(parameterName, "' is not a string"));
-    }
-}
-/**
- * It throws a type error if the parameter value is not a function.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-function requireFunction(parameterValue, parameterName) {
-    if (!isFunction(parameterValue)) {
-        throw new TypeError("Parameter '".concat(parameterName, "' is not a function"));
-    }
-}
-/**
- * It throws a type error if the parameter value is not an array.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-function requireArray(parameterValue, parameterName) {
-    if (!isArray(parameterValue)) {
-        throw new TypeError("Parameter '".concat(parameterName, "' is not an array"));
-    }
-}
-/**
- * It throws a type error if the parameter value is not a uint8array.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-function requireUint8Array(parameterValue, parameterName) {
-    if (!isUint8Array(parameterValue)) {
-        throw new TypeError("Parameter '".concat(parameterName, "' is not a Uint8Array"));
-    }
-}
-/**
- * It throws a type error if the parameter value is not an object.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-function requireObject(parameterValue, parameterName) {
-    if (!isObject(parameterValue)) {
-        throw new TypeError("Parameter '".concat(parameterName, "' is not an object"));
-    }
-}
-/**
- * It throws a type error if the parameter value is not a bigint.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-function requireBigInt(parameterValue, parameterName) {
-    if (!isBigInt(parameterValue)) {
-        throw new TypeError("Parameter '".concat(parameterName, "' is not a bigint"));
-    }
-}
-/**
- * It throws a type error if the parameter value type is not part of the list of types.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-function requireTypes(parameterValue, parameterName, types) {
-    for (var _i = 0, types_1 = types; _i < types_1.length; _i++) {
-        var type = types_1[_i];
-        if (!isSupportedType(type)) {
-            throw new Error("Type '".concat(type, "' is not supported"));
-        }
-    }
-    for (var _a = 0, types_2 = types; _a < types_2.length; _a++) {
-        var type = types_2[_a];
-        if (isType(parameterValue, type)) {
-            return;
-        }
-    }
-    throw new TypeError("Parameter '".concat(parameterName, "' is none of the following types: ").concat(types.join(", ")));
-}
-
-export { requireArray, requireBigInt, requireDefined, requireFunction, requireNumber, requireObject, requireString, requireTypes, requireUint8Array };