Skip to content

Commit 3c45b9e

Browse files
authored
Merge pull request #306 from nnsW3/Docs-improvements
Docs improvements
2 parents f1352b7 + 62b27da commit 3c45b9e

File tree

8 files changed

+8
-8
lines changed

8 files changed

+8
-8
lines changed

NOMENCLATURE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Locally run an Aztec Client and an Ethereum Client that it rolls up to.
5151
# Glossary and Nomenclature - Note specific terms
5252

5353
## "Preimage" (Note Hash context)
54-
Note contents and additional data that is has been hashed into a Note Hash
54+
Note contents and additional data that have been hashed into a Note Hash
5555

5656
## "Consume" (Note read)
5757
Nullifying a note after reading it in a transaction.

hackathons/INSPIRATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ These projects would be implemented as, or in conjunction with, Aztec contracts:
1818
- **Private lending front end** - you can see an example [here](https://github.com/AztecProtocol/aztec-packages/tree/master/noir-projects/noir-contracts/contracts/lending_contract)
1919
- **ZKollateral** - privately prove assets for collateral or creditworthiness for a loan
2020
- **Proof of Liquidity** - privately prove solvency and/or compliance without exposing the underlying assets or trades
21-
- **Private DEX** - allow users to trade assets without revealing the accounts that the assets originate from.
21+
- **Private DEX** - allows users to trade assets without revealing the accounts that the assets originate from.
2222
- **Oracles** - private and/or public price oracles will be critical infrastructure for building DeFi on Aztec.
2323

2424
## Tooling 🔧

hackathons/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,4 @@ When you are ready to submit your project, please provide:
6464
| ZKvote.cc | [project](https://ethglobal.com/showcase/zkvote-cc-rsvkt) | To address the challenges of cross-chain voting, our protocol integrates Voting tokens with standard ERC-20 via bridge, processes voting off-chain, and employs ZK proofs for secure L2 State transfer. This ensures compatibility with existing bridge architectures. | ETHIstanbul |
6565
| Pepe's Computation | [project](https://ethglobal.com/showcase/pepes-computation-q2v90) | Moving from a centralized gaming industry to a decentralized future in which individuals can shape the roadmap games are taking. "Pepe's Party Computation" uses zk-SNARKS and two-party computation to solve trustless self-policing and decentralized fog-of-war | ETHIstanbul |
6666
| Sarma+EVM=ZKEVM,PEXC | [project](https://ethglobal.com/showcase/sarma-evm-zkevm-pexc-9wp7o) | Sarma: simple primitive to achieve private execution on EVM, even cross-chain. | ETHIstabul |
67-
| Vitalik's Secret | [project](https://ethglobal.com/showcase/vitaliks-secret-ajwsw) | A world scale puzzle that challenge anyone to find the best solution. It is a NP-hard problem so rife for exploration | ETHIstanbul |
67+
| Vitalik's Secret | [project](https://ethglobal.com/showcase/vitaliks-secret-ajwsw) | A world-scale puzzle that challenge anyone to find the best solution. It is a NP-hard problem so rife for exploration | ETHIstanbul |

hackathons/TOOLS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
- [SKProof](https://github.com/0x3327/skproof) - a Scikit-learn compatible Python library for generating ZK proofs of execution
6262
- [ML](https://github.com/metavind/noir-ml) - a library for implementing neural networks in Noir
6363
- [zkML-Noir](https://github.com/storswiftlabs/zkml-noir) - a library for Python ML model transcoding Noir, including various algorithms such as Decision tree, K-Means, XGBoost, FNN, CNN
64-
- [Matrix Operations](https://github.com/storswiftlabs/matrix_operations) - a library for matrix operations provides functionality for performing various matrix operations
64+
- [Matrix Operations](https://github.com/storswiftlabs/matrix_operations) - a library for matrix operations that provides functionality for performing various matrix operations
6565
- [Convolution](https://github.com/storswiftlabs/convolution) - a library for Convolutional Neural Network (CNN) library in Noir, including Convolutional layers, Pooling layers, and Linear (fully connected) layers.
6666

6767
##### Miscellaneous

tutorials/sandbox-tutorial/src/e2e_sandbox_example.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ describe('e2e_sandbox_example', () => {
4040
expect(typeof nodeInfo.l1ContractAddresses.rollupAddress).toBe('object');
4141

4242
// For the sandbox quickstart we just want to show them preloaded accounts (since it is a quickstart)
43-
// We show creation of accounts in a later test
43+
// We show the creation of accounts in a later test
4444

4545
// docs:start:load_accounts
4646
////////////// LOAD SOME ACCOUNTS FROM THE SANDBOX //////////////

tutorials/simple-private-token/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ Now in your `package.json` add a `scripts` section and set `"type":"module"`:
370370
},
371371
```
372372
373-
Create a `tsconfig.json` in the root and use your favourite config settings. Here’s an example:
373+
Create a `tsconfig.json` in the root and use your favorite config settings. Here’s an example:
374374
375375
```json
376376
{

tutorials/token-bridge/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ Execution contexts for an Aztec transaction:
175175

176176
1. Private Execution
177177

178-
Users provide inputs and execute locally on a their device for privacy reasons. Outputs of the private execution are commitment and nullifier updates, a proof of correct execution and any return data to pass to the public execution context.
178+
Users provide inputs and execute locally on their device for privacy reasons. Outputs of the private execution are commitment and nullifier updates, a proof of correct execution and any return data to pass to the public execution context.
179179

180180
2. Public Execution
181181

tutorials/token-contract/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ contract Token {
127127
#[aztec(public)]
128128
internal fn _reduce_total_supply(amount: Field) {}
129129

130-
// Unconstrained functions (read only)
130+
// Unconstrained functions (read-only)
131131

132132
unconstrained fn admin() -> Field {}
133133

0 commit comments

Comments
 (0)