@devtion/devcli 0.0.0-dev → 0.0.0-e312890

package/src/commands/index.ts

@@ -1,9 +1,11 @@
 export { default as setup } from "./setup.js"
 export { default as auth } from "./auth.js"
+export { default as authBandada } from "./authBandada.js"
+export { default as authSIWE } from "./authSIWE.js"
 export { default as contribute } from "./contribute.js"
 export { default as observe } from "./observe.js"
 export { default as finalize } from "./finalize.js"
 export { default as clean } from "./clean.js"
 export { default as logout } from "./logout.js"
 export { default as validate } from "./validate.js"
-export { default as listCeremonies} from "./listCeremonies.js"
+export { default as listCeremonies } from "./listCeremonies.js"

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"
 
@@ -17,11 +17,10 @@ const listCeremonies = async () => {
 
         // loop through all ceremonies
         for (const ceremony of ceremonies) names.push(ceremony.data().prefix)
-        
+
         // print them to the console
         console.log(names.join(", "))
         process.exit(0)
-
     } catch (err: any) {
         showError(`${err.toString()}`, false)
         // we want to exit with a non-zero exit code

package/src/commands/logout.ts

@@ -6,7 +6,7 @@ import { showError } from "../lib/errors.js"
 import { askForConfirmation } from "../lib/prompts.js"
 import { customSpinner, sleep, terminate } from "../lib/utils.js"
 import theme from "../lib/theme.js"
-import { deleteLocalAccessToken } from "../lib/localConfigs.js"
+import { deleteLocalAccessToken, deleteLocalAuthMethod, deleteLocalBandadaIdentity } from "../lib/localConfigs.js"
 
 /**
  * Logout command.
@@ -52,7 +52,9 @@ const logout = async () => {
             await signOut(auth)
 
             // Delete local token.
+            deleteLocalAuthMethod()
             deleteLocalAccessToken()
+            deleteLocalBandadaIdentity()
 
             await sleep(3000) // ~3s.
 

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"
@@ -15,7 +15,7 @@ import { COMMAND_ERRORS, GENERIC_ERRORS, showError } from "../lib/errors.js"
 import { promptForCeremonySelection } from "../lib/prompts.js"
 import { bootstrapCommandExecutionAndServices, checkAuth } from "../lib/services.js"
 import theme from "../lib/theme.js"
-import {customSpinner, getSecondsMinutesHoursFromMillis, sleep } from "../lib/utils.js"
+import { customSpinner, getSecondsMinutesHoursFromMillis, sleep } from "../lib/utils.js"
 
 /**
  * Clean cursor lines from current position back to root (default: zero).
@@ -143,11 +143,15 @@ const observe = async () => {
         // Preserve command execution only for coordinators].
         if (!(await isCoordinator(user))) showError(COMMAND_ERRORS.COMMAND_NOT_COORDINATOR, true)
 
-        // Get running cerimonies info (if any).
+        // Get running ceremonies info (if any).
         const runningCeremoniesDocs = await getOpenedCeremonies(firestoreDatabase)
 
         // Ask to select a ceremony.
-        const ceremony = await promptForCeremonySelection(runningCeremoniesDocs, false)
+        const ceremony = await promptForCeremonySelection(
+            runningCeremoniesDocs,
+            false,
+            "Which ceremony would you like to observe?"
+        )
 
         console.log(`${logSymbols.info} Refresh rate set to ~3 seconds for waiting queue updates\n`)
 

package/src/commands/setup.ts

@@ -2,12 +2,11 @@
 
 import { zKey } from "snarkjs"
 import boxen from "boxen"
-import { createWriteStream, Dirent, renameSync } from "fs"
+import { createWriteStream, Dirent, renameSync, existsSync } from "fs"
 import { pipeline } from "node:stream"
 import { promisify } from "node:util"
 import fetch from "node-fetch"
 import { Functions } from "firebase/functions"
-import { S3Client, GetObjectCommand } from "@aws-sdk/client-s3"
 import {
     CeremonyTimeoutType,
     CircomCompilerData,
@@ -37,7 +36,7 @@ import {
     setupCeremony,
     parseCeremonyFile,
     CircuitContributionVerificationMechanism
-} from "@p0tion/actions"
+} from "@devtion/actions"
 import { customSpinner, simpleLoader, sleep, terminate } from "../lib/utils.js"
 import {
     promptCeremonyInputData,
@@ -63,7 +62,6 @@ import {
     getFileStats,
     checkAndMakeNewDirectoryIfNonexistent
 } from "../lib/files.js"
-import { Readable } from "stream"
 
 /**
  * Handle whatever is needed to obtain the input data for a circuit that the coordinator would like to add to the ceremony.
@@ -183,7 +181,7 @@ export const handleAdditionOfCircuitsToCeremony = async (
 
         if (matchingWasms.length !== 1) showError(COMMAND_ERRORS.COMMAND_SETUP_MISMATCH_R1CS_WASM, true)
 
-        // Get input data for choosen circuit.
+        // Get input data for chosen circuit.
         const circuitInputData = await getInputDataToAddCircuitToCeremony(
             choosenCircuitFilename,
             matchingWasms[0],
@@ -273,7 +271,7 @@ export const displayCeremonySummary = (ceremonyInputData: CeremonyInputData, cir
 
 /**
  * Check if the smallest Powers of Tau has already been downloaded/stored in the correspondent local path
- * @dev we are downloading the Powers of Tau file from Hermez Cryptography Phase 1 Trusted Setup.
+ * @dev we are downloading the Powers of Tau file from Perpetual Powers of Tau Phase 1 Trusted Setup.
  * @param powers <string> - the smallest amount of powers needed for the given circuit (should be in a 'XY' stringified form).
  * @param ptauCompleteFilename <string> - the complete file name of the powers of tau file to be downloaded.
  * @returns <Promise<void>>
@@ -295,7 +293,7 @@ export const checkAndDownloadSmallestPowersOfTau = async (
         const spinner = customSpinner(
             `Downloading the ${theme.text.bold(
                 `#${powers}`
-            )} smallest PoT file needed from the Hermez Cryptography Phase 1 Trusted Setup...`,
+            )} smallest PoT file needed from the Perpetual Powers of Tau Phase 1 Trusted Setup...`,
             `clock`
         )
         spinner.start()
@@ -324,7 +322,7 @@ export const checkAndDownloadSmallestPowersOfTau = async (
  * number of powers greater than or equal to the powers needed by the zKey), the coordinator will be asked
  * to provide a number of powers manually, ranging from the smallest possible to the largest.
  * @param neededPowers <number> - the smallest amount of powers needed by the zKey.
- * @returns Promise<string, string> - the information about the choosen Powers of Tau file for the pre-computed zKey
+ * @returns Promise<string, string> - the information about the chosen Powers of Tau file for the pre-computed zKey
  * along with related powers.
  */
 export const handlePreComputedZkeyPowersOfTauSelection = async (
@@ -465,10 +463,10 @@ export const handleCircuitArtifactUploadToStorage = async (
  * @notice The setup command allows the coordinator of the ceremony to prepare the next ceremony by interacting with the CLI.
  * @dev For proper execution, the command must be run in a folder containing the R1CS files related to the circuits
  * for which the coordinator wants to create the ceremony. The command will download the necessary Tau powers
- * from Hermez's ceremony Phase 1 Reliable Setup Ceremony.
+ * from PPoT ceremony Phase 1 Setup Ceremony.
  * @param cmd? <any> - the path to the ceremony setup file.
  */
-const setup = async (cmd: { template?: string, auth?: string}) => {
+const setup = async (cmd: { template?: string; auth?: string }) => {
     // Setup command state.
     const circuits: Array<CircuitDocument> = [] // Circuits.
     let ceremonyId: string = "" // The unique identifier of the ceremony.
@@ -476,8 +474,10 @@ const setup = async (cmd: { template?: string, auth?: string}) => {
     const { firebaseApp, firebaseFunctions, firestoreDatabase } = await bootstrapCommandExecutionAndServices()
 
     // Check for authentication.
-    const { user, providerUserId } = cmd.auth ? await authWithToken(firebaseApp, cmd.auth) : await checkAuth(firebaseApp)
-   
+    const { user, providerUserId } = cmd.auth
+        ? await authWithToken(firebaseApp, cmd.auth)
+        : await checkAuth(firebaseApp)
+
     // Preserve command execution only for coordinators.
     if (!(await isCoordinator(user))) showError(COMMAND_ERRORS.COMMAND_NOT_COORDINATOR, true)
 
@@ -503,7 +503,7 @@ const setup = async (cmd: { template?: string, auth?: string}) => {
     // if there is the file option, then set up the non interactively
     if (cmd.template) {
         // 1. parse the file
-        // tmp data - do not cleanup files as we need them 
+        // tmp data - do not cleanup files as we need them
         const spinner = customSpinner(`Parsing ${theme.text.bold(cmd.template!)} setup configuration file...`, `clock`)
         spinner.start()
         const setupCeremonyData = await parseCeremonyFile(cmd.template!)
@@ -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,36 +526,44 @@ 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
+            await checkAndDownloadSmallestPowersOfTau(
+                convertToDoubleDigits(circuit.metadata?.pot!),
+                circuit.files.potFilename
+            )
+
+            // 3. generate the zKey
             const spinner = customSpinner(
-                `Downloading the ${theme.text.bold(
-                    `#${circuit.name}`
-                )} WASM file from the project's bucket...`,
+                `Generating genesis zKey for circuit ${theme.text.bold(circuit.name)}...`,
                 `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 (existsSync(zkeyLocalPathAndFileName)) {
+                spinner.succeed(
+                    `The genesis zKey for circuit ${theme.text.bold(circuit.name)} is already present on disk`
+                )
+            } else {
+                await zKey.newZKey(
+                    r1csLocalPathAndFileName,
+                    getPotLocalFilePath(circuit.files.potFilename),
+                    zkeyLocalPathAndFileName,
+                    undefined
+                )
+                spinner.succeed(
+                    `Generation of the genesis zKey for circuit ${theme.text.bold(circuit.name)} completed successfully`
+                )
             }
 
-            if (response.Body instanceof Readable) 
-                await streamPipeline(response.Body, createWriteStream(wasmLocalPathAndFileName))
-
-            spinner.stop()
-            // 3. generate the zKey
-            await zKey.newZKey(r1csLocalPathAndFileName, getPotLocalFilePath(circuit.files.potFilename), zkeyLocalPathAndFileName, undefined)
-            
+            const hashSpinner = customSpinner(
+                `Calculating hashes for circuit ${theme.text.bold(circuit.name)}...`,
+                `clock`
+            )
+            hashSpinner.start()
             // 4. calculate the hashes
             const wasmBlake2bHash = await blake512FromPath(wasmLocalPathAndFileName)
             const potBlake2bHash = await blake512FromPath(getPotLocalFilePath(circuit.files.potFilename))
             const initialZkeyBlake2bHash = await blake512FromPath(zkeyLocalPathAndFileName)
+            hashSpinner.succeed(`Hashes for circuit ${theme.text.bold(circuit.name)} calculated successfully`)
 
             // 5. upload the artifacts
 
@@ -570,7 +575,7 @@ const setup = async (cmd: { template?: string, auth?: string}) => {
                 zkeyLocalPathAndFileName,
                 circuit.files.initialZkeyFilename
             )
-           
+
             // Check if PoT file has been already uploaded to storage.
             const alreadyUploadedPot = await checkIfObjectExist(
                 firebaseFunctions,
@@ -611,25 +616,31 @@ const setup = async (cmd: { template?: string, auth?: string}) => {
             // 6 update the setup data object
             ceremonySetupData.circuits[index].files = {
                 ...circuit.files,
-                potBlake2bHash: potBlake2bHash,
-                wasmBlake2bHash: wasmBlake2bHash,
-                initialZkeyBlake2bHash: initialZkeyBlake2bHash
+                potBlake2bHash,
+                wasmBlake2bHash,
+                initialZkeyBlake2bHash
             }
 
             ceremonySetupData.circuits[index].zKeySizeInBytes = getFileStats(zkeyLocalPathAndFileName).size
         }
-      
 
         // 7. setup the ceremony
-        const ceremonyId = await setupCeremony(firebaseFunctions, ceremonySetupData.ceremonyInputData, ceremonySetupData.ceremonyPrefix, ceremonySetupData.circuits)
-        console.log( `Congratulations, the setup of ceremony ${theme.text.bold(
-            ceremonySetupData.ceremonyInputData.title
-        )} (${`UID: ${theme.text.bold(ceremonyId)}`}) has been successfully completed ${
-            theme.emojis.tada
-        }. You will be able to find all the files and info respectively in the ceremony bucket and database document.`)
-    
+        const ceremonyId = await setupCeremony(
+            firebaseFunctions,
+            ceremonySetupData.ceremonyInputData,
+            ceremonySetupData.ceremonyPrefix,
+            ceremonySetupData.circuits
+        )
+        console.log(
+            `Congratulations, the setup of ceremony ${theme.text.bold(
+                ceremonySetupData.ceremonyInputData.title
+            )} (${`UID: ${theme.text.bold(ceremonyId)}`}) has been successfully completed ${
+                theme.emojis.tada
+            }. You will be able to find all the files and info respectively in the ceremony bucket and database document.`
+        )
+
         terminate(providerUserId)
-    } 
+    }
 
     // Look for R1CS files.
     const r1csFilePaths = await filterDirectoryFilesByExtension(cwd, `.r1cs`)

package/src/commands/validate.ts

@@ -1,10 +1,10 @@
-import { parseCeremonyFile } from "@p0tion/actions"
+import { parseCeremonyFile } from "@devtion/actions"
 import { showError } from "../lib/errors.js"
 
 /**
  * Validate ceremony setup command.
  */
-const validate = async (cmd: { template: string, constraints?: number }) => {
+const validate = async (cmd: { template: string; constraints?: number }) => {
     try {
         // parse the file and cleanup after
         const parsedFile = await parseCeremonyFile(cmd.template, true)
@@ -18,7 +18,6 @@ const validate = async (cmd: { template: string, constraints?: number }) => {
         }
 
         console.log(true)
-
     } catch (err: any) {
         showError(`${err.toString()}`, false)
         // we want to exit with a non-zero exit code

package/src/index.ts

@@ -4,7 +4,20 @@ 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"
+import {
+    setup,
+    auth,
+    authSIWE,
+    authBandada,
+    contribute,
+    observe,
+    finalize,
+    clean,
+    logout,
+    validate,
+    listCeremonies
+} from "./commands/index.js"
+import setCeremonyCommands from "./commands/ceremony/index.js"
 
 // Get pkg info (e.g., name, version).
 const packagePath = `${dirname(fileURLToPath(import.meta.url))}/..`
@@ -16,51 +29,60 @@ 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("auth-bandada")
+    .description("authenticate yourself in a privacy-perserving manner using Bandada")
+    .action(authBandada)
+program
+    .command("auth-siwe")
+    .description("authenticate yourself using your Ethereum account (Sign In With Ethereum - SIWE)")
+    .action(authSIWE)
 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", "")
+    .option("-a, --auth <string>", "the Github OAuth 2.0 token", "")
     .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("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")
+    .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")
+const coordinate = program.command("coordinate").description("commands for coordinating a ceremony")
 
-ceremony
+coordinate
     .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', '')
+    .option("-t, --template <path>", "The path to the ceremony setup template", "")
+    .option("-a, --auth <string>", "The Github OAuth 2.0 token", "")
     .action(setup)
-    
-ceremony
+
+coordinate
     .command("observe")
     .description("observe in real-time the waiting queue of each ceremony circuit")
     .action(observe)
 
-ceremony
+coordinate
     .command("finalize")
     .description(
         "finalize a Phase2 Trusted Setup ceremony by applying a beacon, exporting verification key and verifier contract"
     )
+    .option("-a, --auth <string>", "the Github OAuth 2.0 token", "")
     .action(finalize)
 
+setCeremonyCommands(program)
+
 program.parseAsync(process.argv)

package/src/lib/bandada.ts

@@ -0,0 +1,51 @@
+import { ApiSdk, GroupResponse } from "@bandada/api-sdk"
+import { Identity } from "@semaphore-protocol/identity"
+import open from "open"
+
+import { askForConfirmation } from "../lib/prompts.js"
+import { showError } from "./errors.js"
+import theme from "../lib/theme.js"
+
+const { BANDADA_API_URL } = process.env
+
+const bandadaApi = new ApiSdk(BANDADA_API_URL)
+
+export const getGroup = async (groupId: string): Promise<GroupResponse | null> => {
+    try {
+        const group = await bandadaApi.getGroup(groupId)
+        return group
+    } catch (error: any) {
+        showError(`Bandada getGroup error: ${error}`, true)
+        return null
+    }
+}
+
+export const getMembersOfGroup = async (groupId: string): Promise<string[] | null> => {
+    try {
+        const group = await bandadaApi.getGroup(groupId)
+        return group.members
+    } catch (error: any) {
+        showError(`Bandada getMembersOfGroup error: ${error}`, true)
+        return null
+    }
+}
+
+export const addMemberToGroup = async (groupId: string, dashboardUrl: string, identity: Identity) => {
+    const commitment = identity.commitment.toString()
+    const group = await bandadaApi.getGroup(groupId)
+    const providerName = group.credentials.id.split("_")[0].toLowerCase()
+
+    // 6. open a new window with the url:
+    const url = `${dashboardUrl}credentials?group=${groupId}&member=${commitment}&provider=${providerName}`
+    console.log(`${theme.text.bold(`Verification URL:`)} ${theme.text.underlined(url)}`)
+    open(url)
+
+    const { confirmation } = await askForConfirmation("Did you join the Bandada group in the browser?")
+    if (!confirmation) showError("You must join the Bandada group to continue the login process", true)
+}
+
+export const isGroupMember = async (groupId: string, identity: Identity): Promise<boolean> => {
+    const commitment = identity.commitment.toString()
+    const isMember: boolean = await bandadaApi.isGroupMember(groupId, commitment)
+    return isMember
+}

package/src/lib/errors.ts

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

package/src/lib/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"
@@ -24,6 +24,14 @@ const config = new Conf({
         accessToken: {
             type: "string",
             default: ""
+        },
+        bandadaIdentity: {
+            type: "string",
+            default: ""
+        },
+        authMethod: {
+            type: "string",
+            default: ""
         }
     }
 })
@@ -91,6 +99,52 @@ export const setLocalAccessToken = (token: string) => config.set("accessToken",
  */
 export const deleteLocalAccessToken = () => config.delete("accessToken")
 
+/**
+ * Return the Bandada identity, if present.
+ * @returns <string | undefined> - the Bandada identity if present, otherwise undefined.
+ */
+export const getLocalBandadaIdentity = (): string | unknown => config.get("bandadaIdentity")
+
+/**
+ * Check if the Bandada identity exists in the local storage.
+ * @returns <boolean>
+ */
+export const checkLocalBandadaIdentity = (): boolean => config.has("bandadaIdentity") && !!config.get("bandadaIdentity")
+
+/**
+ * Set the Bandada identity.
+ * @param identity <string> - the Bandada identity to be stored.
+ */
+export const setLocalBandadaIdentity = (identity: string) => config.set("bandadaIdentity", identity)
+
+/**
+ * Delete the stored Bandada identity.
+ */
+export const deleteLocalBandadaIdentity = () => config.delete("bandadaIdentity")
+
+/**
+ * Return the authentication method, if present.
+ * @returns <string | undefined> - the authentication method if present, otherwise undefined.
+ */
+export const getLocalAuthMethod = (): string | unknown => config.get("authMethod")
+
+/**
+ * Check if the authentication method exists in the local storage.
+ * @returns <boolean>
+ */
+export const checkLocalAuthMethod = (): boolean => config.has("authMethod") && !!config.get("authMethod")
+
+/**
+ * Set the authentication method.
+ * @param method <string> - the authentication method to be stored.
+ */
+export const setLocalAuthMethod = (method: string) => config.set("authMethod", method)
+
+/**
+ * Delete the stored authentication method.
+ */
+export const deleteLocalAuthMethod = () => config.delete("authMethod")
+
 /**
  * Get the complete local file path.
  * @param cwd <string> - the current working directory path.