Skip to content

Commit

Permalink
Merge pull request #306 from nnsW3/Docs-improvements
Browse files Browse the repository at this point in the history
Docs improvements
  • Loading branch information
critesjosh authored Jun 25, 2024
2 parents f1352b7 + 62b27da commit 3c45b9e
Show file tree
Hide file tree
Showing 8 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion NOMENCLATURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Locally run an Aztec Client and an Ethereum Client that it rolls up to.
# Glossary and Nomenclature - Note specific terms

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

## "Consume" (Note read)
Nullifying a note after reading it in a transaction.
2 changes: 1 addition & 1 deletion hackathons/INSPIRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ These projects would be implemented as, or in conjunction with, Aztec contracts:
- **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)
- **ZKollateral** - privately prove assets for collateral or creditworthiness for a loan
- **Proof of Liquidity** - privately prove solvency and/or compliance without exposing the underlying assets or trades
- **Private DEX** - allow users to trade assets without revealing the accounts that the assets originate from.
- **Private DEX** - allows users to trade assets without revealing the accounts that the assets originate from.
- **Oracles** - private and/or public price oracles will be critical infrastructure for building DeFi on Aztec.

## Tooling 🔧
Expand Down
2 changes: 1 addition & 1 deletion hackathons/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ When you are ready to submit your project, please provide:
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
2 changes: 1 addition & 1 deletion hackathons/TOOLS.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
- [SKProof](https://github.com/0x3327/skproof) - a Scikit-learn compatible Python library for generating ZK proofs of execution
- [ML](https://github.com/metavind/noir-ml) - a library for implementing neural networks in Noir
- [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
- [Matrix Operations](https://github.com/storswiftlabs/matrix_operations) - a library for matrix operations provides functionality for performing various matrix operations
- [Matrix Operations](https://github.com/storswiftlabs/matrix_operations) - a library for matrix operations that provides functionality for performing various matrix operations
- [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.

##### Miscellaneous
Expand Down
2 changes: 1 addition & 1 deletion tutorials/sandbox-tutorial/src/e2e_sandbox_example.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ describe('e2e_sandbox_example', () => {
expect(typeof nodeInfo.l1ContractAddresses.rollupAddress).toBe('object');

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

// docs:start:load_accounts
////////////// LOAD SOME ACCOUNTS FROM THE SANDBOX //////////////
Expand Down
2 changes: 1 addition & 1 deletion tutorials/simple-private-token/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ Now in your `package.json` add a `scripts` section and set `"type":"module"`:
},
```
Create a `tsconfig.json` in the root and use your favourite config settings. Here’s an example:
Create a `tsconfig.json` in the root and use your favorite config settings. Here’s an example:
```json
{
Expand Down
2 changes: 1 addition & 1 deletion tutorials/token-bridge/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ Execution contexts for an Aztec transaction:

1. Private Execution

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.
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.

2. Public Execution

Expand Down
2 changes: 1 addition & 1 deletion tutorials/token-contract/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ contract Token {
#[aztec(public)]
internal fn _reduce_total_supply(amount: Field) {}

// Unconstrained functions (read only)
// Unconstrained functions (read-only)

unconstrained fn admin() -> Field {}

Expand Down

0 comments on commit 3c45b9e

Please sign in to comment.