From 4777a113491c4c9901b4589a9a6cb1e1148c0288 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Bene=C5=A1?= Date: Thu, 12 Oct 2023 17:17:27 +0200 Subject: [PATCH] chore: spell check (#2817) Fixes #1134 + a lot of typo fixes + nuking british spelling --- .circleci/config.yml | 4 +- .vscode/extensions.json | 2 + CHANGELOG.md | 6 +- barretenberg/CHANGELOG.md | 4 +- barretenberg/cpp/CMakeLists.txt | 2 +- barretenberg/cpp/cmake/module.cmake | 4 +- barretenberg/cpp/src/CMakeLists.txt | 6 +- .../dsl/acir_format/block_constraint.cpp | 2 +- .../dsl/acir_format/schnorr_verify.cpp | 2 +- .../honk/composer/eccvm_composer.test.cpp | 2 +- .../proofs/join_split/join_split.test.cpp | 2 +- .../barretenberg/polynomials/polynomial.cpp | 2 +- .../stdlib/primitives/bool/bool.cpp | 2 +- circuits/cpp/CMakeLists.txt | 2 +- circuits/cpp/cmake/module.cmake | 4 +- .../circuits/abis/function_leaf_preimage.hpp | 2 +- .../cpp/src/aztec3/circuits/abis/packers.hpp | 4 +- .../cpp/src/aztec3/circuits/apps/.test.cpp | 8 +- .../apps/function_execution_context.hpp | 4 +- .../apps/notes/default_private_note/note.hpp | 8 +- .../default_singleton_private_note/note.hpp | 4 +- .../default_singleton_private_note/note.tpp | 20 +- .../circuits/apps/notes/note_interface.hpp | 4 +- .../aztec3/circuits/apps/opcodes/opcodes.hpp | 2 +- .../aztec3/circuits/apps/opcodes/opcodes.tpp | 4 +- .../aztec3/circuits/kernel/public/common.hpp | 2 +- circuits/cpp/src/aztec3/constants.hpp | 2 +- cspell.json | 177 ++++++++++++++++++ .../roadmap/engineering_roadmap.md | 2 +- .../advanced/circuits/rollup_circuits/main.md | 2 +- .../advanced/data_structures/trees.md | 2 +- docs/docs/dev_docs/contracts/compiling.md | 2 +- .../dev_docs/contracts/syntax/context.mdx | 2 +- docs/docs/dev_docs/wallets/main.md | 2 +- .../dev_docs/sandbox/components.md | 6 +- docs/static/img/sandbox_sending_a_tx.svg | 8 +- .../img/sandbox_unconstrained_function.svg | 4 +- .../aztec-nr/aztec/src/constants_gen.nr | 2 +- .../aztec/src/state_vars/singleton.nr | 6 +- yarn-project/aztec.js/src/contract/index.ts | 2 +- .../src/barretenberg/crypto/aes128/index.ts | 4 +- .../barretenberg/crypto/ecdsa/signature.ts | 4 +- .../barretenberg/crypto/schnorr/signature.ts | 2 +- .../circuits.js/src/cbind/constants.gen.ts | 2 +- .../circuits.js/src/structs/call_context.ts | 6 +- .../kernel/historic_block_data.test.ts | 16 +- .../src/structs/kernel/historic_block_data.ts | 4 +- .../src/structs/kernel/public_inputs_final.ts | 2 +- .../src/structs/public_call_request.ts | 6 +- .../circuits.js/src/structs/shared.ts | 2 +- .../circuits.js/src/structs/tx_request.ts | 2 +- yarn-project/cli/src/utils.ts | 6 +- .../end-to-end/src/benchmarks/utils.ts | 2 +- yarn-project/end-to-end/src/canary/browser.ts | 2 +- .../end-to-end/src/e2e_card_game.test.ts | 6 +- .../end-to-end/src/e2e_multi_transfer.test.ts | 4 +- yarn-project/end-to-end/src/fixtures/utils.ts | 2 +- .../ethereum/src/deploy_l1_contracts.ts | 2 +- .../foundation/src/eth-address/index.ts | 4 +- .../foundation/src/fields/coordinate.ts | 2 +- yarn-project/foundation/src/fields/point.ts | 2 +- .../src/fifo/bounded_serial_queue.ts | 6 +- .../foundation/src/fifo/serial_queue.ts | 2 +- .../foundation/src/json-rpc/README.md | 2 +- .../foundation/src/json-rpc/convert.ts | 2 +- .../foundation/src/log/log_history.test.ts | 22 +-- .../foundation/src/running-promise/index.ts | 6 +- yarn-project/foundation/src/sleep/index.ts | 8 +- .../src/contract-interface-gen/noir.ts | 6 +- yarn-project/noir-contracts/README.md | 2 +- .../scripts/get_all_libraries.sh | 2 +- .../src/ecdsa_public_key_note.nr | 8 +- yarn-project/p2p/src/client/mocks.ts | 2 +- yarn-project/p2p/src/client/p2p_client.ts | 2 +- yarn-project/p2p/src/service/dummy_service.ts | 2 +- .../p2p/src/service/libp2p_service.ts | 2 +- yarn-project/p2p/src/tx_pool/tx_pool.ts | 2 +- .../src/database/note_spending_info_dao.ts | 2 +- .../pxe/src/note_processor/note_processor.ts | 4 +- .../pxe/src/pxe_service/pxe_service.ts | 2 +- .../pxe/src/synchronizer/synchronizer.ts | 18 +- .../scripts/src/benchmarks/aggregate.ts | 4 +- yarn-project/sequencer-client/src/config.ts | 4 +- .../src/publisher/l1-publisher.ts | 8 +- .../src/sequencer/sequencer.ts | 4 +- yarn-project/sequencer-client/src/utils.ts | 8 +- yarn-project/types/src/interfaces/pxe.ts | 10 +- yarn-project/types/src/l2_block.test.ts | 4 +- yarn-project/types/src/l2_block.ts | 2 +- .../l2_block_downloader.ts | 12 +- yarn-project/types/src/l2_tx.ts | 2 +- .../note_spending_info/browserify-cipher.d.ts | 2 +- yarn-project/types/src/public_data_write.ts | 4 +- yarn-project/types/src/stats/metrics.ts | 2 +- yarn-project/types/src/stats/stats.ts | 4 +- .../server_world_state_synchronizer.test.ts | 2 +- .../src/world-state-db/merkle_trees.ts | 2 +- yarn-project/yarn-project-base/Dockerfile | 8 +- yarn-project/yarn-project-base/README.md | 2 +- 99 files changed, 387 insertions(+), 208 deletions(-) create mode 100644 cspell.json diff --git a/.circleci/config.yml b/.circleci/config.yml index 279e66e9d5b..ad12ed2b33c 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -438,7 +438,7 @@ jobs: - run: name: "Build and test" # We need to force not to use docker buildkit because for some reason on arm only, it ends up making a call - # out to eu-west2 despite the image being locally tagged, resulting in unauthorised 401. Weird docker bug? + # out to eu-west2 despite the image being locally tagged, resulting in unauthorized 401. Weird docker bug? command: | echo "export DOCKER_BUILDKIT=" > $BASH_ENV build aztec-sandbox false arm64 @@ -486,7 +486,7 @@ jobs: - run: name: "Build and test" # We need to force not to use docker buildkit because for some reason on arm only, it ends up making a call - # out to eu-west2 despite the image being locally tagged, resulting in unauthorised 401. Weird docker bug? + # out to eu-west2 despite the image being locally tagged, resulting in unauthorized 401. Weird docker bug? command: | echo "export DOCKER_BUILDKIT=" > $BASH_ENV build pxe false arm64 diff --git a/.vscode/extensions.json b/.vscode/extensions.json index 1d9e5d4870b..988ff79b475 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -36,6 +36,8 @@ "IBM.output-colorizer", // Displays code coverage report information within vscode "ryanluker.vscode-coverage-gutters", + // Spell checking + "streetsidesoftware.code-spell-checker", // End C++/Circuits extensions /////////////////////////////////////// ], diff --git a/CHANGELOG.md b/CHANGELOG.md index 35c5fc75f4d..a32c66e6874 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -199,7 +199,7 @@ * Add boxes to CI ([#2456](https://github.com/AztecProtocol/aztec-packages/issues/2456)) ([a90a185](https://github.com/AztecProtocol/aztec-packages/commit/a90a185bb1d72658c7910366e593303607edf873)) * Add selector to call_context ([#2626](https://github.com/AztecProtocol/aztec-packages/issues/2626)) ([8e317be](https://github.com/AztecProtocol/aztec-packages/commit/8e317be9fafb1daa7bc0bdd08d603ce95d3be2f9)) * AddNote api ([#2535](https://github.com/AztecProtocol/aztec-packages/issues/2535)) ([bb004f4](https://github.com/AztecProtocol/aztec-packages/commit/bb004f4419ca9dba9d8216eaba2e65d3a4a994f8)) -* **aztec_noir:** Abstract storage initialisation ([#2406](https://github.com/AztecProtocol/aztec-packages/issues/2406)) ([974b037](https://github.com/AztecProtocol/aztec-packages/commit/974b037650e7fac6fbc3721359daf5f1891b5a2a)) +* **aztec_noir:** Abstract storage initialization ([#2406](https://github.com/AztecProtocol/aztec-packages/issues/2406)) ([974b037](https://github.com/AztecProtocol/aztec-packages/commit/974b037650e7fac6fbc3721359daf5f1891b5a2a)) * **aztec.js:** Support AddressLike parameters ([#2430](https://github.com/AztecProtocol/aztec-packages/issues/2430)) ([5b5f139](https://github.com/AztecProtocol/aztec-packages/commit/5b5f139af2eb8ceb71e807c49be6c2b54e6e435b)) * Barretenberg/crypto/blake3s supports compile-time hashing ([#2556](https://github.com/AztecProtocol/aztec-packages/issues/2556)) ([da05dd7](https://github.com/AztecProtocol/aztec-packages/commit/da05dd7ea41208aea42efe0aeb838e4d76e2d34a)) * **bb:** Add `bb --version` command ([#2482](https://github.com/AztecProtocol/aztec-packages/issues/2482)) ([530676f](https://github.com/AztecProtocol/aztec-packages/commit/530676f8ec53e63ba24f6fabc9097ae8f5db5fc6)) @@ -227,7 +227,7 @@ * Log topic and contract address in unencrypted logs ([#2595](https://github.com/AztecProtocol/aztec-packages/issues/2595)) ([a5b763f](https://github.com/AztecProtocol/aztec-packages/commit/a5b763fb077b967f592ad4de9e391acf2790a094)), closes [#2580](https://github.com/AztecProtocol/aztec-packages/issues/2580) [#2581](https://github.com/AztecProtocol/aztec-packages/issues/2581) [#2586](https://github.com/AztecProtocol/aztec-packages/issues/2586) [#2587](https://github.com/AztecProtocol/aztec-packages/issues/2587) * Parallelization update for polynomials ([#2311](https://github.com/AztecProtocol/aztec-packages/issues/2311)) ([922fc99](https://github.com/AztecProtocol/aztec-packages/commit/922fc9912a4a88a41eef42fe64ca2b59d859b5b1)) * Restore latest block number ([#2474](https://github.com/AztecProtocol/aztec-packages/issues/2474)) ([6dc2da7](https://github.com/AztecProtocol/aztec-packages/commit/6dc2da70584ed1f1f0f00b3dfeca11610e80cc5a)) -* Serialise L2Block to JSON ([#2496](https://github.com/AztecProtocol/aztec-packages/issues/2496)) ([714c727](https://github.com/AztecProtocol/aztec-packages/commit/714c727a88d4c07b76e456e462ab1cf43bcaea75)) +* Serialize L2Block to JSON ([#2496](https://github.com/AztecProtocol/aztec-packages/issues/2496)) ([714c727](https://github.com/AztecProtocol/aztec-packages/commit/714c727a88d4c07b76e456e462ab1cf43bcaea75)) * Standalone Aztec Node and RPC Server ([#2522](https://github.com/AztecProtocol/aztec-packages/issues/2522)) ([8e355bc](https://github.com/AztecProtocol/aztec-packages/commit/8e355bc8c905d2992678d4a2a3b49d354dfa5bf6)) * Unbox empty box ([#2387](https://github.com/AztecProtocol/aztec-packages/issues/2387)) ([3e3930c](https://github.com/AztecProtocol/aztec-packages/commit/3e3930c6487c3b2a264c7a93bccb25473baf0b22)) * Uniswap private flow ([#2559](https://github.com/AztecProtocol/aztec-packages/issues/2559)) ([39f3a91](https://github.com/AztecProtocol/aztec-packages/commit/39f3a917a3bb88f29d8d17ee6c9e1b2294a45937)) @@ -877,7 +877,7 @@ * Set correct version of RPC & Sandbox when deploying tagged commit ([#1914](https://github.com/AztecProtocol/aztec-packages/issues/1914)) ([898c50d](https://github.com/AztecProtocol/aztec-packages/commit/898c50d594b7515f6ca3b904d31ccf724b683ade)) * Set side effect counter on contract reads ([#1870](https://github.com/AztecProtocol/aztec-packages/issues/1870)) ([1d8881e](https://github.com/AztecProtocol/aztec-packages/commit/1d8881e4872b39195ace523432c0e34bc9081f8d)), closes [#1588](https://github.com/AztecProtocol/aztec-packages/issues/1588) * **simulator:** Use nullifier.value in client's `pendingNullifier` set so `set.has()` works ([#1534](https://github.com/AztecProtocol/aztec-packages/issues/1534)) ([a78daf7](https://github.com/AztecProtocol/aztec-packages/commit/a78daf75e3171d9cfafecba5507d5ae215fdd0ef)) -* **synchroniser:** Store most recent globals hash in the synchroniser, rather than fetching from the latest block ([#1539](https://github.com/AztecProtocol/aztec-packages/issues/1539)) ([1dd6225](https://github.com/AztecProtocol/aztec-packages/commit/1dd62256cc323831418808689496f0506d402fc4)) +* **synchronizer:** Store most recent globals hash in the synchronizer, rather than fetching from the latest block ([#1539](https://github.com/AztecProtocol/aztec-packages/issues/1539)) ([1dd6225](https://github.com/AztecProtocol/aztec-packages/commit/1dd62256cc323831418808689496f0506d402fc4)) * **sync:** Sync latest globals within merkle tree ops ([#1612](https://github.com/AztecProtocol/aztec-packages/issues/1612)) ([03b4cf6](https://github.com/AztecProtocol/aztec-packages/commit/03b4cf67cbd4c1629c2937dfae1ea714248d6d3b)) * Truncate SRS size to the amount of points that we have downloaded ([#1862](https://github.com/AztecProtocol/aztec-packages/issues/1862)) ([0a7058c](https://github.com/AztecProtocol/aztec-packages/commit/0a7058cbda228c9baf378d69c906596e204d804f)) * Try to catch last undefined safety issues ([#2027](https://github.com/AztecProtocol/aztec-packages/issues/2027)) ([12e7486](https://github.com/AztecProtocol/aztec-packages/commit/12e7486c0750f648f51d2b43317df843a3c52bec)) diff --git a/barretenberg/CHANGELOG.md b/barretenberg/CHANGELOG.md index 74c9063bc69..bfa54beb109 100644 --- a/barretenberg/CHANGELOG.md +++ b/barretenberg/CHANGELOG.md @@ -508,7 +508,7 @@ * Multithreaded Sumcheck ([#556](https://github.com/AztecProtocol/barretenberg/issues/556)) ([c4094b1](https://github.com/AztecProtocol/barretenberg/commit/c4094b155ba9d8e914c3e6a5b0d7808945b1eeed)) * **nullifier_tree:** make empty nullifier tree leaves hash be 0 ([#360](https://github.com/AztecProtocol/barretenberg/issues/360)) ([#382](https://github.com/AztecProtocol/barretenberg/issues/382)) ([b85ab8d](https://github.com/AztecProtocol/barretenberg/commit/b85ab8d587b3e93db2aa0f1c4f012e58e5d97915)) * Optimize memory consumption of pedersen generators ([#413](https://github.com/AztecProtocol/barretenberg/issues/413)) ([d60b16a](https://github.com/AztecProtocol/barretenberg/commit/d60b16a14219fd4bd130ce4537c3e94bfa10128f)) -* Parallelised folding in Gemini ([#550](https://github.com/AztecProtocol/barretenberg/issues/550)) ([3b962d3](https://github.com/AztecProtocol/barretenberg/commit/3b962d372491430871443fd1b95fd9e049e233c8)) +* Parallelized folding in Gemini ([#550](https://github.com/AztecProtocol/barretenberg/issues/550)) ([3b962d3](https://github.com/AztecProtocol/barretenberg/commit/3b962d372491430871443fd1b95fd9e049e233c8)) * **pkg-config:** Add a bindir variable ([#239](https://github.com/AztecProtocol/barretenberg/issues/239)) ([611bf34](https://github.com/AztecProtocol/barretenberg/commit/611bf34bcc6f82969a6fe546bf0a7cbecda6d36d)) * Remove TOOLCHAIN logic and replace with CMake presets ([#162](https://github.com/AztecProtocol/barretenberg/issues/162)) ([09db0be](https://github.com/AztecProtocol/barretenberg/commit/09db0be3d09ee12b4b73b03abe8fa4565cdb6660)) * replace `MerkleMembershipConstraint` with`ComputeMerkleRootConstraint` ([#385](https://github.com/AztecProtocol/barretenberg/issues/385)) ([74dbce5](https://github.com/AztecProtocol/barretenberg/commit/74dbce5dfa126ecd6dbda7b758581752f7b6a389)) @@ -584,7 +584,7 @@ * Make the circuit constructors field agnostic so we can check circuits on grumpkin ([#534](https://github.com/AztecProtocol/barretenberg/issues/534)) ([656d794](https://github.com/AztecProtocol/barretenberg/commit/656d7944f94f3da88250f3140838f3e32e9d0174)) * Multithreaded Sumcheck ([#556](https://github.com/AztecProtocol/barretenberg/issues/556)) ([c4094b1](https://github.com/AztecProtocol/barretenberg/commit/c4094b155ba9d8e914c3e6a5b0d7808945b1eeed)) * Optimize memory consumption of pedersen generators ([#413](https://github.com/AztecProtocol/barretenberg/issues/413)) ([d60b16a](https://github.com/AztecProtocol/barretenberg/commit/d60b16a14219fd4bd130ce4537c3e94bfa10128f)) -* Parallelised folding in Gemini ([#550](https://github.com/AztecProtocol/barretenberg/issues/550)) ([3b962d3](https://github.com/AztecProtocol/barretenberg/commit/3b962d372491430871443fd1b95fd9e049e233c8)) +* Parallelized folding in Gemini ([#550](https://github.com/AztecProtocol/barretenberg/issues/550)) ([3b962d3](https://github.com/AztecProtocol/barretenberg/commit/3b962d372491430871443fd1b95fd9e049e233c8)) * Sort includes ([#571](https://github.com/AztecProtocol/barretenberg/issues/571)) ([dfa8736](https://github.com/AztecProtocol/barretenberg/commit/dfa8736136323e62a705066d25bef962a6a0b82d)) * Split plonk and honk tests ([#529](https://github.com/AztecProtocol/barretenberg/issues/529)) ([ba583ff](https://github.com/AztecProtocol/barretenberg/commit/ba583ff00509f636feae7b78304b115e34fc2357)) diff --git a/barretenberg/cpp/CMakeLists.txt b/barretenberg/cpp/CMakeLists.txt index 6ccdef34f04..cf335e5fd06 100644 --- a/barretenberg/cpp/CMakeLists.txt +++ b/barretenberg/cpp/CMakeLists.txt @@ -124,7 +124,7 @@ if(COVERAGE) message(FATAL_ERROR "Couldn't find ${COV_EXECUTABLE_NAME}") endif() - # Add profiling compile options and disable optimisations + # Add profiling compile options and disable optimizations add_compile_options(-fprofile-instr-generate -fcoverage-mapping -O0) # Add a custom target for creating the report diff --git a/barretenberg/cpp/cmake/module.cmake b/barretenberg/cpp/cmake/module.cmake index 27b94b9adc7..996e645e091 100644 --- a/barretenberg/cpp/cmake/module.cmake +++ b/barretenberg/cpp/cmake/module.cmake @@ -6,11 +6,11 @@ # Scans for all .test.cpp files in a subdirectory, and creates a gtest binary named _tests. # Scans for all .bench.cpp files in a subdirectory, and creates a benchmark binary named _bench. # -# We have to get a bit complicated here, due to the fact CMake will not parallelise the building of object files +# We have to get a bit complicated here, due to the fact CMake will not parallelize the building of object files # between dependent targets, due to the potential of post-build code generation steps etc. # To work around this, we create "object libraries" containing the object files. # Then we declare executables/libraries that are to be built from these object files. -# These assets will only be linked as their dependencies complete, but we can parallelise the compilation at least. +# These assets will only be linked as their dependencies complete, but we can parallelize the compilation at least. # This is an interface library that can be used as an install target to include all header files # encountered by the `barretenberg_module` function. There is probably a better way to do this, diff --git a/barretenberg/cpp/src/CMakeLists.txt b/barretenberg/cpp/src/CMakeLists.txt index 51ecf4fabbd..8addf06ba2e 100644 --- a/barretenberg/cpp/src/CMakeLists.txt +++ b/barretenberg/cpp/src/CMakeLists.txt @@ -28,7 +28,7 @@ if(CMAKE_CXX_COMPILER_ID MATCHES "GNU") endif() # We enable -O1 level optimsations, even when compiling debug wasm, otherwise we get "local count too large" at runtime. -# We prioritise reducing size of final artefacts in release with -Oz. +# We prioritise reducing size of final artifacts in release with -Oz. if(WASM) set(CMAKE_CXX_FLAGS_DEBUG "-O1 -g") set(CMAKE_C_FLAGS_DEBUG "-O1 -g") @@ -83,7 +83,7 @@ endif() include(GNUInstallDirs) # For this library we include everything but the env and wasi modules, as it is the responsibility of the -# consumer of this library to define how and in what environment its artefact will run. +# consumer of this library to define how and in what environment its artifact will run. # libbarretenberg + libwasi = a wasi "reactor" that implements it's own env (e.g. logstr), e.g. barretenberg.wasm. # libbarretenberg + env = a wasi "command" that expects a full wasi runtime (e.g. wasmtime), e.g. test binaries. message(STATUS "Compiling all-in-one barretenberg archive") @@ -126,7 +126,7 @@ add_library( if(WASM) # With binaryen installed, it seems its wasm backend optimiser gets invoked automatically. # Due to either a bug in the optimiser, or non-standards compliant c++ in crypto/aes, tests start failing with - # -O3 level optimisations. We force down to -O2 for current workaround. + # -O3 level optimizations. We force down to -O2 for current workaround. # TODO: Time has passed, check if this is still needed. # UPDATE: Uninstall binaryen and any need downstream. set(CMAKE_CXX_FLAGS_RELEASE "-O2") diff --git a/barretenberg/cpp/src/barretenberg/dsl/acir_format/block_constraint.cpp b/barretenberg/cpp/src/barretenberg/dsl/acir_format/block_constraint.cpp index 882d1ac14ed..ff10f339f4b 100644 --- a/barretenberg/cpp/src/barretenberg/dsl/acir_format/block_constraint.cpp +++ b/barretenberg/cpp/src/barretenberg/dsl/acir_format/block_constraint.cpp @@ -35,7 +35,7 @@ void create_block_constraints(Builder& builder, const BlockConstraint constraint field_ct value = poly_to_field_ct(op.value, builder); field_ct index = poly_to_field_ct(op.index, builder); // For a ROM table, constant read should be optimised out: - // The rom_table won't work with a constant read because the table may not be initialised + // The rom_table won't work with a constant read because the table may not be initialized ASSERT(op.index.q_l != 0); // We create a new witness w to avoid issues with non-valid witness assignements: // if witness are not assigned, then w will be zero and table[w] will work diff --git a/barretenberg/cpp/src/barretenberg/dsl/acir_format/schnorr_verify.cpp b/barretenberg/cpp/src/barretenberg/dsl/acir_format/schnorr_verify.cpp index 5c05924b88a..8b7048b52d7 100644 --- a/barretenberg/cpp/src/barretenberg/dsl/acir_format/schnorr_verify.cpp +++ b/barretenberg/cpp/src/barretenberg/dsl/acir_format/schnorr_verify.cpp @@ -71,7 +71,7 @@ void create_schnorr_verify_constraints(Builder& builder, const SchnorrConstraint auto new_sig = convert_signature(builder, input.signature); // From ignorance, you will see me convert a bunch of witnesses from ByteArray -> BitArray // This may not be the most efficient way to do it. It is being used as it is known to work, - // optimisations are welcome! + // optimizations are welcome! // First convert the message of u8 witnesses into a byte_array // Do this by taking each element as a u8 and writing it to the byte array diff --git a/barretenberg/cpp/src/barretenberg/honk/composer/eccvm_composer.test.cpp b/barretenberg/cpp/src/barretenberg/honk/composer/eccvm_composer.test.cpp index 5fb5daafb66..70af8587b2e 100644 --- a/barretenberg/cpp/src/barretenberg/honk/composer/eccvm_composer.test.cpp +++ b/barretenberg/cpp/src/barretenberg/honk/composer/eccvm_composer.test.cpp @@ -18,7 +18,7 @@ namespace test_eccvm_composer { template class ECCVMComposerTests : public ::testing::Test { protected: - // TODO(640): The Standard Honk on Grumpkin test suite fails unless the SRS is initialised for every test. + // TODO(640): The Standard Honk on Grumpkin test suite fails unless the SRS is initialized for every test. void SetUp() override { if constexpr (std::is_same::value) { diff --git a/barretenberg/cpp/src/barretenberg/join_split_example/proofs/join_split/join_split.test.cpp b/barretenberg/cpp/src/barretenberg/join_split_example/proofs/join_split/join_split.test.cpp index ef41bcfbf67..b018a9cd7b8 100644 --- a/barretenberg/cpp/src/barretenberg/join_split_example/proofs/join_split/join_split.test.cpp +++ b/barretenberg/cpp/src/barretenberg/join_split_example/proofs/join_split/join_split.test.cpp @@ -212,7 +212,7 @@ class join_split_tests : public ::testing::Test { uint32_t account_note_index = 0, bool account_required = false) { - // The tree, user and notes are initialised in SetUp(). + // The tree, user and notes are initialized in SetUp(). preload_value_notes(); preload_account_notes(); // indices: [ACCOUNT_INDEX, ACCOUNT_INDEX + 1] return create_join_split_tx(input_indices, diff --git a/barretenberg/cpp/src/barretenberg/polynomials/polynomial.cpp b/barretenberg/cpp/src/barretenberg/polynomials/polynomial.cpp index 31f5496e2bc..e3f94e9c872 100644 --- a/barretenberg/cpp/src/barretenberg/polynomials/polynomial.cpp +++ b/barretenberg/cpp/src/barretenberg/polynomials/polynomial.cpp @@ -130,7 +130,7 @@ template Fr Polynomial::evaluate(const Fr& z) const /** * @brief sets a block of memory to all zeroes * Used to zero out unintialized memory to ensure that, when writing to the polynomial in future, - * memory requests made to the OS do not return virtual pages (performance optimisation). + * memory requests made to the OS do not return virtual pages (performance optimization). * Used, for example, when one polynomial is instantiated from another one with size_>= other.size_. * * @param opening_proof Opening proof computed by `batch_open` diff --git a/barretenberg/cpp/src/barretenberg/stdlib/primitives/bool/bool.cpp b/barretenberg/cpp/src/barretenberg/stdlib/primitives/bool/bool.cpp index 75d41f19d7b..2ae1043f6b4 100644 --- a/barretenberg/cpp/src/barretenberg/stdlib/primitives/bool/bool.cpp +++ b/barretenberg/cpp/src/barretenberg/stdlib/primitives/bool/bool.cpp @@ -450,7 +450,7 @@ template void bool_t::must_imply(const bool_t& other } /** - * Process many implications all at once, for readablity, and as an optimisation. + * Process many implications all at once, for readablity, and as an optimization. * @param conds - each pair is a boolean condition that we want to constrain to be "implied", and an error message if it * is not implied. * diff --git a/circuits/cpp/CMakeLists.txt b/circuits/cpp/CMakeLists.txt index a3286d6121f..e7350df4d34 100644 --- a/circuits/cpp/CMakeLists.txt +++ b/circuits/cpp/CMakeLists.txt @@ -129,7 +129,7 @@ if(COVERAGE) message(FATAL_ERROR "Couldn't find ${COV_EXECUTABLE_NAME}") endif() - # Add profiling compile options and disable optimisations + # Add profiling compile options and disable optimizations add_compile_options(-fprofile-instr-generate -fcoverage-mapping -O0) # Add a custom target for creating the report diff --git a/circuits/cpp/cmake/module.cmake b/circuits/cpp/cmake/module.cmake index 60b265c1d9c..aaa9655c344 100644 --- a/circuits/cpp/cmake/module.cmake +++ b/circuits/cpp/cmake/module.cmake @@ -6,11 +6,11 @@ # Scans for all .test.cpp files in a subdirectory, and creates a gtest binary named _tests. # Scans for all .bench.cpp files in a subdirectory, and creates a benchmark binary named _bench. # -# We have to get a bit complicated here, due to the fact CMake will not parallelise the building of object files +# We have to get a bit complicated here, due to the fact CMake will not parallelize the building of object files # between dependent targets, due to the potential of post-build code generation steps etc. # To work around this, we create "object libraries" containing the object files. # Then we declare executables/libraries that are to be built from these object files. -# These assets will only be linked as their dependencies complete, but we can parallelise the compilation at least. +# These assets will only be linked as their dependencies complete, but we can parallelize the compilation at least. function(circuits_cmake_module MODULE_NAME) file(GLOB_RECURSE SOURCE_FILES *.cpp) diff --git a/circuits/cpp/src/aztec3/circuits/abis/function_leaf_preimage.hpp b/circuits/cpp/src/aztec3/circuits/abis/function_leaf_preimage.hpp index b81c2bf4523..bb82a8c69aa 100644 --- a/circuits/cpp/src/aztec3/circuits/abis/function_leaf_preimage.hpp +++ b/circuits/cpp/src/aztec3/circuits/abis/function_leaf_preimage.hpp @@ -24,7 +24,7 @@ using std::is_same; * This struct includes a `hash()` function for computing its pedersen compression. * There are also static functions for: * - converting preimages between native/circuit types - * - serialising and deserialising preimages + * - serializing and deserializing preimages * - writing a preimage to an ostream */ template struct FunctionLeafPreimage { diff --git a/circuits/cpp/src/aztec3/circuits/abis/packers.hpp b/circuits/cpp/src/aztec3/circuits/abis/packers.hpp index fb001b0f049..8742e895677 100644 --- a/circuits/cpp/src/aztec3/circuits/abis/packers.hpp +++ b/circuits/cpp/src/aztec3/circuits/abis/packers.hpp @@ -107,7 +107,7 @@ struct GeneratorIndexPacker { int UNIQUE_COMMITMENT = GeneratorIndex::UNIQUE_COMMITMENT; int SILOED_COMMITMENT = GeneratorIndex::SILOED_COMMITMENT; int NULLIFIER = GeneratorIndex::NULLIFIER; - int INITIALISATION_NULLIFIER = GeneratorIndex::INITIALISATION_NULLIFIER; + int INITIALIZATION_NULLIFIER = GeneratorIndex::INITIALIZATION_NULLIFIER; int OUTER_NULLIFIER = GeneratorIndex::OUTER_NULLIFIER; int PUBLIC_DATA_READ = GeneratorIndex::PUBLIC_DATA_READ; int PUBLIC_DATA_UPDATE_REQUEST = GeneratorIndex::PUBLIC_DATA_UPDATE_REQUEST; @@ -144,7 +144,7 @@ struct GeneratorIndexPacker { UNIQUE_COMMITMENT, SILOED_COMMITMENT, NULLIFIER, - INITIALISATION_NULLIFIER, + INITIALIZATION_NULLIFIER, OUTER_NULLIFIER, PUBLIC_DATA_READ, PUBLIC_DATA_UPDATE_REQUEST, diff --git a/circuits/cpp/src/aztec3/circuits/apps/.test.cpp b/circuits/cpp/src/aztec3/circuits/apps/.test.cpp index d847c14c699..9fd343b1366 100644 --- a/circuits/cpp/src/aztec3/circuits/apps/.test.cpp +++ b/circuits/cpp/src/aztec3/circuits/apps/.test.cpp @@ -300,7 +300,7 @@ TEST_F(state_var_tests, circuit_initialise_utxo_of_default_singleton_private_not // FUNCTION: // This time we use a slightly different Note type, which is tailored towards singleton UTXO use-cases. In - // particular, it copes with the distinction between initialisation of the UTXO, vs future modification of the UTXO. + // particular, it copes with the distinction between initialization of the UTXO, vs future modification of the UTXO. using Note = DefaultSingletonPrivateNote; UTXO my_utxo(&exec_ctx, "my_utxo"); @@ -315,9 +315,9 @@ TEST_F(state_var_tests, circuit_initialise_utxo_of_default_singleton_private_not // The person who may initialise the note might be different from the person who's actually given the note to own. // (E.g. the caller of this function might be the deployer of the contract, who is initialising notes on behalf of // other users) - CT::address owner_of_initialised_note = 888888; + CT::address owner_of_initialized_note = 888888; - my_utxo.initialise({ .value = 100, .owner = owner_of_initialised_note }); + my_utxo.initialise({ .value = 100, .owner = owner_of_initialized_note }); exec_ctx.finalize(); @@ -348,7 +348,7 @@ TEST_F(state_var_tests, circuit_modify_utxo_of_default_singleton_private_note_fr // FUNCTION: // This time we use a slightly different Note type, which is tailored towards singleton UTXO use-cases. In - // particular, it copes with the distinction between initialisation of the UTXO, vs future modification of the UTXO. + // particular, it copes with the distinction between initialization of the UTXO, vs future modification of the UTXO. using Note = DefaultSingletonPrivateNote; UTXO my_utxo(&exec_ctx, "my_utxo"); diff --git a/circuits/cpp/src/aztec3/circuits/apps/function_execution_context.hpp b/circuits/cpp/src/aztec3/circuits/apps/function_execution_context.hpp index c0107430109..9e41bf07bf3 100644 --- a/circuits/cpp/src/aztec3/circuits/apps/function_execution_context.hpp +++ b/circuits/cpp/src/aztec3/circuits/apps/function_execution_context.hpp @@ -256,7 +256,7 @@ template class FunctionExecutionContext { } /** - * @brief This is an important optimisation, to save on the number of emitted nullifiers. + * @brief This is an important optimization, to save on the number of emitted nullifiers. * * A nullifier is ideal to serve as a nonce for a new note commitment, because its uniqueness is enforced by the * Rollup circuit. But we won't know how many non-dummy nullifiers we have at our disposal (to inject into @@ -268,7 +268,7 @@ template class FunctionExecutionContext { * nullifiers created within the function. Now, at that point, we _could_ generate a dummy nullifier and use that as * a nonce. But that uses up a precious slot in the circuit's nullifiers array (part of the circuit's public inputs * abi). And it might be the case that later in the function, a load of non-dummy nullifiers get created. So as an - * optimisation, it would be better if we could use _those_ nullifiers, so as to minimise dummy values in the + * optimization, it would be better if we could use _those_ nullifiers, so as to minimise dummy values in the * circuit's public inputs. * * And so, we provide the option here of deferring the injection of nonces into note_preimages (and hence deferring diff --git a/circuits/cpp/src/aztec3/circuits/apps/notes/default_private_note/note.hpp b/circuits/cpp/src/aztec3/circuits/apps/notes/default_private_note/note.hpp index 2dcff2259d6..6c2837c5447 100644 --- a/circuits/cpp/src/aztec3/circuits/apps/notes/default_private_note/note.hpp +++ b/circuits/cpp/src/aztec3/circuits/apps/notes/default_private_note/note.hpp @@ -85,16 +85,16 @@ template class DefaultPrivateNote : publi fr generate_nonce() override; - fr get_initialisation_nullifier() override + fr get_initialization_nullifier() override { throw_or_abort( - "DefaultPrivateNote does not support initialisation. Maybe use DefaultSingletonPrivateNote instead?"); + "DefaultPrivateNote does not support initialization. Maybe use DefaultSingletonPrivateNote instead?"); }; - fr get_initialisation_commitment() override + fr get_initialization_commitment() override { throw_or_abort( - "DefaultPrivateNote does not support initialisation. Maybe use DefaultSingletonPrivateNote instead?"); + "DefaultPrivateNote does not support initialization. Maybe use DefaultSingletonPrivateNote instead?"); }; // CUSTOM METHODS diff --git a/circuits/cpp/src/aztec3/circuits/apps/notes/default_singleton_private_note/note.hpp b/circuits/cpp/src/aztec3/circuits/apps/notes/default_singleton_private_note/note.hpp index a5389838cd3..df09571661c 100644 --- a/circuits/cpp/src/aztec3/circuits/apps/notes/default_singleton_private_note/note.hpp +++ b/circuits/cpp/src/aztec3/circuits/apps/notes/default_singleton_private_note/note.hpp @@ -74,9 +74,9 @@ template class DefaultSingletonPrivateNot fr generate_nonce() override; - fr get_initialisation_nullifier() override; + fr get_initialization_nullifier() override; - fr get_initialisation_commitment() override; + fr get_initialization_commitment() override; // CUSTOM METHODS diff --git a/circuits/cpp/src/aztec3/circuits/apps/notes/default_singleton_private_note/note.tpp b/circuits/cpp/src/aztec3/circuits/apps/notes/default_singleton_private_note/note.tpp index 76742963edf..ee976b4eba4 100644 --- a/circuits/cpp/src/aztec3/circuits/apps/notes/default_singleton_private_note/note.tpp +++ b/circuits/cpp/src/aztec3/circuits/apps/notes/default_singleton_private_note/note.tpp @@ -188,13 +188,13 @@ typename CircuitTypes::fr DefaultSingletonPrivateNote::gene }; template -typename CircuitTypes::fr DefaultSingletonPrivateNote::get_initialisation_nullifier() +typename CircuitTypes::fr DefaultSingletonPrivateNote::get_initialization_nullifier() { auto& oracle = get_oracle(); const fr& owner_private_key = oracle.get_msg_sender_private_key(); - // We prevent this storage slot from even being initialised again: + // We prevent this storage slot from even being initialized again: auto& storage_slot_point = state_var->storage_slot_point; const std::vector hash_inputs{ @@ -205,7 +205,7 @@ typename CircuitTypes::fr DefaultSingletonPrivateNote::get_ const bool is_dummy = false; // We compress the hash_inputs with Pedersen, because that's cheap. - const fr compressed_storage_slot_point = CT::compress(hash_inputs, GeneratorIndex::INITIALISATION_NULLIFIER); + const fr compressed_storage_slot_point = CT::compress(hash_inputs, GeneratorIndex::INITIALIZATION_NULLIFIER); // For now, we piggy-back on the regular nullifier function. return DefaultSingletonPrivateNote::compute_nullifier( @@ -213,15 +213,15 @@ typename CircuitTypes::fr DefaultSingletonPrivateNote::get_ }; template -typename CircuitTypes::fr DefaultSingletonPrivateNote::get_initialisation_commitment() +typename CircuitTypes::fr DefaultSingletonPrivateNote::get_initialization_commitment() { /** - * TODO: Get rid of this temporary fix of including owner_private_key while computing the initialisation commitment. - * Details: We need to add the initialisation commitment value to the `nullified_commitments`. - * In this case, since the actual note data is not yet available, we compute the initialisation nullifier as: + * TODO: Get rid of this temporary fix of including owner_private_key while computing the initialization commitment. + * Details: We need to add the initialization commitment value to the `nullified_commitments`. + * In this case, since the actual note data is not yet available, we compute the initialization nullifier as: * null = hash(compressed_storage_slot, owner_private_key, false) * - * Thus, the initialisation commitment here is `compressed_storage_slot`. But since the storage slot is not a real + * Thus, the initialization commitment here is `compressed_storage_slot`. But since the storage slot is not a real * circuit variable, `compressed_storage_slot` would be a circuit constant. The compiler doesn't allow us * to make a circuit constant as a public input of the circuit, it just crashes at runtime. * To avoid this, we compute the initial commitment as: @@ -233,7 +233,7 @@ typename CircuitTypes::fr DefaultSingletonPrivateNote::get_ const fr& owner_private_key = oracle.get_msg_sender_private_key(); - // We prevent this storage slot from even being initialised again: + // We prevent this storage slot from even being initialized again: auto& storage_slot_point = state_var->storage_slot_point; const std::vector hash_inputs{ @@ -243,7 +243,7 @@ typename CircuitTypes::fr DefaultSingletonPrivateNote::get_ }; // We compress the hash_inputs with Pedersen, because that's cheap. - fr compressed_storage_slot_point = CT::compress(hash_inputs, GeneratorIndex::INITIALISATION_NULLIFIER); + fr compressed_storage_slot_point = CT::compress(hash_inputs, GeneratorIndex::INITIALIZATION_NULLIFIER); return compressed_storage_slot_point; }; diff --git a/circuits/cpp/src/aztec3/circuits/apps/notes/note_interface.hpp b/circuits/cpp/src/aztec3/circuits/apps/notes/note_interface.hpp index a56982bb682..f9bfb3c7e94 100644 --- a/circuits/cpp/src/aztec3/circuits/apps/notes/note_interface.hpp +++ b/circuits/cpp/src/aztec3/circuits/apps/notes/note_interface.hpp @@ -38,9 +38,9 @@ template class NoteInterface { virtual fr get_nullifier() = 0; - virtual fr get_initialisation_nullifier() = 0; + virtual fr get_initialization_nullifier() = 0; - virtual fr get_initialisation_commitment() = 0; + virtual fr get_initialization_commitment() = 0; virtual void constrain_against_advice(NoteInterface const& advice_note) = 0; diff --git a/circuits/cpp/src/aztec3/circuits/apps/opcodes/opcodes.hpp b/circuits/cpp/src/aztec3/circuits/apps/opcodes/opcodes.hpp index 59e715f1d0f..bf6b7630f77 100644 --- a/circuits/cpp/src/aztec3/circuits/apps/opcodes/opcodes.hpp +++ b/circuits/cpp/src/aztec3/circuits/apps/opcodes/opcodes.hpp @@ -62,7 +62,7 @@ template class Opcodes { /** * @brief Compute and push a new commitment to the public inputs of this exec_ctx, BUT ALSO compute and produce an - * initialisation nullifier, to prevent this note from being initialised again in the future. + * initialization nullifier, to prevent this note from being initialized again in the future. */ template static void UTXO_INIT(StateVar* state_var, Note& note_to_initialise); diff --git a/circuits/cpp/src/aztec3/circuits/apps/opcodes/opcodes.tpp b/circuits/cpp/src/aztec3/circuits/apps/opcodes/opcodes.tpp index a44bdd04400..7a4d3d1f490 100644 --- a/circuits/cpp/src/aztec3/circuits/apps/opcodes/opcodes.tpp +++ b/circuits/cpp/src/aztec3/circuits/apps/opcodes/opcodes.tpp @@ -122,8 +122,8 @@ void Opcodes::UTXO_NULL(StateVar* state_var, Note& note_to_nul template template void Opcodes::UTXO_INIT(StateVar* state_var, Note& note_to_initialise) { - typename CT::fr const init_nullifier = note_to_initialise.get_initialisation_nullifier(); - typename CT::fr const init_commitment = note_to_initialise.get_initialisation_commitment(); + typename CT::fr const init_nullifier = note_to_initialise.get_initialization_nullifier(); + typename CT::fr const init_commitment = note_to_initialise.get_initialization_commitment(); auto& exec_ctx = state_var->exec_ctx; diff --git a/circuits/cpp/src/aztec3/circuits/kernel/public/common.hpp b/circuits/cpp/src/aztec3/circuits/kernel/public/common.hpp index 7ee34f3d614..a252b5970e0 100644 --- a/circuits/cpp/src/aztec3/circuits/kernel/public/common.hpp +++ b/circuits/cpp/src/aztec3/circuits/kernel/public/common.hpp @@ -442,7 +442,7 @@ void common_update_public_end_values(Builder& builder, /** * @brief Initialises the circuit output end state from provided inputs * @param public_kernel_inputs The inputs to this iteration of the kernel circuit - * @param circuit_outputs The circuit outputs to be initialised + * @param circuit_outputs The circuit outputs to be initialized */ void common_initialise_end_values(PublicKernelInputs const& public_kernel_inputs, KernelCircuitPublicInputs& circuit_outputs); diff --git a/circuits/cpp/src/aztec3/constants.hpp b/circuits/cpp/src/aztec3/constants.hpp index 152c5ce6b56..a9bf9e8bfd1 100644 --- a/circuits/cpp/src/aztec3/constants.hpp +++ b/circuits/cpp/src/aztec3/constants.hpp @@ -146,7 +146,7 @@ enum GeneratorIndex { UNIQUE_COMMITMENT, // Size = 2 SILOED_COMMITMENT, // Size = 2 NULLIFIER, // Size = 4 (unused) - INITIALISATION_NULLIFIER, // Size = 2 (unused) + INITIALIZATION_NULLIFIER, // Size = 2 (unused) OUTER_NULLIFIER, // Size = 2 PUBLIC_DATA_READ, // Size = 2 PUBLIC_DATA_UPDATE_REQUEST, // Size = 3 diff --git a/cspell.json b/cspell.json new file mode 100644 index 00000000000..78b0a83f371 --- /dev/null +++ b/cspell.json @@ -0,0 +1,177 @@ +{ + "words": [ + "tparam", + "abitype", + "acir", + "acvm", + "barretenberg", + "Brillig", + "Bufferable", + "camelcase", + "cbind", + "cbinds", + "composability", + "Daos", + "decrementation", + "delegatecall", + "entrypoints", + "grumpkin", + "hasher", + "keccak", + "keypairs", + "Merkle", + "msgpack", + "Nargo", + "Pedersen", + "Plookup", + "Pokeable", + "preimage", + "preimages", + "pxes", + "rethrown", + "rollup", + "rollups", + "schnorr", + "Signerless", + "struct", + "structs", + "viem", + "fullpath", + "unexclude", + "hardlinks", + "yarnrc", + "memdown", + "tsbuildinfo", + "leveldown", + "isequal", + "rushstack", + "messagebox", + "buildkit", + "unexcluded", + "devs", + "overlayfs", + "wasms", + "interruptible", + "clonedeep", + "callstack", + "callstacks", + "cheatcode", + "flatmap", + "toplevel", + "productionify", + "repr", + "bufs", + "aztecprotocol", + "dbanks", + "rahul", + "herskind", + "danlee", + "suyash", + "diffie", + "bootnode", + "fargate", + "awslogs", + "awsvpc", + "multivalue", + "snakecase", + "upperfirst", + "authwit", + "nullifer", + "unshield", + "codegen", + "secp", + "accum", + "bytecodes", + "yamux", + "libp", + "mplex", + "protobuf", + "pnat", + "chainsafe", + "mockify", + "vals", + "pubkey", + "noirup", + "direnv", + "nixpkgs", + "outdir", + "pako", + "webassembly", + "asyncify", + "indexeddb", + "leveljs", + "filestat", + "prestat", + "transferables", + "proxify", + "proxified", + "proxied", + "typeparam", + "preauthenticated", + "trivago", + "jsons", + "autonat", + "muxers", + "Kademlia", + "mimc", + "gitrepo", + "subrepo", + "typecheck", + "fuzzer", + "fuzzers", + "gtest", + "dockerfiles", + "gitmodules", + "dockerhub", + "utxo", + "sload", + "quickstart", + "otterscan", + "cheatcodes", + "permissionless", + "parallelizable", + "solhint", + "foundryup", + "concat", + "mload", + "calldatacopy", + "ierc", + "erc", + "bbmalloc", + "bbfree", + "archiver", + "sigchld", + "pids", + "comlink", + "checksummed", + "tsdoc", + "muldiv", + "clonedeepwith", + "bodyparser", + "pkgs", + "mktemp", + "unshielding", + "workdir", + "leveldb" + ], + "ignorePaths": [ + "node_modules/", + "dist/", + "build/", + "dest/", + "barretenberg", + "dest", + "node_modules", + ".cache", + ".pnp.cjs", + ".pnp.loader.mjs", + "cmake-build-debug", + ".terraform*", + ".bootstrapped", + "*.svg", + "*.otf", + "git-subrepo/", + "*.snap", + "package.json" + ] +} diff --git a/docs/docs/about_aztec/roadmap/engineering_roadmap.md b/docs/docs/about_aztec/roadmap/engineering_roadmap.md index 55756a69fd6..7f8455187f2 100644 --- a/docs/docs/about_aztec/roadmap/engineering_roadmap.md +++ b/docs/docs/about_aztec/roadmap/engineering_roadmap.md @@ -180,7 +180,7 @@ Some example features: - Revisit the current topology: - We can make the rollup trees 'wonky' (rather than balanced), meaning a sequencer doesn't need to prove a load of pointless 'padding' proofs? - This would also enable new txs (entering the tx pool) to be added to a rollup block 'on-the-fly' (mid way through a rollup being proven) - but of course, the sequencer selection protocol might require an up-front commitment, so this might not be possible for that reason (sad face). - - We can definitely redesign the public kernel circuit to be a '2x2' topology (i.e. a tree of public kernel proofs), to get a logarithmic speed-up (parallelism). The question is, with folding schemes, do we need that optimisation? + - We can definitely redesign the public kernel circuit to be a '2x2' topology (i.e. a tree of public kernel proofs), to get a logarithmic speed-up (parallelism). The question is, with folding schemes, do we need that optimization? #### Refactor of packing & unpacking data in circuits diff --git a/docs/docs/concepts/advanced/circuits/rollup_circuits/main.md b/docs/docs/concepts/advanced/circuits/rollup_circuits/main.md index 6f76754b97d..b1a4f99be70 100644 --- a/docs/docs/concepts/advanced/circuits/rollup_circuits/main.md +++ b/docs/docs/concepts/advanced/circuits/rollup_circuits/main.md @@ -10,7 +10,7 @@ The way we 'squish' all this data is in a 'binary tree of proofs' topology. > Example: If there were 16 txs in a rollup, we'd arrange the 16 kernel proofs into 8 pairs and merge each pair into a single proof (using zk-snark recursion techniques), resulting in 8 output proofs. We'd then arrange those 8 proofs into pairs and again merge each pair into a single proof, resulting in 4 output proofs. And so on until we'd be left with a single proof, which represents the correctness of the original 16 txs. -This 'binary tree of proofs' topology allows proof generation to be greatly parallelised across prover instances. Each layer of the tree can be computed in parallel. Or alternatively, subtrees can be coordinated to be computed in parallel. +This 'binary tree of proofs' topology allows proof generation to be greatly parallelized across prover instances. Each layer of the tree can be computed in parallel. Or alternatively, subtrees can be coordinated to be computed in parallel. > Note: 'binary tree of proofs' is actually an over simlification. The Rollup Circuits are designed so that a Sequencer can actually deviate from a neat, symmetrical tree, for the purposes of efficiency, and instead sometimes create wonky trees. diff --git a/docs/docs/concepts/advanced/data_structures/trees.md b/docs/docs/concepts/advanced/data_structures/trees.md index d2d4034b477..ad801b6a051 100644 --- a/docs/docs/concepts/advanced/data_structures/trees.md +++ b/docs/docs/concepts/advanced/data_structures/trees.md @@ -100,7 +100,7 @@ If a function of a smart contract generates this Nullifier and submits it to the 'Singleton Note' is a term we've been using to mean: "A single Note which contains the whole of a private state's current value, and must be deleted and replaced with another single Note, if one ever wishes to edit that state". It's in contrast to a Note which only contains a small fragment of a Private State's current value. -We've found that such notes require an 'Initialisation Nullifier'; a nullifier which, when emitted, signals the initialisation of this state variable. I.e. the very first time the state variable has been written-to. +We've found that such notes require an 'Initialisation Nullifier'; a nullifier which, when emitted, signals the initialization of this state variable. I.e. the very first time the state variable has been written-to. > There's more on this topic in [the Aztec forum](https://discourse.aztec.network/t/utxo-syntax-2-initialising-singleton-utxos/47). diff --git a/docs/docs/dev_docs/contracts/compiling.md b/docs/docs/dev_docs/contracts/compiling.md index 95b0388e4ca..4751ff03738 100644 --- a/docs/docs/dev_docs/contracts/compiling.md +++ b/docs/docs/dev_docs/contracts/compiling.md @@ -75,7 +75,7 @@ Read more about interacting with contracts using `aztec.js` [here](../getting_st ### Aztec.nr interfaces -An Aztec.nr contract can [call a function](./syntax/functions.md) in another contract via `context.call_private_function` or `context.call_public_function`. However, this requires manually assembling the function selector and manually serialising the arguments, which is not type-safe. +An Aztec.nr contract can [call a function](./syntax/functions.md) in another contract via `context.call_private_function` or `context.call_public_function`. However, this requires manually assembling the function selector and manually serializing the arguments, which is not type-safe. To make this easier, the compiler can generate contract interface structs that expose a convenience method for each function listed in a given contract artifact. These structs are intended to be used from another contract project that calls into the current one. For each contract, two interface structs are generated: one to be used from private functions with a `PrivateContext`, and one to be used from open functions with a `PublicContext`. diff --git a/docs/docs/dev_docs/contracts/syntax/context.mdx b/docs/docs/dev_docs/contracts/syntax/context.mdx index 3b8afffd983..e772b3866e2 100644 --- a/docs/docs/dev_docs/contracts/syntax/context.mdx +++ b/docs/docs/dev_docs/contracts/syntax/context.mdx @@ -94,7 +94,7 @@ New commitments contains an array of all of the commitments created in the curre New nullifiers contains an array of the new nullifiers emitted from the current execution context. ### Nullified Commitments -Nullified commitments is an optimisation for introduced to help reduce state growth. There are often cases where commitments are created and nullified within the same transaction. +Nullified commitments is an optimization for introduced to help reduce state growth. There are often cases where commitments are created and nullified within the same transaction. In these cases there is no reason that these commitments should take up space on the node's commitment/nullifier trees. Keeping track of nullified commitments allows us to "cancel out" and prove these cases. ### Private Call Stack diff --git a/docs/docs/dev_docs/wallets/main.md b/docs/docs/dev_docs/wallets/main.md index b346c8976e4..66da29e8824 100644 --- a/docs/docs/dev_docs/wallets/main.md +++ b/docs/docs/dev_docs/wallets/main.md @@ -14,7 +14,7 @@ The first step for any wallet is to let the user set up their [accounts](../../c A wallet must support at least one specific [account contract implementation](./writing_an_account_contract.md), which means being able to deploy such a contract, as well as interacting with it when sending transactions. Code-wise, this requires [implementing the `AccountContract` interface](https://github.com/AztecProtocol/aztec-packages/blob/master/yarn-project/aztec.js/src/account/contract/index.ts). -Note that users must be able to receive funds in Aztec before deploying their account. A wallet should let a user generate a [deterministic complete address](../../concepts/foundation/accounts/keys.md#addresses-partial-addresses-and-public-keys) without having to interact with the network, so they can share it with others to receive funds. This requires that the wallet pins a specific contract implementation, its initialisation arguments, a deployment salt, and a privacy key. These values yield a deterministic address, so when the account contract is actually deployed, it is available at the precalculated address. Once the account contract is deployed, the user can start sending transactions using it as the transaction origin. +Note that users must be able to receive funds in Aztec before deploying their account. A wallet should let a user generate a [deterministic complete address](../../concepts/foundation/accounts/keys.md#addresses-partial-addresses-and-public-keys) without having to interact with the network, so they can share it with others to receive funds. This requires that the wallet pins a specific contract implementation, its initialization arguments, a deployment salt, and a privacy key. These values yield a deterministic address, so when the account contract is actually deployed, it is available at the precalculated address. Once the account contract is deployed, the user can start sending transactions using it as the transaction origin. ## Transaction lifecycle diff --git a/docs/internal_notes/dev_docs/sandbox/components.md b/docs/internal_notes/dev_docs/sandbox/components.md index 58ba7718f20..313eff2e1d0 100644 --- a/docs/internal_notes/dev_docs/sandbox/components.md +++ b/docs/internal_notes/dev_docs/sandbox/components.md @@ -56,7 +56,7 @@ Responsibilities: Responsibilities: - Returns the sibling path for the given `tree_id` at the given leaf `index`. -- Can be injected into any context that requires path queries for a particular tree. Might be backed by implementations that call out to a server (where privacy doesn't matter, or during early development), or leverages some privacy tech (query via Nym), or could just point to a local `WorldStateSynchroniser`. +- Can be injected into any context that requires path queries for a particular tree. Might be backed by implementations that call out to a server (where privacy doesn't matter, or during early development), or leverages some privacy tech (query via Nym), or could just point to a local `WorldStateSynchronizer`. ### RollupSource @@ -182,7 +182,7 @@ Injected: Implementation notes for this milestone: - Mostly acting as a facade for other components, forwards requests as necessary. -- A `WorldStateSynchroniser` will ingest rollups from the `RollupSource` and maintain an up-to-date `MerkleTreeDb`. +- A `WorldStateSynchronizer` will ingest rollups from the `RollupSource` and maintain an up-to-date `MerkleTreeDb`.