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

tweak_add: fix API doc for tweak=0

Browse Source
This commit is contained in:
Jonas Nick 2023-05-23 18:32:15 +00:00
parent d373a7215b
commit 05873bb6b1
No known key found for this signature in database
GPG Key ID: 4861DBF262123605
2 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
include/secp256k1.h
View File

@ -733,10 +733,10 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_pubkey_negate(
* invalid according to secp256k1_ec_seckey_verify, this * invalid according to secp256k1_ec_seckey_verify, this
* function returns 0. seckey will be set to some unspecified * function returns 0. seckey will be set to some unspecified
* value if this function returns 0. * value if this function returns 0.
* In: tweak32: pointer to a 32-byte tweak. If the tweak is invalid according to * In: tweak32: pointer to a 32-byte tweak, which must be valid according to
* secp256k1_ec_seckey_verify, this function returns 0. For * secp256k1_ec_seckey_verify or 32 zero bytes. For uniformly
* uniformly random 32-byte arrays the chance of being invalid * random 32-byte tweaks, the chance of being invalid is
* is negligible (around 1 in 2^128). * negligible (around 1 in 2^128).
*/ */
SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_seckey_tweak_add( SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_seckey_tweak_add(
const secp256k1_context *ctx, const secp256k1_context *ctx,
@ -761,10 +761,10 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_privkey_tweak_add(
* Args: ctx: pointer to a context object. * Args: ctx: pointer to a context object.
* In/Out: pubkey: pointer to a public key object. pubkey will be set to an * In/Out: pubkey: pointer to a public key object. pubkey will be set to an
* invalid value if this function returns 0. * invalid value if this function returns 0.
* In: tweak32: pointer to a 32-byte tweak. If the tweak is invalid according to * In: tweak32: pointer to a 32-byte tweak, which must be valid according to
* secp256k1_ec_seckey_verify, this function returns 0. For * secp256k1_ec_seckey_verify or 32 zero bytes. For uniformly
* uniformly random 32-byte arrays the chance of being invalid * random 32-byte tweaks, the chance of being invalid is
* is negligible (around 1 in 2^128). * negligible (around 1 in 2^128).
*/ */
SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_pubkey_tweak_add( SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_pubkey_tweak_add(
const secp256k1_context *ctx, const secp256k1_context *ctx,

16
include/secp256k1_extrakeys.h
View File

@ -112,10 +112,10 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_xonly_pubkey_from_pubke
* Out: output_pubkey: pointer to a public key to store the result. Will be set * Out: output_pubkey: pointer to a public key to store the result. Will be set
* to an invalid value if this function returns 0. * to an invalid value if this function returns 0.
* In: internal_pubkey: pointer to an x-only pubkey to apply the tweak to. * In: internal_pubkey: pointer to an x-only pubkey to apply the tweak to.
* tweak32: pointer to a 32-byte tweak. If the tweak is invalid * tweak32: pointer to a 32-byte tweak, which must be valid
* according to secp256k1_ec_seckey_verify, this function * according to secp256k1_ec_seckey_verify or 32 zero
* returns 0. For uniformly random 32-byte arrays the * bytes. For uniformly random 32-byte tweaks, the chance of
* chance of being invalid is negligible (around 1 in 2^128). * being invalid is negligible (around 1 in 2^128).
*/ */
SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_xonly_pubkey_tweak_add( SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_xonly_pubkey_tweak_add(
const secp256k1_context *ctx, const secp256k1_context *ctx,
@ -231,10 +231,10 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_keypair_xonly_pub(
* Args: ctx: pointer to a context object. * Args: ctx: pointer to a context object.
* In/Out: keypair: pointer to a keypair to apply the tweak to. Will be set to * In/Out: keypair: pointer to a keypair to apply the tweak to. Will be set to
* an invalid value if this function returns 0. * an invalid value if this function returns 0.
* In: tweak32: pointer to a 32-byte tweak. If the tweak is invalid according * In: tweak32: pointer to a 32-byte tweak, which must be valid according to
* to secp256k1_ec_seckey_verify, this function returns 0. For * secp256k1_ec_seckey_verify or 32 zero bytes. For uniformly
* uniformly random 32-byte arrays the chance of being invalid * random 32-byte tweaks, the chance of being invalid is
* is negligible (around 1 in 2^128). * negligible (around 1 in 2^128).
*/ */
SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_keypair_xonly_tweak_add( SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_keypair_xonly_tweak_add(
const secp256k1_context *ctx, const secp256k1_context *ctx,