@devtion/devcli 0.0.0-7e983e3 → 0.0.0-92056fa

package/README.md

@@ -61,6 +61,8 @@ or run specific commands with `npx`:
 npx @p0tion/phase2cli contribute
 ```
 
+> Please note that phase2cli only runs on Linux or Mac systems. If a Windows user, please install [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install) first.
+
 ## 📜 Usage
 
 ### Local Development

package/dist/index.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 
 /**
- * @module @p0tion/phase2cli
- * @version 1.0.5
+ * @module @devtion/devcli
+ * @version 1.0.6
  * @file All-in-one interactive command-line for interfacing with zkSNARK Phase 2 Trusted Setup ceremonies
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -17,8 +17,7 @@ import boxen from 'boxen';
 import { pipeline } from 'node:stream';
 import { promisify } from 'node:util';
 import fetch$1 from 'node-fetch';
-import { S3Client, GetObjectCommand } from '@aws-sdk/client-s3';
-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 } from '@p0tion/actions';
+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 } from '@devtion/actions';
 import fetch from '@adobe/node-fetch-retry';
 import { request } from '@octokit/request';
 import { SingleBar, Presets } from 'cli-progress';
@@ -34,7 +33,6 @@ import Conf from 'conf';
 import prompts from 'prompts';
 import clear from 'clear';
 import figlet from 'figlet';
-import { Readable } from 'stream';
 import { createOAuthDeviceAuth } from '@octokit/auth-oauth-device';
 import clipboard from 'clipboardy';
 import open from 'open';
@@ -1853,8 +1851,6 @@ const setup = async (cmd) => {
         // create a new bucket
         const bucketName = await handleCeremonyBucketCreation(firebaseFunctions, ceremonySetupData.ceremonyPrefix);
         console.log(`\n${theme.symbols.success} Ceremony bucket name: ${theme.text.bold(bucketName)}`);
-        // create S3 clienbt
-        const s3 = new S3Client({ region: 'us-east-1' });
         // loop through each circuit
         for await (const circuit of setupCeremonyData.circuits) {
             // Local paths.
@@ -1864,21 +1860,12 @@ const setup = async (cmd) => {
             const potLocalPathAndFileName = getPotLocalFilePath(circuit.files.potFilename);
             const zkeyLocalPathAndFileName = getZkeyLocalFilePath(circuit.files.initialZkeyFilename);
             // 2. download the pot and wasm files
-            const streamPipeline = promisify(pipeline);
             await checkAndDownloadSmallestPowersOfTau(convertToDoubleDigits(circuit.metadata?.pot), circuit.files.potFilename);
-            // download the wasm to calculate the hash
-            const spinner = customSpinner(`Downloading the ${theme.text.bold(`#${circuit.name}`)} WASM file from the project's bucket...`, `clock`);
-            spinner.start();
-            const command = new GetObjectCommand({ Bucket: ceremonySetupData.circuitArtifacts[index].artifacts.bucket, Key: ceremonySetupData.circuitArtifacts[index].artifacts.wasmStoragePath });
-            const response = await s3.send(command);
-            if (response.$metadata.httpStatusCode !== 200) {
-                throw new Error("There was an error while trying to download the wasm file. Please check that the file has the correct permissions (public) set.");
-            }
-            if (response.Body instanceof Readable)
-                await streamPipeline(response.Body, createWriteStream(wasmLocalPathAndFileName));
-            spinner.stop();
             // 3. generate the zKey
+            const spinner = customSpinner(`Generating genesis zKey for circuit ${theme.text.bold(circuit.name)}...`, `clock`);
+            spinner.start();
             await zKey.newZKey(r1csLocalPathAndFileName, getPotLocalFilePath(circuit.files.potFilename), zkeyLocalPathAndFileName, undefined);
+            spinner.succeed(`Generation of the genesis zKey for citcui ${theme.text.bold(circuit.name)} completed successfully`);
             // 4. calculate the hashes
             const wasmBlake2bHash = await blake512FromPath(wasmLocalPathAndFileName);
             const potBlake2bHash = await blake512FromPath(getPotLocalFilePath(circuit.files.potFilename));
@@ -2113,8 +2100,9 @@ const onVerification = async (verification) => {
     clipboard.writeSync(verification.user_code);
     clipboard.readSync();
     // Display data.
-    console.log(`${theme.symbols.warning} Visit ${theme.text.bold(theme.text.underlined(verification.verification_uri))} on this device to generate a new token and authenticate`);
-    console.log(`${theme.symbols.info} Your auth code: ${theme.text.bold(verification.user_code)} (${theme.emojis.clipboard} ${theme.symbols.success})\n`);
+    console.log(`${theme.symbols.warning} Visit ${theme.text.bold(theme.text.underlined(verification.verification_uri))} on this device to generate a new token and authenticate\n`);
+    console.log(theme.colors.magenta(figlet.textSync("Code is Below", { font: "ANSI Shadow" })), '\n');
+    console.log(`${theme.symbols.info} Your auth code: ${theme.text.bold(verification.user_code)} has been copied to your clipboard (${theme.emojis.clipboard} ${theme.symbols.success})\n`);
     const spinner = customSpinner(`Redirecting to Github...`, `clock`);
     spinner.start();
     await sleep(10000); // ~10s to make users able to read the CLI.
@@ -2407,7 +2395,6 @@ const listenToCeremonyCircuitDocumentChanges = (firestoreDatabase, ceremonyId, p
         const { avgTimings, waitingQueue } = changedCircuit.data();
         const { fullContribution, verifyCloudFunction } = avgTimings;
         const { currentContributor } = waitingQueue;
-        // Get circuit current contributor participant document.
         const circuitCurrentContributor = await getDocumentById(firestoreDatabase, getParticipantsCollectionPath(ceremonyId), currentContributor);
         // Check data.
         if (!circuitCurrentContributor.data())
@@ -2616,7 +2603,7 @@ const listenToParticipantDocumentChanges = async (firestoreDatabase, cloudFuncti
                     // Get latest contribution verification result.
                     await getLatestVerificationResult(firestoreDatabase, ceremony.id, circuit.id, participant.id);
                 // Get next circuit for contribution.
-                const nextCircuit = getCircuitBySequencePosition(circuits, changedContributionProgress + 1);
+                const nextCircuit = timeoutExpired ? getCircuitBySequencePosition(circuits, changedContributionProgress) : getCircuitBySequencePosition(circuits, changedContributionProgress + 1);
                 // Check disk space requirements for participant.
                 const wannaGenerateAttestation = await handleDiskSpaceRequirementForNextContribution(cloudFunctions, ceremony.id, nextCircuit.data.sequencePosition, nextCircuit.data.zKeySizeInBytes, timeoutExpired, providerUserId);
                 // Check if the participant would like to generate a new attestation.

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

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { Contribution, ContributionValidity, FirebaseDocumentInfo } from "@p0tion/actions";
+import { Contribution, ContributionValidity, FirebaseDocumentInfo } from "@devtion/actions";
 import { DocumentSnapshot, DocumentData, Firestore } from "firebase/firestore";
 import { Functions } from "firebase/functions";
 /**

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

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { FirebaseDocumentInfo } from "@p0tion/actions";
+import { FirebaseDocumentInfo } from "@devtion/actions";
 import { Functions } from "firebase/functions";
 import { Firestore } from "firebase/firestore";
 /**

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

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { FirebaseDocumentInfo } from "@p0tion/actions";
+import { FirebaseDocumentInfo } from "@devtion/actions";
 import { Firestore } from "firebase/firestore";
 /**
  * Clean cursor lines from current position back to root (default: zero).

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

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 import { Functions } from "firebase/functions";
-import { CeremonyTimeoutType, CircomCompilerData, CircuitInputData, CeremonyInputData, CircuitDocument } from "@p0tion/actions";
+import { CeremonyTimeoutType, CircomCompilerData, CircuitInputData, CeremonyInputData, CircuitDocument } from "@devtion/actions";
 /**
  * Handle whatever is needed to obtain the input data for a circuit that the coordinator would like to add to the ceremony.
  * @param choosenCircuitFilename <string> - the name of the circuit to add.

package/dist/types/lib/prompts.d.ts

@@ -1,6 +1,6 @@
 import { Answers } from "prompts";
 import { Firestore } from "firebase/firestore";
-import { CeremonyInputData, FirebaseDocumentInfo, CircomCompilerData, CircuitInputData, CeremonyTimeoutType, DiskTypeForVM } from "@p0tion/actions";
+import { CeremonyInputData, FirebaseDocumentInfo, CircomCompilerData, CircuitInputData, CeremonyTimeoutType, DiskTypeForVM } from "@devtion/actions";
 /**
  * Ask a binary (yes/no or true/false) customizable question.
  * @param question <string> - the question to be answered.

package/dist/types/lib/utils.d.ts

@@ -1,4 +1,4 @@
-import { FirebaseDocumentInfo } from "@p0tion/actions";
+import { FirebaseDocumentInfo } from "@devtion/actions";
 import { OAuthCredential } from "firebase/auth";
 import { DocumentData, Firestore } from "firebase/firestore";
 import { Functions } from "firebase/functions";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@devtion/devcli",
   "type": "module",
-  "version": "0.0.0-7e983e3",
+  "version": "0.0.0-92056fa",
   "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",
@@ -64,10 +64,11 @@
   },
   "dependencies": {
     "@adobe/node-fetch-retry": "^2.2.0",
+    "@aws-sdk/client-s3": "^3.329.0",
+    "@devtion/actions": "latest",
     "@octokit/auth-oauth-app": "^5.0.5",
     "@octokit/auth-oauth-device": "^4.0.4",
     "@octokit/request": "^6.2.3",
-    "@p0tion/actions": "^1.0.5",
     "blakejs": "^1.2.1",
     "boxen": "^7.1.0",
     "chalk": "^5.2.0",
@@ -96,5 +97,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "afae72061a3b366b05508de53fe91e9b254cc3d5"
+  "gitHead": "9ecb8d55d49edf248244fdd83e06deb20036c340"
 }

package/src/commands/auth.ts

@@ -4,6 +4,7 @@ import { Verification } from "@octokit/auth-oauth-device/dist-types/types.js"
 import clipboard from "clipboardy"
 import dotenv from "dotenv"
 import open from "open"
+import figlet from "figlet"
 import { fileURLToPath } from "url"
 import { dirname } from "path"
 import { GENERIC_ERRORS, showError } from "../lib/errors.js"
@@ -69,10 +70,13 @@ export const onVerification = async (verification: Verification): Promise<void>
     console.log(
         `${theme.symbols.warning} Visit ${theme.text.bold(
             theme.text.underlined(verification.verification_uri)
-        )} on this device to generate a new token and authenticate`
+        )} on this device to generate a new token and authenticate\n`
     )
+
+    console.log(theme.colors.magenta(figlet.textSync("Code is Below", { font: "ANSI Shadow" })), '\n')
+        
     console.log(
-        `${theme.symbols.info} Your auth code: ${theme.text.bold(verification.user_code)} (${theme.emojis.clipboard} ${
+        `${theme.symbols.info} Your auth code: ${theme.text.bold(verification.user_code)} has been copied to your clipboard (${theme.emojis.clipboard} ${
             theme.symbols.success
         })\n`
     )

package/src/commands/contribute.ts

@@ -22,7 +22,7 @@ import {
     generateValidContributionsAttestation,
     commonTerms,
     convertToDoubleDigits
-} from "@p0tion/actions"
+} from "@devtion/actions"
 import { DocumentSnapshot, DocumentData, Firestore, onSnapshot, Timestamp } from "firebase/firestore"
 import { Functions } from "firebase/functions"
 import open from "open"
@@ -464,7 +464,6 @@ export const listenToCeremonyCircuitDocumentChanges = (
         const { fullContribution, verifyCloudFunction } = avgTimings
         const { currentContributor } = waitingQueue
 
-        // Get circuit current contributor participant document.
         const circuitCurrentContributor = await getDocumentById(
             firestoreDatabase,
             getParticipantsCollectionPath(ceremonyId),
@@ -811,7 +810,7 @@ export const listenToParticipantDocumentChanges = async (
                     await getLatestVerificationResult(firestoreDatabase, ceremony.id, circuit.id, participant.id)
 
                 // Get next circuit for contribution.
-                const nextCircuit = getCircuitBySequencePosition(circuits, changedContributionProgress + 1)
+                const nextCircuit = timeoutExpired ? getCircuitBySequencePosition(circuits, changedContributionProgress) : getCircuitBySequencePosition(circuits, changedContributionProgress + 1)
 
                 // Check disk space requirements for participant.
                 const wannaGenerateAttestation = await handleDiskSpaceRequirementForNextContribution(

package/src/commands/finalize.ts

@@ -22,7 +22,7 @@ import {
     exportVerifierContract,
     FirebaseDocumentInfo,
     exportVkey
-} from "@p0tion/actions"
+} from "@devtion/actions"
 import { Functions } from "firebase/functions"
 import { Firestore } from "firebase/firestore"
 import { dirname } from "path"

package/src/commands/listCeremonies.ts

@@ -1,4 +1,4 @@
-import { commonTerms, getAllCollectionDocs } from "@p0tion/actions"
+import { commonTerms, getAllCollectionDocs } from "@devtion/actions"
 import { showError } from "../lib/errors.js"
 import { bootstrapCommandExecutionAndServices } from "../lib/services.js"
 

package/src/commands/observe.ts

@@ -7,7 +7,7 @@ import {
     getOpenedCeremonies,
     isCoordinator,
     convertToDoubleDigits
-} from "@p0tion/actions"
+} from "@devtion/actions"
 import { Firestore } from "firebase/firestore"
 import logSymbols from "log-symbols"
 import readline from "readline"

package/src/commands/setup.ts

@@ -37,7 +37,7 @@ import {
     setupCeremony,
     parseCeremonyFile,
     CircuitContributionVerificationMechanism
-} from "@p0tion/actions"
+} from "@devtion/actions"
 import { customSpinner, simpleLoader, sleep, terminate } from "../lib/utils.js"
 import {
     promptCeremonyInputData,
@@ -516,9 +516,6 @@ const setup = async (cmd: { template?: string, auth?: string}) => {
         const bucketName = await handleCeremonyBucketCreation(firebaseFunctions, ceremonySetupData.ceremonyPrefix)
         console.log(`\n${theme.symbols.success} Ceremony bucket name: ${theme.text.bold(bucketName)}`)
 
-        // create S3 clienbt
-        const s3 = new S3Client({region: 'us-east-1'})
-
         // loop through each circuit
         for await (const circuit of setupCeremonyData.circuits) {
             // Local paths.
@@ -529,32 +526,14 @@ const setup = async (cmd: { template?: string, auth?: string}) => {
             const zkeyLocalPathAndFileName = getZkeyLocalFilePath(circuit.files.initialZkeyFilename)
 
             // 2. download the pot and wasm files
-            const streamPipeline = promisify(pipeline)
             await checkAndDownloadSmallestPowersOfTau(convertToDoubleDigits(circuit.metadata?.pot!), circuit.files.potFilename)
           
-            // download the wasm to calculate the hash
-            const spinner = customSpinner(
-                `Downloading the ${theme.text.bold(
-                    `#${circuit.name}`
-                )} WASM file from the project's bucket...`,
-                `clock`
-            )
-            spinner.start()
-            const command = new GetObjectCommand({ Bucket: ceremonySetupData.circuitArtifacts[index].artifacts.bucket, Key: ceremonySetupData.circuitArtifacts[index].artifacts.wasmStoragePath })
-
-            const response = await s3.send(command)
-
-            if (response.$metadata.httpStatusCode !== 200) {
-                throw new Error("There was an error while trying to download the wasm file. Please check that the file has the correct permissions (public) set.")
-            }
-
-            if (response.Body instanceof Readable) 
-                await streamPipeline(response.Body, createWriteStream(wasmLocalPathAndFileName))
-
-            spinner.stop()
             // 3. generate the zKey
+            const spinner = customSpinner(`Generating genesis zKey for circuit ${theme.text.bold(circuit.name)}...`, `clock`)
+            spinner.start()
             await zKey.newZKey(r1csLocalPathAndFileName, getPotLocalFilePath(circuit.files.potFilename), zkeyLocalPathAndFileName, undefined)
-            
+            spinner.succeed(`Generation of the genesis zKey for citcui ${theme.text.bold(circuit.name)} completed successfully`)
+
             // 4. calculate the hashes
             const wasmBlake2bHash = await blake512FromPath(wasmLocalPathAndFileName)
             const potBlake2bHash = await blake512FromPath(getPotLocalFilePath(circuit.files.potFilename))

package/src/commands/validate.ts

@@ -1,4 +1,4 @@
-import { parseCeremonyFile } from "@p0tion/actions"
+import { parseCeremonyFile } from "@devtion/actions"
 import { showError } from "../lib/errors.js"
 
 /**

package/src/lib/localConfigs.ts

@@ -1,4 +1,4 @@
-import { commonTerms } from "@p0tion/actions"
+import { commonTerms } from "@devtion/actions"
 import Conf from "conf"
 import { dirname } from "path"
 import { readFileSync } from "fs"

package/src/lib/prompts.ts

@@ -14,7 +14,7 @@ import {
     CircuitContributionVerificationMechanism,
     vmConfigurationTypes,
     DiskTypeForVM
-} from "@p0tion/actions"
+} from "@devtion/actions"
 import theme from "./theme.js"
 import { COMMAND_ERRORS, showError } from "./errors.js"
 

package/src/lib/services.ts

@@ -2,7 +2,7 @@ import {
     getCurrentFirebaseAuthUser,
     initializeFirebaseCoreServices,
     signInToFirebaseWithCredentials
-} from "@p0tion/actions"
+} from "@devtion/actions"
 import clear from "clear"
 import figlet from "figlet"
 import { FirebaseApp } from "firebase/app"

package/src/lib/utils.ts

@@ -19,7 +19,7 @@ import {
     permanentlyStoreCurrentContributionTimeAndHash,
     progressToNextContributionStep,
     verifyContribution
-} from "@p0tion/actions"
+} from "@devtion/actions"
 import { Presets, SingleBar } from "cli-progress"
 import dotenv from "dotenv"
 import { GithubAuthProvider, OAuthCredential } from "firebase/auth"