Skip to content

Commit e7d0185

Browse files
docs: Get rid of "initialized for signing" terminology
1 parent 0612636 commit e7d0185

5 files changed

+6
-7
lines changed

contrib/lax_der_privatekey_parsing.h

+1-2
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@ extern "C" {
4343
/** Export a private key in DER format.
4444
*
4545
* Returns: 1 if the private key was valid.
46-
* Args: ctx: pointer to a context object, initialized for signing (cannot
47-
* be NULL)
46+
* Args: ctx: pointer to a context object (not secp256k1_context_static).
4847
* Out: privkey: pointer to an array for storing the private key in BER.
4948
* Should have space for 279 bytes, and cannot be NULL.
5049
* privkeylen: Pointer to an int where the length of the private key in

include/secp256k1.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -636,7 +636,7 @@ SECP256K1_API extern const secp256k1_nonce_function secp256k1_nonce_function_def
636636
*
637637
* Returns: 1: signature created
638638
* 0: the nonce generation function failed, or the secret key was invalid.
639-
* Args: ctx: pointer to a context object, initialized for signing.
639+
* Args: ctx: pointer to a context object (not secp256k1_context_static).
640640
* Out: sig: pointer to an array where the signature will be placed.
641641
* In: msghash32: the 32-byte message hash being signed.
642642
* seckey: pointer to a 32-byte secret key.
@@ -680,7 +680,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_seckey_verify(
680680
*
681681
* Returns: 1: secret was valid, public key stores.
682682
* 0: secret was invalid, try again.
683-
* Args: ctx: pointer to a context object, initialized for signing.
683+
* Args: ctx: pointer to a context object (not secp256k1_context_static).
684684
* Out: pubkey: pointer to the created public key.
685685
* In: seckey: pointer to a 32-byte secret key.
686686
*/

include/secp256k1_extrakeys.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_xonly_pubkey_tweak_add_
159159
*
160160
* Returns: 1: secret was valid, keypair is ready to use
161161
* 0: secret was invalid, try again with a different secret
162-
* Args: ctx: pointer to a context object, initialized for signing.
162+
* Args: ctx: pointer to a context object (not secp256k1_context_static).
163163
* Out: keypair: pointer to the created keypair.
164164
* In: seckey: pointer to a 32-byte secret key.
165165
*/

include/secp256k1_recovery.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ SECP256K1_API int secp256k1_ecdsa_recoverable_signature_serialize_compact(
7272
*
7373
* Returns: 1: signature created
7474
* 0: the nonce generation function failed, or the secret key was invalid.
75-
* Args: ctx: pointer to a context object, initialized for signing.
75+
* Args: ctx: pointer to a context object (not secp256k1_context_static).
7676
* Out: sig: pointer to an array where the signature will be placed.
7777
* In: msghash32: the 32-byte message hash being signed.
7878
* seckey: pointer to a 32-byte secret key.

include/secp256k1_schnorrsig.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ typedef struct {
106106
* signatures from being valid in multiple contexts by accident.
107107
*
108108
* Returns 1 on success, 0 on failure.
109-
* Args: ctx: pointer to a context object, initialized for signing.
109+
* Args: ctx: pointer to a context object (not secp256k1_context_static).
110110
* Out: sig64: pointer to a 64-byte array to store the serialized signature.
111111
* In: msg32: the 32-byte message being signed.
112112
* keypair: pointer to an initialized keypair.

0 commit comments

Comments
 (0)