extrakeys: Clarify comparison order of compare/sort functions

Note that the touched functions don't exist upstream currently.
This commit is contained in:
Tim Ruffing 2023-04-21 15:56:09 +02:00
parent 050d9b2912
commit da7702844e

View File

@ -242,7 +242,8 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_keypair_xonly_tweak_add
const unsigned char *tweak32 const unsigned char *tweak32
) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3); ) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3);
/** Compare two public keys using lexicographic order /** Compare two public keys using lexicographic order of their compressed
* serialization.
* *
* 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
@ -257,7 +258,8 @@ SECP256K1_API int secp256k1_pubkey_cmp(
const secp256k1_pubkey* pk2 const secp256k1_pubkey* pk2
) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3); ) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3);
/** Sorts public keys using lexicographic order /** Sort public keys using lexicographic order of their compressed
* serialization.
* *
* Returns: 0 if the arguments are invalid. 1 otherwise. * Returns: 0 if the arguments are invalid. 1 otherwise.
* *