@devtion/devcli 0.0.0-9843891 → 0.0.0-9d46256

package/README.md

@@ -97,7 +97,7 @@ Commands:
   auth            authenticate yourself using your Github Account (Device Flow OAuth 2.0)
   contribute      compute contributions for a Phase2 Trusted Setup ceremony circuits
   clean           clean up output generated by commands from the current working directory
-  logout          sign out from Firebae Auth service and delete Github OAuth 2.0 token from your machine
+  logout          sign out from Firebase Auth service and delete Github OAuth 2.0 token from your machine
   coordinate      special subset of commands for coordinating a ceremony (coordinator only)
   help [command]  display help for command
 ```

package/dist/index.js

@@ -2,7 +2,7 @@
 
 /**
  * @module @p0tion/phase2cli
- * @version 1.2.3
+ * @version 1.2.8
  * @file All-in-one interactive command-line for interfacing with zkSNARK Phase 2 Trusted Setup ceremonies
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -17,7 +17,7 @@ import boxen from 'boxen';
 import { pipeline } from 'node:stream';
 import { promisify } from 'node:util';
 import fetch$1 from 'node-fetch';
-import { commonTerms, formatZkeyIndex, getZkeyStorageFilePath, finalContributionIndex, createCustomLoggerForFile, getBucketName, progressToNextContributionStep, permanentlyStoreCurrentContributionTimeAndHash, convertToDoubleDigits, multiPartUpload, verifyContribution, generateGetObjectPreSignedUrl, convertBytesOrKbToGb, numExpIterations, getDocumentById, getParticipantsCollectionPath, fromQueryToFirebaseDocumentInfo, getAllCollectionDocs, extractPrefix, autoGenerateEntropy, vmConfigurationTypes, initializeFirebaseCoreServices, signInToFirebaseWithCredentials, getCurrentFirebaseAuthUser, isCoordinator, parseCeremonyFile, blake512FromPath, checkIfObjectExist, setupCeremony, genesisZkeyIndex, getR1csStorageFilePath, getWasmStorageFilePath, getPotStorageFilePath, extractPoTFromFilename, potFileDownloadMainUrl, createS3Bucket, potFilenameTemplate, getR1CSInfo, getOpenedCeremonies, getCeremonyCircuits, checkParticipantForCeremony, getCurrentActiveParticipantTimeout, getCircuitBySequencePosition, getCircuitContributionsFromContributor, progressToNextCircuitForContribution, resumeContributionAfterTimeoutExpiration, generateValidContributionsAttestation, getContributionsValidityForContributor, getClosedCeremonies, checkAndPrepareCoordinatorForFinalization, computeSHA256ToHex, finalizeCeremony, getVerificationKeyStorageFilePath, verificationKeyAcronym, getVerifierContractStorageFilePath, verifierSmartContractAcronym, finalizeCircuit, exportVkey, exportVerifierContract, getAllCeremonies } from '@devtion/actions';
+import { commonTerms, formatZkeyIndex, getZkeyStorageFilePath, finalContributionIndex, createCustomLoggerForFile, getBucketName, progressToNextContributionStep, contribHashRegex, permanentlyStoreCurrentContributionTimeAndHash, convertToDoubleDigits, multiPartUpload, verifyContribution, generateGetObjectPreSignedUrl, convertBytesOrKbToGb, numExpIterations, getDocumentById, getParticipantsCollectionPath, fromQueryToFirebaseDocumentInfo, getAllCollectionDocs, extractPrefix, autoGenerateEntropy, vmConfigurationTypes, initializeFirebaseCoreServices, signInToFirebaseWithCredentials, getCurrentFirebaseAuthUser, isCoordinator, parseCeremonyFile, blake512FromPath, checkIfObjectExist, setupCeremony, genesisZkeyIndex, getR1csStorageFilePath, getWasmStorageFilePath, getPotStorageFilePath, extractPoTFromFilename, potFileDownloadMainUrl, createS3Bucket, potFilenameTemplate, getR1CSInfo, getOpenedCeremonies, getCeremonyCircuits, checkParticipantForCeremony, getCurrentActiveParticipantTimeout, getCircuitBySequencePosition, getCircuitContributionsFromContributor, progressToNextCircuitForContribution, resumeContributionAfterTimeoutExpiration, generateValidContributionsAttestation, getContributionsValidityForContributor, getClosedCeremonies, checkAndPrepareCoordinatorForFinalization, computeSHA256ToHex, finalizeCeremony, getVerificationKeyStorageFilePath, verificationKeyAcronym, getVerifierContractStorageFilePath, verifierSmartContractAcronym, finalizeCircuit, exportVkey, exportVerifierContract, getAllCeremonies } from '@devtion/actions';
 import fetch from '@adobe/node-fetch-retry';
 import { request } from '@octokit/request';
 import { SingleBar, Presets } from 'cli-progress';
@@ -122,7 +122,7 @@ const COMMAND_ERRORS = {
     COMMAND_SETUP_NO_R1CS: `Unable to retrieve R1CS files from current working directory. Please, run this command from a working directory where the R1CS files are located to continue with the setup process. We kindly ask you to run the command from an empty directory containing only the R1CS and WASM files.`,
     COMMAND_SETUP_NO_WASM: `Unable to retrieve WASM files from current working directory. Please, run this command from a working directory where the WASM files are located to continue with the setup process. We kindly ask you to run the command from an empty directory containing only the WASM and R1CS files.`,
     COMMAND_SETUP_MISMATCH_R1CS_WASM: `The folder contains more R1CS files than WASM files (or vice versa). Please, run this command from a working directory where each R1CS is paired with its corresponding file WASM.`,
-    COMMAND_SETUP_DOWNLOAD_PTAU: `Unable to download Powers of Tau file from Hermez Cryptography Phase 1 Trusted Setup. Possible causes may involve an error while making the request (be sure to have a stable internet connection). Please, we kindly ask you to terminate the current session and repeat the process.`,
+    COMMAND_SETUP_DOWNLOAD_PTAU: `Unable to download Powers of Tau file from PPoT Phase 1 Trusted Setup. Possible causes may involve an error while making the request (be sure to have a stable internet connection). Please, we kindly ask you to terminate the current session and repeat the process.`,
     COMMAND_SETUP_ABORT: `You chose to abort the setup process.`,
     COMMAND_CONTRIBUTE_NO_OPENED_CEREMONIES: `Unfortunately, there is no ceremony for which you can make a contribution at this time. Please, try again later.`,
     COMMAND_CONTRIBUTE_NO_PARTICIPANT_DATA: `Unable to retrieve your data as ceremony participant. Please, terminate the current session and try again later. If the error persists, please contact the ceremony coordinator.`,
@@ -523,7 +523,7 @@ const getUserHandleFromProviderUserId = (providerUserId) => {
     if (providerUserId.indexOf("-") === -1) {
         return providerUserId;
     }
-    return providerUserId.split("-")[0];
+    return providerUserId.substring(0, providerUserId.lastIndexOf("-"));
 };
 /**
  * Return a custom spinner.
@@ -637,19 +637,22 @@ const publishGist = async (token, content, ceremonyTitle, ceremonyPrefix) => {
  * @param isFinalizing <boolean> - flag to discriminate between ceremony finalization (true) and contribution (false).
  * @returns <string> - the ready to share tweet url.
  */
-const generateCustomUrlToTweetAboutParticipation = (ceremonyName, gistUrl, isFinalizing) => isFinalizing
-    ? `https://twitter.com/intent/tweet?text=I%20have%20finalized%20the%20${ceremonyName}${ceremonyName.toLowerCase().includes("trusted") ||
-        ceremonyName.toLowerCase().includes("setup") ||
-        ceremonyName.toLowerCase().includes("phase2") ||
-        ceremonyName.toLowerCase().includes("ceremony")
-        ? "!"
-        : "%20Phase%202%20Trusted%20Setup%20ceremony!"}%20You%20can%20view%20my%20final%20attestation%20here:%20${gistUrl}%20#Ethereum%20#ZKP%20#PSE`
-    : `https://twitter.com/intent/tweet?text=I%20contributed%20to%20the%20${ceremonyName}${ceremonyName.toLowerCase().includes("trusted") ||
-        ceremonyName.toLowerCase().includes("setup") ||
-        ceremonyName.toLowerCase().includes("phase2") ||
-        ceremonyName.toLowerCase().includes("ceremony")
-        ? "!"
-        : "%20Phase%202%20Trusted%20Setup%20ceremony!"}%20You%20can%20view%20the%20steps%20to%20contribute%20here:%20https://ceremony.pse.dev%20You%20can%20view%20my%20attestation%20here:%20${gistUrl}%20#Ethereum%20#ZKP`;
+const generateCustomUrlToTweetAboutParticipation = (ceremonyName, gistUrl, isFinalizing) => {
+    ceremonyName = ceremonyName.replace(/ /g, "%20");
+    return isFinalizing
+        ? `https://twitter.com/intent/tweet?text=I%20have%20finalized%20the%20${ceremonyName}${ceremonyName.toLowerCase().includes("trusted") ||
+            ceremonyName.toLowerCase().includes("setup") ||
+            ceremonyName.toLowerCase().includes("phase2") ||
+            ceremonyName.toLowerCase().includes("ceremony")
+            ? "!"
+            : "%20Phase%202%20Trusted%20Setup%20ceremony!"}%20You%20can%20view%20my%20final%20attestation%20here:%20${gistUrl}%20#Ethereum%20#ZKP%20#PSE`
+        : `https://twitter.com/intent/tweet?text=I%20contributed%20to%20the%20${ceremonyName}${ceremonyName.toLowerCase().includes("trusted") ||
+            ceremonyName.toLowerCase().includes("setup") ||
+            ceremonyName.toLowerCase().includes("phase2") ||
+            ceremonyName.toLowerCase().includes("ceremony")
+            ? "!"
+            : "%20Phase%202%20Trusted%20Setup%20ceremony!"}%20You%20can%20view%20the%20steps%20to%20contribute%20here:%20https://ceremony.pse.dev%20You%20can%20view%20my%20attestation%20here:%20${gistUrl}%20#Ethereum%20#ZKP`;
+};
 /**
  * Return a custom progress bar.
  * @param type <ProgressBarType> - the type of the progress bar.
@@ -853,7 +856,7 @@ const handleStartOrResumeContribution = async (cloudFunctions, firestoreDatabase
         spinner.start();
         // Read local transcript file info to get the contribution hash.
         const transcriptContents = readFile(transcriptLocalFilePath);
-        const matchContributionHash = transcriptContents.match(/Contribution.+Hash.+\n\t\t.+\n\t\t.+\n.+\n\t\t.+\n/);
+        const matchContributionHash = transcriptContents.match(contribHashRegex);
         if (!matchContributionHash)
             showError(COMMAND_ERRORS.COMMAND_CONTRIBUTE_FINALIZE_NO_TRANSCRIPT_CONTRIBUTION_HASH_MATCH, true);
         // Format contribution hash.
@@ -1783,7 +1786,7 @@ const displayCeremonySummary = (ceremonyInputData, circuits) => {
 };
 /**
  * Check if the smallest Powers of Tau has already been downloaded/stored in the correspondent local path
- * @dev we are downloading the Powers of Tau file from Hermez Cryptography Phase 1 Trusted Setup.
+ * @dev we are downloading the Powers of Tau file from Perpetual Powers of Tau Phase 1 Trusted Setup.
  * @param powers <string> - the smallest amount of powers needed for the given circuit (should be in a 'XY' stringified form).
  * @param ptauCompleteFilename <string> - the complete file name of the powers of tau file to be downloaded.
  * @returns <Promise<void>>
@@ -1797,7 +1800,7 @@ const checkAndDownloadSmallestPowersOfTau = async (powers, ptauCompleteFilename)
         .map((dirent) => dirent.name);
     // Check if already downloaded or not.
     if (smallestPtauFileForGivenPowers.length === 0) {
-        const spinner = customSpinner(`Downloading the ${theme.text.bold(`#${powers}`)} smallest PoT file needed from the Hermez Cryptography Phase 1 Trusted Setup...`, `clock`);
+        const spinner = customSpinner(`Downloading the ${theme.text.bold(`#${powers}`)} smallest PoT file needed from the Perpetual Powers of Tau Phase 1 Trusted Setup...`, `clock`);
         spinner.start();
         // Download smallest Powers of Tau file from remote server.
         const streamPipeline = promisify(pipeline);
@@ -1883,6 +1886,7 @@ const handleCeremonyBucketCreation = async (firebaseFunctions, ceremonyPrefix) =
     spinner.start();
     try {
         // Make the call to create the bucket.
+        spinner.info(`Creating bucket ${bucketName}`);
         await createS3Bucket(firebaseFunctions, bucketName);
     }
     catch (error) {
@@ -1912,7 +1916,7 @@ const handleCircuitArtifactUploadToStorage = async (firebaseFunctions, bucketNam
  * @notice The setup command allows the coordinator of the ceremony to prepare the next ceremony by interacting with the CLI.
  * @dev For proper execution, the command must be run in a folder containing the R1CS files related to the circuits
  * for which the coordinator wants to create the ceremony. The command will download the necessary Tau powers
- * from Hermez's ceremony Phase 1 Reliable Setup Ceremony.
+ * from PPoT ceremony Phase 1 Setup Ceremony.
  * @param cmd? <any> - the path to the ceremony setup file.
  */
 const setup = async (cmd) => {
@@ -2187,10 +2191,11 @@ const expirationCountdownForGithubOAuth = (expirationInSeconds) => {
             // Update time and seconds counter.
             expirationInSeconds -= interval;
             secondsCounter -= interval;
-            if (secondsCounter % 60 === 0)
-                secondsCounter = 0;
+            if (secondsCounter === 0) {
+                secondsCounter = 59;
+            }
             // Notify user.
-            process.stdout.write(`${theme.symbols.warning} Expires in ${theme.text.bold(theme.colors.magenta(`00:${Math.floor(expirationInSeconds / 60)}:${secondsCounter}`))}\r`);
+            process.stdout.write(`${theme.symbols.warning} Expires in ${theme.text.bold(theme.colors.magenta(`00:${Math.floor(expirationInSeconds / 60)}:${secondsCounter.toString().padStart(2, "0")}`))}\r`);
         }
         else {
             process.stdout.write(`\n\n`); // workaround to \r.
@@ -2203,6 +2208,7 @@ const expirationCountdownForGithubOAuth = (expirationInSeconds) => {
  * @param verification <Verification> - the data from Github OAuth2.0 device flow.
  */
 const onVerification = async (verification) => {
+    verification.interval = 7; // overwrite Github interval with 7 seconds
     // Copy code to clipboard.
     let noClipboard = false;
     try {

package/dist/types/commands/setup.d.ts

@@ -27,7 +27,7 @@ export declare const handleAdditionOfCircuitsToCeremony: (r1csOptions: Array<str
 export declare const displayCeremonySummary: (ceremonyInputData: CeremonyInputData, circuits: Array<CircuitDocument>) => void;
 /**
  * Check if the smallest Powers of Tau has already been downloaded/stored in the correspondent local path
- * @dev we are downloading the Powers of Tau file from Hermez Cryptography Phase 1 Trusted Setup.
+ * @dev we are downloading the Powers of Tau file from Perpetual Powers of Tau Phase 1 Trusted Setup.
  * @param powers <string> - the smallest amount of powers needed for the given circuit (should be in a 'XY' stringified form).
  * @param ptauCompleteFilename <string> - the complete file name of the powers of tau file to be downloaded.
  * @returns <Promise<void>>
@@ -76,7 +76,7 @@ export declare const handleCircuitArtifactUploadToStorage: (firebaseFunctions: F
  * @notice The setup command allows the coordinator of the ceremony to prepare the next ceremony by interacting with the CLI.
  * @dev For proper execution, the command must be run in a folder containing the R1CS files related to the circuits
  * for which the coordinator wants to create the ceremony. The command will download the necessary Tau powers
- * from Hermez's ceremony Phase 1 Reliable Setup Ceremony.
+ * from PPoT ceremony Phase 1 Setup Ceremony.
  * @param cmd? <any> - the path to the ceremony setup file.
  */
 declare const setup: (cmd: {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@devtion/devcli",
   "type": "module",
-  "version": "0.0.0-9843891",
+  "version": "0.0.0-9d46256",
   "description": "All-in-one interactive command-line for interfacing with zkSNARK Phase 2 Trusted Setup ceremonies",
   "repository": "git@github.com:privacy-scaling-explorations/p0tion.git",
   "homepage": "https://github.com/privacy-scaling-explorations/p0tion",
@@ -104,5 +104,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "438c08492d7e96d2e935cb07aa26492beb79170a"
+  "gitHead": "db993436c57f04fae0ee535d013474a6f87f8271"
 }

package/src/commands/auth.ts

@@ -47,12 +47,16 @@ export const expirationCountdownForGithubOAuth = (expirationInSeconds: number) =
             expirationInSeconds -= interval
             secondsCounter -= interval
 
-            if (secondsCounter % 60 === 0) secondsCounter = 0
+            if (secondsCounter === 0) {
+                secondsCounter = 59
+            }
 
             // Notify user.
             process.stdout.write(
                 `${theme.symbols.warning} Expires in ${theme.text.bold(
-                    theme.colors.magenta(`00:${Math.floor(expirationInSeconds / 60)}:${secondsCounter}`)
+                    theme.colors.magenta(
+                        `00:${Math.floor(expirationInSeconds / 60)}:${secondsCounter.toString().padStart(2, "0")}`
+                    )
                 )}\r`
             )
         } else {
@@ -67,6 +71,7 @@ export const expirationCountdownForGithubOAuth = (expirationInSeconds: number) =
  * @param verification <Verification> - the data from Github OAuth2.0 device flow.
  */
 export const onVerification = async (verification: Verification): Promise<void> => {
+    verification.interval = 7 // overwrite Github interval with 7 seconds
     // Copy code to clipboard.
     let noClipboard = false
     try {

package/src/commands/setup.ts

@@ -271,7 +271,7 @@ export const displayCeremonySummary = (ceremonyInputData: CeremonyInputData, cir
 
 /**
  * Check if the smallest Powers of Tau has already been downloaded/stored in the correspondent local path
- * @dev we are downloading the Powers of Tau file from Hermez Cryptography Phase 1 Trusted Setup.
+ * @dev we are downloading the Powers of Tau file from Perpetual Powers of Tau Phase 1 Trusted Setup.
  * @param powers <string> - the smallest amount of powers needed for the given circuit (should be in a 'XY' stringified form).
  * @param ptauCompleteFilename <string> - the complete file name of the powers of tau file to be downloaded.
  * @returns <Promise<void>>
@@ -293,7 +293,7 @@ export const checkAndDownloadSmallestPowersOfTau = async (
         const spinner = customSpinner(
             `Downloading the ${theme.text.bold(
                 `#${powers}`
-            )} smallest PoT file needed from the Hermez Cryptography Phase 1 Trusted Setup...`,
+            )} smallest PoT file needed from the Perpetual Powers of Tau Phase 1 Trusted Setup...`,
             `clock`
         )
         spinner.start()
@@ -417,6 +417,7 @@ export const handleCeremonyBucketCreation = async (
 
     try {
         // Make the call to create the bucket.
+        spinner.info(`Creating bucket ${bucketName}`)
         await createS3Bucket(firebaseFunctions, bucketName)
     } catch (error: any) {
         const errorBody = JSON.parse(JSON.stringify(error))
@@ -463,7 +464,7 @@ export const handleCircuitArtifactUploadToStorage = async (
  * @notice The setup command allows the coordinator of the ceremony to prepare the next ceremony by interacting with the CLI.
  * @dev For proper execution, the command must be run in a folder containing the R1CS files related to the circuits
  * for which the coordinator wants to create the ceremony. The command will download the necessary Tau powers
- * from Hermez's ceremony Phase 1 Reliable Setup Ceremony.
+ * from PPoT ceremony Phase 1 Setup Ceremony.
  * @param cmd? <any> - the path to the ceremony setup file.
  */
 const setup = async (cmd: { template?: string; auth?: string }) => {

package/src/lib/errors.ts

@@ -34,7 +34,7 @@ export const COMMAND_ERRORS = {
     COMMAND_SETUP_NO_R1CS: `Unable to retrieve R1CS files from current working directory. Please, run this command from a working directory where the R1CS files are located to continue with the setup process. We kindly ask you to run the command from an empty directory containing only the R1CS and WASM files.`,
     COMMAND_SETUP_NO_WASM: `Unable to retrieve WASM files from current working directory. Please, run this command from a working directory where the WASM files are located to continue with the setup process. We kindly ask you to run the command from an empty directory containing only the WASM and R1CS files.`,
     COMMAND_SETUP_MISMATCH_R1CS_WASM: `The folder contains more R1CS files than WASM files (or vice versa). Please, run this command from a working directory where each R1CS is paired with its corresponding file WASM.`,
-    COMMAND_SETUP_DOWNLOAD_PTAU: `Unable to download Powers of Tau file from Hermez Cryptography Phase 1 Trusted Setup. Possible causes may involve an error while making the request (be sure to have a stable internet connection). Please, we kindly ask you to terminate the current session and repeat the process.`,
+    COMMAND_SETUP_DOWNLOAD_PTAU: `Unable to download Powers of Tau file from PPoT Phase 1 Trusted Setup. Possible causes may involve an error while making the request (be sure to have a stable internet connection). Please, we kindly ask you to terminate the current session and repeat the process.`,
     COMMAND_SETUP_ABORT: `You chose to abort the setup process.`,
     COMMAND_CONTRIBUTE_NO_OPENED_CEREMONIES: `Unfortunately, there is no ceremony for which you can make a contribution at this time. Please, try again later.`,
     COMMAND_CONTRIBUTE_NO_PARTICIPANT_DATA: `Unable to retrieve your data as ceremony participant. Please, terminate the current session and try again later. If the error persists, please contact the ceremony coordinator.`,

package/src/lib/utils.ts

@@ -18,7 +18,8 @@ import {
     ParticipantContributionStep,
     permanentlyStoreCurrentContributionTimeAndHash,
     progressToNextContributionStep,
-    verifyContribution
+    verifyContribution,
+    contribHashRegex
 } from "@devtion/actions"
 import { Presets, SingleBar } from "cli-progress"
 import dotenv from "dotenv"
@@ -159,7 +160,7 @@ export const getUserHandleFromProviderUserId = (providerUserId: string): string
         return providerUserId
     }
 
-    return providerUserId.split("-")[0]
+    return providerUserId.substring(0, providerUserId.lastIndexOf("-"))
 }
 
 /**
@@ -311,8 +312,9 @@ export const generateCustomUrlToTweetAboutParticipation = (
     ceremonyName: string,
     gistUrl: string,
     isFinalizing: boolean
-) =>
-    isFinalizing
+) => {
+    ceremonyName = ceremonyName.replace(/ /g, "%20")
+    return isFinalizing
         ? `https://twitter.com/intent/tweet?text=I%20have%20finalized%20the%20${ceremonyName}${
               ceremonyName.toLowerCase().includes("trusted") ||
               ceremonyName.toLowerCase().includes("setup") ||
@@ -329,6 +331,7 @@ export const generateCustomUrlToTweetAboutParticipation = (
                   ? "!"
                   : "%20Phase%202%20Trusted%20Setup%20ceremony!"
           }%20You%20can%20view%20the%20steps%20to%20contribute%20here:%20https://ceremony.pse.dev%20You%20can%20view%20my%20attestation%20here:%20${gistUrl}%20#Ethereum%20#ZKP`
+}
 
 /**
  * Return a custom progress bar.
@@ -664,7 +667,7 @@ export const handleStartOrResumeContribution = async (
 
         // Read local transcript file info to get the contribution hash.
         const transcriptContents = readFile(transcriptLocalFilePath)
-        const matchContributionHash = transcriptContents.match(/Contribution.+Hash.+\n\t\t.+\n\t\t.+\n.+\n\t\t.+\n/)
+        const matchContributionHash = transcriptContents.match(contribHashRegex)
 
         if (!matchContributionHash)
             showError(COMMAND_ERRORS.COMMAND_CONTRIBUTE_FINALIZE_NO_TRANSCRIPT_CONTRIBUTION_HASH_MATCH, true)