[ecdsa] add mini docstring for verify

mratsim · Dec 28, 2024 · 5a43ae2 · 5a43ae2
1 parent c5b003c
commit 5a43ae2
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/constantine/ecdsa_secp256k1.nim b/constantine/ecdsa_secp256k1.nim
@@ -62,6 +62,7 @@ proc verify*(
     message: openArray[byte],
     signature: Signature
 ): bool {.libPrefix: prefix_ffi, genCharAPI.} =
+  ## Verify `signature` using `publicKey` for `message`.
   result = publicKey.raw.coreVerify(message, signature, sha256)
 
 func derive_pubkey*(public_key: var PublicKey, secret_key: SecretKey) {.libPrefix: prefix_ffi.} =