docs: clarify the documentation for hash_mask field of a branch node (

#70) docs: clarify the `hash_mask` field of a branch node
alloy-rs · Dec 4, 2024 · 432910b · 432910b
1 parent 29c9f98
commit 432910b
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/deny.toml b/deny.toml
@@ -19,7 +19,6 @@ allow = [
     "BSD-3-Clause",
     "ISC",
     "Unicode-3.0",
-    "Unicode-DFS-2016",
     "Unlicense",
     "MPL-2.0",
     "Zlib",

diff --git a/src/nodes/branch.rs b/src/nodes/branch.rs
@@ -269,10 +269,11 @@ pub struct BranchNodeCompact {
     /// child at the nibble value `i` is stored in the database. If the bit is unset (0), it means
     /// the child is not stored in the database.
     pub tree_mask: TrieMask,
-    /// The bitmask representing the hashed children at the respective nibble positions in the
-    /// trie. If the bit at position `i` (counting from the right) is set (1) and also present
-    /// in the state_mask, it indicates that the corresponding child at the nibble value `i` is
-    /// a hashed child. If the bit is unset (0), it means the child is not a hashed child.
+    /// The bitmask representing the hashed branch children nodes at the respective nibble
+    /// positions in the trie. If the bit at position `i` (counting from the right) is set (1)
+    /// and also present in the state_mask, it indicates that the corresponding child at the
+    /// nibble value `i` is a hashed branch child node. If the bit is unset (0), it means the child
+    /// is not a hashed branch child node.
     pub hash_mask: TrieMask,
     /// Collection of hashes associated with the children of the branch node.
     /// Each child hash is calculated by hashing two consecutive sub-branch roots.