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

docs: Fix return value for functions that don't have invalid inputs

Browse Source 
_tagged_sha256 simply cannot have invalid inputs.

The other functions could in some sense have invalid inputs but only in
violation of the type system. For example, a pubkey could be invalid but
invalid objects of type secp256k1_pubkey either can't be obtained
via the API or will be caught by an ARG_CHECK when calling pubkey_load.

This is consistent with similar functions in the public API, e.g.,
_ec_pubkey_negate or _ec_pubkey_serialize.
This commit is contained in:
Tim Ruffing 2022-03-16 12:43:18 +01:00
parent f813bb0df3
commit b8f8b99f0f
2 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/secp256k1.h
View File

@ -814,7 +814,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_pubkey_combine(
* implementations optimized for a specific tag can precompute the SHA256 state * implementations optimized for a specific tag can precompute the SHA256 state
* after hashing the tag hashes. * after hashing the tag hashes.
* *
* Returns 0 if the arguments are invalid and 1 otherwise. * Returns: 1 always.
* Args: ctx: pointer to a context object * Args: ctx: pointer to a context object
* Out: hash32: pointer to a 32-byte array to store the resulting hash * Out: hash32: pointer to a 32-byte array to store the resulting hash
* In: tag: pointer to an array containing the tag * In: tag: pointer to an array containing the tag

9
include/secp256k1_extrakeys.h
View File

@ -81,8 +81,7 @@ SECP256K1_API int secp256k1_xonly_pubkey_cmp(
/** Converts a secp256k1_pubkey into a secp256k1_xonly_pubkey. /** Converts a secp256k1_pubkey into a secp256k1_xonly_pubkey.
* *
* Returns: 1 if the public key was successfully converted * Returns: 1 always.
* 0 otherwise
* *
* Args: ctx: pointer to a context object. * Args: ctx: pointer to a context object.
* Out: xonly_pubkey: pointer to an x-only public key object for placing the converted public key. * Out: xonly_pubkey: pointer to an x-only public key object for placing the converted public key.
@ -172,7 +171,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_keypair_create(
/** Get the secret key from a keypair. /** Get the secret key from a keypair.
* *
* Returns: 0 if the arguments are invalid. 1 otherwise. * Returns: 1 always.
* Args: ctx: pointer to a context object. * Args: ctx: pointer to a context object.
* Out: seckey: pointer to a 32-byte buffer for the secret key. * Out: seckey: pointer to a 32-byte buffer for the secret key.
* In: keypair: pointer to a keypair. * In: keypair: pointer to a keypair.
@ -185,7 +184,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_keypair_sec(
/** Get the public key from a keypair. /** Get the public key from a keypair.
* *
* Returns: 0 if the arguments are invalid. 1 otherwise. * Returns: 1 always.
* Args: ctx: pointer to a context object. * Args: ctx: pointer to a context object.
* Out: pubkey: pointer to a pubkey object. If 1 is returned, it is set to * Out: pubkey: pointer to a pubkey object. If 1 is returned, it is set to
* the keypair public key. If not, it's set to an invalid value. * the keypair public key. If not, it's set to an invalid value.
@ -202,7 +201,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_keypair_pub(
* This is the same as calling secp256k1_keypair_pub and then * This is the same as calling secp256k1_keypair_pub and then
* secp256k1_xonly_pubkey_from_pubkey. * secp256k1_xonly_pubkey_from_pubkey.
* *
* Returns: 0 if the arguments are invalid. 1 otherwise. * Returns: 1 always.
* Args: ctx: pointer to a context object. * Args: ctx: pointer to a context object.
* Out: pubkey: pointer to an xonly_pubkey object. If 1 is returned, it is set * Out: pubkey: pointer to an xonly_pubkey object. If 1 is returned, it is set
* to the keypair public key after converting it to an * to the keypair public key after converting it to an