@devtion/actions 0.0.0-bfc9ee4 → 0.0.0-c1f4cbe

package/dist/index.node.js

@@ -1,6 +1,6 @@
 /**
- * @module @p0tion/actions
- * @version 1.0.5
+ * @module @devtion/actions
+ * @version 1.1.1
  * @file A set of actions and helpers for CLI commands
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -17,9 +17,7 @@ var firestore = require('firebase/firestore');
 var snarkjs = require('snarkjs');
 var crypto = require('crypto');
 var blake = require('blakejs');
-var ffjavascript = require('ffjavascript');
 var winston = require('winston');
-var clientS3 = require('@aws-sdk/client-s3');
 var stream = require('stream');
 var util = require('util');
 var app = require('firebase/app');
@@ -246,6 +244,12 @@ const commonTerms = {
                 verificationStartedAt: "verificationStartedAt"
             }
         },
+        avatars: {
+            name: "avatars",
+            fields: {
+                avatarUrl: "avatarUrl"
+            }
+        },
         ceremonies: {
             name: "ceremonies",
             fields: {
@@ -337,6 +341,8 @@ const commonTerms = {
         finalizeCeremony: "finalizeCeremony",
         downloadCircuitArtifacts: "downloadCircuitArtifacts",
         transferObject: "transferObject",
+        bandadaValidateProof: "bandadaValidateProof",
+        checkNonceOfSIWEAddress: "checkNonceOfSIWEAddress"
     }
 };
 
@@ -687,19 +693,23 @@ const getChunksAndPreSignedUrls = async (cloudFunctions, bucketName, objectKey,
  * @param cloudFunctions <Functions> - the Firebase Cloud Functions service instance.
  * @param ceremonyId <string> - the unique identifier of the ceremony.
  * @param alreadyUploadedChunks Array<ETagWithPartNumber> - the temporary information about the already uploaded chunks.
+ * @param logger <GenericBar> - an optional logger to show progress.
  * @returns <Promise<Array<ETagWithPartNumber>>> - the completed (uploaded) chunks information.
  */
-const uploadParts = async (chunksWithUrls, contentType, cloudFunctions, ceremonyId, alreadyUploadedChunks) => {
+const uploadParts = async (chunksWithUrls, contentType, cloudFunctions, ceremonyId, alreadyUploadedChunks, logger) => {
     // Keep track of uploaded chunks.
     const uploadedChunks = alreadyUploadedChunks || [];
+    // if we were passed a logger, start it
+    if (logger)
+        logger.start(chunksWithUrls.length, 0);
     // Loop through remaining chunks.
     for (let i = alreadyUploadedChunks ? alreadyUploadedChunks.length : 0; i < chunksWithUrls.length; i += 1) {
         // Consume the pre-signed url to upload the chunk.
         // @ts-ignore
         const response = await fetch(chunksWithUrls[i].preSignedUrl, {
             retryOptions: {
-                retryInitialDelay: 500,
-                socketTimeout: 60000,
+                retryInitialDelay: 500, // 500 ms.
+                socketTimeout: 60000, // 60 seconds.
                 retryMaxDuration: 300000 // 5 minutes.
             },
             method: "PUT",
@@ -723,6 +733,9 @@ const uploadParts = async (chunksWithUrls, contentType, cloudFunctions, ceremony
         // nb. this must be done only when contributing (not finalizing).
         if (!!ceremonyId && !!cloudFunctions)
             await temporaryStoreCurrentContributionUploadedChunkData(cloudFunctions, ceremonyId, chunk);
+        // increment the count on the logger
+        if (logger)
+            logger.increment();
     }
     return uploadedChunks;
 };
@@ -743,8 +756,9 @@ const uploadParts = async (chunksWithUrls, contentType, cloudFunctions, ceremony
  * @param configStreamChunkSize <number> - size of each chunk into which the artifact is going to be splitted (nb. will be converted in MB).
  * @param [ceremonyId] <string> - the unique identifier of the ceremony (used as a double-edge sword - as identifier and as a check if current contributor is the coordinator finalizing the ceremony).
  * @param [temporaryDataToResumeMultiPartUpload] <TemporaryParticipantContributionData> - the temporary information necessary to resume an already started multi-part upload.
+ * @param logger <GenericBar> - an optional logger to show progress.
  */
-const multiPartUpload = async (cloudFunctions, bucketName, objectKey, localFilePath, configStreamChunkSize, ceremonyId, temporaryDataToResumeMultiPartUpload) => {
+const multiPartUpload = async (cloudFunctions, bucketName, objectKey, localFilePath, configStreamChunkSize, ceremonyId, temporaryDataToResumeMultiPartUpload, logger) => {
     // The unique identifier of the multi-part upload.
     let multiPartUploadId = "";
     // The list of already uploaded chunks.
@@ -768,7 +782,7 @@ const multiPartUpload = async (cloudFunctions, bucketName, objectKey, localFileP
     const chunksWithUrlsZkey = await getChunksAndPreSignedUrls(cloudFunctions, bucketName, objectKey, localFilePath, multiPartUploadId, configStreamChunkSize, ceremonyId);
     // Step (2).
     const partNumbersAndETagsZkey = await uploadParts(chunksWithUrlsZkey, mime.lookup(localFilePath), // content-type.
-    cloudFunctions, ceremonyId, alreadyUploadedChunks);
+    cloudFunctions, ceremonyId, alreadyUploadedChunks, logger);
     // Step (3).
     await completeMultiPartUpload(cloudFunctions, bucketName, objectKey, multiPartUploadId, partNumbersAndETagsZkey, ceremonyId);
 };
@@ -992,6 +1006,17 @@ const getClosedCeremonies = async (firestoreDatabase) => {
     ]);
     return fromQueryToFirebaseDocumentInfo(closedCeremoniesQuerySnap.docs);
 };
+/**
+ * Query all ceremonies
+ * @notice get all ceremonies from the database.
+ * @dev this is a helper for the CLI ceremony methods.
+ * @param firestoreDatabase <Firestore> - the Firestore service instance associated to the current Firebase application.
+ * @returns <Promise<Array<FirebaseDocumentInfo>>> - the list of all ceremonies.
+ */
+const getAllCeremonies = async (firestoreDatabase) => {
+    const ceremoniesQuerySnap = await queryCollection(firestoreDatabase, commonTerms.collections.ceremonies.name, []);
+    return fromQueryToFirebaseDocumentInfo(ceremoniesQuerySnap.docs);
+};
 
 /**
  * @hidden
@@ -1040,207 +1065,22 @@ const compareHashes = async (path1, path2) => {
 };
 
 /**
- * Parse and validate that the ceremony configuration is correct
- * @notice this does not upload any files to storage
- * @param path <string> - the path to the configuration file
- * @param cleanup <boolean> - whether to delete the r1cs file after parsing
- * @returns any - the data to pass to the cloud function for setup and the circuit artifacts
+ * Return a string with double digits if the provided input is one digit only.
+ * @param in <number> - the input number to be converted.
+ * @returns <string> - the two digits stringified number derived from the conversion.
  */
-const parseCeremonyFile = async (path, cleanup = false) => {
-    // check that the path exists
-    if (!fs.existsSync(path))
-        throw new Error("The provided path to the configuration file does not exist. Please provide an absolute path and try again.");
-    try {
-        // read the data
-        const data = JSON.parse(fs.readFileSync(path).toString());
-        // verify that the data is correct
-        if (data['timeoutMechanismType'] !== "DYNAMIC" /* CeremonyTimeoutType.DYNAMIC */ && data['timeoutMechanismType'] !== "FIXED" /* CeremonyTimeoutType.FIXED */)
-            throw new Error("Invalid timeout type. Please choose between DYNAMIC and FIXED.");
-        // validate that we have at least 1 circuit input data
-        if (!data.circuits || data.circuits.length === 0)
-            throw new Error("You need to provide the data for at least 1 circuit.");
-        // validate that the end date is in the future
-        let endDate;
-        let startDate;
-        try {
-            endDate = new Date(data.endDate);
-            startDate = new Date(data.startDate);
-        }
-        catch (error) {
-            throw new Error("The dates should follow this format: 2023-07-04T00:00:00.");
-        }
-        if (endDate <= startDate)
-            throw new Error("The end date should be greater than the start date.");
-        const currentDate = new Date();
-        if (endDate <= currentDate || startDate <= currentDate)
-            throw new Error("The start and end dates should be in the future.");
-        // validate penalty
-        if (data.penalty <= 0)
-            throw new Error("The penalty should be greater than zero.");
-        const circuits = [];
-        const urlPattern = /(https?:\/\/[^\s]+)/g;
-        const commitHashPattern = /^[a-f0-9]{40}$/i;
-        const circuitArtifacts = [];
-        for (let i = 0; i < data.circuits.length; i++) {
-            const circuitData = data.circuits[i];
-            const artifacts = circuitData.artifacts;
-            circuitArtifacts.push({
-                artifacts: artifacts
-            });
-            const r1csPath = artifacts.r1csStoragePath;
-            const wasmPath = artifacts.wasmStoragePath;
-            // where we storing the r1cs downloaded
-            const localR1csPath = `./${circuitData.name}.r1cs`;
-            // check that the artifacts exist in S3
-            // we don't need any privileges to download this
-            // just the correct region
-            const s3 = new clientS3.S3Client({ region: artifacts.region });
-            try {
-                await s3.send(new clientS3.HeadObjectCommand({
-                    Bucket: artifacts.bucket,
-                    Key: r1csPath
-                }));
-            }
-            catch (error) {
-                throw new Error(`The r1cs file (${r1csPath}) seems to not exist. Please ensure this is correct and that the object is publicly available.`);
-            }
-            try {
-                await s3.send(new clientS3.HeadObjectCommand({
-                    Bucket: artifacts.bucket,
-                    Key: wasmPath
-                }));
-            }
-            catch (error) {
-                throw new Error(`The wasm file (${wasmPath}) seems to not exist. Please ensure this is correct and that the object is publicly available.`);
-            }
-            // download the r1cs to extract the metadata
-            const command = new clientS3.GetObjectCommand({ Bucket: artifacts.bucket, Key: artifacts.r1csStoragePath });
-            const response = await s3.send(command);
-            const streamPipeline = util.promisify(stream.pipeline);
-            if (response.$metadata.httpStatusCode !== 200)
-                throw new Error("There was an error while trying to download the r1cs file. Please check that the file has the correct permissions (public) set.");
-            if (response.Body instanceof stream.Readable)
-                await streamPipeline(response.Body, fs.createWriteStream(localR1csPath));
-            // extract the metadata from the r1cs
-            const metadata = getR1CSInfo(localR1csPath);
-            // validate that the circuit hash and template links are valid
-            const template = circuitData.template;
-            const URLMatch = template.source.match(urlPattern);
-            if (!URLMatch || URLMatch.length === 0 || URLMatch.length > 1)
-                throw new Error("You should provide the URL to the circuits templates on GitHub.");
-            const hashMatch = template.commitHash.match(commitHashPattern);
-            if (!hashMatch || hashMatch.length === 0 || hashMatch.length > 1)
-                throw new Error("You should provide a valid commit hash of the circuit templates.");
-            // calculate the hash of the r1cs file
-            const r1csBlake2bHash = await blake512FromPath(localR1csPath);
-            const circuitPrefix = extractPrefix(circuitData.name);
-            // filenames
-            const doubleDigitsPowers = convertToDoubleDigits(metadata.pot);
-            const r1csCompleteFilename = `${circuitData.name}.r1cs`;
-            const wasmCompleteFilename = `${circuitData.name}.wasm`;
-            const smallestPowersOfTauCompleteFilenameForCircuit = `${potFilenameTemplate}${doubleDigitsPowers}.ptau`;
-            const firstZkeyCompleteFilename = `${circuitPrefix}_${genesisZkeyIndex}.zkey`;
-            // storage paths 
-            const r1csStorageFilePath = getR1csStorageFilePath(circuitPrefix, r1csCompleteFilename);
-            const wasmStorageFilePath = getWasmStorageFilePath(circuitPrefix, wasmCompleteFilename);
-            const potStorageFilePath = getPotStorageFilePath(smallestPowersOfTauCompleteFilenameForCircuit);
-            const zkeyStorageFilePath = getZkeyStorageFilePath(circuitPrefix, firstZkeyCompleteFilename);
-            const files = {
-                potFilename: smallestPowersOfTauCompleteFilenameForCircuit,
-                r1csFilename: r1csCompleteFilename,
-                wasmFilename: wasmCompleteFilename,
-                initialZkeyFilename: firstZkeyCompleteFilename,
-                potStoragePath: potStorageFilePath,
-                r1csStoragePath: r1csStorageFilePath,
-                wasmStoragePath: wasmStorageFilePath,
-                initialZkeyStoragePath: zkeyStorageFilePath,
-                r1csBlake2bHash: r1csBlake2bHash
-            };
-            // validate that the compiler hash is a valid hash 
-            const compiler = circuitData.compiler;
-            const compilerHashMatch = compiler.commitHash.match(commitHashPattern);
-            if (!compilerHashMatch || compilerHashMatch.length === 0 || compilerHashMatch.length > 1)
-                throw new Error("You should provide a valid commit hash of the circuit compiler.");
-            // validate that the verification options are valid
-            const verification = circuitData.verification;
-            if (verification.cfOrVm !== "CF" && verification.cfOrVm !== "VM")
-                throw new Error("Please enter a valid verification mechanism: either CF or VM");
-            // @todo VM parameters verification
-            // if (verification['cfOrVM'] === "VM") {}
-            // check that the timeout is provided for the correct configuration
-            let dynamicThreshold;
-            let fixedTimeWindow;
-            let circuit = {};
-            if (data.timeoutMechanismType === "DYNAMIC" /* CeremonyTimeoutType.DYNAMIC */) {
-                if (circuitData.dynamicThreshold <= 0)
-                    throw new Error("The dynamic threshold should be > 0.");
-                dynamicThreshold = circuitData.dynamicThreshold;
-                // the Circuit data for the ceremony setup
-                circuit = {
-                    name: circuitData.name,
-                    description: circuitData.description,
-                    prefix: circuitPrefix,
-                    sequencePosition: i + 1,
-                    metadata: metadata,
-                    files: files,
-                    template: template,
-                    compiler: compiler,
-                    verification: verification,
-                    dynamicThreshold: dynamicThreshold,
-                    avgTimings: {
-                        contributionComputation: 0,
-                        fullContribution: 0,
-                        verifyCloudFunction: 0
-                    },
-                };
-            }
-            if (data.timeoutMechanismType === "FIXED" /* CeremonyTimeoutType.FIXED */) {
-                if (circuitData.fixedTimeWindow <= 0)
-                    throw new Error("The fixed time window threshold should be > 0.");
-                fixedTimeWindow = circuitData.fixedTimeWindow;
-                // the Circuit data for the ceremony setup
-                circuit = {
-                    name: circuitData.name,
-                    description: circuitData.description,
-                    prefix: circuitPrefix,
-                    sequencePosition: i + 1,
-                    metadata: metadata,
-                    files: files,
-                    template: template,
-                    compiler: compiler,
-                    verification: verification,
-                    fixedTimeWindow: fixedTimeWindow,
-                    avgTimings: {
-                        contributionComputation: 0,
-                        fullContribution: 0,
-                        verifyCloudFunction: 0
-                    },
-                };
-            }
-            circuits.push(circuit);
-            // remove the local r1cs download (if used for verifying the config only vs setup)
-            if (cleanup)
-                fs.unlinkSync(localR1csPath);
-        }
-        const setupData = {
-            ceremonyInputData: {
-                title: data.title,
-                description: data.description,
-                startDate: startDate.valueOf(),
-                endDate: endDate.valueOf(),
-                timeoutMechanismType: data.timeoutMechanismType,
-                penalty: data.penalty
-            },
-            ceremonyPrefix: extractPrefix(data.title),
-            circuits: circuits,
-            circuitArtifacts: circuitArtifacts
-        };
-        return setupData;
-    }
-    catch (error) {
-        throw new Error(`Error while parsing up the ceremony setup file. ${error.message}`);
-    }
-};
+const convertToDoubleDigits = (amount) => (amount < 10 ? `0${amount}` : amount.toString());
+/**
+ * Extract a prefix consisting of alphanumeric and underscore characters from a string with arbitrary characters.
+ * @dev replaces all special symbols and whitespaces with an underscore char ('_'). Convert all uppercase chars to lowercase.
+ * @notice example: str = 'Multiplier-2!2.4.zkey'; output prefix = 'multiplier_2_2_4.zkey'.
+ * NB. Prefix extraction is a key process that conditions the name of the ceremony artifacts, download/upload from/to storage, collections paths.
+ * @param str <string> - the arbitrary string from which to extract the prefix.
+ * @returns <string> - the resulting prefix.
+ */
+const extractPrefix = (str) => 
+// eslint-disable-next-line no-useless-escape
+str.replace(/[`\s~!@#$%^&*()|+\-=?;:'",.<>\{\}\[\]\\\/]/gi, "-").toLowerCase();
 /**
  * Extract data from a R1CS metadata file generated with a custom file-based logger.
  * @notice useful for extracting metadata circuits contained in the generated file using a logger
@@ -1297,17 +1137,6 @@ const formatZkeyIndex = (progress) => {
  * @returns <number> - the amount of powers.
  */
 const extractPoTFromFilename = (potCompleteFilename) => Number(potCompleteFilename.split("_").pop()?.split(".").at(0));
-/**
- * Extract a prefix consisting of alphanumeric and underscore characters from a string with arbitrary characters.
- * @dev replaces all special symbols and whitespaces with an underscore char ('_'). Convert all uppercase chars to lowercase.
- * @notice example: str = 'Multiplier-2!2.4.zkey'; output prefix = 'multiplier_2_2_4.zkey'.
- * NB. Prefix extraction is a key process that conditions the name of the ceremony artifacts, download/upload from/to storage, collections paths.
- * @param str <string> - the arbitrary string from which to extract the prefix.
- * @returns <string> - the resulting prefix.
- */
-const extractPrefix = (str) => 
-// eslint-disable-next-line no-useless-escape
-str.replace(/[`\s~!@#$%^&*()|+\-=?;:'",.<>\{\}\[\]\\\/]/gi, "-").toLowerCase();
 /**
  * Automate the generation of an entropy for a contribution.
  * @dev Took inspiration from here https://github.com/glamperd/setup-mpc-ui/blob/master/client/src/state/Compute.tsx#L112.
@@ -1374,7 +1203,9 @@ const getContributionsValidityForContributor = async (firestoreDatabase, circuit
  * @param isFinalizing <boolean> - true when the coordinator is finalizing the ceremony, otherwise false.
  * @returns <string> - the public attestation preamble.
  */
-const getPublicAttestationPreambleForContributor = (contributorIdentifier, ceremonyName, isFinalizing) => `Hey, I'm ${contributorIdentifier} and I have ${isFinalizing ? "finalized" : "contributed to"} the ${ceremonyName} MPC Phase2 Trusted Setup ceremony.\nThe following are my contribution signatures:`;
+const getPublicAttestationPreambleForContributor = (contributorIdentifier, ceremonyName, isFinalizing) => `Hey, I'm ${contributorIdentifier} and I have ${isFinalizing ? "finalized" : "contributed to"} the ${ceremonyName}${ceremonyName.toLowerCase().includes("trusted setup") || ceremonyName.toLowerCase().includes("ceremony")
+    ? "."
+    : " MPC Phase2 Trusted Setup ceremony."}\nThe following are my contribution signatures:`;
 /**
  * Check and prepare public attestation for the contributor made only of its valid contributions.
  * @param firestoreDatabase <Firestore> - the Firestore service instance associated to the current Firebase application.
@@ -1445,6 +1276,41 @@ const readBytesFromFile = (localFilePath, offset, length, position) => {
     // Return the read bytes.
     return buffer;
 };
+/**
+ * Given a buffer in little endian format, convert it to bigint
+ * @param buffer
+ * @returns
+ */
+function leBufferToBigint(buffer) {
+    return BigInt(`0x${buffer.reverse().toString("hex")}`);
+}
+/**
+ * Given an input containing string values, convert them
+ * to bigint
+ * @param input - The input to convert
+ * @returns the input with string values converted to bigint
+ */
+const unstringifyBigInts = (input) => {
+    if (typeof input === "string" && /^[0-9]+$/.test(input)) {
+        return BigInt(input);
+    }
+    if (typeof input === "string" && /^0x[0-9a-fA-F]+$/.test(input)) {
+        return BigInt(input);
+    }
+    if (Array.isArray(input)) {
+        return input.map(unstringifyBigInts);
+    }
+    if (input === null) {
+        return null;
+    }
+    if (typeof input === "object") {
+        return Object.entries(input).reduce((acc, [key, value]) => {
+            acc[key] = unstringifyBigInts(value);
+            return acc;
+        }, {});
+    }
+    return input;
+};
 /**
  * Return the info about the R1CS file.ù
  * @dev this method was built taking inspiration from
@@ -1505,17 +1371,17 @@ const getR1CSInfo = (localR1CSFilePath) => {
     let constraints = 0;
     try {
         // Get 'number of section' (jump magic r1cs and version1 data).
-        const numberOfSections = ffjavascript.utils.leBuff2int(readBytesFromFile(localR1CSFilePath, 0, 4, 8));
+        const numberOfSections = leBufferToBigint(readBytesFromFile(localR1CSFilePath, 0, 4, 8));
         // Jump to first section.
         pointer = 12;
         // For each section
         for (let i = 0; i < numberOfSections; i++) {
             // Read section type.
-            const sectionType = ffjavascript.utils.leBuff2int(readBytesFromFile(localR1CSFilePath, 0, 4, pointer));
+            const sectionType = leBufferToBigint(readBytesFromFile(localR1CSFilePath, 0, 4, pointer));
             // Jump to section size.
             pointer += 4;
             // Read section size
-            const sectionSize = Number(ffjavascript.utils.leBuff2int(readBytesFromFile(localR1CSFilePath, 0, 8, pointer)));
+            const sectionSize = Number(leBufferToBigint(readBytesFromFile(localR1CSFilePath, 0, 8, pointer)));
             // If at header section (0x00000001 : Header Section).
             if (sectionType === BigInt(1)) {
                 // Read info from header section.
@@ -1547,22 +1413,22 @@ const getR1CSInfo = (localR1CSFilePath) => {
                  */
                 pointer += sectionSize - 20;
                 // Read R1CS info.
-                wires = Number(ffjavascript.utils.leBuff2int(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
+                wires = Number(leBufferToBigint(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
                 pointer += 4;
-                publicOutputs = Number(ffjavascript.utils.leBuff2int(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
+                publicOutputs = Number(leBufferToBigint(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
                 pointer += 4;
-                publicInputs = Number(ffjavascript.utils.leBuff2int(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
+                publicInputs = Number(leBufferToBigint(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
                 pointer += 4;
-                privateInputs = Number(ffjavascript.utils.leBuff2int(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
+                privateInputs = Number(leBufferToBigint(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
                 pointer += 4;
-                labels = Number(ffjavascript.utils.leBuff2int(readBytesFromFile(localR1CSFilePath, 0, 8, pointer)));
+                labels = Number(leBufferToBigint(readBytesFromFile(localR1CSFilePath, 0, 8, pointer)));
                 pointer += 8;
-                constraints = Number(ffjavascript.utils.leBuff2int(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
+                constraints = Number(leBufferToBigint(readBytesFromFile(localR1CSFilePath, 0, 4, pointer)));
             }
             pointer += 8 + Number(sectionSize);
         }
         return {
-            curve: "bn-128",
+            curve: "bn-128", /// @note currently default to bn-128 as we support only Groth16 proving system.
             wires,
             constraints,
             privateInputs,
@@ -1577,11 +1443,194 @@ const getR1CSInfo = (localR1CSFilePath) => {
     }
 };
 /**
- * Return a string with double digits if the provided input is one digit only.
- * @param in <number> - the input number to be converted.
- * @returns <string> - the two digits stringified number derived from the conversion.
+ * Parse and validate that the ceremony configuration is correct
+ * @notice this does not upload any files to storage
+ * @param path <string> - the path to the configuration file
+ * @param cleanup <boolean> - whether to delete the r1cs file after parsing
+ * @returns any - the data to pass to the cloud function for setup and the circuit artifacts
  */
-const convertToDoubleDigits = (amount) => (amount < 10 ? `0${amount}` : amount.toString());
+const parseCeremonyFile = async (path, cleanup = false) => {
+    // check that the path exists
+    if (!fs.existsSync(path))
+        throw new Error("The provided path to the configuration file does not exist. Please provide an absolute path and try again.");
+    try {
+        // read the data
+        const data = JSON.parse(fs.readFileSync(path).toString());
+        // verify that the data is correct
+        if (data.timeoutMechanismType !== "DYNAMIC" /* CeremonyTimeoutType.DYNAMIC */ &&
+            data.timeoutMechanismType !== "FIXED" /* CeremonyTimeoutType.FIXED */)
+            throw new Error("Invalid timeout type. Please choose between DYNAMIC and FIXED.");
+        // validate that we have at least 1 circuit input data
+        if (!data.circuits || data.circuits.length === 0)
+            throw new Error("You need to provide the data for at least 1 circuit.");
+        // validate that the end date is in the future
+        let endDate;
+        let startDate;
+        try {
+            endDate = new Date(data.endDate);
+            startDate = new Date(data.startDate);
+        }
+        catch (error) {
+            throw new Error("The dates should follow this format: 2023-07-04T00:00:00.");
+        }
+        if (endDate <= startDate)
+            throw new Error("The end date should be greater than the start date.");
+        const currentDate = new Date();
+        if (endDate <= currentDate || startDate <= currentDate)
+            throw new Error("The start and end dates should be in the future.");
+        // validate penalty
+        if (data.penalty <= 0)
+            throw new Error("The penalty should be greater than zero.");
+        const circuits = [];
+        const urlPattern = /(https?:\/\/[^\s]+)/g;
+        const commitHashPattern = /^[a-f0-9]{40}$/i;
+        const circuitArtifacts = [];
+        for (let i = 0; i < data.circuits.length; i++) {
+            const circuitData = data.circuits[i];
+            const { artifacts } = circuitData;
+            circuitArtifacts.push({
+                artifacts
+            });
+            // where we storing the r1cs downloaded
+            const localR1csPath = `./${circuitData.name}.r1cs`;
+            // where we storing the wasm downloaded
+            const localWasmPath = `./${circuitData.name}.wasm`;
+            // download the r1cs to extract the metadata
+            const streamPipeline = util.promisify(stream.pipeline);
+            // Make the call.
+            const responseR1CS = await fetch(artifacts.r1csStoragePath);
+            // Handle errors.
+            if (!responseR1CS.ok && responseR1CS.status !== 200)
+                throw new Error(`There was an error while trying to download the r1cs file for circuit ${circuitData.name}. Please check that the file has the correct permissions (public) set.`);
+            await streamPipeline(responseR1CS.body, fs.createWriteStream(localR1csPath));
+            // Write the file locally
+            // extract the metadata from the r1cs
+            const metadata = getR1CSInfo(localR1csPath);
+            // download wasm too to ensure it's available
+            const responseWASM = await fetch(artifacts.wasmStoragePath);
+            if (!responseWASM.ok && responseWASM.status !== 200)
+                throw new Error(`There was an error while trying to download the WASM file for circuit ${circuitData.name}. Please check that the file has the correct permissions (public) set.`);
+            await streamPipeline(responseWASM.body, fs.createWriteStream(localWasmPath));
+            // validate that the circuit hash and template links are valid
+            const { template } = circuitData;
+            const URLMatch = template.source.match(urlPattern);
+            if (!URLMatch || URLMatch.length === 0 || URLMatch.length > 1)
+                throw new Error("You should provide the URL to the circuits templates on GitHub.");
+            const hashMatch = template.commitHash.match(commitHashPattern);
+            if (!hashMatch || hashMatch.length === 0 || hashMatch.length > 1)
+                throw new Error("You should provide a valid commit hash of the circuit templates.");
+            // calculate the hash of the r1cs file
+            const r1csBlake2bHash = await blake512FromPath(localR1csPath);
+            const circuitPrefix = extractPrefix(circuitData.name);
+            // filenames
+            const doubleDigitsPowers = convertToDoubleDigits(metadata.pot);
+            const r1csCompleteFilename = `${circuitData.name}.r1cs`;
+            const wasmCompleteFilename = `${circuitData.name}.wasm`;
+            const smallestPowersOfTauCompleteFilenameForCircuit = `${potFilenameTemplate}${doubleDigitsPowers}.ptau`;
+            const firstZkeyCompleteFilename = `${circuitPrefix}_${genesisZkeyIndex}.zkey`;
+            // storage paths
+            const r1csStorageFilePath = getR1csStorageFilePath(circuitPrefix, r1csCompleteFilename);
+            const wasmStorageFilePath = getWasmStorageFilePath(circuitPrefix, wasmCompleteFilename);
+            const potStorageFilePath = getPotStorageFilePath(smallestPowersOfTauCompleteFilenameForCircuit);
+            const zkeyStorageFilePath = getZkeyStorageFilePath(circuitPrefix, firstZkeyCompleteFilename);
+            const files = {
+                potFilename: smallestPowersOfTauCompleteFilenameForCircuit,
+                r1csFilename: r1csCompleteFilename,
+                wasmFilename: wasmCompleteFilename,
+                initialZkeyFilename: firstZkeyCompleteFilename,
+                potStoragePath: potStorageFilePath,
+                r1csStoragePath: r1csStorageFilePath,
+                wasmStoragePath: wasmStorageFilePath,
+                initialZkeyStoragePath: zkeyStorageFilePath,
+                r1csBlake2bHash
+            };
+            // validate that the compiler hash is a valid hash
+            const { compiler } = circuitData;
+            const compilerHashMatch = compiler.commitHash.match(commitHashPattern);
+            if (!compilerHashMatch || compilerHashMatch.length === 0 || compilerHashMatch.length > 1)
+                throw new Error("You should provide a valid commit hash of the circuit compiler.");
+            // validate that the verification options are valid
+            const { verification } = circuitData;
+            if (verification.cfOrVm !== "CF" && verification.cfOrVm !== "VM")
+                throw new Error("Please enter a valid verification mechanism: either CF or VM");
+            // @todo VM parameters verification
+            // if (verification['cfOrVM'] === "VM") {}
+            // check that the timeout is provided for the correct configuration
+            let dynamicThreshold;
+            let fixedTimeWindow;
+            let circuit = {};
+            if (data.timeoutMechanismType === "DYNAMIC" /* CeremonyTimeoutType.DYNAMIC */) {
+                if (circuitData.dynamicThreshold <= 0)
+                    throw new Error("The dynamic threshold should be > 0.");
+                dynamicThreshold = circuitData.dynamicThreshold;
+                // the Circuit data for the ceremony setup
+                circuit = {
+                    name: circuitData.name,
+                    description: circuitData.description,
+                    prefix: circuitPrefix,
+                    sequencePosition: i + 1,
+                    metadata,
+                    files,
+                    template,
+                    compiler,
+                    verification,
+                    dynamicThreshold,
+                    avgTimings: {
+                        contributionComputation: 0,
+                        fullContribution: 0,
+                        verifyCloudFunction: 0
+                    }
+                };
+            }
+            if (data.timeoutMechanismType === "FIXED" /* CeremonyTimeoutType.FIXED */) {
+                if (circuitData.fixedTimeWindow <= 0)
+                    throw new Error("The fixed time window threshold should be > 0.");
+                fixedTimeWindow = circuitData.fixedTimeWindow;
+                // the Circuit data for the ceremony setup
+                circuit = {
+                    name: circuitData.name,
+                    description: circuitData.description,
+                    prefix: circuitPrefix,
+                    sequencePosition: i + 1,
+                    metadata,
+                    files,
+                    template,
+                    compiler,
+                    verification,
+                    fixedTimeWindow,
+                    avgTimings: {
+                        contributionComputation: 0,
+                        fullContribution: 0,
+                        verifyCloudFunction: 0
+                    }
+                };
+            }
+            circuits.push(circuit);
+            // remove the local r1cs and wasm downloads (if used for verifying the config only vs setup)
+            if (cleanup) {
+                fs.unlinkSync(localR1csPath);
+                fs.unlinkSync(localWasmPath);
+            }
+        }
+        const setupData = {
+            ceremonyInputData: {
+                title: data.title,
+                description: data.description,
+                startDate: startDate.valueOf(),
+                endDate: endDate.valueOf(),
+                timeoutMechanismType: data.timeoutMechanismType,
+                penalty: data.penalty
+            },
+            ceremonyPrefix: extractPrefix(data.title),
+            circuits,
+            circuitArtifacts
+        };
+        return setupData;
+    }
+    catch (error) {
+        throw new Error(`Error while parsing up the ceremony setup file. ${error.message}`);
+    }
+};
 
 /**
  * Verify that a zKey is valid
@@ -1830,7 +1879,7 @@ const getFirestoreDatabase = (app) => firestore.getFirestore(app);
  * @param app <FirebaseApp> - the Firebase application.
  * @returns <Functions> - the Cloud Functions associated to the application.
  */
-const getFirebaseFunctions = (app) => functions.getFunctions(app, 'europe-west1');
+const getFirebaseFunctions = (app) => functions.getFunctions(app, "europe-west1");
 /**
  * Retrieve the configuration variables for the AWS services (S3, EC2).
  * @returns <AWSVariables> - the values of the AWS services configuration variables.
@@ -1839,14 +1888,14 @@ const getAWSVariables = () => {
     if (!process.env.AWS_ACCESS_KEY_ID ||
         !process.env.AWS_SECRET_ACCESS_KEY ||
         !process.env.AWS_REGION ||
-        !process.env.AWS_ROLE_ARN ||
+        !process.env.AWS_INSTANCE_PROFILE_ARN ||
         !process.env.AWS_AMI_ID)
         throw new Error("Could not retrieve the AWS environment variables. Please, verify your environment configuration and retry");
     return {
         accessKeyId: process.env.AWS_ACCESS_KEY_ID,
         secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
         region: process.env.AWS_REGION || "us-east-1",
-        roleArn: process.env.AWS_ROLE_ARN,
+        instanceProfileArn: process.env.AWS_INSTANCE_PROFILE_ARN,
         amiId: process.env.AWS_AMI_ID
     };
 };
@@ -1927,11 +1976,11 @@ const p256 = (proofPart) => {
  */
 const formatSolidityCalldata = (circuitInput, _proof) => {
     try {
-        const proof = ffjavascript.utils.unstringifyBigInts(_proof);
+        const proof = unstringifyBigInts(_proof);
         // format the public inputs to the circuit
         const formattedCircuitInput = [];
         for (const cInput of circuitInput) {
-            formattedCircuitInput.push(p256(ffjavascript.utils.unstringifyBigInts(cInput)));
+            formattedCircuitInput.push(p256(unstringifyBigInts(cInput)));
         }
         // construct calldata
         const calldata = {
@@ -2081,55 +2130,28 @@ const verifyCeremony = async (functions, firestore$1, ceremonyPrefix, outputDire
 };
 
 /**
- * This function will return the number of public repos of a user
- * @param user <string> The username of the user
- * @returns <number> The number of public repos
- */
-const getNumberOfPublicReposGitHub = async (user) => {
-    const response = await fetch(`https://api.github.com/user/${user}/repos`, {
-        method: "GET",
-        headers: {
-            Authorization: `token ${process.env.GITHUB_ACCESS_TOKEN}`
-        }
-    });
-    if (response.status !== 200)
-        throw new Error("It was not possible to retrieve the number of public repositories. Please try again.");
-    const jsonData = await response.json();
-    return jsonData.length;
-};
-/**
- * This function will return the number of followers of a user
- * @param user <string> The username of the user
- * @returns <number> The number of followers
+ * This function queries the GitHub API to fetch users statistics
+ * @param user {string} the user uid
+ * @returns {any} the stats from the GitHub API
  */
-const getNumberOfFollowersGitHub = async (user) => {
-    const response = await fetch(`https://api.github.com/user/${user}/followers`, {
+const getGitHubStats = async (user) => {
+    const response = await fetch(`https://api.github.com/user/${user}`, {
         method: "GET",
         headers: {
             Authorization: `token ${process.env.GITHUB_ACCESS_TOKEN}`
         }
     });
     if (response.status !== 200)
-        throw new Error("It was not possible to retrieve the number of followers. Please try again.");
+        throw new Error("It was not possible to retrieve the user's statistic. Please try again.");
     const jsonData = await response.json();
-    return jsonData.length;
-};
-/**
- * This function will return the number of following of a user
- * @param user <string> The username of the user
- * @returns <number> The number of following users
- */
-const getNumberOfFollowingGitHub = async (user) => {
-    const response = await fetch(`https://api.github.com/user/${user}/following`, {
-        method: "GET",
-        headers: {
-            Authorization: `token ${process.env.GITHUB_ACCESS_TOKEN}`
-        }
-    });
-    if (response.status !== 200)
-        throw new Error("It was not possible to retrieve the number of following. Please try again.");
-    const jsonData = await response.json();
-    return jsonData.length;
+    const data = {
+        following: jsonData.following,
+        followers: jsonData.followers,
+        publicRepos: jsonData.public_repos,
+        avatarUrl: jsonData.avatar_url,
+        age: jsonData.created_at
+    };
+    return data;
 };
 /**
  * This function will check if the user is reputable enough to be able to use the app
@@ -2137,19 +2159,24 @@ const getNumberOfFollowingGitHub = async (user) => {
  * @param minimumAmountOfFollowing <number> The minimum amount of following the user should have
  * @param minimumAmountOfFollowers <number> The minimum amount of followers the user should have
  * @param minimumAmountOfPublicRepos <number> The minimum amount of public repos the user should have
- * @returns <boolean> True if the user is reputable enough, false otherwise
+ * @returns <any> Return the avatar URL of the user if the user is reputable, false otherwise
  */
-const githubReputation = async (userLogin, minimumAmountOfFollowing, minimumAmountOfFollowers, minimumAmountOfPublicRepos) => {
+const githubReputation = async (userLogin, minimumAmountOfFollowing, minimumAmountOfFollowers, minimumAmountOfPublicRepos, minimumAge) => {
     if (!process.env.GITHUB_ACCESS_TOKEN)
         throw new Error("The GitHub access token is missing. Please insert a valid token to be used for anti-sybil checks on user registation, and then try again.");
-    const following = await getNumberOfFollowingGitHub(userLogin);
-    const repos = await getNumberOfPublicReposGitHub(userLogin);
-    const followers = await getNumberOfFollowersGitHub(userLogin);
+    const { following, followers, publicRepos, avatarUrl, age } = await getGitHubStats(userLogin);
     if (following < minimumAmountOfFollowing ||
-        repos < minimumAmountOfPublicRepos ||
-        followers < minimumAmountOfFollowers)
-        return false;
-    return true;
+        publicRepos < minimumAmountOfPublicRepos ||
+        followers < minimumAmountOfFollowers ||
+        new Date(age) > new Date(Date.now() - minimumAge))
+        return {
+            reputable: false,
+            avatarUrl: ""
+        };
+    return {
+        reputable: true,
+        avatarUrl
+    };
 };
 
 /**
@@ -2335,8 +2362,8 @@ const createSSMClient = async () => {
  * @returns <Array<string>> - the list of startup commands to be executed.
  */
 const vmBootstrapCommand = (bucketName) => [
-    "#!/bin/bash",
-    `aws s3 cp s3://${bucketName}/${vmBootstrapScriptFilename} ${vmBootstrapScriptFilename}`,
+    "#!/bin/bash", // shabang.
+    `aws s3 cp s3://${bucketName}/${vmBootstrapScriptFilename} ${vmBootstrapScriptFilename}`, // copy file from S3 bucket to VM.
     `chmod +x ${vmBootstrapScriptFilename} && bash ${vmBootstrapScriptFilename}` // grant permission and execute.
 ];
 /**
@@ -2357,8 +2384,13 @@ const vmDependenciesAndCacheArtifactsCommand = (zKeyPath, potPath, snsTopic, reg
     // eslint-disable-next-line no-template-curly-in-string
     "touch ${MARKER_FILE}",
     "sudo yum update -y",
-    "curl -sL https://rpm.nodesource.com/setup_16.x | sudo bash - ",
-    "sudo yum install -y nodejs",
+    "curl -O https://nodejs.org/dist/v16.13.0/node-v16.13.0-linux-x64.tar.xz",
+    "tar -xf node-v16.13.0-linux-x64.tar.xz",
+    "mv node-v16.13.0-linux-x64 nodejs",
+    "sudo mv nodejs /opt/",
+    "echo 'export NODEJS_HOME=/opt/nodejs' >> /etc/profile",
+    "echo 'export PATH=$NODEJS_HOME/bin:$PATH' >> /etc/profile",
+    "source /etc/profile",
     "npm install -g snarkjs",
     `aws s3 cp s3://${zKeyPath} /var/tmp/genesisZkey.zkey`,
     `aws s3 cp s3://${potPath} /var/tmp/pot.ptau`,
@@ -2377,6 +2409,7 @@ const vmDependenciesAndCacheArtifactsCommand = (zKeyPath, potPath, snsTopic, reg
  * @returns Array<string> - the list of commands for contribution verification.
  */
 const vmContributionVerificationCommand = (bucketName, lastZkeyStoragePath, verificationTranscriptStoragePathAndFilename) => [
+    `source /etc/profile`,
     `aws s3 cp s3://${bucketName}/${lastZkeyStoragePath} /var/tmp/lastZKey.zkey > /var/tmp/log.txt`,
     `snarkjs zkvi /var/tmp/genesisZkey.zkey /var/tmp/pot.ptau /var/tmp/lastZKey.zkey > /var/tmp/verification_transcript.log`,
     `aws s3 cp /var/tmp/verification_transcript.log s3://${bucketName}/${verificationTranscriptStoragePathAndFilename} &>/dev/null`,
@@ -2403,7 +2436,7 @@ const computeDiskSizeForVM = (zKeySizeInBytes, pot) => Math.ceil(2 * convertByte
  */
 const createEC2Instance = async (ec2, commands, instanceType, volumeSize, diskType) => {
     // Get the AWS variables.
-    const { amiId, roleArn } = getAWSVariables();
+    const { amiId, instanceProfileArn } = getAWSVariables();
     // Parametrize the VM EC2 instance.
     const params = {
         ImageId: amiId,
@@ -2412,7 +2445,7 @@ const createEC2Instance = async (ec2, commands, instanceType, volumeSize, diskTy
         MinCount: 1,
         // nb. to find this: iam -> roles -> role_name.
         IamInstanceProfile: {
-            Arn: roleArn
+            Arn: instanceProfileArn
         },
         // nb. for running commands at the startup.
         UserData: Buffer.from(commands.join("\n")).toString("base64"),
@@ -2421,7 +2454,7 @@ const createEC2Instance = async (ec2, commands, instanceType, volumeSize, diskTy
                 DeviceName: "/dev/xvda",
                 Ebs: {
                     DeleteOnTermination: true,
-                    VolumeSize: volumeSize,
+                    VolumeSize: volumeSize, // disk size in GB.
                     VolumeType: diskType
                 }
             }
@@ -2649,6 +2682,7 @@ exports.generatePreSignedUrlsParts = generatePreSignedUrlsParts;
 exports.generateValidContributionsAttestation = generateValidContributionsAttestation;
 exports.generateZkeyFromScratch = generateZkeyFromScratch;
 exports.genesisZkeyIndex = genesisZkeyIndex;
+exports.getAllCeremonies = getAllCeremonies;
 exports.getAllCollectionDocs = getAllCollectionDocs;
 exports.getBucketName = getBucketName;
 exports.getCeremonyCircuits = getCeremonyCircuits;