diff --git a/.github/workflows/README.md b/.github/workflows/README.md index 9431a1a2..7dd0c5fa 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` diff --git a/ethereum/README.md b/ethereum/README.md index 31f56a00..3852b2d4 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 diff --git a/ethereum/circuits/lib/src/merkle_patricia_proofs/README.md b/ethereum/circuits/lib/src/merkle_patricia_proofs/README.md index 4ddc2368..b69a624c 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(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`