frost/secp256k1-zkp
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

include: make doc about ctx more consistent

Browse Source 
Replaces "ctx: a secp256k1 context object" with "ctx: pointer to a context
object". Also removes the word "existing".
This commit is contained in:
Jonas Nick 2024-01-04 17:12:59 +00:00
parent e3f690015a
commit aa3dd5280b
No known key found for this signature in database
GPG Key ID: 4861DBF262123605
5 changed files with 40 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
include/secp256k1.h
View File

@ -265,7 +265,7 @@ SECP256K1_API void secp256k1_selftest(void);
* memory allocation entirely, see secp256k1_context_static and the functions in * memory allocation entirely, see secp256k1_context_static and the functions in
* secp256k1_preallocated.h. * secp256k1_preallocated.h.
* *
* Returns: a newly created context object. * Returns: pointer to a newly created context object.
* In: flags: Always set to SECP256K1_CONTEXT_NONE (see below). * In: flags: Always set to SECP256K1_CONTEXT_NONE (see below).
* *
* The only valid non-deprecated flag in recent library versions is * The only valid non-deprecated flag in recent library versions is
@ -296,8 +296,8 @@ SECP256K1_API secp256k1_context *secp256k1_context_create(
* Cloning secp256k1_context_static is not possible, and should not be emulated by * Cloning secp256k1_context_static is not possible, and should not be emulated by
* the caller (e.g., using memcpy). Create a new context instead. * the caller (e.g., using memcpy). Create a new context instead.
* *
* Returns: a newly created context object. * Returns: pointer to a newly created context object.
* Args: ctx: an existing context to copy (not secp256k1_context_static) * Args: ctx: pointer to a context to copy (not secp256k1_context_static).
*/ */
SECP256K1_API secp256k1_context *secp256k1_context_clone( SECP256K1_API secp256k1_context *secp256k1_context_clone(
const secp256k1_context *ctx const secp256k1_context *ctx
@ -313,7 +313,7 @@ SECP256K1_API secp256k1_context *secp256k1_context_clone(
* behaviour is undefined. In that case, secp256k1_context_preallocated_destroy must * behaviour is undefined. In that case, secp256k1_context_preallocated_destroy must
* be used instead. * be used instead.
* *
* Args: ctx: an existing context to destroy, constructed using * Args: ctx: pointer to a context to destroy, constructed using
* secp256k1_context_create or secp256k1_context_clone * secp256k1_context_create or secp256k1_context_clone
* (i.e., not secp256k1_context_static). * (i.e., not secp256k1_context_static).
*/ */
@ -350,7 +350,7 @@ SECP256K1_API void secp256k1_context_destroy(
* fails. In this case, the corresponding default handler will be called with * fails. In this case, the corresponding default handler will be called with
* the data pointer argument set to NULL. * the data pointer argument set to NULL.
* *
* Args: ctx: an existing context object. * Args: ctx: pointer to a context object.
* In: fun: a pointer to a function to call when an illegal argument is * In: fun: a pointer to a function to call when an illegal argument is
* passed to the API, taking a message and an opaque pointer. * passed to the API, taking a message and an opaque pointer.
* (NULL restores the default handler.) * (NULL restores the default handler.)
@ -377,7 +377,7 @@ SECP256K1_API void secp256k1_context_set_illegal_callback(
* for that). After this callback returns, anything may happen, including * for that). After this callback returns, anything may happen, including
* crashing. * crashing.
* *
* Args: ctx: an existing context object. * Args: ctx: pointer to a context object.
* In: fun: a pointer to a function to call when an internal error occurs, * In: fun: a pointer to a function to call when an internal error occurs,
* taking a message and an opaque pointer (NULL restores the * taking a message and an opaque pointer (NULL restores the
* default handler, see secp256k1_context_set_illegal_callback * default handler, see secp256k1_context_set_illegal_callback
@ -395,7 +395,7 @@ SECP256K1_API void secp256k1_context_set_error_callback(
/** Create a secp256k1 scratch space object. /** Create a secp256k1 scratch space object.
* *
* Returns: a newly created scratch space. * Returns: a newly created scratch space.
* Args: ctx: an existing context object. * Args: ctx: pointer to a context object.
* In: size: amount of memory to be available as scratch space. Some extra * In: size: amount of memory to be available as scratch space. Some extra
* (<100 bytes) will be allocated for extra accounting. * (<100 bytes) will be allocated for extra accounting.
*/ */
@ -407,7 +407,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT secp256k1_scratch_space *secp256k1_sc
/** Destroy a secp256k1 scratch space. /** Destroy a secp256k1 scratch space.
* *
* The pointer may not be used afterwards. * The pointer may not be used afterwards.
* Args: ctx: a secp256k1 context object. * Args: ctx: a pointer to a context object.
* scratch: space to destroy * scratch: space to destroy
*/ */
SECP256K1_API void secp256k1_scratch_space_destroy( SECP256K1_API void secp256k1_scratch_space_destroy(
@ -419,7 +419,7 @@ SECP256K1_API void secp256k1_scratch_space_destroy(
* *
* Returns: 1 if the public key was fully valid. * Returns: 1 if the public key was fully valid.
* 0 if the public key could not be parsed or is invalid. * 0 if the public key could not be parsed or is invalid.
* Args: ctx: a secp256k1 context object. * Args: ctx: pointer to a context object.
* Out: pubkey: pointer to a pubkey object. If 1 is returned, it is set to a * Out: pubkey: pointer to a pubkey object. If 1 is returned, it is set to a
* parsed version of input. If not, its value is undefined. * parsed version of input. If not, its value is undefined.
* In: input: pointer to a serialized public key * In: input: pointer to a serialized public key
@ -439,7 +439,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_pubkey_parse(
/** Serialize a pubkey object into a serialized byte sequence. /** Serialize a pubkey object into a serialized byte sequence.
* *
* Returns: 1 always. * Returns: 1 always.
* Args: ctx: a secp256k1 context object. * Args: ctx: pointer to a context object.
* Out: output: a pointer to a 65-byte (if compressed==0) or 33-byte (if * Out: output: a pointer to a 65-byte (if compressed==0) or 33-byte (if
* compressed==1) byte array to place the serialized key * compressed==1) byte array to place the serialized key
* in. * in.
@ -464,7 +464,7 @@ SECP256K1_API int secp256k1_ec_pubkey_serialize(
* Returns: <0 if the first public key is less than the second * Returns: <0 if the first public key is less than the second
* >0 if the first public key is greater than the second * >0 if the first public key is greater than the second
* 0 if the two public keys are equal * 0 if the two public keys are equal
* Args: ctx: a secp256k1 context object. * Args: ctx: pointer to a context object
* In: pubkey1: first public key to compare * In: pubkey1: first public key to compare
* pubkey2: second public key to compare * pubkey2: second public key to compare
*/ */
@ -477,9 +477,9 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_pubkey_cmp(
/** Parse an ECDSA signature in compact (64 bytes) format. /** Parse an ECDSA signature in compact (64 bytes) format.
* *
* Returns: 1 when the signature could be parsed, 0 otherwise. * Returns: 1 when the signature could be parsed, 0 otherwise.
* Args: ctx: a secp256k1 context object * Args: ctx: pointer to a context object
* Out: sig: a pointer to a signature object * Out: sig: pointer to a signature object
* In: input64: a pointer to the 64-byte array to parse * In: input64: pointer to the 64-byte array to parse
* *
* The signature must consist of a 32-byte big endian R value, followed by a * The signature must consist of a 32-byte big endian R value, followed by a
* 32-byte big endian S value. If R or S fall outside of [0..order-1], the * 32-byte big endian S value. If R or S fall outside of [0..order-1], the
@ -498,7 +498,7 @@ SECP256K1_API int secp256k1_ecdsa_signature_parse_compact(
/** Parse a DER ECDSA signature. /** Parse a DER ECDSA signature.
* *
* Returns: 1 when the signature could be parsed, 0 otherwise. * Returns: 1 when the signature could be parsed, 0 otherwise.
* Args: ctx: a secp256k1 context object * Args: ctx: pointer to a context object
* Out: sig: a pointer to a signature object * Out: sig: a pointer to a signature object
* In: input: a pointer to the signature to be parsed * In: input: a pointer to the signature to be parsed
* inputlen: the length of the array pointed to be input * inputlen: the length of the array pointed to be input
@ -520,7 +520,7 @@ SECP256K1_API int secp256k1_ecdsa_signature_parse_der(
/** Serialize an ECDSA signature in DER format. /** Serialize an ECDSA signature in DER format.
* *
* Returns: 1 if enough space was available to serialize, 0 otherwise * Returns: 1 if enough space was available to serialize, 0 otherwise
* Args: ctx: a secp256k1 context object * Args: ctx: pointer to a context object
* Out: output: a pointer to an array to store the DER serialization * Out: output: a pointer to an array to store the DER serialization
* In/Out: outputlen: a pointer to a length integer. Initially, this integer * In/Out: outputlen: a pointer to a length integer. Initially, this integer
* should be set to the length of output. After the call * should be set to the length of output. After the call
@ -538,9 +538,9 @@ SECP256K1_API int secp256k1_ecdsa_signature_serialize_der(
/** Serialize an ECDSA signature in compact (64 byte) format. /** Serialize an ECDSA signature in compact (64 byte) format.
* *
* Returns: 1 * Returns: 1
* Args: ctx: a secp256k1 context object * Args: ctx: pointer to a context object
* Out: output64: a pointer to a 64-byte array to store the compact serialization * Out: output64: pointer to a 64-byte array to store the compact serialization
* In: sig: a pointer to an initialized signature object * In: sig: pointer to an initialized signature object
* *
* See secp256k1_ecdsa_signature_parse_compact for details about the encoding. * See secp256k1_ecdsa_signature_parse_compact for details about the encoding.
*/ */
@ -554,7 +554,7 @@ SECP256K1_API int secp256k1_ecdsa_signature_serialize_compact(
* *
* Returns: 1: correct signature * Returns: 1: correct signature
* 0: incorrect or unparseable signature * 0: incorrect or unparseable signature
* Args: ctx: a secp256k1 context object. * Args: ctx: pointer to a context object
* In: sig: the signature being verified. * In: sig: the signature being verified.
* msghash32: the 32-byte message hash being verified. * msghash32: the 32-byte message hash being verified.
* The verifier must make sure to apply a cryptographic * The verifier must make sure to apply a cryptographic
@ -585,7 +585,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ecdsa_verify(
/** Convert a signature to a normalized lower-S form. /** Convert a signature to a normalized lower-S form.
* *
* Returns: 1 if sigin was not normalized, 0 if it already was. * Returns: 1 if sigin was not normalized, 0 if it already was.
* Args: ctx: a secp256k1 context object * Args: ctx: pointer to a context object
* Out: sigout: a pointer to a signature to fill with the normalized form, * Out: sigout: a pointer to a signature to fill with the normalized form,
* or copy if the input was already normalized. (can be NULL if * or copy if the input was already normalized. (can be NULL if
* you're only interested in whether the input was already * you're only interested in whether the input was already

6
include/secp256k1_extrakeys.h
View File

@ -39,7 +39,7 @@ typedef struct {
* Returns: 1 if the public key was fully valid. * Returns: 1 if the public key was fully valid.
* 0 if the public key could not be parsed or is invalid. * 0 if the public key could not be parsed or is invalid.
* *
* Args: ctx: a secp256k1 context object. * Args: ctx: pointer to a context object.
* Out: pubkey: pointer to a pubkey object. If 1 is returned, it is set to a * Out: pubkey: pointer to a pubkey object. If 1 is returned, it is set to a
* parsed version of input. If not, it's set to an invalid value. * parsed version of input. If not, it's set to an invalid value.
* In: input32: pointer to a serialized xonly_pubkey. * In: input32: pointer to a serialized xonly_pubkey.
@ -54,7 +54,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_xonly_pubkey_parse(
* *
* Returns: 1 always. * Returns: 1 always.
* *
* Args: ctx: a secp256k1 context object. * Args: ctx: pointer to a context object.
* Out: output32: a pointer to a 32-byte array to place the serialized key in. * Out: output32: a pointer to a 32-byte array to place the serialized key in.
* In: pubkey: a pointer to a secp256k1_xonly_pubkey containing an initialized public key. * In: pubkey: a pointer to a secp256k1_xonly_pubkey containing an initialized public key.
*/ */
@ -69,7 +69,7 @@ SECP256K1_API int secp256k1_xonly_pubkey_serialize(
* Returns: <0 if the first public key is less than the second * Returns: <0 if the first public key is less than the second
* >0 if the first public key is greater than the second * >0 if the first public key is greater than the second
* 0 if the two public keys are equal * 0 if the two public keys are equal
* Args: ctx: a secp256k1 context object. * Args: ctx: pointer to a context object.
* In: pubkey1: first public key to compare * In: pubkey1: first public key to compare
* pubkey2: second public key to compare * pubkey2: second public key to compare
*/ */

10
include/secp256k1_preallocated.h
View File

@ -52,7 +52,7 @@ SECP256K1_API size_t secp256k1_context_preallocated_size(
* in the memory. In simpler words, the prealloc pointer (or any pointer derived * in the memory. In simpler words, the prealloc pointer (or any pointer derived
* from it) should not be used during the lifetime of the context object. * from it) should not be used during the lifetime of the context object.
* *
* Returns: a newly created context object. * Returns: pointer to newly created context object.
* In: prealloc: a pointer to a rewritable contiguous block of memory of * In: prealloc: a pointer to a rewritable contiguous block of memory of
* size at least secp256k1_context_preallocated_size(flags) * size at least secp256k1_context_preallocated_size(flags)
* bytes, as detailed above. * bytes, as detailed above.
@ -72,7 +72,7 @@ SECP256K1_API secp256k1_context *secp256k1_context_preallocated_create(
* caller-provided memory. * caller-provided memory.
* *
* Returns: the required size of the caller-provided memory block. * Returns: the required size of the caller-provided memory block.
* In: ctx: an existing context to copy. * In: ctx: pointer to a context to copy.
*/ */
SECP256K1_API size_t secp256k1_context_preallocated_clone_size( SECP256K1_API size_t secp256k1_context_preallocated_clone_size(
const secp256k1_context *ctx const secp256k1_context *ctx
@ -91,8 +91,8 @@ SECP256K1_API size_t secp256k1_context_preallocated_clone_size(
* Cloning secp256k1_context_static is not possible, and should not be emulated by * Cloning secp256k1_context_static is not possible, and should not be emulated by
* the caller (e.g., using memcpy). Create a new context instead. * the caller (e.g., using memcpy). Create a new context instead.
* *
* Returns: a newly created context object. * Returns: pointer to a newly created context object.
* Args: ctx: an existing context to copy (not secp256k1_context_static). * Args: ctx: pointer to a context to copy (not secp256k1_context_static).
* In: prealloc: a pointer to a rewritable contiguous block of memory of * In: prealloc: a pointer to a rewritable contiguous block of memory of
* size at least secp256k1_context_preallocated_size(flags) * size at least secp256k1_context_preallocated_size(flags)
* bytes, as detailed above. * bytes, as detailed above.
@ -118,7 +118,7 @@ SECP256K1_API secp256k1_context *secp256k1_context_preallocated_clone(
* preallocated pointer given to secp256k1_context_preallocated_create or * preallocated pointer given to secp256k1_context_preallocated_create or
* secp256k1_context_preallocated_clone. * secp256k1_context_preallocated_clone.
* *
* Args: ctx: an existing context to destroy, constructed using * Args: ctx: pointer to a context to destroy, constructed using
* secp256k1_context_preallocated_create or * secp256k1_context_preallocated_create or
* secp256k1_context_preallocated_clone * secp256k1_context_preallocated_clone
* (i.e., not secp256k1_context_static). * (i.e., not secp256k1_context_static).

20
include/secp256k1_recovery.h
View File

@ -28,9 +28,9 @@ typedef struct {
/** Parse a compact ECDSA signature (64 bytes + recovery id). /** Parse a compact ECDSA signature (64 bytes + recovery id).
* *
* Returns: 1 when the signature could be parsed, 0 otherwise * Returns: 1 when the signature could be parsed, 0 otherwise
* Args: ctx: a secp256k1 context object * Args: ctx: pointer to a context object
* Out: sig: a pointer to a signature object * Out: sig: pointer to a signature object
* In: input64: a pointer to a 64-byte compact signature * In: input64: pointer to a 64-byte compact signature
* recid: the recovery id (0, 1, 2 or 3) * recid: the recovery id (0, 1, 2 or 3)
*/ */
SECP256K1_API int secp256k1_ecdsa_recoverable_signature_parse_compact( SECP256K1_API int secp256k1_ecdsa_recoverable_signature_parse_compact(
@ -43,9 +43,9 @@ SECP256K1_API int secp256k1_ecdsa_recoverable_signature_parse_compact(
/** Convert a recoverable signature into a normal signature. /** Convert a recoverable signature into a normal signature.
* *
* Returns: 1 * Returns: 1
* Args: ctx: a secp256k1 context object. * Args: ctx: pointer to a context object.
* Out: sig: a pointer to a normal signature. * Out: sig: pointer to a normal signature.
* In: sigin: a pointer to a recoverable signature. * In: sigin: pointer to a recoverable signature.
*/ */
SECP256K1_API int secp256k1_ecdsa_recoverable_signature_convert( SECP256K1_API int secp256k1_ecdsa_recoverable_signature_convert(
const secp256k1_context *ctx, const secp256k1_context *ctx,
@ -56,10 +56,10 @@ SECP256K1_API int secp256k1_ecdsa_recoverable_signature_convert(
/** Serialize an ECDSA signature in compact format (64 bytes + recovery id). /** Serialize an ECDSA signature in compact format (64 bytes + recovery id).
* *
* Returns: 1 * Returns: 1
* Args: ctx: a secp256k1 context object. * Args: ctx: pointer to a context object.
* Out: output64: a pointer to a 64-byte array of the compact signature. * Out: output64: pointer to a 64-byte array of the compact signature.
* recid: a pointer to an integer to hold the recovery id. * recid: pointer to an integer to hold the recovery id.
* In: sig: a pointer to an initialized signature object. * In: sig: pointer to an initialized signature object.
*/ */
SECP256K1_API int secp256k1_ecdsa_recoverable_signature_serialize_compact( SECP256K1_API int secp256k1_ecdsa_recoverable_signature_serialize_compact(
const secp256k1_context *ctx, const secp256k1_context *ctx,

2
include/secp256k1_schnorrsig.h
View File

@ -169,7 +169,7 @@ SECP256K1_API int secp256k1_schnorrsig_sign_custom(
* *
* Returns: 1: correct signature * Returns: 1: correct signature
* 0: incorrect signature * 0: incorrect signature
* Args: ctx: a secp256k1 context object. * Args: ctx: pointer to a context object.
* In: sig64: pointer to the 64-byte signature to verify. * In: sig64: pointer to the 64-byte signature to verify.
* msg: the message being verified. Can only be NULL if msglen is 0. * msg: the message being verified. Can only be NULL if msglen is 0.
* msglen: length of the message * msglen: length of the message