From d12fafe74e393ff9776de0e0f9b7a4219031ac2a Mon Sep 17 00:00:00 2001 From: yudrywet Date: Sun, 14 Apr 2024 20:35:57 +0800 Subject: [PATCH] chore: fix some typos in comments Signed-off-by: yudrywet --- README.md | 6 +++--- script/common/ScriptHelper.sol | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 89041f1..5ad8cd5 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,13 @@ Murky contains contracts that can generate merkle roots and proofs. Murky also p 1. [`Merkle.sol`](./src/Merkle.sol) is the original Murky implementation. It implements the tree as a [Full Binary Tree](https://xlinux.nist.gov/dads/HTML/fullBinaryTree.html). -2. [`CompleteMerkle.sol`](./src/CompleteMerkle.sol) is a merkle tree implementation using [Complete Binary Trees](https://xlinux.nist.gov/dads/HTML/completeBinaryTree.html). Some external libraries, particulary front-end or off-chain ones, use this type of tree. +2. [`CompleteMerkle.sol`](./src/CompleteMerkle.sol) is a merkle tree implementation using [Complete Binary Trees](https://xlinux.nist.gov/dads/HTML/completeBinaryTree.html). Some external libraries, particularly front-end or off-chain ones, use this type of tree. -By default, both trees use sorted concatentation based hashing; you can also "bring your own" hashing function by inherting from [`MurkyBase.sol`](./src/common/MurkyBase.sol). +By default, both trees use sorted concatenation based hashing; you can also "bring your own" hashing function by inheriting from [`MurkyBase.sol`](./src/common/MurkyBase.sol). The root generation, proof generation, and verification functions are all fuzz tested (configured 10,000 runs by default) using arbitrary bytes32 arrays and uint leaves. See [testing](#testing). -> Note: Code is not audited (yet). Please do your own due dilligence testing if you are planning to use this code! +> Note: Code is not audited (yet). Please do your own due diligence testing if you are planning to use this code! You can currently see Murky in action in the [Seaport](https://github.com/ProjectOpenSea/Seaport) test suite. diff --git a/script/common/ScriptHelper.sol b/script/common/ScriptHelper.sol index 6a05cba..1855c32 100644 --- a/script/common/ScriptHelper.sol +++ b/script/common/ScriptHelper.sol @@ -16,7 +16,7 @@ contract ScriptHelper is Script { } /// @dev Returns a slice of `_bytes` starting at index `_start` and of length `_length`. - /// referenece: https://github.com/GNSPS/solidity-bytes-utils/blob/6458fb2780a3092bc756e737f246be1de6d3d362/contracts/BytesLib.sol#L228 + /// reference: https://github.com/GNSPS/solidity-bytes-utils/blob/6458fb2780a3092bc756e737f246be1de6d3d362/contracts/BytesLib.sol#L228 function slice(bytes memory _bytes, uint256 _start, uint256 _length) internal pure returns (bytes memory) { require(_length + 31 >= _length, "slice_overflow"); require(_bytes.length >= _start + _length, "slice_outOfBounds");