From dc7d8fd9e2576c399a7ed25aa98b0f23ffac6766 Mon Sep 17 00:00:00 2001 From: Marko Bencun Date: Thu, 16 Jan 2020 16:48:49 +0100 Subject: [PATCH] scalar: extend docstring of secp256k1_scalar_set_b32 --- src/scalar.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/scalar.h b/src/scalar.h index 59304cb6..1ee50e1f 100644 --- a/src/scalar.h +++ b/src/scalar.h @@ -32,7 +32,11 @@ static unsigned int secp256k1_scalar_get_bits(const secp256k1_scalar *a, unsigne /** Access bits from a scalar. Not constant time. */ static unsigned int secp256k1_scalar_get_bits_var(const secp256k1_scalar *a, unsigned int offset, unsigned int count); -/** Set a scalar from a big endian byte array. */ +/** Set a scalar from a big endian byte array. The scalar will be reduced modulo group order `n`. + * In: bin: pointer to a 32-byte array. + * Out: r: scalar to be set. + * overflow: non-zero if the scalar was bigger or equal to `n` before reduction, zero otherwise (can be NULL). + */ static void secp256k1_scalar_set_b32(secp256k1_scalar *r, const unsigned char *bin, int *overflow); /** Set a scalar to an unsigned integer. */