docs: Never require a verification context

jonasnick · Nov 25, 2022 · ee7341f · ee7341f
1 parent 2286f80
commit ee7341f
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/include/secp256k1.h b/include/secp256k1.h
@@ -494,7 +494,7 @@ SECP256K1_API int secp256k1_ecdsa_signature_serialize_compact(
  *
  * Returns: 1: correct signature
  * 0: incorrect or unparseable signature
- * Args: ctx: a secp256k1 context object, initialized for verification.
+ * Args: ctx: a secp256k1 context object.
  * In: sig: the signature being verified.
  * msghash32: the 32-byte message hash being verified.
  * The verifier must make sure to apply a cryptographic
@@ -705,7 +705,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_privkey_tweak_add(
  * Returns: 0 if the arguments are invalid or the resulting public key would be
  * invalid (only when the tweak is the negation of the corresponding
  * secret key). 1 otherwise.
- * Args: ctx: pointer to a context object initialized for validation.
+ * 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
@@ -750,7 +750,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_privkey_tweak_mul(
 /** Tweak a public key by multiplying it by a tweak value.
  *
  * Returns: 0 if the arguments are invalid. 1 otherwise.
- * Args: ctx: pointer to a context object initialized for validation.
+ * 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

diff --git a/include/secp256k1_extrakeys.h b/include/secp256k1_extrakeys.h
@@ -108,7 +108,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_xonly_pubkey_from_pubke
  * invalid (only when the tweak is the negation of the corresponding
  * secret key). 1 otherwise.
  *
- * Args: ctx: pointer to a context object initialized for verification.
+ * Args: ctx: pointer to a context object.
  * 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.
@@ -137,7 +137,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_xonly_pubkey_tweak_add(
  *
  * Returns: 0 if the arguments are invalid or the tweaked pubkey is not the
  * result of tweaking the internal_pubkey with tweak32. 1 otherwise.
- * Args: ctx: pointer to a context object initialized for verification.
+ * Args: ctx: pointer to a context object.
  * In: tweaked_pubkey32: pointer to a serialized xonly_pubkey.
  * tweaked_pk_parity: the parity of the tweaked pubkey (whose serialization
  * is passed in as tweaked_pubkey32). This must match the
@@ -228,7 +228,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_keypair_xonly_pub(
  * invalid (only when the tweak is the negation of the keypair's
  * secret key). 1 otherwise.
  *
- * Args: ctx: pointer to a context object initialized for verification.
+ * 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

diff --git a/include/secp256k1_recovery.h b/include/secp256k1_recovery.h
@@ -94,7 +94,7 @@ SECP256K1_API int secp256k1_ecdsa_sign_recoverable(
  *
  * Returns: 1: public key successfully recovered (which guarantees a correct signature).
  * 0: otherwise.
- * Args: ctx: pointer to a context object, initialized for verification.
+ * Args: ctx: pointer to a context object.
  * Out: pubkey: pointer to the recovered public key.
  * In: sig: pointer to initialized signature that supports pubkey recovery.
  * msghash32: the 32-byte message hash assumed to be signed.

diff --git a/include/secp256k1_schnorrsig.h b/include/secp256k1_schnorrsig.h
@@ -161,7 +161,7 @@ SECP256K1_API int secp256k1_schnorrsig_sign_custom(
  *
  * Returns: 1: correct signature
  * 0: incorrect signature
- * Args: ctx: a secp256k1 context object, initialized for verification.
+ * Args: ctx: a secp256k1 context object.
  * In: sig64: pointer to the 64-byte signature to verify.
  * msg: the message being verified. Can only be NULL if msglen is 0.
  * msglen: length of the message