@devtion/devcli 1.0.5-alpha.0

package/src/commands/validate.ts

@@ -0,0 +1,29 @@
+import { parseCeremonyFile } from "@p0tion/actions"
+import { showError } from "../lib/errors.js"
+
+/**
+ * Validate ceremony setup command.
+ */
+const validate = async (cmd: { template: string, constraints?: number }) => {
+    try {
+        // parse the file and cleanup after
+        const parsedFile = await parseCeremonyFile(cmd.template, true)
+        // check whether we have a constraints option otherwise default to 1M
+        const constraints = cmd.constraints || 1000000
+        for await (const circuit of parsedFile.circuits) {
+            if (circuit.metadata.constraints > constraints) {
+                console.log(false)
+                process.exit(0)
+            }
+        }
+
+        console.log(true)
+
+    } catch (err: any) {
+        showError(`${err.toString()}`, false)
+        // we want to exit with a non-zero exit code
+        process.exit(1)
+    }
+}
+
+export default validate

package/src/index.ts

@@ -0,0 +1,66 @@
+#!/usr/bin/env node
+
+import { createCommand } from "commander"
+import { readFileSync } from "fs"
+import { dirname } from "path"
+import { fileURLToPath } from "url"
+import { setup, auth, contribute, observe, finalize, clean, logout, validate, listCeremonies } from "./commands/index.js"
+
+// Get pkg info (e.g., name, version).
+const packagePath = `${dirname(fileURLToPath(import.meta.url))}/..`
+const { description, version, name } = JSON.parse(readFileSync(`${packagePath}/package.json`, "utf8"))
+const program = createCommand()
+
+// Entry point.
+program.name(name).description(description).version(version)
+
+// User commands.
+program.command("auth").description("authenticate yourself using your Github account (OAuth 2.0)").action(auth)
+program
+    .command("contribute")
+    .description("compute contributions for a Phase2 Trusted Setup ceremony circuits")
+    .option("-c, --ceremony <string>", "the prefix of the ceremony you want to contribute for", "")
+    .option("-e, --entropy <string>", "the entropy (aka toxic waste) of your contribution", "")
+    .action(contribute)
+program
+    .command("clean")
+    .description("clean up output generated by commands from the current working directory")
+    .action(clean)
+program
+    .command("list")
+    .description("List all ceremonies prefixes")
+    .action(listCeremonies)
+program
+    .command("logout")
+    .description("sign out from Firebae Auth service and delete Github OAuth 2.0 token from local storage")
+    .action(logout)
+program
+    .command("validate")
+    .description("Validate that a Ceremony Setup file is correct")
+    .requiredOption("-t, --template <path>", "The path to the ceremony setup template", "")
+    .option("-c, --constraints <number>", "The number of constraints to check against")
+    .action(validate)
+
+// Only coordinator commands.
+const ceremony = program.command("coordinate").description("commands for coordinating a ceremony")
+
+ceremony
+    .command("setup")
+    .description("setup a Groth16 Phase 2 Trusted Setup ceremony for zk-SNARK circuits")
+    .option('-t, --template <path>', 'The path to the ceremony setup template', '')
+    .option('-a, --auth <string>', 'The Github OAuth 2.0 token', '')
+    .action(setup)
+    
+ceremony
+    .command("observe")
+    .description("observe in real-time the waiting queue of each ceremony circuit")
+    .action(observe)
+
+ceremony
+    .command("finalize")
+    .description(
+        "finalize a Phase2 Trusted Setup ceremony by applying a beacon, exporting verification key and verifier contract"
+    )
+    .action(finalize)
+
+program.parseAsync(process.argv)

package/src/lib/errors.ts

@@ -0,0 +1,77 @@
+import theme from "./theme.js"
+
+/** Services */
+export const CORE_SERVICES_ERRORS = {
+    FIREBASE_DEFAULT_APP_DOUBLE_CONFIG: `Wrong double default configuration for Firebase application`,
+    FIREBASE_TOKEN_EXPIRED_REMOVED_PERMISSIONS: `The Github authorization has failed due to lack of association between your account and the CLI`,
+    FIREBASE_USER_DISABLED: `The Github account has been suspended by the ceremony coordinator(s), blocking the possibility of contribution. Please, contact them to understand the motivation behind it.`,
+    FIREBASE_FAILED_CREDENTIALS_VERIFICATION: `Firebase cannot verify your Github credentials due to network errors. Please, try once again later.`,
+    FIREBASE_NETWORK_ERROR: `Unable to reach Firebase due to network erros. Please, try once again later and make sure your Internet connection is stable.`,
+    FIREBASE_CEREMONY_NOT_OPENED: `There are no ceremonies opened to contributions`,
+    FIREBASE_CEREMONY_NOT_CLOSED: `There are no ceremonies ready to finalization`,
+    AWS_CEREMONY_BUCKET_CREATION: `Unable to create a new bucket for the ceremony. Something went wrong during the creation. Please, repeat the process by providing a new ceremony name of the ceremony.`,
+    AWS_CEREMONY_BUCKET_CANNOT_DOWNLOAD_GET_PRESIGNED_URL: `Unable to download the file from the ceremony bucket. This problem could be related to failure when generating the pre-signed url. Please, we kindly ask you to terminate the current session and repeat the process.`
+}
+
+/** Github */
+export const THIRD_PARTY_SERVICES_ERRORS = {
+    GITHUB_ACCOUNT_ASSOCIATION_REJECTED: `You have decided not to associate the CLI application with your Github account. This declination will not allow you to make a contribution to any ceremony. In case you made a mistake, you can always repeat the process and accept the association of your Github account with the CLI.`,
+    GITHUB_SERVER_TIMEDOUT: `Github's servers are experiencing downtime. Please, try once again later and make sure your Internet connection is stable.`,
+    GITHUB_GET_GITHUB_ACCOUNT_INFO: `Something went wrong while retrieving your Github account public information (handle and identifier). Please, try once again later`,
+    GITHUB_NOT_AUTHENTICATED: `You are unable to execute the command since you have not authorized this device with your Github account.\n${
+        theme.symbols.info
+    } Please, run the ${theme.text.bold(
+        "phase2cli auth"
+    )} command and make sure that your account meets the authentication criteria.`,
+    GITHUB_GIST_PUBLICATION_FAILED: `Unable to publish the public attestation as gist making the request using your authenticated Github account. Please, verify that you have allowed the 'gist' access permission during the authentication step.`
+}
+
+/** Command */
+export const COMMAND_ERRORS = {
+    COMMAND_NOT_COORDINATOR: `Unable to execute the command. In order to perform coordinator functionality you must authenticate with an account having adeguate permissions.`,
+    COMMAND_ABORT_PROMPT: `The data submission process was suddenly interrupted. Your previous data has not been saved. We are sorry, you will have to repeat the process again from the beginning.`,
+    COMMAND_ABORT_SELECTION: `The data selection process was suddenly interrupted. Your previous data has not been saved. We are sorry, you will have to repeat the process again from the beginning.`,
+    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_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.`,
+    COMMAND_CONTRIBUTE_WRONG_OPTION_CEREMONY: `The ceremony name you provided does not exist or belongs to a ceremony not yet open. Please, double-check your option and retry.`,
+    COMMAND_CONTRIBUTE_NO_CURRENT_CONTRIBUTOR_DATA: `Unable to retrieve current circuit contributor information. Please, terminate the current session and try again later. If the error persists, please contact the ceremony coordinator.`,
+    COMMAND_CONTRIBUTE_NO_CURRENT_CONTRIBUTOR_CONTRIBUTION: `Unable to retrieve circuit last contribution information. This could happen due to a timeout or some errors while writing the information on the database.`,
+    COMMAND_CONTRIBUTE_WRONG_CURRENT_CONTRIBUTOR_CONTRIBUTION_STEP: `Something went wrong when progressing the contribution step of the current circuit contributor. If the error persists, please contact the ceremony coordinator.`,
+    COMMAND_CONTRIBUTE_NO_CIRCUIT_DATA: `Unable to retrieve circuit data from the ceremony. Please, terminate the current session and try again later. If the error persists, please contact the ceremony coordinator.`,
+    COMMAND_CONTRIBUTE_NO_ACTIVE_TIMEOUT_DATA: `Unable to retrieve your active timeout data. This problem could be related to failure to write timeout data to the database. If the error persists, please contact the ceremony coordinator.`,
+    COMMAND_CONTRIBUTE_NO_UNIQUE_ACTIVE_TIMEOUTS: `The number of active timeouts is different from one. This problem could be related to failure to update timeout document in the database. If the error persists, please contact the ceremony coordinator.`,
+    COMMAND_CONTRIBUTE_FINALIZE_NO_TRANSCRIPT_CONTRIBUTION_HASH_MATCH: `Unable to retrieve contribution hash from transcript. Possible causes may involve an error while using the logger or unexpected file descriptor termination. Please, terminate the current session and repeat the process.`,
+    COMMAND_FINALIZED_NO_CLOSED_CEREMONIES: `Unfortunately, there is no ceremony closed and ready for finalization. Please, try again later.`,
+    COMMAND_FINALIZED_NOT_READY_FOR_FINALIZATION: `You are not ready for ceremony finalization. This could happen because the ceremony does not appear closed or you do not have completed every circuit contributions. If the error persists, please contact the operator to check the server logs.`
+}
+
+/** Config */
+export const CONFIG_ERRORS = {
+    CONFIG_GITHUB_ERROR: `Configuration error. The Github client id environment variable has not been configured correctly.`,
+    CONFIG_FIREBASE_ERROR: `Configuration error. The Firebase environment variable has not been configured correctly`,
+    CONFIG_OTHER_ERROR: `Configuration error. One or more config environment variable has not been configured correctly`
+}
+
+/** Generic */
+export const GENERIC_ERRORS = {
+    GENERIC_ERROR_RETRIEVING_DATA: `Something went wrong when retrieving the data from the database`,
+    GENERIC_COUNTDOWN_EXPIRATION: `Your time to carry out the action has expired`
+}
+
+/**
+ * Print an error string and gracefully terminate the process.
+ * @param err <string> - the error string to be shown.
+ * @param doExit <boolean> - when true the function terminate the process; otherwise not.
+ */
+export const showError = (err: string, doExit: boolean) => {
+    // Print the error.
+    console.error(`${theme.symbols.error} ${err}`)
+
+    // Terminate the process.
+    if (doExit) process.exit(1)
+}

package/src/lib/files.ts

@@ -0,0 +1,102 @@
+import fs, { Dirent, Stats } from "fs"
+import path from "path"
+import { fileURLToPath } from "url"
+
+/**
+ * Check a directory path.
+ * @param directoryPath <string> - the local path of the directory.
+ * @returns <boolean> true if the directory at given path exists, otherwise false.
+ */
+export const directoryExists = (directoryPath: string): boolean => fs.existsSync(directoryPath)
+
+/**
+ * Write a new file locally.
+ * @param localFilePath <string> - the local path of the file.
+ * @param data <Buffer> - the content to be written inside the file.
+ */
+export const writeFile = (localFilePath: string, data: Buffer): void => fs.writeFileSync(localFilePath, data)
+
+/**
+ * Read a new file from local folder.
+ * @param localFilePath <string> - the local path of the file.
+ */
+export const readFile = (localFilePath: string): string => fs.readFileSync(localFilePath, "utf-8")
+
+/**
+ * Get back the statistics of the provided file.
+ * @param localFilePath <string> - the local path of the file.
+ * @returns <Stats> - the metadata of the file.
+ */
+export const getFileStats = (localFilePath: string): Stats => fs.statSync(localFilePath)
+
+/**
+ * Return the sub-paths for each file stored in the given directory.
+ * @param directoryLocalPath <string> - the local path of the directory.
+ * @returns <Promise<Array<Dirent>>> - the list of sub-paths of the files contained inside the directory.
+ */
+export const getDirFilesSubPaths = async (directoryLocalPath: string): Promise<Array<Dirent>> => {
+    // Get Dirent sub paths for folders and files.
+    const subPaths = await fs.promises.readdir(directoryLocalPath, { withFileTypes: true })
+
+    // Return Dirent sub paths for files only.
+    return subPaths.filter((dirent: Dirent) => dirent.isFile())
+}
+
+/**
+ * Filter all files in a directory by returning only those that match the given extension.
+ * @param directoryLocalPath <string> - the local path of the directory.
+ * @param fileExtension <string> - the file extension.
+ * @returns <Promise<Array<Dirent>>> - return the filenames of the file that match the given extension, if any
+ */
+export const filterDirectoryFilesByExtension = async (
+    directoryLocalPath: string,
+    fileExtension: string
+): Promise<Array<Dirent>> => {
+    // Get the sub paths for each file stored in the given directory.
+    const cwdFiles = await getDirFilesSubPaths(directoryLocalPath)
+    // Filter by extension.
+    return cwdFiles.filter((file: Dirent) => file.name.includes(fileExtension))
+}
+
+/**
+ * Delete a directory specified at a given path.
+ * @param directoryLocalPath <string> - the local path of the directory.
+ */
+export const deleteDir = (directoryLocalPath: string): void => {
+    fs.rmSync(directoryLocalPath, { recursive: true, force: true })
+}
+
+/**
+ * Clean a directory specified at a given path.
+ * @param directoryLocalPath <string> - the local path of the directory.
+ */
+export const cleanDir = (directoryLocalPath: string): void => {
+    deleteDir(directoryLocalPath)
+    fs.mkdirSync(directoryLocalPath)
+}
+
+/**
+ * Create a new directory in a specified path if not exist in that path.
+ * @param directoryLocalPath <string> - the local path of the directory.
+ */
+export const checkAndMakeNewDirectoryIfNonexistent = (directoryLocalPath: string): void => {
+    if (!directoryExists(directoryLocalPath)) fs.mkdirSync(directoryLocalPath)
+}
+
+/**
+ * Write data a local JSON file at a given path.
+ * @param localFilePath <string> - the local path of the file.
+ * @param data <JSON> - the JSON content to be written inside the file.
+ */
+export const writeLocalJsonFile = (filePath: string, data: JSON) => {
+    fs.writeFileSync(filePath, JSON.stringify(data), "utf-8")
+}
+
+/**
+ * Return the local current project directory name.
+ * @returns <string> - the local project (e.g., dist/) directory name.
+ */
+export const getLocalDirname = (): string => {
+    const filename = fileURLToPath(import.meta.url)
+    return path.dirname(filename)
+}

package/src/lib/localConfigs.ts

@@ -0,0 +1,186 @@
+import { commonTerms } from "@p0tion/actions"
+import Conf from "conf"
+import { dirname } from "path"
+import { readFileSync } from "fs"
+import { fileURLToPath } from "url"
+
+// Get npm package name.
+const packagePath = `${dirname(fileURLToPath(import.meta.url))}/..`
+const { name } = JSON.parse(
+    readFileSync(
+        packagePath.includes(`src/lib/`) ? `${packagePath}/../package.json` : `${packagePath}/package.json`,
+        "utf8"
+    )
+)
+
+/**
+ * Local Storage.
+ * @dev The CLI implementation use the Conf package to create a local storage
+ * in the user device (`.config/@p0tion/phase2cli-nodejs/config.json` path) to store the access token.
+ */
+const config = new Conf({
+    projectName: name,
+    schema: {
+        accessToken: {
+            type: "string",
+            default: ""
+        }
+    }
+})
+
+/**
+ * Local Paths.
+ * @dev definition of the paths to the local folders containing the CLI-generated artifacts.
+ */
+const outputLocalFolderPath = `./${commonTerms.foldersAndPathsTerms.output}`
+const setupLocalFolderPath = `${outputLocalFolderPath}/${commonTerms.foldersAndPathsTerms.setup}`
+const contributeLocalFolderPath = `${outputLocalFolderPath}/${commonTerms.foldersAndPathsTerms.contribute}`
+const finalizeLocalFolderPath = `${outputLocalFolderPath}/${commonTerms.foldersAndPathsTerms.finalize}`
+const potLocalFolderPath = `${setupLocalFolderPath}/${commonTerms.foldersAndPathsTerms.pot}`
+const zkeysLocalFolderPath = `${setupLocalFolderPath}/${commonTerms.foldersAndPathsTerms.zkeys}`
+const wasmLocalFolderPath = `${setupLocalFolderPath}/${commonTerms.foldersAndPathsTerms.wasm}`
+const contributionsLocalFolderPath = `${contributeLocalFolderPath}/${commonTerms.foldersAndPathsTerms.zkeys}`
+const contributionTranscriptsLocalFolderPath = `${contributeLocalFolderPath}/${commonTerms.foldersAndPathsTerms.transcripts}`
+const attestationLocalFolderPath = `${contributeLocalFolderPath}/${commonTerms.foldersAndPathsTerms.attestation}`
+const finalZkeysLocalFolderPath = `${finalizeLocalFolderPath}/${commonTerms.foldersAndPathsTerms.zkeys}`
+const finalPotLocalFolderPath = `${finalizeLocalFolderPath}/${commonTerms.foldersAndPathsTerms.pot}`
+const finalTranscriptsLocalFolderPath = `${finalizeLocalFolderPath}/${commonTerms.foldersAndPathsTerms.transcripts}`
+const finalAttestationsLocalFolderPath = `${finalizeLocalFolderPath}/${commonTerms.foldersAndPathsTerms.attestation}`
+const verificationKeysLocalFolderPath = `${finalizeLocalFolderPath}/${commonTerms.foldersAndPathsTerms.vkeys}`
+const verifierContractsLocalFolderPath = `${finalizeLocalFolderPath}/${commonTerms.foldersAndPathsTerms.verifiers}`
+
+export const localPaths = {
+    output: outputLocalFolderPath,
+    setup: setupLocalFolderPath,
+    contribute: contributeLocalFolderPath,
+    finalize: finalizeLocalFolderPath,
+    pot: potLocalFolderPath,
+    zkeys: zkeysLocalFolderPath,
+    wasm: wasmLocalFolderPath,
+    contributions: contributionsLocalFolderPath,
+    transcripts: contributionTranscriptsLocalFolderPath,
+    attestations: attestationLocalFolderPath,
+    finalZkeys: finalZkeysLocalFolderPath,
+    finalPot: finalPotLocalFolderPath,
+    finalTranscripts: finalTranscriptsLocalFolderPath,
+    finalAttestations: finalAttestationsLocalFolderPath,
+    verificationKeys: verificationKeysLocalFolderPath,
+    verifierContracts: verifierContractsLocalFolderPath
+}
+
+/**
+ * Return the access token, if present.
+ * @returns <string | undefined> - the access token if present, otherwise undefined.
+ */
+export const getLocalAccessToken = (): string | unknown => config.get("accessToken")
+
+/**
+ * Check if the access token exists in the local storage.
+ * @returns <boolean>
+ */
+export const checkLocalAccessToken = (): boolean => config.has("accessToken") && !!config.get("accessToken")
+
+/**
+ * Set the access token.
+ * @param token <string> - the access token to be stored.
+ */
+export const setLocalAccessToken = (token: string) => config.set("accessToken", token)
+
+/**
+ * Delete the stored access token.
+ */
+export const deleteLocalAccessToken = () => config.delete("accessToken")
+
+/**
+ * Get the complete local file path.
+ * @param cwd <string> - the current working directory path.
+ * @param completeFilename <string> - the complete filename of the file (name.ext).
+ * @returns <string> - the complete local path to the file.
+ */
+export const getCWDFilePath = (cwd: string, completeFilename: string): string => `${cwd}/${completeFilename}`
+
+/**
+ * Get the complete PoT file path.
+ * @param completeFilename <string> - the complete filename of the file (name.ext).
+ * @returns <string> - the complete PoT path to the file.
+ */
+export const getPotLocalFilePath = (completeFilename: string): string => `${potLocalFolderPath}/${completeFilename}`
+
+/**
+ * Get the complete zKey file path.
+ * @param completeFilename <string> - the complete filename of the file (name.ext).
+ * @returns <string> - the complete zKey path to the file.
+ */
+export const getZkeyLocalFilePath = (completeFilename: string): string => `${zkeysLocalFolderPath}/${completeFilename}`
+
+/**
+ * Get the complete contribution file path.
+ * @param completeFilename <string> - the complete filename of the file (name.ext).
+ * @returns <string> - the complete contribution path to the file.
+ */
+export const getContributionLocalFilePath = (completeFilename: string): string =>
+    `${contributionsLocalFolderPath}/${completeFilename}`
+
+/**
+ * Get the contribution attestation file path.
+ * @param completeFilename <string> - the complete filename of the file (name.ext).
+ * @returns <string> - the the contribution attestation path to the file.
+ */
+export const getAttestationLocalFilePath = (completeFilename: string): string =>
+    `${attestationLocalFolderPath}/${completeFilename}`
+
+/**
+ * Get the transcript file path.
+ * @param completeFilename <string> - the complete filename of the file (name.ext).
+ * @returns <string> - the the transcript path to the file.
+ */
+export const getTranscriptLocalFilePath = (completeFilename: string): string =>
+    `${contributionTranscriptsLocalFolderPath}/${completeFilename}`
+
+/**
+ * Get the complete final zKey file path.
+ * @param completeFilename <string> - the complete filename of the file (name.ext).
+ * @returns <string> - the complete final zKey path to the file.
+ */
+export const getFinalZkeyLocalFilePath = (completeFilename: string): string =>
+    `${finalZkeysLocalFolderPath}/${completeFilename}`
+
+/**
+ * Get the complete final PoT file path.
+ * @param completeFilename <string> - the complete filename of the file (name.ext).
+ * @returns <string> - the complete final PoT path to the file.
+ */
+export const getFinalPotLocalFilePath = (completeFilename: string): string =>
+    `${finalPotLocalFolderPath}/${completeFilename}`
+
+/**
+ * Get the complete verification key file path.
+ * @param completeFilename <string> - the complete filename of the file (name.ext).
+ * @returns <string> - the complete final verification key path to the file.
+ */
+export const getVerificationKeyLocalFilePath = (completeFilename: string): string =>
+    `${verificationKeysLocalFolderPath}/${completeFilename}`
+
+/**
+ * Get the complete verifier contract file path.
+ * @param completeFilename <string> - the complete filename of the file (name.ext).
+ * @returns <string> - the complete final verifier contract path to the file.
+ */
+export const getVerifierContractLocalFilePath = (completeFilename: string): string =>
+    `${verifierContractsLocalFolderPath}/${completeFilename}`
+
+/**
+ * Get the complete final attestation file path.
+ * @param completeFilename <string> - the complete filename of the file (name.ext).
+ * @returns <string> - the complete final final attestation path to the file.
+ */
+export const getFinalAttestationLocalFilePath = (completeFilename: string): string =>
+    `${finalAttestationsLocalFolderPath}/${completeFilename}`
+
+/**
+ * Get the final transcript file path.
+ * @param completeFilename <string> - the complete filename of the file (name.ext).
+ * @returns <string> - the the final transcript path to the file.
+ */
+export const getFinalTranscriptLocalFilePath = (completeFilename: string): string =>
+    `${finalTranscriptsLocalFolderPath}/${completeFilename}`