From 70b6be1834e2ece8d9cfcf2ad12e4452c87cdc20 Mon Sep 17 00:00:00 2001 From: Jonas Nick Date: Sun, 13 Oct 2024 19:08:02 +0000 Subject: [PATCH] extrakeys: improve doc of keypair_create (don't suggest retry) --- include/secp256k1.h | 2 +- include/secp256k1_extrakeys.h | 9 ++++++--- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/include/secp256k1.h b/include/secp256k1.h index 6e96778da9..25196fb752 100644 --- a/include/secp256k1.h +++ b/include/secp256k1.h @@ -684,7 +684,7 @@ SECP256K1_API int secp256k1_ecdsa_sign( * 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. However, if it does happen it should + * 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. * diff --git a/include/secp256k1_extrakeys.h b/include/secp256k1_extrakeys.h index ad70b92f95..13acb0325f 100644 --- a/include/secp256k1_extrakeys.h +++ b/include/secp256k1_extrakeys.h @@ -155,10 +155,13 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_xonly_pubkey_tweak_add_ const unsigned char *tweak32 ) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(4) SECP256K1_ARG_NONNULL(5); -/** Compute the keypair for a secret key. +/** Compute the keypair for a valid secret key. * - * Returns: 1: secret was valid, keypair is ready to use - * 0: secret was invalid, try again with a different secret + * See the documentation of `secp256k1_ec_seckey_verify` for more information + * about the validity of secret keys. + * + * Returns: 1: secret key is valid + * 0: secret key is invalid * Args: ctx: pointer to a context object (not secp256k1_context_static). * Out: keypair: pointer to the created keypair. * In: seckey: pointer to a 32-byte secret key.