Merge pull request #2178 from o1-labs/boray/mega-typo-fix

boray · web-flow · commit 47eff1c48f72 · 2025-04-23T21:10:37.000+03:00
Mega Typo Fix
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -55,7 +55,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
   - New transaction construction API `new ZkappCommand()`. https://github.com/o1-labs/o1js/pull/2042
 - Bump up Rust version to 1.79.0. Bindings now depends on nightly-2024-06-13.
   https://github.com/o1-labs/o1js/pull/2063
-- `setVerificationKeyUnsafe` static method to `SmartContract` [#2091](httpts://github.com/o1-labs/o1js/pull/2091)
+- `setVerificationKeyUnsafe` static method to `SmartContract` [#2091](https://github.com/o1-labs/o1js/pull/2091)
 - `toBits()` and `fromBits()` methods added for `UInt32` and `UInt64` classes. https://github.com/o1-labs/o1js/pull/2099
 - **Provable BigInt** exposed through the `createProvableBigInt()` class factory https://github.com/o1-labs/o1js/pull/2008
 
@@ -102,7 +102,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - Method for optional types to assert none https://github.com/o1-labs/o1js/pull/1922
 - Increased maximum supported amount of methods in a `SmartContract` or `ZkProgram` to 30. https://github.com/o1-labs/o1js/pull/1918
 - Expose low-level conversion methods `Proof.{_proofToBase64,_proofFromBase64}` https://github.com/o1-labs/o1js/pull/1928
-- Expore `maxProofsVerified()` and a `Proof` class directly on ZkPrograms https://github.com/o1-labs/o1js/pull/1933
+- Expose `maxProofsVerified()` and a `Proof` class directly on ZkPrograms https://github.com/o1-labs/o1js/pull/1933
 
 ### Changed
 
@@ -277,7 +277,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ### Deprecated
 
-- `MerkleMap.computeRootAndKey()` deprecated in favor of `MerkleMap.computeRootAndKeyV2()` due to a potential issue of computing hash collisions in key indicies https://github.com/o1-labs/o1js/pull/1694
+- `MerkleMap.computeRootAndKey()` deprecated in favor of `MerkleMap.computeRootAndKeyV2()` due to a potential issue of computing hash collisions in key indices https://github.com/o1-labs/o1js/pull/1694
 
 ## [1.3.1](https://github.com/o1-labs/o1js/compare/1ad7333e9e...40c597775) - 2024-06-11
 
@@ -948,7 +948,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 ### Fixed
 
 - Failing `Mina.transaction` on Berkeley because of unsatisfied constraints caused by dummy data before we fetched account state https://github.com/o1-labs/o1js/pull/807
-  - Previously, you could work around this by calling `fetchAccount()` for every account invovled in a transaction. This is not necessary anymore.
+  - Previously, you could work around this by calling `fetchAccount()` for every account involved in a transaction. This is not necessary anymore.
 - Update the zkApp verification key from within one of its own methods, via proof https://github.com/o1-labs/o1js/pull/812
 
 ## [0.9.4](https://github.com/o1-labs/o1js/compare/9acec55...21de489)
diff --git a/README-dev.md b/README-dev.md
@@ -62,7 +62,7 @@ This will trigger our self-hosted runner to build the bindings for your commit a
 
 Much like the mina repo, we use the nix registry to conveniently handle git submodules.
 You can enter the devshell with `./pin.sh` and `nix develop o1js#default` or by using
-direnv with the `.envrc` provided. This devshell provides all the dependencies required for npm scripts including `npm run:update-bindings`.
+direnv with the `.envrc` provided. This devshell provides all the dependencies required for npm scripts including `npm run build:update-bindings`.
 
 ## Building Bindings
 
@@ -116,7 +116,7 @@ This can also be helpful when the bindings don't build identically, as unfortuna
 
 To use this patch:
 
-- Click details on the `Build o1js bindings / build-bindings-ubunutu` job
+- Click details on the `Build o1js bindings / build-bindings-ubuntu` job
 - Go to the `patch-upload` job and expand the logs for `Upload patch`
 - Download the file linked in the last line of the logs ie.
   `Artifact download URL: https://github.com/o1-labs/o1js/actions/runs/12401083741/artifacts/2339952965`
@@ -160,7 +160,7 @@ This repo uses minimal [oxlint](https://oxc.rs/docs/guide/usage/linter.html) and
 
 1. Check for style violations by running the npm commands `npm run lint path/to/file` and `npm run format:check path/to/file`
 
-- To attempt to fix all style violations in all changed filed, you can run:
+- To attempt to fix all style violations in all changed files, you can run:
   - `git diff --cached --name-only --diff-filter=d | grep -E '\.(ts|js)$' | xargs npm run format`
   - and `git diff --cached --name-only --diff-filter=d | grep -E '\.(ts|js)$' | xargs npm run lint:fix`
 
@@ -170,7 +170,7 @@ This repo uses minimal [oxlint](https://oxc.rs/docs/guide/usage/linter.html) and
 
 3. Enable pre-commit hooks
 
-- There is an opt-in pre-commit hook avaibale that will attempt to fix styling for all diffed files. Enable it by running `git config husky.optin true`
+- There is an opt-in pre-commit hook available that will attempt to fix styling for all diffed files. Enable it by running `git config husky.optin true`
 
 > [!NOTE]
 > You can opt-out of linting in a PR by tagging it with skip-lint, in case the linting script is legitimately blocking an important PR
diff --git a/README-nix.md b/README-nix.md
@@ -99,7 +99,7 @@ npm run build:update-bindings
 ```
 
 If you need to update the underlying `mina` code, you can also do so with Nix,
-but from the corresopnding subdirectory. In particular, you should build Mina
+but from the corresponding subdirectory. In particular, you should build Mina
 from the o1js subdirectory from a Nix shell. That means,
 
 ```console
@@ -118,14 +118,14 @@ Nix has a garbage collector that **is not used by default** after every run. Ins
 
 Instead, you can try to run `nix-env --delete-generations old` or any other time bound like `7d`. This will not have any effect on MacOS though. Alternatively, the [direnv](https://github.com/direnv/direnv) / [nix-direnv](https://github.com/nix-community/nix-direnv) tool can create garbage collector roots that won't be collected for removal. It just keeps one gc-root to the latest build of the dev shell so that `nix-store --gc` only removes older generations.
 
-On top of that, adding `auto-optimise-store = true` to `/etc/nix/nix.conf` and running `nix-store --optimize` shoud help with disk usage, as it replaces duplicated files with symlinks.
+On top of that, adding `auto-optimise-store = true` to `/etc/nix/nix.conf` and running `nix-store --optimize` should help with disk usage, as it replaces duplicated files with symlinks.
 
 ### Runtime optimization
 
 Other configurations are worth adding into your `/etc/nix/nix.conf`:
 
 ```bash
-keep-otuputs = true
+keep-outputs = true
 max-jobs = 20
 extra-substituters = https://storage.googleapis.com/mina-nix-cache
 extra-trusted-public-keys = nix-cache.minaprotocol.org:fdcuDzmnM0Kbf7yU4yywBuUEJWClySc1WIF6t6Mm8h4= nix-cache.minaprotocol.org:D3B1W+V7ND1Fmfii8EhbAbF1JXoe2Ct4N34OKChwk2c= mina-nix-cache-1:djtioLfv2oxuK2lqPUgmZbf8bY8sK/BnYZCU2iU5Q10=
diff --git a/src/examples/crypto/foreign-field.ts b/src/examples/crypto/foreign-field.ts
@@ -33,7 +33,7 @@ assert(z instanceof SmallField.Unreduced);
 // note: "unreduced" doesn't usually mean that the underlying witness is larger than the modulus.
 // it just means we haven't _proved_ so.. which means a malicious prover _could_ have managed to make it larger.
 
-// unreduced fields can be added and subtracted, but not be used in multiplcation:
+// unreduced fields can be added and subtracted, but not be used in multiplication:
 
 z.add(1).sub(x).assertEquals(0); // works
 
diff --git a/src/examples/zkapps/voting/membership.ts b/src/examples/zkapps/voting/membership.ts
@@ -94,7 +94,7 @@ export class Membership_ extends SmartContract {
     // Preconditions: Restrict who can vote or who can be a candidate
 
     // since we need to keep this contract "generic", we always assert within a range
-    // even tho voters cant have a maximum balance, only candidates
+    // even tho voters can't have a maximum balance, only candidates
     // but for a voter we simply use UInt64.MAXINT() as the maximum
 
     let accountUpdate = AccountUpdate.create(member.publicKey);
@@ -123,7 +123,7 @@ export class Membership_ extends SmartContract {
     );
 
     /*
-    we cant really branch the control flow - we will always have to emit an event no matter what, 
+    we can't really branch the control flow - we will always have to emit an event no matter what, 
     so we emit an empty event if the member already exists
     it the member doesn't exist, emit the "real" member
     */
diff --git a/src/examples/zkapps/voting/test.ts b/src/examples/zkapps/voting/test.ts
@@ -503,7 +503,7 @@ export async function testSet(
     }
 
     // the merkle roots of both membership contract should still be the initial ones because publish hasn't been invoked
-    // therefor the state should not have changes
+    // therefore the state should not have changes
     if (!candidateContract.committedMembers.get().equals(initialRoot).toBoolean()) {
       throw Error('candidate merkle root is not the initialroot');
     }
diff --git a/src/lib/mina/v1/account-update.ts b/src/lib/mina/v1/account-update.ts
@@ -1129,7 +1129,7 @@ class AccountUpdate implements Types.AccountUpdate {
    * This function acts as the `check()` method on an `AccountUpdate` that is sent to the Mina node as part of a transaction.
    *
    * Background: the Mina node performs most necessary validity checks on account updates, both in- and outside of circuits.
-   * To save constraints, we don't repeat these checks in zkApps in places where we can be sure the checked account udpates
+   * To save constraints, we don't repeat these checks in zkApps in places where we can be sure the checked account updates
    * will be part of a transaction.
    *
    * However, there are a few checks skipped by the Mina node, that could cause vulnerabilities in zkApps if
diff --git a/src/lib/mina/v1/mina.ts b/src/lib/mina/v1/mina.ts
@@ -331,7 +331,7 @@ function Network(
     },
     transaction(sender: FeePayerSpec, f: () => Promise<void>) {
       return toTransactionPromise(async () => {
-        // TODO we run the transcation twice to be able to fetch data in between
+        // TODO we run the transaction twice to be able to fetch data in between
         let tx = await createTransaction(sender, f, 0, {
           fetchMode: 'test',
           isFinalRunOutsideCircuit: false,
diff --git a/src/lib/mina/v1/state.ts b/src/lib/mina/v1/state.ts
@@ -269,7 +269,7 @@ function createState<T>(defaultValue?: T): InternalStateType<T> {
       if (this._contract === undefined)
         throw Error('get can only be called when the State is assigned to a SmartContract @state.');
       // inside the circuit, we have to cache variables, so there's only one unique variable per on-chain state.
-      // if we'd return a fresh variable everytime, developers could easily end up linking just *one* of them to the precondition,
+      // if we'd return a fresh variable every time, developers could easily end up linking just *one* of them to the precondition,
       // while using an unconstrained variable elsewhere, which would create a loophole in the proof.
       if (
         this._contract.cachedVariable !== undefined &&
diff --git a/src/lib/mina/v1/zkapp.ts b/src/lib/mina/v1/zkapp.ts
@@ -192,7 +192,7 @@ function wrapMethod(
       const { id, context } = SmartContractContext.enter(this, selfAccountUpdate(this, methodName));
       try {
         if (inCompile() || inProver() || inAnalyze()) {
-          // important to run this with a fresh accountUpdate everytime, otherwise compile messes up our circuits
+          // important to run this with a fresh accountUpdate every time, otherwise compile messes up our circuits
           // because it runs this multiple times
           let proverData = inProver() ? zkAppProver.getData() : undefined;
           let txId = Mina.currentTransaction.enter({
@@ -635,7 +635,7 @@ class SmartContract extends SmartContractBase {
   }
 
   /**
-   * Manually set the verificaiton key.
+   * Manually set the verification key.
    */
   static setVerificationKeyUnsafe(verificationKey: { data: string; hash: Field | string }) {
     SmartContract._verificationKey = {
@@ -776,7 +776,7 @@ super.init();
     let inTransaction = Mina.currentTransaction.has();
     let inSmartContract = smartContractContext.get();
     if (!inTransaction && !inSmartContract) {
-      // TODO: it's inefficient to return a fresh account update everytime, would be better to return a constant "non-writable" account update,
+      // TODO: it's inefficient to return a fresh account update every time, would be better to return a constant "non-writable" account update,
       // or even expose the .get() methods independently of any account update (they don't need one)
       return selfAccountUpdate(this);
     }
diff --git a/src/lib/mina/v2/dsl/mina-program.ts b/src/lib/mina/v2/dsl/mina-program.ts
@@ -356,7 +356,7 @@ function proverMethod<
   // methods are invoked externally.
   //
   // We perform shallow evaluation on the roots of account update trees returned by method
-  // invokations. This requires that all child updates were manually applied before invoking the
+  // invocations. This requires that all child updates were manually applied before invoking the
   // method call. Importantly, with this restriction, methods cannot actually generate new
   // children, the children must be passed in as private inputs and constrained accordingly.
   // Unproven update arguments which are not at the root of the tree returned by a method must be
diff --git a/src/lib/mina/v2/state.ts b/src/lib/mina/v2/state.ts
@@ -470,7 +470,7 @@ const StateValues = {
       (values, preconditions) => {
         for (const i in values.values) {
           if (preconditions.preconditions[i].isSatisfied(values.values[i]).not().toBoolean())
-            throw new Error(`precondition for state field ${i} not satisified`);
+            throw new Error(`precondition for state field ${i} not satisfied`);
         }
       },
       () => {
@@ -495,7 +495,7 @@ const StateValues = {
 
     //   for(const i in state) {
     //     if(statePreconditions.preconditions[i].isSatisfied(state[i]).not().toBoolean())
-    //       throw new Error(`precondition for state field ${i} not satisified`);
+    //       throw new Error(`precondition for state field ${i} not satisfied`);
     //   }
     // } else {
     //   // TODO: evaluate these directly on the custom state representation and give meaningful errors
diff --git a/src/lib/proof-system/proof.ts b/src/lib/proof-system/proof.ts
@@ -202,7 +202,7 @@ class Proof<Input, Output> extends ProofBase<Input, Output> {
 let sideloadedKeysCounter = 0;
 
 /**
- * The `DynamicProof` class enables circuits to verify proofs using in-ciruit verfication keys.
+ * The `DynamicProof` class enables circuits to verify proofs using in-ciruit verification keys.
  * This is opposed to the baked-in verification keys of the `Proof` class.
  *
  * In order to use this, a subclass of DynamicProof that specifies the public input and output types along with the maxProofsVerified number has to be created.
diff --git a/src/lib/proof-system/zkprogram.ts b/src/lib/proof-system/zkprogram.ts
@@ -562,7 +562,7 @@ function ZkProgram<
     provers
   );
 
-  // Object.assign only shallow-copies, hence we cant use this getter and have to define it explicitly
+  // Object.assign only shallow-copies, hence we can't use this getter and have to define it explicitly
   Object.defineProperty(program, 'proofsEnabled', {
     get: () => doProving,
   });
diff --git a/src/lib/provable/bigint.ts b/src/lib/provable/bigint.ts
@@ -314,7 +314,7 @@ function createProvableBigInt(modulus: bigint, config?: BigIntParameter) {
     /**
      * Subtracts one ProvableBigInt from another
      * Cost: Cheap
-     * @param a The ProvableBigInt to substract
+     * @param a The ProvableBigInt to subtract
      * @returns The difference as a ProvableBigInt
      */
     sub(a: ProvableBigInt_): ProvableBigInt_ {
diff --git a/src/lib/provable/core/fieldvar.ts b/src/lib/provable/core/fieldvar.ts
@@ -31,7 +31,7 @@ enum FieldType {
 }
 
 /**
- * `FieldVar` is the core data type in snarky. It is eqivalent to `Cvar.t` in OCaml.
+ * `FieldVar` is the core data type in snarky. It is equivalent to `Cvar.t` in OCaml.
  * It represents a field element that is part of provable code - either a constant or a variable.
  *
  * **Variables** end up filling the witness columns of a constraint system.
diff --git a/src/lib/provable/gadgets/blake2b.ts b/src/lib/provable/gadgets/blake2b.ts
@@ -104,7 +104,7 @@ function G(v: UInt64[], a: number, b: number, c: number, d: number, x: UInt64, y
  */
 function compress(state: State, last: boolean): State {
   const { h, t, buf } = state;
-  const v = h.concat(BLAKE2B.IV); // initalize local work vector. First half from state and second half from IV.
+  const v = h.concat(BLAKE2B.IV); // initialize local work vector. First half from state and second half from IV.
 
   v[12] = v[12].xor(UInt64.from(t[0])); // low word of the offset
   v[13] = v[13].xor(UInt64.from(t[1])); // high word of the offset
diff --git a/src/lib/provable/group.ts b/src/lib/provable/group.ts
@@ -88,7 +88,7 @@ class Group {
    */
   add(g: Group) {
     if (isConstant(this) && isConstant(g)) {
-      // we check if either operand is zero, because adding zero to g just results in g (and vise versa)
+      // we check if either operand is zero, because adding zero to g just results in g (and vice versa)
       if (this.isZero().toBoolean()) {
         return g;
       } else if (g.isZero().toBoolean()) {
diff --git a/src/lib/provable/merkle-tree-indexed.ts b/src/lib/provable/merkle-tree-indexed.ts
@@ -52,7 +52,7 @@ export { Leaf };
  *
  * Initially, every `IndexedMerkleMap` is populated by a single key-value pair: `(0, 0)`. The value for key `0` can be updated like any other.
  * When keys and values are hash outputs, `(0, 0)` can serve as a convenient way to represent a dummy update to the tree, since 0 is not
- * effciently computable as a hash image, and this update doesn't affect the Merkle root.
+ * efficiently computable as a hash image, and this update doesn't affect the Merkle root.
  */
 function IndexedMerkleMap(height: number): typeof IndexedMerkleMapBase {
   assert(height > 0, 'height must be positive');
diff --git a/src/lib/provable/scalar-field.ts b/src/lib/provable/scalar-field.ts
@@ -19,7 +19,7 @@ class ScalarField extends createForeignField(Fq.modulus) {
 
   public static toScalar(field: ForeignField) {
     if (field.modulus !== Fq.modulus) {
-      throw new Error('Only ForeignFields with Fq modulus are convertable into a scalar');
+      throw new Error('Only ForeignFields with Fq modulus are convertible into a scalar');
     }
     const field3 = field.value;
     const shiftedScalar = field3ToShiftedScalar(field3);
diff --git a/src/lib/provable/test/bigint.test.ts b/src/lib/provable/test/bigint.test.ts
@@ -280,7 +280,7 @@ describe('BigInt17', () => {
       expect(result.toBigInt()).toStrictEqual(0n);
     });
 
-    it('should throw when square root doesnt exist', () => {
+    it('should throw when square root does not exist', () => {
       const a = BigInt17.fromBigInt(5n);
       expect(() => a.sqrt()).toThrowError();
     });
@@ -855,7 +855,7 @@ describe('BigInt255', () => {
       expect(result.toBigInt()).toStrictEqual(0n);
     });
 
-    it('should throw when square root doesnt exist', () => {
+    it('should throw when square root does not exist', () => {
       const a = BigInt255.fromBigInt(5n);
       expect(() => a.sqrt()).toThrowError();
     });
@@ -1489,7 +1489,7 @@ describe('BigInt381', () => {
       expect(result.toBigInt()).toStrictEqual(0n);
     });
 
-    it('should throw when square root doesnt exist', () => {
+    it('should throw when square root does not exist', () => {
       const a = BigInt381.fromBigInt(5n);
       expect(() => a.sqrt()).toThrowError();
     });
@@ -2123,7 +2123,7 @@ describe('BigInt512', () => {
       expect(result.toBigInt()).toStrictEqual(0n);
     });
 
-    it('should throw when square root doesnt exist', () => {
+    it('should throw when square root does not exist', () => {
       const a = BigInt512.fromBigInt(5n);
       expect(() => a.sqrt()).toThrowError();
     });
diff --git a/src/lib/provable/test/nullifier.unit-test.ts b/src/lib/provable/test/nullifier.unit-test.ts
@@ -27,7 +27,7 @@ let jsonNullifier2 = createNullifier(
   sk_faulty
 );
 
-// trying to manipulate the nullifier to take a real pk that it doesnt know the sk to
+// trying to manipulate the nullifier to take a real pk that it does not know the sk to
 let pk = priv.toPublicKey().toGroup();
 jsonNullifier2.publicKey = {
   x: pk.x.toBigInt(),
diff --git a/src/lib/provable/types/struct.ts b/src/lib/provable/types/struct.ts
@@ -102,7 +102,7 @@ type AnyConstructor = Constructor<any>;
  * ```
  *
  * In addition to creating types composed of Field elements, you can also include auxiliary data which does not become part of the proof.
- * This, for example, allows you to re-use the same type outside o1js methods, where you might want to store additional metadata.
+ * This, for example, allows you to reuse the same type outside o1js methods, where you might want to store additional metadata.
  *
  * To declare non-proof values of type `string`, `number`, etc, you can use the built-in objects `String`, `Number`, etc.
  * Here's how we could add the voter's name (a string) as auxiliary data:
diff --git a/src/lib/provable/wrapped-classes.ts b/src/lib/provable/wrapped-classes.ts
@@ -20,5 +20,5 @@ Bytes.from = InternalBytes.from;
 Bytes.fromHex = InternalBytes.fromHex;
 Bytes.fromString = InternalBytes.fromString;
 
-// expore base class so that we can detect Bytes with `instanceof`
+// expose base class so that we can detect Bytes with `instanceof`
 Bytes.Base = InternalBytes;

Original file line number	Diff line number	Diff line change
`@@ -503,7 +503,7 @@ export async function testSet(`
`503`	`503`	`}`
`504`	`504`
`505`	`505`	`// the merkle roots of both membership contract should still be the initial ones because publish hasn't been invoked`
`506`		`- // therefor the state should not have changes`
	`506`	`+ // therefore the state should not have changes`
`507`	`507`	`if (!candidateContract.committedMembers.get().equals(initialRoot).toBoolean()) {`
`508`	`508`	`throw Error('candidate merkle root is not the initialroot');`
`509`	`509`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1129,7 +1129,7 @@ class AccountUpdate implements Types.AccountUpdate {`
`1129`	`1129`	* This function acts as the `check()` method on an `AccountUpdate` that is sent to the Mina node as part of a transaction.
`1130`	`1130`	`*`
`1131`	`1131`	`* Background: the Mina node performs most necessary validity checks on account updates, both in- and outside of circuits.`
`1132`		`- * To save constraints, we don't repeat these checks in zkApps in places where we can be sure the checked account udpates`
	`1132`	`+ * To save constraints, we don't repeat these checks in zkApps in places where we can be sure the checked account updates`
`1133`	`1133`	`* will be part of a transaction.`
`1134`	`1134`	`*`
`1135`	`1135`	`* However, there are a few checks skipped by the Mina node, that could cause vulnerabilities in zkApps if`