@devtion/devcli 1.0.5-alpha.0

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

@@ -0,0 +1,104 @@
+import { Answers } from "prompts";
+import { Firestore } from "firebase/firestore";
+import { CeremonyInputData, FirebaseDocumentInfo, CircomCompilerData, CircuitInputData, CeremonyTimeoutType, DiskTypeForVM } from "@p0tion/actions";
+/**
+ * Ask a binary (yes/no or true/false) customizable question.
+ * @param question <string> - the question to be answered.
+ * @param active <string> - the active option (default yes).
+ * @param inactive <string> - the inactive option (default no).
+ * @returns <Promise<Answers<string>>>
+ */
+export declare const askForConfirmation: (question: string, active?: string, inactive?: string) => Promise<Answers<string>>;
+/**
+ * Prompt a series of questios to gather input data for the ceremony setup.
+ * @param firestore <Firestore> - the instance of the Firestore database.
+ * @returns <Promise<CeremonyInputData>> - the necessary information for the ceremony provided by the coordinator.
+ */
+export declare const promptCeremonyInputData: (firestore: Firestore) => Promise<CeremonyInputData>;
+/**
+ * Prompt a series of questios to gather input about the Circom compiler.
+ * @returns <Promise<CircomCompilerData>> - the necessary information for the Circom compiler used for the circuits.
+ */
+export declare const promptCircomCompiler: () => Promise<CircomCompilerData>;
+/**
+ * Shows a list of circuits for a single option selection.
+ * @dev the circuit names are derived from local R1CS files.
+ * @param options <Array<string>> - an array of circuits names.
+ * @returns Promise<string> - the name of the choosen circuit.
+ */
+export declare const promptCircuitSelector: (options: Array<string>) => Promise<string>;
+/**
+ * Shows a list of standard EC2 VM instance types for a single option selection.
+ * @notice the suggested VM configuration type is calculated based on circuit constraint size.
+ * @param constraintSize <number> - the amount of circuit constraints
+ * @returns Promise<string> - the name of the choosen VM type.
+ */
+export declare const promptVMTypeSelector: (constraintSize: any) => Promise<string>;
+/**
+ * Shows a list of disk types for selected VM.
+ * @returns Promise<DiskTypeForVM> - the selected disk type.
+ */
+export declare const promptVMDiskTypeSelector: () => Promise<DiskTypeForVM>;
+/**
+ * Show a series of questions about the circuits.
+ * @param constraintSize <number> - the amount of circuit constraints.
+ * @param timeoutMechanismType <CeremonyTimeoutType> - the choosen timeout mechanism type for the ceremony.
+ * @param needPromptCircomCompiler <boolean> - a boolean value indicating if the questions related to the Circom compiler version and commit hash must be asked.
+ * @param enforceVM <boolean> - a boolean value indicating if the contribution verification could be supported by VM-only approach or not.
+ * @returns Promise<Array<Circuit>> - circuit info prompted by the coordinator.
+ */
+export declare const promptCircuitInputData: (constraintSize: number, timeoutMechanismType: CeremonyTimeoutType, sameCircomCompiler: boolean, enforceVM: boolean) => Promise<CircuitInputData>;
+/**
+ * Prompt for asking if the same circom compiler version has been used for all circuits of the ceremony.
+ * @returns <Promise<boolean>>
+ */
+export declare const promptSameCircomCompiler: () => Promise<boolean>;
+/**
+ * Prompt for asking if the coordinator wanna use a pre-computed zKey for the given circuit.
+ * @returns <Promise<boolean>>
+ */
+export declare const promptPreComputedZkey: () => Promise<boolean>;
+/**
+ * Prompt for asking if the coordinator wants to add a new circuit to the ceremony.
+ * @returns <Promise<boolean>>
+ */
+export declare const promptCircuitAddition: () => Promise<boolean>;
+/**
+ * Shows a list of pre-computed zKeys for a single option selection.
+ * @dev the names are derived from local zKeys files.
+ * @param options <Array<string>> - an array of pre-computed zKeys names.
+ * @returns Promise<string> - the name of the choosen pre-computed zKey.
+ */
+export declare const promptPreComputedZkeySelector: (options: Array<string>) => Promise<string>;
+/**
+ * Prompt asking to the coordinator to choose the desired PoT file for the zKey for the circuit.
+ * @param suggestedSmallestNeededPowers <number> - the minimal number of powers necessary for circuit zKey generation.
+ * @returns Promise<number> - the selected amount of powers.
+ */
+export declare const promptNeededPowersForCircuit: (suggestedSmallestNeededPowers: number) => Promise<number>;
+/**
+ * Shows a list of PoT files for a single option selection.
+ * @dev the names are derived from local PoT files.
+ * @param options <Array<string>> - an array of PoT file names.
+ * @returns Promise<string> - the name of the choosen PoT.
+ */
+export declare const promptPotSelector: (options: Array<string>) => Promise<string>;
+/**
+ * Prompt for asking about ceremony selection.
+ * @dev this method is used to show a list of ceremonies to be selected for both the computation of a contribution and the finalization of a ceremony.
+ * @param ceremoniesDocuments <Array<FirebaseDocumentInfo>> - the list of ceremonies Firestore documents.
+ * @param isFinalizing <boolean> - true when the coordinator must select a ceremony for finalization; otherwise false (participant selects a ceremony for contribution).
+ * @returns Promise<FirebaseDocumentInfo> - the Firestore document of the selected ceremony.
+ */
+export declare const promptForCeremonySelection: (ceremoniesDocuments: Array<FirebaseDocumentInfo>, isFinalizing: boolean) => Promise<FirebaseDocumentInfo>;
+/**
+ * Prompt the participant to type the entropy or the coordinator to type the beacon.
+ * @param isEntropy <boolean> - true when prompting for typing entropy; otherwise false.
+ * @returns <Promise<string>> - the entropy or beacon value.
+ */
+export declare const promptToTypeEntropyOrBeacon: (isEntropy?: boolean) => Promise<string>;
+/**
+ * Prompt for entropy generation or insertion.
+ * @return <Promise<string>> - the entropy.
+ */
+export declare const promptForEntropy: () => Promise<string>;

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

@@ -0,0 +1,31 @@
+import { FirebaseApp } from "firebase/app";
+import { OAuthCredential } from "firebase/auth";
+import { AuthUser } from "../types/index.js";
+/**
+ * Bootstrap services and configs is needed for a new command execution and related services.
+ * @returns <Promise<FirebaseServices>>
+ */
+export declare const bootstrapCommandExecutionAndServices: () => Promise<any>;
+/**
+ * Execute the sign in to Firebase using OAuth credentials.
+ * @dev wrapper method to handle custom errors.
+ * @param firebaseApp <FirebaseApp> - the configured instance of the Firebase App in use.
+ * @param credentials <OAuthCredential> - the OAuth credential generated from token exchange.
+ * @returns <Promise<void>>
+ */
+export declare const signInToFirebase: (firebaseApp: FirebaseApp, credentials: OAuthCredential) => Promise<void>;
+/**
+ * Ensure that the callee is an authenticated user.
+ * @notice The token will be passed as parameter.
+ * @dev This method can be used within GitHub actions or other CI/CD pipelines.
+ * @param firebaseApp <FirebaseApp> - the configured instance of the Firebase App in use.
+ * @param token <string> - the token to be used for authentication.
+ * @returns <Promise<AuthUser>> - a custom object containing info about the authenticated user, the token and github handle.
+ */
+export declare const authWithToken: (firebaseApp: FirebaseApp, token: string) => Promise<AuthUser>;
+/**
+ * Ensure that the callee is an authenticated user.
+ * @dev This method MUST be executed before each command to avoid authentication errors when interacting with the command.
+ * @returns <Promise<AuthUser>> - a custom object containing info about the authenticated user, the token and github handle.
+ */
+export declare const checkAuth: (firebaseApp: FirebaseApp) => Promise<AuthUser>;

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

@@ -0,0 +1,42 @@
+/**
+ * Custom theme object.
+ */
+declare const _default: {
+    colors: {
+        yellow: import("chalk").ChalkInstance;
+        magenta: import("chalk").ChalkInstance;
+        red: import("chalk").ChalkInstance;
+        green: import("chalk").ChalkInstance;
+    };
+    text: {
+        underlined: import("chalk").ChalkInstance;
+        bold: import("chalk").ChalkInstance;
+        italic: import("chalk").ChalkInstance;
+    };
+    symbols: {
+        success: string;
+        warning: string;
+        error: string;
+        info: string;
+    };
+    emojis: {
+        tada: string;
+        key: string;
+        broom: string;
+        pointDown: string;
+        eyes: string;
+        wave: string;
+        clipboard: string;
+        fire: string;
+        clock: string;
+        dizzy: string;
+        rocket: string;
+        oldKey: string;
+        pray: string;
+        moon: string;
+        upsideDown: string;
+        arrowUp: string;
+        arrowDown: string;
+    };
+};
+export default _default;

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

@@ -0,0 +1,158 @@
+import { FirebaseDocumentInfo } from "@p0tion/actions";
+import { OAuthCredential } from "firebase/auth";
+import { DocumentData, Firestore } from "firebase/firestore";
+import { Functions } from "firebase/functions";
+import { Ora } from "ora";
+import { Logger } from "winston";
+import { GithubGistFile, Timing } from "../types/index.js";
+/**
+ * Exchange the Github token for OAuth credential.
+ * @param githubToken <string> - the Github token generated through the Device Flow process.
+ * @returns <OAuthCredential>
+ */
+export declare const exchangeGithubTokenForCredentials: (githubToken: string) => OAuthCredential;
+/**
+ * Get the information associated to the account from which the token has been generated to
+ * create a custom unique identifier for the user.
+ * @notice the unique identifier has the following form 'handle-identifier'.
+ * @param githubToken <string> - the Github token.
+ * @returns <Promise<any>> - the Github (provider) unique identifier associated to the user.
+ */
+export declare const getGithubProviderUserId: (githubToken: string) => Promise<any>;
+/**
+ * Get the gists associated to the authenticated user account.
+ * @param githubToken <string> - the Github token.
+ * @param params <Object<number,number>> - the necessary parameters for the request.
+ * @returns <Promise<any>> - the Github gists associated with the authenticated user account.
+ */
+export declare const getGithubAuthenticatedUserGists: (githubToken: string, params: {
+    perPage: number;
+    page: number;
+}) => Promise<any>;
+/**
+ * Check whether or not the user has published the gist.
+ * @dev gather all the user's gists and check if there is a match with the expected public attestation.
+ * @param githubToken <string> - the Github token.
+ * @param publicAttestationFilename <string> - the public attestation filename.
+ * @returns <Promise<GithubGistFile | undefined>> - return the public attestation gist if and only if has been published.
+ */
+export declare const getPublicAttestationGist: (githubToken: string, publicAttestationFilename: string) => Promise<GithubGistFile | undefined>;
+/**
+ * Return the Github handle from the provider user id.
+ * @notice the provider user identifier must have the following structure 'handle-id'.
+ * @param providerUserId <string> - the unique provider user identifier.
+ * @returns <string> - the third-party provider handle of the user.
+ */
+export declare const getUserHandleFromProviderUserId: (providerUserId: string) => string;
+/**
+ * Return a custom spinner.
+ * @param text <string> - the text that should be displayed as spinner status.
+ * @param spinnerLogo <any> - the logo.
+ * @returns <Ora> - a new Ora custom spinner.
+ */
+export declare const customSpinner: (text: string, spinnerLogo: any) => Ora;
+/**
+ * Custom sleeper.
+ * @dev to be used in combination with loggers and for workarounds where listeners cannot help.
+ * @param ms <number> - sleep amount in milliseconds
+ * @returns <Promise<any>>
+ */
+export declare const sleep: (ms: number) => Promise<any>;
+/**
+ * Simple loader for task simulation.
+ * @param loadingText <string> - spinner text while loading.
+ * @param spinnerLogo <any> - spinner logo.
+ * @param durationInMs <number> - spinner loading duration in ms.
+ * @returns <Promise<void>>.
+ */
+export declare const simpleLoader: (loadingText: string, spinnerLogo: any, durationInMs: number) => Promise<void>;
+/**
+ * Check and return the free aggregated disk space (in KB) for participant machine.
+ * @dev this method use the node-disk-info method to retrieve the information about
+ * disk availability for all visible disks.
+ * nb. no other type of data or operation is performed by this methods.
+ * @returns <number> - the free aggregated disk space in kB for the participant machine.
+ */
+export declare const estimateParticipantFreeGlobalDiskSpace: () => number;
+/**
+ * Get seconds, minutes, hours and days from milliseconds.
+ * @param millis <number> - the amount of milliseconds.
+ * @returns <Timing> - a custom object containing the amount of seconds, minutes, hours and days in the provided millis.
+ */
+export declare const getSecondsMinutesHoursFromMillis: (millis: number) => Timing;
+/**
+ * Convert milliseconds to seconds.
+ * @param millis <number>
+ * @returns <number>
+ */
+export declare const convertMillisToSeconds: (millis: number) => number;
+/**
+ * Gracefully terminate the command execution
+ * @params ghUsername <string> - the Github username of the user.
+ */
+export declare const terminate: (ghUsername: string) => Promise<never>;
+/**
+ * Publish public attestation using Github Gist.
+ * @dev the contributor must have agreed to provide 'gist' access during the execution of the 'auth' command.
+ * @param accessToken <string> - the contributor access token.
+ * @param publicAttestation <string> - the public attestation.
+ * @param ceremonyTitle <string> - the ceremony title.
+ * @param ceremonyPrefix <string> - the ceremony prefix.
+ * @returns <Promise<string>> - the url where the gist has been published.
+ */
+export declare const publishGist: (token: string, content: string, ceremonyTitle: string, ceremonyPrefix: string) => Promise<string>;
+/**
+ * Generate a custom url that when clicked allows you to compose a tweet ready to be shared.
+ * @param ceremonyName <string> - the name of the ceremony.
+ * @param gistUrl <string> - the url of the gist where the public attestation has been shared.
+ * @param isFinalizing <boolean> - flag to discriminate between ceremony finalization (true) and contribution (false).
+ * @returns <string> - the ready to share tweet url.
+ */
+export declare const generateCustomUrlToTweetAboutParticipation: (ceremonyName: string, gistUrl: string, isFinalizing: boolean) => string;
+/**
+ * Download an artifact from the ceremony bucket.
+ * @dev this method request a pre-signed url to make a GET request to download the artifact.
+ * @param cloudFunctions <Functions> - the instance of the Firebase cloud functions for the application.
+ * @param bucketName <string> - the name of the ceremony artifacts bucket (AWS S3).
+ * @param storagePath <string> - the storage path that locates the artifact to be downloaded in the bucket.
+ * @param localPath <string> - the local path where the artifact will be downloaded.
+ */
+export declare const downloadCeremonyArtifact: (cloudFunctions: Functions, bucketName: string, storagePath: string, localPath: string) => Promise<void>;
+/**
+ *
+ * @param lastZkeyLocalFilePath <string> - the local path of the last contribution.
+ * @param nextZkeyLocalFilePath <string> - the local path where the next contribution is going to be stored.
+ * @param entropyOrBeacon <string> - the entropy or beacon (only when finalizing) for the contribution.
+ * @param contributorOrCoordinatorIdentifier <string> - the identifier of the contributor or coordinator (only when finalizing).
+ * @param averageComputingTime <number> - the current average contribution computation time.
+ * @param transcriptLogger <Logger> - the custom file logger to generate the contribution transcript.
+ * @param isFinalizing <boolean> - flag to discriminate between ceremony finalization (true) and contribution (false).
+ * @returns <Promise<number>> - the amount of time spent contributing.
+ */
+export declare const handleContributionComputation: (lastZkeyLocalFilePath: string, nextZkeyLocalFilePath: string, entropyOrBeacon: string, contributorOrCoordinatorIdentifier: string, averageComputingTime: number, transcriptLogger: Logger, isFinalizing: boolean) => Promise<number>;
+/**
+ * Return the most up-to-date data about the participant document for the given ceremony.
+ * @param firestoreDatabase <Firestore> - the Firestore service instance associated to the current Firebase application.
+ * @param ceremonyId <string> - the unique identifier of the ceremony.
+ * @param participantId <string> - the unique identifier of the participant.
+ * @returns <Promise<DocumentData>> - the most up-to-date participant data.
+ */
+export declare const getLatestUpdatesFromParticipant: (firestoreDatabase: Firestore, ceremonyId: string, participantId: string) => Promise<DocumentData>;
+/**
+ * Start or resume a contribution from the last participant contribution step.
+ * @notice this method goes through each contribution stage following this order:
+ * 1) Downloads the last contribution from previous contributor.
+ * 2) Computes the new contribution.
+ * 3) Uploads the new contribution.
+ * 4) Requests the verification of the new contribution to the coordinator's backend and waits for the result.
+ * @param cloudFunctions <Functions> - the instance of the Firebase cloud functions for the application.
+ * @param firestoreDatabase <Firestore> - the Firestore service instance associated to the current Firebase application.
+ * @param ceremony <FirebaseDocumentInfo> - the Firestore document of the ceremony.
+ * @param circuit <FirebaseDocumentInfo> - the Firestore document of the ceremony circuit.
+ * @param participant <FirebaseDocumentInfo> - the Firestore document of the participant (contributor or coordinator).
+ * @param participantContributionStep <ParticipantContributionStep> - the contribution step of the participant (from where to start/resume contribution).
+ * @param entropyOrBeaconHash <string> - the entropy or beacon hash (only when finalizing) for the contribution.
+ * @param contributorOrCoordinatorIdentifier <string> - the identifier of the contributor or coordinator (only when finalizing).
+ * @param isFinalizing <boolean> - flag to discriminate between ceremony finalization (true) and contribution (false).
+ */
+export declare const handleStartOrResumeContribution: (cloudFunctions: Functions, firestoreDatabase: Firestore, ceremony: FirebaseDocumentInfo, circuit: FirebaseDocumentInfo, participant: FirebaseDocumentInfo, entropyOrBeaconHash: any, contributorOrCoordinatorIdentifier: string, isFinalizing: boolean) => Promise<void>;

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

@@ -0,0 +1,65 @@
+import { User as FirebaseAuthUser } from "firebase/auth";
+/**
+ * Different custom progress bar types.
+ * @enum {string}
+ */
+export declare enum ProgressBarType {
+    DOWNLOAD = "DOWNLOAD",
+    UPLOAD = "UPLOAD"
+}
+/**
+ * Define the current authenticated user in the Firebase app.
+ * @typedef {Object} AuthUser
+ * @property {FirebaseAuthUser} user - the instance of the Firebase authenticated user.
+ * @property {string} token - the access token.
+ * @property {string} providerUserId - the unique identifier of the user tied to its account from a third party provider (e.g., Github).
+ */
+export type AuthUser = {
+    user: FirebaseAuthUser;
+    token: string;
+    providerUserId: string;
+};
+/**
+ * Define a custom object for time management tasks.
+ * @typedef {Object} Timing
+ * @property {number} seconds
+ * @property {number} minutes
+ * @property {number} hours
+ * @property {number} days
+ */
+export type Timing = {
+    seconds: number;
+    minutes: number;
+    hours: number;
+    days: number;
+};
+/**
+ * Define a custom object containing contribution verification data.
+ * @typedef {Object} VerifyContributionComputation
+ * @property {boolean} valid - true if the contribution is valid; otherwise false.
+ * @property {number} verificationComputationTime - the time spent for completing the verification task only.
+ * @property {number} verifyCloudFunctionTime - the time spent for the execution of the verify contribution cloud function.
+ * @property {number} fullContributionTime - the time spent while contributing (from download to upload).
+ */
+export type VerifyContributionComputation = {
+    valid: boolean;
+    verificationComputationTime: number;
+    verifyCloudFunctionTime: number;
+    fullContributionTime: number;
+};
+/**
+ * Define a custom object containing a Github Gist file data.
+ * @typedef {Object} GithubGistFile
+ * @property {string} filename - the name of the file.
+ * @property {string} type - the type of the content of the file (e.g., text/plain).
+ * @property {string} language - the type of file (e.g, Text, Markdown).
+ * @property {string} raw_url - the url to file content.
+ * @property {number} size - the size of the file (in bytes).
+ */
+export type GithubGistFile = {
+    filename: string;
+    type: string;
+    language: string;
+    raw_url: string;
+    size: number;
+};

package/package.json

@@ -0,0 +1,99 @@
+{
+    "name": "@devtion/devcli",
+    "type": "module",
+    "version": "1.0.5-alpha.0",
+    "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",
+    "bugs": "https://github.com/privacy-scaling-explorations/p0tion/issues",
+    "license": "MIT",
+    "bin": "dist/index.js",
+    "main": "dist/index.js",
+    "types": "dist/types/index.d.ts",
+    "engines": {
+        "node": ">=16.14.0"
+    },
+    "files": [
+        "dist/",
+        "src/",
+        "types/",
+        "README.md"
+    ],
+    "keywords": [
+        "typescript",
+        "zero-knowledge",
+        "zk-snarks",
+        "phase-2",
+        "trusted-setup",
+        "ceremony",
+        "snarkjs",
+        "circom"
+    ],
+    "scripts": {
+        "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
+        "build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
+        "start": "ts-node --esm ./src/index.ts",
+        "auth": "yarn start auth",
+        "contribute": "yarn start contribute",
+        "clean": "yarn start clean",
+        "list": "yarn start list",
+        "logout": "yarn start logout",
+        "validate": "yarn start validate",
+        "coordinate:setup": "yarn start coordinate setup",
+        "coordinate:observe": "yarn start coordinate observe",
+        "coordinate:finalize": "yarn start coordinate finalize",
+        "docs": "typedoc src/**/*.ts --out ../../docs/phase2cli"
+    },
+    "devDependencies": {
+        "@types/clear": "^0.1.2",
+        "@types/cli-progress": "^3.11.0",
+        "@types/figlet": "^1.5.6",
+        "@types/mime-types": "^2.1.1",
+        "@types/node-emoji": "^1.8.2",
+        "@types/node-fetch": "^2.6.3",
+        "@types/ora": "^3.2.0",
+        "@types/prompts": "^2.4.4",
+        "@types/rollup-plugin-auto-external": "^2.0.2",
+        "@types/winston": "^2.4.4",
+        "rollup-plugin-auto-external": "^2.0.0",
+        "rollup-plugin-cleanup": "^3.2.1",
+        "rollup-plugin-typescript2": "^0.34.1",
+        "solc": "^0.8.19",
+        "ts-node": "^10.9.1",
+        "typescript": "^5.0.4"
+    },
+    "dependencies": {
+        "@adobe/node-fetch-retry": "^2.2.0",
+        "@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",
+        "clear": "^0.1.0",
+        "cli-progress": "^3.12.0",
+        "clipboardy": "^3.0.0",
+        "commander": "^10.0.1",
+        "conf": "^11.0.1",
+        "dotenv": "^16.0.3",
+        "figlet": "^1.6.0",
+        "firebase": "^9.21.0",
+        "log-symbols": "^5.1.0",
+        "mime-types": "^2.1.35",
+        "node-disk-info": "^1.3.0",
+        "node-emoji": "^1.11.0",
+        "node-fetch": "^3.3.1",
+        "open": "^9.1.0",
+        "ora": "^6.3.0",
+        "prompts": "^2.4.2",
+        "rimraf": "^5.0.0",
+        "rollup": "^3.21.6",
+        "snarkjs": "^0.6.11",
+        "timer-node": "^5.0.7",
+        "winston": "^3.8.2"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}