@devtion/devcli 0.0.0-dev → 0.0.0-e312890

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"
 
@@ -203,7 +203,7 @@ export const promptCircomCompiler = async (): 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.
+ * @returns Promise<string> - the name of the chosen circuit.
  */
 export const promptCircuitSelector = async (options: Array<string>): Promise<string> => {
     const { circuitFilename } = await prompts({
@@ -223,7 +223,7 @@ export const promptCircuitSelector = async (options: Array<string>): Promise<str
  * 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.
+ * @returns Promise<string> - the name of the chosen VM type.
  */
 export const promptVMTypeSelector = async (constraintSize): Promise<string> => {
     let suggestedConfiguration: number = 0
@@ -325,7 +325,7 @@ export const promptVMDiskTypeSelector = async (): 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 timeoutMechanismType <CeremonyTimeoutType> - the chosen 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.
@@ -343,7 +343,7 @@ export const promptCircuitInputData = async (
     let circomVersion: string = ""
     let circomCommitHash: string = ""
     let circuitInputData: CircuitInputData
-    let useCfOrVm: CircuitContributionVerificationMechanism
+    let cfOrVm: CircuitContributionVerificationMechanism
     let vmDiskType: DiskTypeForVM
     let vmConfigurationType: string = ""
 
@@ -422,19 +422,23 @@ export const promptCircuitInputData = async (
         circomCommitHash = commitHash
     }
 
-    // Ask for prefered contribution verification method (CF vs VM).
+    // Ask for preferred contribution verification method (CF vs VM).
     if (!enforceVM) {
         const { confirmation } = await askForConfirmation(
             `The contribution verification can be performed using Cloud Functions (CF, cheaper for small contributions but limited to 1M constraints) or custom virtual machines (expensive but could scale up to 30M constraints). Be aware about VM costs and if you wanna learn more, please visit the documentation to have a complete overview about cost estimation of the two mechanisms.\nChoose the contribution verification mechanism`,
             `CF`, // eq. true.
             `VM` // eq. false.
         )
-        useCfOrVm = confirmation
-    } else useCfOrVm = CircuitContributionVerificationMechanism.VM
+        cfOrVm = confirmation
+            ? CircuitContributionVerificationMechanism.CF
+            : CircuitContributionVerificationMechanism.VM
+    } else {
+        cfOrVm = CircuitContributionVerificationMechanism.VM
+    }
 
-    if (useCfOrVm === undefined) showError(COMMAND_ERRORS.COMMAND_ABORT_PROMPT, true)
+    if (cfOrVm === undefined) showError(COMMAND_ERRORS.COMMAND_ABORT_PROMPT, true)
 
-    if (!useCfOrVm) {
+    if (cfOrVm === CircuitContributionVerificationMechanism.VM) {
         // Ask for selecting the specific VM configuration type.
         vmConfigurationType = await promptVMTypeSelector(constraintSize)
 
@@ -478,9 +482,7 @@ export const promptCircuitInputData = async (
                 paramsConfiguration: circuitConfigurationValues
             },
             verification: {
-                cfOrVm: useCfOrVm
-                    ? CircuitContributionVerificationMechanism.CF
-                    : CircuitContributionVerificationMechanism.VM,
+                cfOrVm,
                 vm: {
                     vmConfigurationType,
                     vmDiskType
@@ -520,9 +522,7 @@ export const promptCircuitInputData = async (
                 paramsConfiguration: circuitConfigurationValues
             },
             verification: {
-                cfOrVm: useCfOrVm
-                    ? CircuitContributionVerificationMechanism.CF
-                    : CircuitContributionVerificationMechanism.VM,
+                cfOrVm,
                 vm: {
                     vmConfigurationType,
                     vmDiskType
@@ -586,7 +586,7 @@ export const promptCircuitAddition = async (): 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.
+ * @returns Promise<string> - the name of the chosen pre-computed zKey.
  */
 export const promptPreComputedZkeySelector = async (options: Array<string>): Promise<string> => {
     const { preComputedZkeyFilename } = await prompts({
@@ -633,13 +633,13 @@ export const promptNeededPowersForCircuit = async (suggestedSmallestNeededPowers
  * 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.
+ * @returns Promise<string> - the name of the chosen PoT.
  */
 export const promptPotSelector = async (options: Array<string>): Promise<string> => {
     const { potFilename } = await prompts({
         type: "select",
         name: "potFilename",
-        message: theme.text.bold("Select the Powers of Tau file choosen for the circuit"),
+        message: theme.text.bold("Select the Powers of Tau file chosen for the circuit"),
         choices: options.map((option: string) => {
             console.log(option)
             return { title: option, value: option }
@@ -661,7 +661,8 @@ export const promptPotSelector = async (options: Array<string>): Promise<string>
  */
 export const promptForCeremonySelection = async (
     ceremoniesDocuments: Array<FirebaseDocumentInfo>,
-    isFinalizing: boolean
+    isFinalizing: boolean,
+    messageToDisplay?: string
 ): Promise<FirebaseDocumentInfo> => {
     // Prepare state.
     const choices: Array<Choice> = []
@@ -686,11 +687,7 @@ export const promptForCeremonySelection = async (
     const { ceremony } = await prompts({
         type: "select",
         name: "ceremony",
-        message: theme.text.bold(
-            !isFinalizing
-                ? "Which ceremony would you like to contribute to?"
-                : "Which ceremony would you like to finalize?"
-        ),
+        message: theme.text.bold(messageToDisplay),
         choices,
         initial: 0
     })
@@ -731,7 +728,7 @@ export const promptToTypeEntropyOrBeacon = async (isEntropy = true): Promise<str
  * @return <Promise<string>> - the entropy.
  */
 export const promptForEntropy = async (): Promise<string> => {
-    // Prompt for entropy generation prefered method.
+    // Prompt for entropy generation preferred method.
     const { confirmation } = await askForConfirmation(
         `Do you prefer to type your entropy or generate it randomly?`,
         "Manually",

package/src/lib/services.ts

@@ -2,17 +2,22 @@ import {
     getCurrentFirebaseAuthUser,
     initializeFirebaseCoreServices,
     signInToFirebaseWithCredentials
-} from "@p0tion/actions"
+} from "@devtion/actions"
 import clear from "clear"
 import figlet from "figlet"
 import { FirebaseApp } from "firebase/app"
-import { OAuthCredential } from "firebase/auth"
+import { OAuthCredential, getAuth, signInWithCustomToken } from "firebase/auth"
 import dotenv from "dotenv"
 import { fileURLToPath } from "url"
 import { dirname } from "path"
 import { AuthUser } from "../types/index.js"
 import { CONFIG_ERRORS, CORE_SERVICES_ERRORS, showError, THIRD_PARTY_SERVICES_ERRORS } from "./errors.js"
-import { checkLocalAccessToken, deleteLocalAccessToken, getLocalAccessToken } from "./localConfigs.js"
+import {
+    checkLocalAccessToken,
+    deleteLocalAccessToken,
+    getLocalAccessToken,
+    getLocalAuthMethod
+} from "./localConfigs.js"
 import theme from "./theme.js"
 import { exchangeGithubTokenForCredentials, getGithubProviderUserId, getUserHandleFromProviderUserId } from "./utils.js"
 
@@ -117,8 +122,6 @@ export const signInToFirebase = async (firebaseApp: FirebaseApp, credentials: OA
     }
 }
 
-
-
 /**
  * Ensure that the callee is an authenticated user.
  * @notice The token will be passed as parameter.
@@ -166,22 +169,42 @@ export const checkAuth = async (firebaseApp: FirebaseApp): Promise<AuthUser> =>
     // Retrieve local access token.
     const token = String(getLocalAccessToken())
 
-    // Get credentials.
-    const credentials = exchangeGithubTokenForCredentials(token)
-
-    // Sign in to Firebase using credentials.
-    await signInToFirebase(firebaseApp, credentials)
+    let providerUserId: string
+    let username: string
+    const authMethod = getLocalAuthMethod()
+    switch (authMethod) {
+        case "github": {
+            // Get credentials.
+            const credentials = exchangeGithubTokenForCredentials(token)
+            // Sign in to Firebase using credentials.
+            await signInToFirebase(firebaseApp, credentials)
+            // Get Github unique identifier (handle-id).
+            providerUserId = await getGithubProviderUserId(String(token))
+            username = getUserHandleFromProviderUserId(providerUserId)
+            break
+        }
+        case "bandada": {
+            const userCredentials = await signInWithCustomToken(getAuth(), token)
+            providerUserId = userCredentials.user.uid
+            username = providerUserId
+            break
+        }
+        case "siwe": {
+            const userCredentials = await signInWithCustomToken(getAuth(), token)
+            providerUserId = userCredentials.user.uid
+            username = providerUserId
+            break
+        }
+        default: {
+            break
+        }
+    }
 
     // Get current authenticated user.
     const user = getCurrentFirebaseAuthUser(firebaseApp)
 
-    // Get Github unique identifier (handle-id).
-    const providerUserId = await getGithubProviderUserId(String(token))
-
     // Greet the user.
-    console.log(
-        `Greetings, @${theme.text.bold(getUserHandleFromProviderUserId(providerUserId))} ${theme.emojis.wave}\n`
-    )
+    console.log(`Greetings, @${theme.text.bold(username)} ${theme.emojis.wave}\n`)
 
     return {
         user,

package/src/lib/utils.ts

@@ -18,8 +18,9 @@ import {
     ParticipantContributionStep,
     permanentlyStoreCurrentContributionTimeAndHash,
     progressToNextContributionStep,
-    verifyContribution
-} from "@p0tion/actions"
+    verifyContribution,
+    contribHashRegex
+} from "@devtion/actions"
 import { Presets, SingleBar } from "cli-progress"
 import dotenv from "dotenv"
 import { GithubAuthProvider, OAuthCredential } from "firebase/auth"
@@ -155,9 +156,11 @@ export const getPublicAttestationGist = async (
  * @returns <string> - the third-party provider handle of the user.
  */
 export const getUserHandleFromProviderUserId = (providerUserId: string): string => {
-    if (providerUserId.indexOf("-") === -1) showError(THIRD_PARTY_SERVICES_ERRORS.GITHUB_GET_GITHUB_ACCOUNT_INFO, true)
+    if (providerUserId.indexOf("-") === -1) {
+        return providerUserId
+    }
 
-    return providerUserId.split("-")[0]
+    return providerUserId.substring(0, providerUserId.lastIndexOf("-"))
 }
 
 /**
@@ -309,10 +312,26 @@ export const generateCustomUrlToTweetAboutParticipation = (
     ceremonyName: string,
     gistUrl: string,
     isFinalizing: boolean
-) =>
-    isFinalizing
-        ? `https://twitter.com/intent/tweet?text=I%20have%20finalized%20the%20${ceremonyName}%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}%20Phase%202%20Trusted%20Setup%20ceremony!%20You%20can%20contribute%20here:%20https://github.com/privacy-scaling-explorations/p0tion%20You%20can%20view%20my%20attestation%20here:%20${gistUrl}%20#Ethereum%20#ZKP`
+) => {
+    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.
@@ -521,6 +540,7 @@ export const getLatestUpdatesFromParticipant = async (
  * @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).
+ * @param circuitsLength <number> - the total number of circuits in the ceremony.
  */
 export const handleStartOrResumeContribution = async (
     cloudFunctions: Functions,
@@ -530,7 +550,8 @@ export const handleStartOrResumeContribution = async (
     participant: FirebaseDocumentInfo,
     entropyOrBeaconHash: any,
     contributorOrCoordinatorIdentifier: string,
-    isFinalizing: boolean
+    isFinalizing: boolean,
+    circuitsLength: number
 ): Promise<void> => {
     // Extract data.
     const { prefix: ceremonyPrefix } = ceremony.data
@@ -538,7 +559,9 @@ export const handleStartOrResumeContribution = async (
     const { completedContributions } = waitingQueue // = current progress.
 
     console.log(
-        `${theme.text.bold(`\n- Circuit # ${theme.colors.magenta(`${sequencePosition}`)}`)} (Contribution Steps)`
+        `${theme.text.bold(
+            `\n- Circuit # ${theme.colors.magenta(`${sequencePosition}/${circuitsLength}`)}`
+        )} (Contribution Steps)`
     )
 
     // Get most up-to-date data from the participant document.
@@ -607,6 +630,8 @@ export const handleStartOrResumeContribution = async (
             `${theme.symbols.success} Contribution ${theme.text.bold(`#${lastZkeyIndex}`)} correctly downloaded`
         )
 
+        await sleep(3000)
+
         // Advance to next contribution step (COMPUTING) if not finalizing.
         if (!isFinalizing) {
             spinner.text = `Preparing for contribution computation...`
@@ -642,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)
@@ -650,6 +675,8 @@ export const handleStartOrResumeContribution = async (
         // Format contribution hash.
         const contributionHash = matchContributionHash?.at(0)?.replace("\n\t\t", "")!
 
+        await sleep(500)
+
         // Make request to cloud functions to permanently store the information.
         await permanentlyStoreCurrentContributionTimeAndHash(
             cloudFunctions,
@@ -675,6 +702,9 @@ export const handleStartOrResumeContribution = async (
             )}`
         )
 
+        // ensure the previous step is completed
+        await sleep(5000)
+
         // Advance to next contribution step (UPLOADING) if not finalizing.
         if (!isFinalizing) {
             spinner.text = `Preparing for uploading the contribution...`
@@ -696,10 +726,12 @@ export const handleStartOrResumeContribution = async (
             !isFinalizing ? theme.text.bold(`#${nextZkeyIndex}`) : ""
         } to storage.\n${
             theme.symbols.warning
-        } This step may take a while based on circuit size and your contribution speed. Everything's fine, just be patient.`
+        } This step may take a while based on circuit size and your internet speed. Everything's fine, just be patient.`
         spinner.start()
 
-        if (!isFinalizing)
+        const progressBar = customProgressBar(ProgressBarType.UPLOAD, `your contribution`)
+
+        if (!isFinalizing) {
             await multiPartUpload(
                 cloudFunctions,
                 bucketName,
@@ -707,9 +739,12 @@ export const handleStartOrResumeContribution = async (
                 nextZkeyLocalFilePath,
                 Number(process.env.CONFIG_STREAM_CHUNK_SIZE_IN_MB),
                 ceremony.id,
-                participantData.tempContributionData
+                participantData.tempContributionData,
+                progressBar
             )
-        else
+
+            progressBar.stop()
+        } else
             await multiPartUpload(
                 cloudFunctions,
                 bucketName,
@@ -718,6 +753,9 @@ export const handleStartOrResumeContribution = async (
                 Number(process.env.CONFIG_STREAM_CHUNK_SIZE_IN_MB)
             )
 
+        // small sleep to ensure the previous step is completed
+        await sleep(5000)
+
         spinner.succeed(
             `${
                 isFinalizing ? `Contribution` : `Contribution ${theme.text.bold(`#${nextZkeyIndex}`)}`

package/src/types/index.ts

@@ -68,3 +68,78 @@ export type GithubGistFile = {
     raw_url: string
     size: number
 }
+
+/**
+ * Define the return object of the function that verifies the Bandada membership and proof.
+ * @typedef {Object} VerifiedBandadaResponse
+ * @property {boolean} valid - true if the proof is valid and the user is a member of the group; otherwise false.
+ * @property {string} message - a message describing the result of the verification.
+ * @property {string} token - the custom access token.
+ */
+export type VerifiedBandadaResponse = {
+    valid: boolean
+    message: string
+    token: string
+}
+
+/**
+ * Define the return object of the device code uri request.
+ * @typedef {Object} OAuthDeviceCodeResponse
+ * @property {string} device_code - the device code.
+ * @property {string} user_code - the user code.
+ * @property {string} verification_uri - the verification uri.
+ * @property {number} expires_in - the expiration time in seconds.
+ * @property {number} interval - the interval time in seconds.
+ * @property {string} verification_uri_complete - the complete verification uri.
+ * @property {string} error - in case there was an error, show the code
+ * @property {string} error_description - error details.
+ * @property {string} error_uri - error uri.
+ */
+export type OAuthDeviceCodeResponse = {
+    device_code: string
+    user_code: string
+    verification_uri: string
+    expires_in: number
+    interval: number
+    verification_uri_complete: string
+    // error response should contain
+    error?: string
+    error_description?: string
+    error_uri?: string
+}
+
+/**
+ * Define the return object of the polling endpoint
+ * @typedef {Object} OAuthTokenResponse
+ * @property {string} access_token - the resulting device flow token
+ * @property {string} token_type - token type
+ * @property {number} expires_in - when does the token expires
+ * @property {string} scope - the scope requested by the initial device flow endpoint
+ * @property {string} refresh_token - refresh token
+ * @property {string} id_token - id token
+ * @property {string} error - in case there was an error, show the code
+ * @property {string} error_description - error details
+ */
+export type OAuthTokenResponse = {
+    access_token: string
+    token_type: string
+    expires_in: number
+    scope: string
+    refresh_token: string
+    id_token: string
+    // error response should contain
+    error?: string
+    error_description?: string
+}
+
+/**
+ * @typedef {Object} CheckNonceOfSIWEAddressResponse
+ * @property {boolean} valid - if the checking was valid or not
+ * @property {string} message - more information about the validity
+ * @property {string} token - token to sign into Firebase
+ */
+export type CheckNonceOfSIWEAddressResponse = {
+    valid: boolean
+    message: string
+    token: string
+}