From e3f153c96162b17779f3f7d25a3737f57cf043f8 Mon Sep 17 00:00:00 2001 From: osrm <90407222+osrm@users.noreply.github.com> Date: Tue, 12 Nov 2024 20:46:40 +0900 Subject: [PATCH 1/4] fix invalid link path README.md Invalid link path fixed --- .github/workflows/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/README.md b/.github/workflows/README.md index 9431a1a2e..7dd0c5fa0 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -1,14 +1,14 @@ # Workflows -- [Circuits profiling](./circuits_profile.yml) +- [Circuits profiling](./circuits_profile.yaml) - Runs `nargo info` and stores the results into an artefact -- [Circuits tests](./circuits_test.yml) +- [Circuits tests](./circuits_test.yaml) - Runs `nargo test` -- [Circuits E2E tests](./circuits_e2e.yml) +- [Circuits E2E tests](./circuits_e2e.yaml) - Runs `nargo prove` & `nargo verify` - [Solidity tests](./contract_test.yml) - Runs `forge test` -- [TypeScript E2E tests using solidity verifiers](./e2e_test.yml) +- [TypeScript E2E tests using solidity verifiers](./e2e_test.yaml) - Runs `yarn test:e2e` - [Static checks](./static_checks.yaml) - Runs `yarn format:all:ci` From a0a9d42053d23a3edca37daffedc81f0145a9c3e Mon Sep 17 00:00:00 2001 From: osrm <90407222+osrm@users.noreply.github.com> Date: Tue, 12 Nov 2024 20:49:18 +0900 Subject: [PATCH 2/4] fix invalid link path README.md [smart contracts](./contracts/src/EthereumHistoryVerifier.sol) path is invalid, fixed it rightly. --- ethereum/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ethereum/README.md b/ethereum/README.md index 31f56a004..3852b2d4b 100644 --- a/ethereum/README.md +++ b/ethereum/README.md @@ -21,7 +21,7 @@ Codebase also includes support for base Ethereum structures in Noir: - Mappings of Basic Ethereum data types: uint256, address, bytes32, hash - Fragment data structure, similar to Rust's slice, used for parsing data -Additionally, we provide [smart contracts](./ethereum/contracts/src/EthereumHistoryVerifier.sol) that allow to verify inclusion of block in the chain for last 256 blocks. +Additionally, we provide [smart contracts](./contracts/src/EthereumHistoryVerifier.sol) that allow to verify inclusion of block in the chain for last 256 blocks. ## Repository structure From 835708ed30b7699874f4cdc8ec53e27e16ca68b4 Mon Sep 17 00:00:00 2001 From: osrm <90407222+osrm@users.noreply.github.com> Date: Tue, 12 Nov 2024 20:57:57 +0900 Subject: [PATCH 3/4] fix typos README.md "it's" should be "its" in the sentence: "it points at the beginning of it's RLP Header." -> "it points at the beginning of its RLP Header." "Whe" should be "When" in the sentence: "Whe working with RLP data" -> "When working with RLP data" --- ethereum/circuits/lib/src/rlp/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ethereum/circuits/lib/src/rlp/README.md b/ethereum/circuits/lib/src/rlp/README.md index 19e753fd3..a36c63b8d 100644 --- a/ethereum/circuits/lib/src/rlp/README.md +++ b/ethereum/circuits/lib/src/rlp/README.md @@ -12,7 +12,7 @@ pub fn decode_string(data: Fragment) -> RlpFragment; pub fn decode_list(data: Fragment) -> RlpList; ``` -**Note:** For string elements - offset points at the beginning of the data itself, while for lists - it points at the beginning of it's RLP Header. +**Note:** For string elements - offset points at the beginning of the data itself, while for lists - it points at the beginning of its RLP Header. The library also exports a more performant special case version of `decode_list`, that can be used when the input consists exclusively of strings of length <= 55 bytes: @@ -50,7 +50,7 @@ struct RlpFragment { `RlpFragment` contains the `offset` and `length` of the decoded item within the input data. It also contains the `data_type` of an item. Unlike the Fragment it does not contain the data as RLP data can have multiple fields and having multiple data copies is costly. -Whe working with RLP data - it's a common pattern to have a structure (Tx, Log, Receipt) and its RLP encoding and comparing both field by field. To simplify this flow - we export some helper methods on `RlpFragment`. Each of those methods accepts `field_name`, `rlp` and `expected_value`. +When working with RLP data - it's a common pattern to have a structure (Tx, Log, Receipt) and its RLP encoding and comparing both field by field. To simplify this flow - we export some helper methods on `RlpFragment`. Each of those methods accepts `field_name`, `rlp` and `expected_value`. - `field_name` is used in assertion messages - `rlp` contains the data to compare the `value` against using `offset` and `length` from `RlpFragment` From bf8fc69ddaf24d1fff76a18ec779ffa88dbcd582 Mon Sep 17 00:00:00 2001 From: osrm <90407222+osrm@users.noreply.github.com> Date: Tue, 12 Nov 2024 21:01:02 +0900 Subject: [PATCH 4/4] fix typo README.md "parameteres" -> "parameters" --- ethereum/circuits/lib/src/merkle_patricia_proofs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ethereum/circuits/lib/src/merkle_patricia_proofs/README.md b/ethereum/circuits/lib/src/merkle_patricia_proofs/README.md index 4ddc23684..b69a624c0 100644 --- a/ethereum/circuits/lib/src/merkle_patricia_proofs/README.md +++ b/ethereum/circuits/lib/src/merkle_patricia_proofs/README.md @@ -19,7 +19,7 @@ pub fn verify_merkle_proof