tweak_add: fix API doc for tweak=0

bitcoin-core · May 23, 2023 · 92f7c19 · 92f7c19
1 parent d373a72
commit 92f7c19
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 16 deletions.
diff --git a/include/secp256k1.h b/include/secp256k1.h
@@ -733,10 +733,11 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_pubkey_negate(
  *                  invalid according to secp256k1_ec_seckey_verify, this
  *                  function returns 0. seckey will be set to some unspecified
  *                  value if this function returns 0.
- *  In:    tweak32: pointer to a 32-byte tweak. If the tweak is invalid according to
- *                  secp256k1_ec_seckey_verify, this function returns 0. For
- *                  uniformly random 32-byte arrays the chance of being invalid
- *                  is negligible (around 1 in 2^128).
+ *  In:    tweak32: pointer to a 32-byte tweak. For non-zero tweaks, the function
+ *                  returns 0 if the tweak is invalid according to
+ *                  secp256k1_ec_seckey_verify. For uniformly random 32-byte
+ *                  tweaks, the chance of being invalid is negligible (around 1
+ *                  in 2^128).
  */
 SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_seckey_tweak_add(
     const secp256k1_context *ctx,
@@ -761,10 +762,11 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_privkey_tweak_add(
  *  Args:    ctx:   pointer to a context object.
  *  In/Out: pubkey: pointer to a public key object. pubkey will be set to an
  *                  invalid value if this function returns 0.
- *  In:    tweak32: pointer to a 32-byte tweak. If the tweak is invalid according to
- *                  secp256k1_ec_seckey_verify, this function returns 0. For
- *                  uniformly random 32-byte arrays the chance of being invalid
- *                  is negligible (around 1 in 2^128).
+ *  In:    tweak32: pointer to a 32-byte tweak. For non-zero tweaks, the function
+ *                  returns 0 if the tweak is invalid according to
+ *                  secp256k1_ec_seckey_verify. For uniformly random 32-byte
+ *                  tweaks, the chance of being invalid is negligible (around 1
+ *                  in 2^128).
  */
 SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_pubkey_tweak_add(
     const secp256k1_context *ctx,

diff --git a/include/secp256k1_extrakeys.h b/include/secp256k1_extrakeys.h
@@ -112,10 +112,11 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_xonly_pubkey_from_pubke
  *  Out:  output_pubkey: pointer to a public key to store the result. Will be set
  *                       to an invalid value if this function returns 0.
  *  In: internal_pubkey: pointer to an x-only pubkey to apply the tweak to.
- *              tweak32: pointer to a 32-byte tweak. If the tweak is invalid
- *                       according to secp256k1_ec_seckey_verify, this function
- *                       returns 0. For uniformly random 32-byte arrays the
- *                       chance of being invalid is negligible (around 1 in 2^128).
+ *  In:         tweak32: pointer to a 32-byte tweak. For non-zero tweaks, the
+ *                       function returns 0 if the tweak is invalid according
+ *                       to secp256k1_ec_seckey_verify. For uniformly random
+ *                       32-byte tweaks, the chance of being invalid is
+ *                       negligible (around 1 in 2^128).
  */
 SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_xonly_pubkey_tweak_add(
     const secp256k1_context *ctx,
@@ -231,10 +232,11 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_keypair_xonly_pub(
  *  Args:       ctx: pointer to a context object.
  *  In/Out: keypair: pointer to a keypair to apply the tweak to. Will be set to
  *                   an invalid value if this function returns 0.
- *  In:     tweak32: pointer to a 32-byte tweak. If the tweak is invalid according
- *                   to secp256k1_ec_seckey_verify, this function returns 0. For
- *                   uniformly random 32-byte arrays the chance of being invalid
- *                   is negligible (around 1 in 2^128).
+ *  In:     tweak32: pointer to a 32-byte tweak. For non-zero tweaks, the function
+ *                   returns 0 if the tweak is invalid according to
+ *                   secp256k1_ec_seckey_verify. For uniformly random 32-byte
+ *                   tweaks, the chance of being invalid is negligible (around 1
+ *                   in 2^128).
  */
 SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_keypair_xonly_tweak_add(
     const secp256k1_context *ctx,