What the developer wrote
Authored by Marko Bencun
secp256k1: fix docstring typo
keystore locked error used to be the case in the past when this
function took the private key from the keystore, but that changed.
What changed, and why it matters
This commit only fixes a typo in a code comment (docstring). It changes the description of when a function can return an error, matching the fact that the function now receives the private key directly rather than fetching it from a locked keystore. No actual code behavior is changed.
No action needed; this is a non-functional documentation correction.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies a single docstring line in src/rust/bitbox02-rust/src/secp256k1.rs for the secp256k1_sign function. The old comment stated Err(()) is returned if the keystore is locked; the new comment states Err(()) is returned on error. The function signature already takes private_key: &[u8; 32] directly, so the old comment was stale. There are no code, logic, or API changes.
Changed components
src/rust/bitbox02-rust/src/secp256k1.rs (documentation only)Inspect captured patch +1 / −1
diff --git a/src/rust/bitbox02-rust/src/secp256k1.rs b/src/rust/bitbox02-rust/src/secp256k1.rs
index fc992d8..800508b 100644
--- a/src/rust/bitbox02-rust/src/secp256k1.rs
+++ b/src/rust/bitbox02-rust/src/secp256k1.rs
@@ -70,7 +70,7 @@ impl Deref for GlobalContext {
///
/// # Returns
/// * `Ok(SignResult)` containing signature in compact format and recoverable id on success
-/// * `Err(())` if the keystore is locked
+/// * `Err(())` on error.
pub fn secp256k1_sign(
private_key: &[u8; 32],
msg: &[u8; 32],
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.