@semaphore-protocol/utils 4.0.0-beta.3 → 4.0.0-beta.5

package/dist/index.cjs

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/utils
- * @version 4.0.0-beta.3
+ * @version 4.0.0-beta.5
  * @file A library to provide utility functions to the other Semaphore packages.
  * @copyright Ethereum Foundation 2024
  * @license MIT
@@ -12,8 +12,8 @@ var abi = require('ethers/abi');
 var utils = require('ethers/utils');
 
 // TODO: Support all tree depths after trusted-setup. MAX_DEPTH would be 32.
-var MIN_DEPTH = 1;
-var MAX_DEPTH = 12;
+const MIN_DEPTH = 1;
+const MAX_DEPTH = 12;
 
 var constants = /*#__PURE__*/Object.freeze({
     __proto__: null,
@@ -35,9 +35,168 @@ function decodeMessage(message) {
     return abi.decodeBytes32String(utils.toBeHex(message, 32));
 }
 
-// List of Semaphore supported networks.
-var supportedNetwork = ["sepolia", "mumbai", "optimism-sepolia", "arbitrum-sepolia", "arbitrum"];
+var deployedContracts = [
+	{
+		network: "sepolia",
+		contracts: [
+			{
+				name: "SemaphoreVerifier",
+				address: "0x58AD7a4389E0F5d814815E5D5A3Ab903dAE9284a",
+				startBlock: 5539276
+			},
+			{
+				name: "PoseidonT3",
+				address: "0x4EFfF6a6a7BB31cdAd9Ee742b0faAA6Bb9BF096B",
+				startBlock: 5539276
+			},
+			{
+				name: "Semaphore",
+				address: "0x0A09FB3f63c13F1C54F2fA41AFB1e7a98cffc774",
+				startBlock: 5539276
+			}
+		]
+	},
+	{
+		network: "arbitrum-sepolia",
+		contracts: [
+			{
+				name: "SemaphoreVerifier",
+				address: "0x5f4edC58142f4395D1D536e793137A0252dA5a49",
+				startBlock: 25837653
+			},
+			{
+				name: "PoseidonT3",
+				address: "0x181B7f34538cE3BceC68597d4A212aB3f7881648",
+				startBlock: 25837653
+			},
+			{
+				name: "Semaphore",
+				address: "0x220fBdB6F996827b1Cf12f0C181E8d5e6de3a36F",
+				startBlock: 25837653
+			}
+		]
+	},
+	{
+		network: "optimism-sepolia",
+		contracts: [
+			{
+				name: "SemaphoreVerifier",
+				address: "0x3d3df6CFc6BFf68d9693e097F32bF4a9903E77a5",
+				startBlock: 9663266
+			},
+			{
+				name: "PoseidonT3",
+				address: "0x5f4edC58142f4395D1D536e793137A0252dA5a49",
+				startBlock: 9663266
+			},
+			{
+				name: "Semaphore",
+				address: "0x181B7f34538cE3BceC68597d4A212aB3f7881648",
+				startBlock: 9663266
+			}
+		]
+	},
+	{
+		network: "matic-mumbai",
+		contracts: [
+			{
+				name: "SemaphoreVerifier",
+				address: "0xE5269ae1E996C6FEEf6E832c7032401E73087568",
+				startBlock: 47356015
+			},
+			{
+				name: "PoseidonT3",
+				address: "0xC0ae1a8D3505B2bE9DCe0e826abd722Afd13F1c9",
+				startBlock: 47356015
+			},
+			{
+				name: "Semaphore",
+				address: "0x346a936b19071b2f619200848B8ADbb938D72250",
+				startBlock: 47356015
+			}
+		]
+	}
+];
+
+var supportedNetworks = {
+    sepolia: {
+        name: "Sepolia",
+        url: "https://rpc2.sepolia.org",
+        chainId: 11155111,
+        explorer: "https://sepolia.etherscan.io"
+    },
+    "arbitrum-sepolia": {
+        name: "Arbitrum Sepolia",
+        url: "https://sepolia-rollup.arbitrum.io/rpc",
+        chainId: 421614,
+        explorer: "https://sepolia.arbiscan.io"
+    },
+    "optimism-sepolia": {
+        name: "Optimism Sepolia",
+        url: "https://sepolia.optimism.io",
+        chainId: 11155420,
+        explorer: "https://sepolia-optimism.etherscan.io"
+    },
+    "matic-mumbai": {
+        name: "Matic Mumbai",
+        url: "https://rpc-mumbai.polygon.technology",
+        chainId: 80001,
+        explorer: "https://mumbai.polygonscan.com"
+    }
+};
+
+/**
+ * @module Networks
+ * This module provides a collection of utility functions to provide the other internal
+ * packages and developers with information on deployed contracts and networks supported
+ * by Semaphore.
+ */
+// Default Semaphore network.
+const defaultNetwork = "sepolia";
+/**
+ * Returns true if a network is supported by Semaphore, false otherwise.
+ * @param supportedNetwork The network to be checked.
+ */
+function isSupportedNetwork(supportedNetwork) {
+    return Object.keys(supportedNetworks).includes(supportedNetwork);
+}
+/**
+ * Utility function to get an object compatible with the Hardhat 'networks' option.
+ * If the private key is not defined it returns an empty object.
+ * @param privateKey Private key to be used with networks.
+ * @returns An object compatible with the Hardhat 'networks' option.
+ */
+function getHardhatNetworks(privateKey) {
+    if (!privateKey) {
+        return {};
+    }
+    const supportedNetworksCopy = JSON.parse(JSON.stringify(supportedNetworks));
+    for (const key in supportedNetworksCopy) {
+        if (Object.prototype.hasOwnProperty.call(supportedNetworksCopy, key)) {
+            supportedNetworksCopy[key].accounts = [`0x${privateKey}`];
+        }
+    }
+    return supportedNetworksCopy;
+}
+/**
+ * Returns name, address and start block of a Semaphore contract deployed
+ * on a specific supported network.
+ * @param The network supported by Semaphore.
+ * @returns An object with name, address and start block of the deployed contract.
+ */
+function getDeployedContract(supportedNetwork) {
+    if (!isSupportedNetwork(supportedNetwork)) {
+        throw new Error(`Semaphore has not been deployed on '${supportedNetwork}' yet`);
+    }
+    const deployedContract = deployedContracts.find(({ network }) => network === supportedNetwork);
+    return deployedContract.contracts.find(({ name }) => name === "Semaphore");
+}
 
 exports.constants = constants;
 exports.decodeMessage = decodeMessage;
-exports.supportedNetworks = supportedNetwork;
+exports.defaultNetwork = defaultNetwork;
+exports.deployedContracts = deployedContracts;
+exports.getDeployedContract = getDeployedContract;
+exports.getHardhatNetworks = getHardhatNetworks;
+exports.isSupportedNetwork = isSupportedNetwork;
+exports.supportedNetworks = supportedNetworks;

package/dist/index.js

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/utils
- * @version 4.0.0-beta.3
+ * @version 4.0.0-beta.5
  * @file A library to provide utility functions to the other Semaphore packages.
  * @copyright Ethereum Foundation 2024
  * @license MIT
@@ -10,8 +10,8 @@ import { decodeBytes32String } from 'ethers/abi';
 import { toBeHex } from 'ethers/utils';
 
 // TODO: Support all tree depths after trusted-setup. MAX_DEPTH would be 32.
-var MIN_DEPTH = 1;
-var MAX_DEPTH = 12;
+const MIN_DEPTH = 1;
+const MAX_DEPTH = 12;
 
 var constants = /*#__PURE__*/Object.freeze({
     __proto__: null,
@@ -33,7 +33,161 @@ function decodeMessage(message) {
     return decodeBytes32String(toBeHex(message, 32));
 }
 
-// List of Semaphore supported networks.
-var supportedNetwork = ["sepolia", "mumbai", "optimism-sepolia", "arbitrum-sepolia", "arbitrum"];
+var deployedContracts = [
+	{
+		network: "sepolia",
+		contracts: [
+			{
+				name: "SemaphoreVerifier",
+				address: "0x58AD7a4389E0F5d814815E5D5A3Ab903dAE9284a",
+				startBlock: 5539276
+			},
+			{
+				name: "PoseidonT3",
+				address: "0x4EFfF6a6a7BB31cdAd9Ee742b0faAA6Bb9BF096B",
+				startBlock: 5539276
+			},
+			{
+				name: "Semaphore",
+				address: "0x0A09FB3f63c13F1C54F2fA41AFB1e7a98cffc774",
+				startBlock: 5539276
+			}
+		]
+	},
+	{
+		network: "arbitrum-sepolia",
+		contracts: [
+			{
+				name: "SemaphoreVerifier",
+				address: "0x5f4edC58142f4395D1D536e793137A0252dA5a49",
+				startBlock: 25837653
+			},
+			{
+				name: "PoseidonT3",
+				address: "0x181B7f34538cE3BceC68597d4A212aB3f7881648",
+				startBlock: 25837653
+			},
+			{
+				name: "Semaphore",
+				address: "0x220fBdB6F996827b1Cf12f0C181E8d5e6de3a36F",
+				startBlock: 25837653
+			}
+		]
+	},
+	{
+		network: "optimism-sepolia",
+		contracts: [
+			{
+				name: "SemaphoreVerifier",
+				address: "0x3d3df6CFc6BFf68d9693e097F32bF4a9903E77a5",
+				startBlock: 9663266
+			},
+			{
+				name: "PoseidonT3",
+				address: "0x5f4edC58142f4395D1D536e793137A0252dA5a49",
+				startBlock: 9663266
+			},
+			{
+				name: "Semaphore",
+				address: "0x181B7f34538cE3BceC68597d4A212aB3f7881648",
+				startBlock: 9663266
+			}
+		]
+	},
+	{
+		network: "matic-mumbai",
+		contracts: [
+			{
+				name: "SemaphoreVerifier",
+				address: "0xE5269ae1E996C6FEEf6E832c7032401E73087568",
+				startBlock: 47356015
+			},
+			{
+				name: "PoseidonT3",
+				address: "0xC0ae1a8D3505B2bE9DCe0e826abd722Afd13F1c9",
+				startBlock: 47356015
+			},
+			{
+				name: "Semaphore",
+				address: "0x346a936b19071b2f619200848B8ADbb938D72250",
+				startBlock: 47356015
+			}
+		]
+	}
+];
 
-export { constants, decodeMessage, supportedNetwork as supportedNetworks };
+var supportedNetworks = {
+    sepolia: {
+        name: "Sepolia",
+        url: "https://rpc2.sepolia.org",
+        chainId: 11155111,
+        explorer: "https://sepolia.etherscan.io"
+    },
+    "arbitrum-sepolia": {
+        name: "Arbitrum Sepolia",
+        url: "https://sepolia-rollup.arbitrum.io/rpc",
+        chainId: 421614,
+        explorer: "https://sepolia.arbiscan.io"
+    },
+    "optimism-sepolia": {
+        name: "Optimism Sepolia",
+        url: "https://sepolia.optimism.io",
+        chainId: 11155420,
+        explorer: "https://sepolia-optimism.etherscan.io"
+    },
+    "matic-mumbai": {
+        name: "Matic Mumbai",
+        url: "https://rpc-mumbai.polygon.technology",
+        chainId: 80001,
+        explorer: "https://mumbai.polygonscan.com"
+    }
+};
+
+/**
+ * @module Networks
+ * This module provides a collection of utility functions to provide the other internal
+ * packages and developers with information on deployed contracts and networks supported
+ * by Semaphore.
+ */
+// Default Semaphore network.
+const defaultNetwork = "sepolia";
+/**
+ * Returns true if a network is supported by Semaphore, false otherwise.
+ * @param supportedNetwork The network to be checked.
+ */
+function isSupportedNetwork(supportedNetwork) {
+    return Object.keys(supportedNetworks).includes(supportedNetwork);
+}
+/**
+ * Utility function to get an object compatible with the Hardhat 'networks' option.
+ * If the private key is not defined it returns an empty object.
+ * @param privateKey Private key to be used with networks.
+ * @returns An object compatible with the Hardhat 'networks' option.
+ */
+function getHardhatNetworks(privateKey) {
+    if (!privateKey) {
+        return {};
+    }
+    const supportedNetworksCopy = JSON.parse(JSON.stringify(supportedNetworks));
+    for (const key in supportedNetworksCopy) {
+        if (Object.prototype.hasOwnProperty.call(supportedNetworksCopy, key)) {
+            supportedNetworksCopy[key].accounts = [`0x${privateKey}`];
+        }
+    }
+    return supportedNetworksCopy;
+}
+/**
+ * Returns name, address and start block of a Semaphore contract deployed
+ * on a specific supported network.
+ * @param The network supported by Semaphore.
+ * @returns An object with name, address and start block of the deployed contract.
+ */
+function getDeployedContract(supportedNetwork) {
+    if (!isSupportedNetwork(supportedNetwork)) {
+        throw new Error(`Semaphore has not been deployed on '${supportedNetwork}' yet`);
+    }
+    const deployedContract = deployedContracts.find(({ network }) => network === supportedNetwork);
+    return deployedContract.contracts.find(({ name }) => name === "Semaphore");
+}
+
+export { constants, decodeMessage, defaultNetwork, deployedContracts, getDeployedContract, getHardhatNetworks, isSupportedNetwork, supportedNetworks };

package/dist/lib.commonjs/constants.cjs

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/utils
- * @version 4.0.0-beta.3
+ * @version 4.0.0-beta.5
  * @file A library to provide utility functions to the other Semaphore packages.
  * @copyright Ethereum Foundation 2024
  * @license MIT
@@ -9,8 +9,8 @@
 'use strict';
 
 // TODO: Support all tree depths after trusted-setup. MAX_DEPTH would be 32.
-var MIN_DEPTH = 1;
-var MAX_DEPTH = 12;
+const MIN_DEPTH = 1;
+const MAX_DEPTH = 12;
 
 exports.MAX_DEPTH = MAX_DEPTH;
 exports.MIN_DEPTH = MIN_DEPTH;

package/dist/lib.commonjs/decode-message.cjs

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/utils
- * @version 4.0.0-beta.3
+ * @version 4.0.0-beta.5
  * @file A library to provide utility functions to the other Semaphore packages.
  * @copyright Ethereum Foundation 2024
  * @license MIT

package/dist/lib.commonjs/index.cjs

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/utils
- * @version 4.0.0-beta.3
+ * @version 4.0.0-beta.5
  * @file A library to provide utility functions to the other Semaphore packages.
  * @copyright Ethereum Foundation 2024
  * @license MIT
@@ -10,10 +10,17 @@
 
 var constants = require('./constants.cjs');
 var decodeMessage = require('./decode-message.cjs');
-var supportedNetworks = require('./supported-networks.cjs');
+var index = require('./networks/index.cjs');
+var deployedContracts = require('./networks/deployed-contracts.json.cjs');
+var supportedNetworks = require('./networks/supported-networks.cjs');
 
 
 
 exports.constants = constants;
 exports.decodeMessage = decodeMessage;
+exports.defaultNetwork = index.defaultNetwork;
+exports.getDeployedContract = index.getDeployedContract;
+exports.getHardhatNetworks = index.getHardhatNetworks;
+exports.isSupportedNetwork = index.isSupportedNetwork;
+exports.deployedContracts = deployedContracts;
 exports.supportedNetworks = supportedNetworks;

package/dist/lib.commonjs/networks/deployed-contracts.json.cjs

@@ -0,0 +1,94 @@
+/**
+ * @module @semaphore-protocol/utils
+ * @version 4.0.0-beta.5
+ * @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 deployedContracts = [
+	{
+		network: "sepolia",
+		contracts: [
+			{
+				name: "SemaphoreVerifier",
+				address: "0x58AD7a4389E0F5d814815E5D5A3Ab903dAE9284a",
+				startBlock: 5539276
+			},
+			{
+				name: "PoseidonT3",
+				address: "0x4EFfF6a6a7BB31cdAd9Ee742b0faAA6Bb9BF096B",
+				startBlock: 5539276
+			},
+			{
+				name: "Semaphore",
+				address: "0x0A09FB3f63c13F1C54F2fA41AFB1e7a98cffc774",
+				startBlock: 5539276
+			}
+		]
+	},
+	{
+		network: "arbitrum-sepolia",
+		contracts: [
+			{
+				name: "SemaphoreVerifier",
+				address: "0x5f4edC58142f4395D1D536e793137A0252dA5a49",
+				startBlock: 25837653
+			},
+			{
+				name: "PoseidonT3",
+				address: "0x181B7f34538cE3BceC68597d4A212aB3f7881648",
+				startBlock: 25837653
+			},
+			{
+				name: "Semaphore",
+				address: "0x220fBdB6F996827b1Cf12f0C181E8d5e6de3a36F",
+				startBlock: 25837653
+			}
+		]
+	},
+	{
+		network: "optimism-sepolia",
+		contracts: [
+			{
+				name: "SemaphoreVerifier",
+				address: "0x3d3df6CFc6BFf68d9693e097F32bF4a9903E77a5",
+				startBlock: 9663266
+			},
+			{
+				name: "PoseidonT3",
+				address: "0x5f4edC58142f4395D1D536e793137A0252dA5a49",
+				startBlock: 9663266
+			},
+			{
+				name: "Semaphore",
+				address: "0x181B7f34538cE3BceC68597d4A212aB3f7881648",
+				startBlock: 9663266
+			}
+		]
+	},
+	{
+		network: "matic-mumbai",
+		contracts: [
+			{
+				name: "SemaphoreVerifier",
+				address: "0xE5269ae1E996C6FEEf6E832c7032401E73087568",
+				startBlock: 47356015
+			},
+			{
+				name: "PoseidonT3",
+				address: "0xC0ae1a8D3505B2bE9DCe0e826abd722Afd13F1c9",
+				startBlock: 47356015
+			},
+			{
+				name: "Semaphore",
+				address: "0x346a936b19071b2f619200848B8ADbb938D72250",
+				startBlock: 47356015
+			}
+		]
+	}
+];
+
+module.exports = deployedContracts;

package/dist/lib.commonjs/networks/index.cjs

@@ -0,0 +1,66 @@
+/**
+ * @module @semaphore-protocol/utils
+ * @version 4.0.0-beta.5
+ * @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 deployedContracts = require('./deployed-contracts.json.cjs');
+var supportedNetworks = require('./supported-networks.cjs');
+
+/**
+ * @module Networks
+ * This module provides a collection of utility functions to provide the other internal
+ * packages and developers with information on deployed contracts and networks supported
+ * by Semaphore.
+ */
+// Default Semaphore network.
+const defaultNetwork = "sepolia";
+/**
+ * Returns true if a network is supported by Semaphore, false otherwise.
+ * @param supportedNetwork The network to be checked.
+ */
+function isSupportedNetwork(supportedNetwork) {
+    return Object.keys(supportedNetworks).includes(supportedNetwork);
+}
+/**
+ * Utility function to get an object compatible with the Hardhat 'networks' option.
+ * If the private key is not defined it returns an empty object.
+ * @param privateKey Private key to be used with networks.
+ * @returns An object compatible with the Hardhat 'networks' option.
+ */
+function getHardhatNetworks(privateKey) {
+    if (!privateKey) {
+        return {};
+    }
+    const supportedNetworksCopy = JSON.parse(JSON.stringify(supportedNetworks));
+    for (const key in supportedNetworksCopy) {
+        if (Object.prototype.hasOwnProperty.call(supportedNetworksCopy, key)) {
+            supportedNetworksCopy[key].accounts = [`0x${privateKey}`];
+        }
+    }
+    return supportedNetworksCopy;
+}
+/**
+ * Returns name, address and start block of a Semaphore contract deployed
+ * on a specific supported network.
+ * @param The network supported by Semaphore.
+ * @returns An object with name, address and start block of the deployed contract.
+ */
+function getDeployedContract(supportedNetwork) {
+    if (!isSupportedNetwork(supportedNetwork)) {
+        throw new Error(`Semaphore has not been deployed on '${supportedNetwork}' yet`);
+    }
+    const deployedContract = deployedContracts.find(({ network }) => network === supportedNetwork);
+    return deployedContract.contracts.find(({ name }) => name === "Semaphore");
+}
+
+exports.deployedContracts = deployedContracts;
+exports.supportedNetworks = supportedNetworks;
+exports.defaultNetwork = defaultNetwork;
+exports.getDeployedContract = getDeployedContract;
+exports.getHardhatNetworks = getHardhatNetworks;
+exports.isSupportedNetwork = isSupportedNetwork;

package/dist/lib.commonjs/networks/supported-networks.cjs

@@ -0,0 +1,38 @@
+/**
+ * @module @semaphore-protocol/utils
+ * @version 4.0.0-beta.5
+ * @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 supportedNetworks = {
+    sepolia: {
+        name: "Sepolia",
+        url: "https://rpc2.sepolia.org",
+        chainId: 11155111,
+        explorer: "https://sepolia.etherscan.io"
+    },
+    "arbitrum-sepolia": {
+        name: "Arbitrum Sepolia",
+        url: "https://sepolia-rollup.arbitrum.io/rpc",
+        chainId: 421614,
+        explorer: "https://sepolia.arbiscan.io"
+    },
+    "optimism-sepolia": {
+        name: "Optimism Sepolia",
+        url: "https://sepolia.optimism.io",
+        chainId: 11155420,
+        explorer: "https://sepolia-optimism.etherscan.io"
+    },
+    "matic-mumbai": {
+        name: "Matic Mumbai",
+        url: "https://rpc-mumbai.polygon.technology",
+        chainId: 80001,
+        explorer: "https://mumbai.polygonscan.com"
+    }
+};
+
+module.exports = supportedNetworks;

package/dist/lib.esm/constants.js

@@ -1,13 +1,13 @@
 /**
  * @module @semaphore-protocol/utils
- * @version 4.0.0-beta.3
+ * @version 4.0.0-beta.5
  * @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}
 */
 // TODO: Support all tree depths after trusted-setup. MAX_DEPTH would be 32.
-var MIN_DEPTH = 1;
-var MAX_DEPTH = 12;
+const MIN_DEPTH = 1;
+const MAX_DEPTH = 12;
 
 export { MAX_DEPTH, MIN_DEPTH };

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

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/utils
- * @version 4.0.0-beta.3
+ * @version 4.0.0-beta.5
  * @file A library to provide utility functions to the other Semaphore packages.
  * @copyright Ethereum Foundation 2024
  * @license MIT

package/dist/lib.esm/index.js

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/utils
- * @version 4.0.0-beta.3
+ * @version 4.0.0-beta.5
  * @file A library to provide utility functions to the other Semaphore packages.
  * @copyright Ethereum Foundation 2024
  * @license MIT
@@ -9,4 +9,6 @@
 import * as constants from './constants.js';
 export { constants };
 export { default as decodeMessage } from './decode-message.js';
-export { default as supportedNetworks } from './supported-networks.js';
+export { defaultNetwork, getDeployedContract, getHardhatNetworks, isSupportedNetwork } from './networks/index.js';
+export { default as deployedContracts } from './networks/deployed-contracts.json.js';
+export { default as supportedNetworks } from './networks/supported-networks.js';

package/dist/lib.esm/networks/deployed-contracts.json.js

@@ -0,0 +1,92 @@
+/**
+ * @module @semaphore-protocol/utils
+ * @version 4.0.0-beta.5
+ * @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}
+*/
+var deployedContracts = [
+	{
+		network: "sepolia",
+		contracts: [
+			{
+				name: "SemaphoreVerifier",
+				address: "0x58AD7a4389E0F5d814815E5D5A3Ab903dAE9284a",
+				startBlock: 5539276
+			},
+			{
+				name: "PoseidonT3",
+				address: "0x4EFfF6a6a7BB31cdAd9Ee742b0faAA6Bb9BF096B",
+				startBlock: 5539276
+			},
+			{
+				name: "Semaphore",
+				address: "0x0A09FB3f63c13F1C54F2fA41AFB1e7a98cffc774",
+				startBlock: 5539276
+			}
+		]
+	},
+	{
+		network: "arbitrum-sepolia",
+		contracts: [
+			{
+				name: "SemaphoreVerifier",
+				address: "0x5f4edC58142f4395D1D536e793137A0252dA5a49",
+				startBlock: 25837653
+			},
+			{
+				name: "PoseidonT3",
+				address: "0x181B7f34538cE3BceC68597d4A212aB3f7881648",
+				startBlock: 25837653
+			},
+			{
+				name: "Semaphore",
+				address: "0x220fBdB6F996827b1Cf12f0C181E8d5e6de3a36F",
+				startBlock: 25837653
+			}
+		]
+	},
+	{
+		network: "optimism-sepolia",
+		contracts: [
+			{
+				name: "SemaphoreVerifier",
+				address: "0x3d3df6CFc6BFf68d9693e097F32bF4a9903E77a5",
+				startBlock: 9663266
+			},
+			{
+				name: "PoseidonT3",
+				address: "0x5f4edC58142f4395D1D536e793137A0252dA5a49",
+				startBlock: 9663266
+			},
+			{
+				name: "Semaphore",
+				address: "0x181B7f34538cE3BceC68597d4A212aB3f7881648",
+				startBlock: 9663266
+			}
+		]
+	},
+	{
+		network: "matic-mumbai",
+		contracts: [
+			{
+				name: "SemaphoreVerifier",
+				address: "0xE5269ae1E996C6FEEf6E832c7032401E73087568",
+				startBlock: 47356015
+			},
+			{
+				name: "PoseidonT3",
+				address: "0xC0ae1a8D3505B2bE9DCe0e826abd722Afd13F1c9",
+				startBlock: 47356015
+			},
+			{
+				name: "Semaphore",
+				address: "0x346a936b19071b2f619200848B8ADbb938D72250",
+				startBlock: 47356015
+			}
+		]
+	}
+];
+
+export { deployedContracts as default };

package/dist/lib.esm/networks/index.js

@@ -0,0 +1,59 @@
+/**
+ * @module @semaphore-protocol/utils
+ * @version 4.0.0-beta.5
+ * @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 deployedContracts from './deployed-contracts.json.js';
+import supportedNetworks from './supported-networks.js';
+
+/**
+ * @module Networks
+ * This module provides a collection of utility functions to provide the other internal
+ * packages and developers with information on deployed contracts and networks supported
+ * by Semaphore.
+ */
+// Default Semaphore network.
+const defaultNetwork = "sepolia";
+/**
+ * Returns true if a network is supported by Semaphore, false otherwise.
+ * @param supportedNetwork The network to be checked.
+ */
+function isSupportedNetwork(supportedNetwork) {
+    return Object.keys(supportedNetworks).includes(supportedNetwork);
+}
+/**
+ * Utility function to get an object compatible with the Hardhat 'networks' option.
+ * If the private key is not defined it returns an empty object.
+ * @param privateKey Private key to be used with networks.
+ * @returns An object compatible with the Hardhat 'networks' option.
+ */
+function getHardhatNetworks(privateKey) {
+    if (!privateKey) {
+        return {};
+    }
+    const supportedNetworksCopy = JSON.parse(JSON.stringify(supportedNetworks));
+    for (const key in supportedNetworksCopy) {
+        if (Object.prototype.hasOwnProperty.call(supportedNetworksCopy, key)) {
+            supportedNetworksCopy[key].accounts = [`0x${privateKey}`];
+        }
+    }
+    return supportedNetworksCopy;
+}
+/**
+ * Returns name, address and start block of a Semaphore contract deployed
+ * on a specific supported network.
+ * @param The network supported by Semaphore.
+ * @returns An object with name, address and start block of the deployed contract.
+ */
+function getDeployedContract(supportedNetwork) {
+    if (!isSupportedNetwork(supportedNetwork)) {
+        throw new Error(`Semaphore has not been deployed on '${supportedNetwork}' yet`);
+    }
+    const deployedContract = deployedContracts.find(({ network }) => network === supportedNetwork);
+    return deployedContract.contracts.find(({ name }) => name === "Semaphore");
+}
+
+export { defaultNetwork, deployedContracts, getDeployedContract, getHardhatNetworks, isSupportedNetwork, supportedNetworks };

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

@@ -0,0 +1,36 @@
+/**
+ * @module @semaphore-protocol/utils
+ * @version 4.0.0-beta.5
+ * @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}
+*/
+var supportedNetworks = {
+    sepolia: {
+        name: "Sepolia",
+        url: "https://rpc2.sepolia.org",
+        chainId: 11155111,
+        explorer: "https://sepolia.etherscan.io"
+    },
+    "arbitrum-sepolia": {
+        name: "Arbitrum Sepolia",
+        url: "https://sepolia-rollup.arbitrum.io/rpc",
+        chainId: 421614,
+        explorer: "https://sepolia.arbiscan.io"
+    },
+    "optimism-sepolia": {
+        name: "Optimism Sepolia",
+        url: "https://sepolia.optimism.io",
+        chainId: 11155420,
+        explorer: "https://sepolia-optimism.etherscan.io"
+    },
+    "matic-mumbai": {
+        name: "Matic Mumbai",
+        url: "https://rpc-mumbai.polygon.technology",
+        chainId: 80001,
+        explorer: "https://mumbai.polygonscan.com"
+    }
+};
+
+export { supportedNetworks as default };

package/dist/types/index.d.ts

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

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

@@ -0,0 +1,34 @@
+/**
+ * @module Networks
+ * This module provides a collection of utility functions to provide the other internal
+ * packages and developers with information on deployed contracts and networks supported
+ * by Semaphore.
+ */
+import deployedContracts from "./deployed-contracts.json";
+import supportedNetworks from "./supported-networks";
+export type SupportedNetwork = keyof typeof supportedNetworks;
+export declare const defaultNetwork: SupportedNetwork;
+/**
+ * Returns true if a network is supported by Semaphore, false otherwise.
+ * @param supportedNetwork The network to be checked.
+ */
+export declare function isSupportedNetwork(supportedNetwork: string): boolean;
+/**
+ * Utility function to get an object compatible with the Hardhat 'networks' option.
+ * If the private key is not defined it returns an empty object.
+ * @param privateKey Private key to be used with networks.
+ * @returns An object compatible with the Hardhat 'networks' option.
+ */
+export declare function getHardhatNetworks(privateKey?: string): any;
+/**
+ * Returns name, address and start block of a Semaphore contract deployed
+ * on a specific supported network.
+ * @param The network supported by Semaphore.
+ * @returns An object with name, address and start block of the deployed contract.
+ */
+export declare function getDeployedContract(supportedNetwork: SupportedNetwork): {
+    name: string;
+    address: string;
+    startBlock: number;
+};
+export { deployedContracts, supportedNetworks };

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

@@ -0,0 +1,27 @@
+declare const _default: {
+    sepolia: {
+        name: string;
+        url: string;
+        chainId: number;
+        explorer: string;
+    };
+    "arbitrum-sepolia": {
+        name: string;
+        url: string;
+        chainId: number;
+        explorer: string;
+    };
+    "optimism-sepolia": {
+        name: string;
+        url: string;
+        chainId: number;
+        explorer: string;
+    };
+    "matic-mumbai": {
+        name: string;
+        url: string;
+        chainId: number;
+        explorer: string;
+    };
+};
+export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@semaphore-protocol/utils",
-  "version": "4.0.0-beta.3",
+  "version": "4.0.0-beta.5",
   "description": "A library to provide utility functions to the other Semaphore packages.",
   "type": "module",
   "license": "MIT",
@@ -12,10 +12,10 @@
       "require": "./dist/index.cjs",
       "default": "./dist/index.js"
     },
-    "./supported-networks": {
-      "types": "./dist/types/supported-networks.d.ts",
-      "require": "./dist/lib.commonjs/supported-networks.cjs",
-      "default": "./dist/lib.esm/supported-networks.js"
+    "./networks": {
+      "types": "./dist/types/networks/index.d.ts",
+      "require": "./dist/lib.commonjs/networks/index.cjs",
+      "default": "./dist/lib.esm/networks/index.js"
     },
     "./constants": {
       "types": "./dist/types/constants.d.ts",
@@ -47,6 +47,7 @@
     "access": "public"
   },
   "devDependencies": {
+    "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-typescript": "^11.1.6",
     "rimraf": "^5.0.5",
     "rollup": "^4.12.0",

package/src/index.ts

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

package/src/networks/deployed-contracts.json

@@ -0,0 +1,82 @@
+[
+    {
+        "network": "sepolia",
+        "contracts": [
+            {
+                "name": "SemaphoreVerifier",
+                "address": "0x58AD7a4389E0F5d814815E5D5A3Ab903dAE9284a",
+                "startBlock": 5539276
+            },
+            {
+                "name": "PoseidonT3",
+                "address": "0x4EFfF6a6a7BB31cdAd9Ee742b0faAA6Bb9BF096B",
+                "startBlock": 5539276
+            },
+            {
+                "name": "Semaphore",
+                "address": "0x0A09FB3f63c13F1C54F2fA41AFB1e7a98cffc774",
+                "startBlock": 5539276
+            }
+        ]
+    },
+    {
+        "network": "arbitrum-sepolia",
+        "contracts": [
+            {
+                "name": "SemaphoreVerifier",
+                "address": "0x5f4edC58142f4395D1D536e793137A0252dA5a49",
+                "startBlock": 25837653
+            },
+            {
+                "name": "PoseidonT3",
+                "address": "0x181B7f34538cE3BceC68597d4A212aB3f7881648",
+                "startBlock": 25837653
+            },
+            {
+                "name": "Semaphore",
+                "address": "0x220fBdB6F996827b1Cf12f0C181E8d5e6de3a36F",
+                "startBlock": 25837653
+            }
+        ]
+    },
+    {
+        "network": "optimism-sepolia",
+        "contracts": [
+            {
+                "name": "SemaphoreVerifier",
+                "address": "0x3d3df6CFc6BFf68d9693e097F32bF4a9903E77a5",
+                "startBlock": 9663266
+            },
+            {
+                "name": "PoseidonT3",
+                "address": "0x5f4edC58142f4395D1D536e793137A0252dA5a49",
+                "startBlock": 9663266
+            },
+            {
+                "name": "Semaphore",
+                "address": "0x181B7f34538cE3BceC68597d4A212aB3f7881648",
+                "startBlock": 9663266
+            }
+        ]
+    },
+    {
+        "network": "matic-mumbai",
+        "contracts": [
+            {
+                "name": "SemaphoreVerifier",
+                "address": "0xE5269ae1E996C6FEEf6E832c7032401E73087568",
+                "startBlock": 47356015
+            },
+            {
+                "name": "PoseidonT3",
+                "address": "0xC0ae1a8D3505B2bE9DCe0e826abd722Afd13F1c9",
+                "startBlock": 47356015
+            },
+            {
+                "name": "Semaphore",
+                "address": "0x346a936b19071b2f619200848B8ADbb938D72250",
+                "startBlock": 47356015
+            }
+        ]
+    }
+]

package/src/networks/index.ts

@@ -0,0 +1,66 @@
+/**
+ * @module Networks
+ * This module provides a collection of utility functions to provide the other internal
+ * packages and developers with information on deployed contracts and networks supported
+ * by Semaphore.
+ */
+
+import deployedContracts from "./deployed-contracts.json"
+import supportedNetworks from "./supported-networks"
+
+export type SupportedNetwork = keyof typeof supportedNetworks
+
+// Default Semaphore network.
+export const defaultNetwork: SupportedNetwork = "sepolia"
+
+/**
+ * Returns true if a network is supported by Semaphore, false otherwise.
+ * @param supportedNetwork The network to be checked.
+ */
+export function isSupportedNetwork(supportedNetwork: string): boolean {
+    return Object.keys(supportedNetworks).includes(supportedNetwork)
+}
+
+/**
+ * Utility function to get an object compatible with the Hardhat 'networks' option.
+ * If the private key is not defined it returns an empty object.
+ * @param privateKey Private key to be used with networks.
+ * @returns An object compatible with the Hardhat 'networks' option.
+ */
+export function getHardhatNetworks(privateKey?: string) {
+    if (!privateKey) {
+        return {}
+    }
+
+    const supportedNetworksCopy = JSON.parse(JSON.stringify(supportedNetworks))
+
+    for (const key in supportedNetworksCopy) {
+        if (Object.prototype.hasOwnProperty.call(supportedNetworksCopy, key)) {
+            supportedNetworksCopy[key].accounts = [`0x${privateKey}`]
+        }
+    }
+
+    return supportedNetworksCopy
+}
+
+/**
+ * Returns name, address and start block of a Semaphore contract deployed
+ * on a specific supported network.
+ * @param The network supported by Semaphore.
+ * @returns An object with name, address and start block of the deployed contract.
+ */
+export function getDeployedContract(supportedNetwork: SupportedNetwork) {
+    if (!isSupportedNetwork(supportedNetwork)) {
+        throw new Error(`Semaphore has not been deployed on '${supportedNetwork}' yet`)
+    }
+
+    const deployedContract = deployedContracts.find(({ network }) => network === supportedNetwork)
+
+    return deployedContract!.contracts.find(({ name }) => name === "Semaphore") as {
+        name: string
+        address: string
+        startBlock: number
+    }
+}
+
+export { deployedContracts, supportedNetworks }

package/src/networks/supported-networks.ts

@@ -0,0 +1,26 @@
+export default {
+    sepolia: {
+        name: "Sepolia",
+        url: "https://rpc2.sepolia.org",
+        chainId: 11155111,
+        explorer: "https://sepolia.etherscan.io"
+    },
+    "arbitrum-sepolia": {
+        name: "Arbitrum Sepolia",
+        url: "https://sepolia-rollup.arbitrum.io/rpc",
+        chainId: 421614,
+        explorer: "https://sepolia.arbiscan.io"
+    },
+    "optimism-sepolia": {
+        name: "Optimism Sepolia",
+        url: "https://sepolia.optimism.io",
+        chainId: 11155420,
+        explorer: "https://sepolia-optimism.etherscan.io"
+    },
+    "matic-mumbai": {
+        name: "Matic Mumbai",
+        url: "https://rpc-mumbai.polygon.technology",
+        chainId: 80001,
+        explorer: "https://mumbai.polygonscan.com"
+    }
+}

package/dist/lib.commonjs/supported-networks.cjs

@@ -1,14 +0,0 @@
-/**
- * @module @semaphore-protocol/utils
- * @version 4.0.0-beta.3
- * @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';
-
-// List of Semaphore supported networks.
-var supportedNetwork = ["sepolia", "mumbai", "optimism-sepolia", "arbitrum-sepolia", "arbitrum"];
-
-module.exports = supportedNetwork;

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

@@ -1,12 +0,0 @@
-/**
- * @module @semaphore-protocol/utils
- * @version 4.0.0-beta.3
- * @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/supported-networks.d.ts

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

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

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

package/src/supported-networks.ts

@@ -1,6 +0,0 @@
-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

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