fix: some typos

privacy-scaling-explorations · Oct 26, 2023 · 71104c0 · 71104c0
1 parent 79cb89f
commit 71104c0
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -187,7 +187,7 @@ For test execution (e2e/unit) we leverage [Jest](https://jestjs.io/).
 
 #### Local Environment
 
-**Prerequisities**
+**Prerequisites**
 
 -   Node.js version 16.0 or higher.
 -   Java JDK version 11 or higher.
@@ -202,7 +202,7 @@ yarn test
 
 #### Production Environment
 
-**Prerequisities**
+**Prerequisites**
 
 -   A Firebase Application w/ active billing (Blaze Plan) in order to support Cloud Functions deployment.
 -   Copy the `packages/actions/.env.default` file as `.env` `cp .env.default .env` and add your environment variables.

diff --git a/packages/actions/README.md b/packages/actions/README.md
@@ -67,7 +67,7 @@ yarn add @p0tion/actions
 
 ### Local Development
 
-**Prerequisities**
+**Prerequisites**
 
 -   Node.js version 16.0 or higher.
 -   Yarn version 3.5.0 or higher.

diff --git a/packages/backend/README.md b/packages/backend/README.md
@@ -51,7 +51,7 @@ Launching the ready-to-run customized scripts everyone could handle whatever is
 
 ## 🛠 Installation
 
-**Prerequisities**
+**Prerequisites**
 
 -   Node.js version 16.0 or higher.
 -   Yarn version 3.5.0 or higher.
@@ -148,7 +148,7 @@ yarn firebase:deploy-firestore
 
 Firebase provides a [Local Emulator Suite](https://firebase.google.com/docs/emulator-suite) as a set of advanced dev-tools w/ a rich user-interface to build and test apps locally using Firebase services as Cloud Functions, Firestore and Authentication.
 
-**Prerequisities**
+**Prerequisites**
 
 -   You will need Java JDK version 11 or higher to run the Firebase Local Emulator.
 

diff --git a/packages/backend/src/lib/utils.ts b/packages/backend/src/lib/utils.ts
@@ -166,7 +166,7 @@ export const getCircuitDocumentByPosition = async (
     // Query for all ceremony circuits.
     const circuits = await getCeremonyCircuits(ceremonyId)
 
-    // Apply a filter using the sequence postion.
+    // Apply a filter using the sequence position.
     const matchedCircuits = circuits.filter(
         (circuit: DocumentData) => circuit.data().sequencePosition === sequencePosition
     )

diff --git a/packages/phase2cli/README.md b/packages/phase2cli/README.md
@@ -67,7 +67,7 @@ npx @p0tion/phase2cli contribute
 
 ### Local Development
 
-**Prerequisities**
+**Prerequisites**
 
 -   Node.js version 16.0 or higher.
 -   Yarn version 3.5.0 or higher.

diff --git a/packages/phase2cli/src/commands/observe.ts b/packages/phase2cli/src/commands/observe.ts
@@ -143,7 +143,7 @@ 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.

diff --git a/packages/phase2cli/src/commands/setup.ts b/packages/phase2cli/src/commands/setup.ts
@@ -181,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],
@@ -322,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 (

diff --git a/packages/phase2cli/src/lib/prompts.ts b/packages/phase2cli/src/lib/prompts.ts
@@ -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.
@@ -422,7 +422,7 @@ 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`,
@@ -587,7 +587,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({
@@ -634,13 +634,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 }
@@ -732,7 +732,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",