chore: add comments

ChainSafe · Nov 6, 2024 · cc9f73c · cc9f73c
1 parent 3447aa0
commit cc9f73c
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/packages/persistent-merkle-tree/src/hasher/as-sha256.ts b/packages/persistent-merkle-tree/src/hasher/as-sha256.ts
@@ -10,7 +10,10 @@ import {Node} from "../node";
 import type {HashComputationLevel} from "../hashComputation";
 import {BLOCK_SIZE, doDigestNLevel, doMerkleizeBlockArray, doMerkleizeBlocksBytes} from "./util";
 
-/** hashInto() function of as-sha256 loop through every 256 bytes */
+/**
+ * hashInto() function of as-sha256 loop through every 256 bytes
+ * This is the same to hashInto() function of as-sha256 https://github.com/ChainSafe/ssz/blob/cf3e1f038c8bf7cba1bb27c38540e50b0391d0e6/packages/as-sha256/src/index.ts#L270
+ */
 const buffer = new Uint8Array(4 * BLOCK_SIZE);
 
 export const hasher: Hasher = {

diff --git a/packages/persistent-merkle-tree/src/hasher/types.ts b/packages/persistent-merkle-tree/src/hasher/types.ts
@@ -22,6 +22,7 @@ export type Hasher = {
   merkleizeBlocksBytes(blocksBytes: Uint8Array, padFor: number, output: Uint8Array, offset: number): void;
   /**
    * Merkleize n SHA256 blocks, each is 64 bytes Uint8Array
+   * blockLimit is the number of blocks to hash, should be <= blocks.length
    * padFor is maxChunkCount, use it to compute layers to hash
    * blocks are mutated after the function
    */

diff --git a/packages/persistent-merkle-tree/src/hasher/util.ts b/packages/persistent-merkle-tree/src/hasher/util.ts
@@ -76,9 +76,9 @@ export function doMerkleizeBlocksBytes(
 
 /**
  * Merkleize multiple SHA256 blocks into ${output} at ${offset}
+ * @param blockLimit number of blocks, should be <= blocks.length so that consumer can reuse memory
  * @param padFor is maxChunkCount, should be >= 2
  * @param blocks is unsafe because it's modified
- * @param blockLimit number of blocks, should be <= blocks.length so that consumer can reuse memory
  */
 export function doMerkleizeBlockArray(
   blocks: Uint8Array[],