taproot: Lowercase error messages

jamillambert · jamillambert · commit e8a30bfca798 · 2024-07-01T17:42:43.000+01:00
By convention error messages should not be capitalised or use full
stops.

Fix the `taproot` module error messages.
diff --git a/bitcoin/src/taproot/mod.rs b/bitcoin/src/taproot/mod.rs
@@ -533,7 +533,7 @@ impl TaprootBuilder {
                 if let Some(Some(node)) = self.branch.pop() {
                     Ok(TaprootSpendInfo::from_node_info(secp, internal_key, node))
                 } else {
-                    unreachable!("Size checked above. Builder guarantees the last element is Some")
+                    unreachable!("size checked above. Builder guarantees the last element is Some")
                 },
             _ => Err(self),
         }
@@ -557,7 +557,7 @@ impl TaprootBuilder {
 
         while self.branch.len() == depth as usize + 1 {
             let child = match self.branch.pop() {
-                None => unreachable!("Len of branch checked to be >= 1"),
+                None => unreachable!("length of branch checked to be >= 1"),
                 Some(Some(child)) => child,
                 // Needs an explicit push to add the None that we just popped.
                 // Cannot use .last() because of borrow checker issues.
@@ -621,9 +621,9 @@ impl core::fmt::Display for IncompleteBuilderError {
 
         f.write_str(match self {
             NotFinalized(_) =>
-                "an attempt to construct a Taproot tree from a builder containing incomplete branches.",
+                "an attempt to construct a Taproot tree from a builder containing incomplete branches",
             HiddenParts(_) =>
-                "an attempt to construct a Taproot tree from a builder containing hidden parts.",
+                "an attempt to construct a Taproot tree from a builder containing hidden parts",
         })
     }
 }
@@ -667,7 +667,7 @@ impl core::fmt::Display for HiddenNodesError {
 
         f.write_str(match self {
             HiddenParts(_) =>
-                "an attempt to construct a Taproot tree from a node_info containing hidden parts.",
+                "an attempt to construct a Taproot tree from a node_info containing hidden parts",
         })
     }
 }
@@ -921,26 +921,26 @@ impl<'de> serde::Deserialize<'de> for NodeInfo {
                 while let Some(depth) = seq.next_element()? {
                     let tap_leaf: TapLeaf = seq
                         .next_element()?
-                        .ok_or_else(|| serde::de::Error::custom("Missing tap_leaf"))?;
+                        .ok_or_else(|| serde::de::Error::custom("missing tap_leaf"))?;
                     match tap_leaf {
                         TapLeaf::Script(script, ver) => {
                             builder =
                                 builder.add_leaf_with_ver(depth, script, ver).map_err(|e| {
-                                    serde::de::Error::custom(format!("Leaf insertion error: {}", e))
+                                    serde::de::Error::custom(format!("leaf insertion error: {}", e))
                                 })?;
                         }
                         TapLeaf::Hidden(h) => {
                             builder = builder.add_hidden_node(depth, h).map_err(|e| {
                                 serde::de::Error::custom(format!(
-                                    "Hidden node insertion error: {}",
+                                    "hidden node insertion error: {}",
                                     e
                                 ))
                             })?;
                         }
                     }
                 }
                 NodeInfo::try_from(builder).map_err(|e| {
-                    serde::de::Error::custom(format!("Incomplete Taproot tree: {}", e))
+                    serde::de::Error::custom(format!("incomplete Taproot tree: {}", e))
                 })
             }
         }
@@ -1354,11 +1354,11 @@ impl fmt::Display for TaprootBuilderError {
             }
             OverCompleteTree => write!(
                 f,
-                "Attempted to create a tree with two nodes at depth 0. There must\
-                only be a exactly one node at depth 0",
+                "attempted to create a tree with two nodes at depth 0. There must\
+                only be exactly one node at depth 0",
             ),
             EmptyTree => {
-                write!(f, "Called finalize on an empty tree")
+                write!(f, "called finalize on an empty tree")
             }
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -533,7 +533,7 @@ impl TaprootBuilder {`
`533`	`533`	`if let Some(Some(node)) = self.branch.pop() {`
`534`	`534`	`Ok(TaprootSpendInfo::from_node_info(secp, internal_key, node))`
`535`	`535`	`} else {`
`536`		`- unreachable!("Size checked above. Builder guarantees the last element is Some")`
	`536`	`+ unreachable!("size checked above. Builder guarantees the last element is Some")`
`537`	`537`	`},`
`538`	`538`	`_ => Err(self),`
`539`	`539`	`}`
`@@ -557,7 +557,7 @@ impl TaprootBuilder {`
`557`	`557`
`558`	`558`	`while self.branch.len() == depth as usize + 1 {`
`559`	`559`	`let child = match self.branch.pop() {`
`560`		`- None => unreachable!("Len of branch checked to be >= 1"),`
	`560`	`+ None => unreachable!("length of branch checked to be >= 1"),`
`561`	`561`	`Some(Some(child)) => child,`
`562`	`562`	`// Needs an explicit push to add the None that we just popped.`
`563`	`563`	`// Cannot use .last() because of borrow checker issues.`
`@@ -621,9 +621,9 @@ impl core::fmt::Display for IncompleteBuilderError {`
`621`	`621`
`622`	`622`	`f.write_str(match self {`
`623`	`623`	`NotFinalized(_) =>`
`624`		`- "an attempt to construct a Taproot tree from a builder containing incomplete branches.",`
	`624`	`+ "an attempt to construct a Taproot tree from a builder containing incomplete branches",`
`625`	`625`	`HiddenParts(_) =>`
`626`		`- "an attempt to construct a Taproot tree from a builder containing hidden parts.",`
	`626`	`+ "an attempt to construct a Taproot tree from a builder containing hidden parts",`
`627`	`627`	`})`
`628`	`628`	`}`
`629`	`629`	`}`
`@@ -667,7 +667,7 @@ impl core::fmt::Display for HiddenNodesError {`
`667`	`667`
`668`	`668`	`f.write_str(match self {`
`669`	`669`	`HiddenParts(_) =>`
`670`		`- "an attempt to construct a Taproot tree from a node_info containing hidden parts.",`
	`670`	`+ "an attempt to construct a Taproot tree from a node_info containing hidden parts",`
`671`	`671`	`})`
`672`	`672`	`}`
`673`	`673`	`}`
`@@ -921,26 +921,26 @@ impl<'de> serde::Deserialize<'de> for NodeInfo {`
`921`	`921`	`while let Some(depth) = seq.next_element()? {`
`922`	`922`	`let tap_leaf: TapLeaf = seq`
`923`	`923`	`.next_element()?`
`924`		`- .ok_or_else(\|\| serde::de::Error::custom("Missing tap_leaf"))?;`
	`924`	`+ .ok_or_else(\|\| serde::de::Error::custom("missing tap_leaf"))?;`
`925`	`925`	`match tap_leaf {`
`926`	`926`	`TapLeaf::Script(script, ver) => {`
`927`	`927`	`builder =`
`928`	`928`	`builder.add_leaf_with_ver(depth, script, ver).map_err(\|e\| {`
`929`		`- serde::de::Error::custom(format!("Leaf insertion error: {}", e))`
	`929`	`+ serde::de::Error::custom(format!("leaf insertion error: {}", e))`
`930`	`930`	`})?;`
`931`	`931`	`}`
`932`	`932`	`TapLeaf::Hidden(h) => {`
`933`	`933`	`builder = builder.add_hidden_node(depth, h).map_err(\|e\| {`
`934`	`934`	`serde::de::Error::custom(format!(`
`935`		`- "Hidden node insertion error: {}",`
	`935`	`+ "hidden node insertion error: {}",`
`936`	`936`	`e`
`937`	`937`	`))`
`938`	`938`	`})?;`
`939`	`939`	`}`
`940`	`940`	`}`
`941`	`941`	`}`
`942`	`942`	`NodeInfo::try_from(builder).map_err(\|e\| {`
`943`		`- serde::de::Error::custom(format!("Incomplete Taproot tree: {}", e))`
	`943`	`+ serde::de::Error::custom(format!("incomplete Taproot tree: {}", e))`
`944`	`944`	`})`
`945`	`945`	`}`
`946`	`946`	`}`
`@@ -1354,11 +1354,11 @@ impl fmt::Display for TaprootBuilderError {`
`1354`	`1354`	`}`
`1355`	`1355`	`OverCompleteTree => write!(`
`1356`	`1356`	`f,`
`1357`		`- "Attempted to create a tree with two nodes at depth 0. There must\`
`1358`		`- only be a exactly one node at depth 0",`
	`1357`	`+ "attempted to create a tree with two nodes at depth 0. There must\`
	`1358`	`+ only be exactly one node at depth 0",`
`1359`	`1359`	`),`
`1360`	`1360`	`EmptyTree => {`
`1361`		`- write!(f, "Called finalize on an empty tree")`
	`1361`	`+ write!(f, "called finalize on an empty tree")`
`1362`	`1362`	`}`
`1363`	`1363`	`}`
`1364`	`1364`	`}`