Skip to content

Commit fc13cef

Browse files
committed
docs: fix readmes and changelog typos
1 parent eadfa80 commit fc13cef

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
4545
- New transaction construction API `new ZkappCommand()`. https://github.com/o1-labs/o1js/pull/2042
4646
- Bump up Rust version to 1.79.0. Bindings now depends on nightly-2024-06-13.
4747
https://github.com/o1-labs/o1js/pull/2063
48-
- `setVerificationKeyUnsafe` static method to `SmartContract` [#2091](httpts://github.com/o1-labs/o1js/pull/2091)
48+
- `setVerificationKeyUnsafe` static method to `SmartContract` [#2091](https://github.com/o1-labs/o1js/pull/2091)
4949
- `toBits()` and `fromBits()` methods added for `UInt32` and `UInt64` classes. https://github.com/o1-labs/o1js/pull/2099
5050
- **Provable BigInt** exposed through the `createProvableBigInt()` class factory https://github.com/o1-labs/o1js/pull/2008
5151

@@ -92,7 +92,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
9292
- Method for optional types to assert none https://github.com/o1-labs/o1js/pull/1922
9393
- Increased maximum supported amount of methods in a `SmartContract` or `ZkProgram` to 30. https://github.com/o1-labs/o1js/pull/1918
9494
- Expose low-level conversion methods `Proof.{_proofToBase64,_proofFromBase64}` https://github.com/o1-labs/o1js/pull/1928
95-
- Expore `maxProofsVerified()` and a `Proof` class directly on ZkPrograms https://github.com/o1-labs/o1js/pull/1933
95+
- Expose `maxProofsVerified()` and a `Proof` class directly on ZkPrograms https://github.com/o1-labs/o1js/pull/1933
9696

9797
### Changed
9898

@@ -267,7 +267,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
267267

268268
### Deprecated
269269

270-
- `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
270+
- `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
271271

272272
## [1.3.1](https://github.com/o1-labs/o1js/compare/1ad7333e9e...40c597775) - 2024-06-11
273273

@@ -938,7 +938,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
938938
### Fixed
939939

940940
- 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
941-
- Previously, you could work around this by calling `fetchAccount()` for every account invovled in a transaction. This is not necessary anymore.
941+
- Previously, you could work around this by calling `fetchAccount()` for every account involved in a transaction. This is not necessary anymore.
942942
- Update the zkApp verification key from within one of its own methods, via proof https://github.com/o1-labs/o1js/pull/812
943943

944944
## [0.9.4](https://github.com/o1-labs/o1js/compare/9acec55...21de489)

README-dev.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ This command compiles the TypeScript source files, making them ready for use. Th
3939

4040
Much like the mina repo, we use the nix registry to conveniently handle git submodules.
4141
You can enter the devshell with `./pin.sh` and `nix develop o1js#default` or by using
42-
direnv with the `.envrc` provided. This devshell provides all the dependencies required for npm scripts including `npm run:update-bindings`.
42+
direnv with the `.envrc` provided. This devshell provides all the dependencies required for npm scripts including `npm run build:update-bindings`.
4343

4444
## Building Bindings
4545

@@ -93,7 +93,7 @@ This can also be helpful when the bindings don't build identically, as unfortuna
9393

9494
To use this patch:
9595

96-
- Click details on the `Build o1js bindings / build-bindings-ubunutu` job
96+
- Click details on the `Build o1js bindings / build-bindings-ubuntu` job
9797
- Go to the `patch-upload` job and expand the logs for `Upload patch`
9898
- Download the file linked in the last line of the logs ie.
9999
`Artifact download URL: https://github.com/o1-labs/o1js/actions/runs/12401083741/artifacts/2339952965`
@@ -137,7 +137,7 @@ This repo uses minimal [oxlint](https://oxc.rs/docs/guide/usage/linter.html) and
137137

138138
1. Check for style violations by running the npm commands `npm run lint path/to/file` and `npm run format:check path/to/file`
139139

140-
- To attempt to fix all style violations in all changed filed, you can run:
140+
- To attempt to fix all style violations in all changed files, you can run:
141141
- `git diff --cached --name-only --diff-filter=d | grep -E '\.(ts|js)$' | xargs npm run format`
142142
- and `git diff --cached --name-only --diff-filter=d | grep -E '\.(ts|js)$' | xargs npm run lint:fix`
143143

@@ -147,7 +147,7 @@ This repo uses minimal [oxlint](https://oxc.rs/docs/guide/usage/linter.html) and
147147

148148
3. Enable pre-commit hooks
149149

150-
- 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`
150+
- 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`
151151

152152
> [!NOTE]
153153
> 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

README-nix.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ npm run build:update-bindings
9999
```
100100
101101
If you need to update the underlying `mina` code, you can also do so with Nix,
102-
but from the corresopnding subdirectory. In particular, you should build Mina
102+
but from the corresponding subdirectory. In particular, you should build Mina
103103
from the o1js subdirectory from a Nix shell. That means,
104104
105105
```console
@@ -118,14 +118,14 @@ Nix has a garbage collector that **is not used by default** after every run. Ins
118118
119119
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.
120120
121-
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.
121+
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.
122122
123123
### Runtime optimization
124124
125125
Other configurations are worth adding into your `/etc/nix/nix.conf`:
126126
127127
```bash
128-
keep-otuputs = true
128+
keep-outputs = true
129129
max-jobs = 20
130130
extra-substituters = https://storage.googleapis.com/mina-nix-cache
131131
extra-trusted-public-keys = nix-cache.minaprotocol.org:fdcuDzmnM0Kbf7yU4yywBuUEJWClySc1WIF6t6Mm8h4= nix-cache.minaprotocol.org:D3B1W+V7ND1Fmfii8EhbAbF1JXoe2Ct4N34OKChwk2c= mina-nix-cache-1:djtioLfv2oxuK2lqPUgmZbf8bY8sK/BnYZCU2iU5Q10=

0 commit comments

Comments
 (0)