Skip to content

Commit ee7341f

Browse files
docs: Never require a verification context
1 parent 2286f80 commit ee7341f

4 files changed

+8
-8
lines changed

include/secp256k1.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -494,7 +494,7 @@ SECP256K1_API int secp256k1_ecdsa_signature_serialize_compact(
494494
*
495495
* Returns: 1: correct signature
496496
* 0: incorrect or unparseable signature
497-
* Args: ctx: a secp256k1 context object, initialized for verification.
497+
* Args: ctx: a secp256k1 context object.
498498
* In: sig: the signature being verified.
499499
* msghash32: the 32-byte message hash being verified.
500500
* 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(
705705
* Returns: 0 if the arguments are invalid or the resulting public key would be
706706
* invalid (only when the tweak is the negation of the corresponding
707707
* secret key). 1 otherwise.
708-
* Args: ctx: pointer to a context object initialized for validation.
708+
* Args: ctx: pointer to a context object.
709709
* In/Out: pubkey: pointer to a public key object. pubkey will be set to an
710710
* invalid value if this function returns 0.
711711
* 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(
750750
/** Tweak a public key by multiplying it by a tweak value.
751751
*
752752
* Returns: 0 if the arguments are invalid. 1 otherwise.
753-
* Args: ctx: pointer to a context object initialized for validation.
753+
* Args: ctx: pointer to a context object.
754754
* In/Out: pubkey: pointer to a public key object. pubkey will be set to an
755755
* invalid value if this function returns 0.
756756
* In: tweak32: pointer to a 32-byte tweak. If the tweak is invalid according to

include/secp256k1_extrakeys.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_xonly_pubkey_from_pubke
108108
* invalid (only when the tweak is the negation of the corresponding
109109
* secret key). 1 otherwise.
110110
*
111-
* Args: ctx: pointer to a context object initialized for verification.
111+
* Args: ctx: pointer to a context object.
112112
* Out: output_pubkey: pointer to a public key to store the result. Will be set
113113
* to an invalid value if this function returns 0.
114114
* 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(
137137
*
138138
* Returns: 0 if the arguments are invalid or the tweaked pubkey is not the
139139
* result of tweaking the internal_pubkey with tweak32. 1 otherwise.
140-
* Args: ctx: pointer to a context object initialized for verification.
140+
* Args: ctx: pointer to a context object.
141141
* In: tweaked_pubkey32: pointer to a serialized xonly_pubkey.
142142
* tweaked_pk_parity: the parity of the tweaked pubkey (whose serialization
143143
* 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(
228228
* invalid (only when the tweak is the negation of the keypair's
229229
* secret key). 1 otherwise.
230230
*
231-
* Args: ctx: pointer to a context object initialized for verification.
231+
* Args: ctx: pointer to a context object.
232232
* In/Out: keypair: pointer to a keypair to apply the tweak to. Will be set to
233233
* an invalid value if this function returns 0.
234234
* In: tweak32: pointer to a 32-byte tweak. If the tweak is invalid according

include/secp256k1_recovery.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ SECP256K1_API int secp256k1_ecdsa_sign_recoverable(
9494
*
9595
* Returns: 1: public key successfully recovered (which guarantees a correct signature).
9696
* 0: otherwise.
97-
* Args: ctx: pointer to a context object, initialized for verification.
97+
* Args: ctx: pointer to a context object.
9898
* Out: pubkey: pointer to the recovered public key.
9999
* In: sig: pointer to initialized signature that supports pubkey recovery.
100100
* msghash32: the 32-byte message hash assumed to be signed.

include/secp256k1_schnorrsig.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ SECP256K1_API int secp256k1_schnorrsig_sign_custom(
161161
*
162162
* Returns: 1: correct signature
163163
* 0: incorrect signature
164-
* Args: ctx: a secp256k1 context object, initialized for verification.
164+
* Args: ctx: a secp256k1 context object.
165165
* In: sig64: pointer to the 64-byte signature to verify.
166166
* msg: the message being verified. Can only be NULL if msglen is 0.
167167
* msglen: length of the message

0 commit comments

Comments
 (0)