From c6933910f15c7510c9eed5e5dcd33f011a649970 Mon Sep 17 00:00:00 2001 From: cheapshot003 Date: Wed, 4 Sep 2024 12:00:00 +0300 Subject: [PATCH] adjust documentation: secp256k1_ec_seckey_verify --- include/secp256k1.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/include/secp256k1.h b/include/secp256k1.h index cfbdd528c2..88928111c4 100644 --- a/include/secp256k1.h +++ b/include/secp256k1.h @@ -679,12 +679,14 @@ SECP256K1_API int secp256k1_ecdsa_sign( const void *ndata ) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3) SECP256K1_ARG_NONNULL(4); -/** Verify an ECDSA secret key. +/** Verify an elliptic curve secret key. * * A secret key is valid if it is not 0 and less than the secp256k1 curve order * when interpreted as an integer (most significant byte first). The * probability of choosing a 32-byte string uniformly at random which is an - * invalid secret key is negligible. + * invalid secret key is negligible. However, if it does happen it should + * be assumed that the randomness source is severely broken and there should + * be no retry. * * Returns: 1: secret key is valid * 0: secret key is invalid