Skip to content

Commit 4985ac0

Browse files
Merge #1737: doc: mention ctx requirement for _ellswift_create (not secp256k1_context_static)
806de38 doc: mention ctx requirement for `_ellswift_create` (not secp256k1_context_static) (Sebastian Falbesoner) Pull request description: Public functions that require a context for generator point multiplication (i.e. `ctx->ecmult_gen_ctx` is built) usually denote this in the API header by mentioning to not use `secp256k1_context_static`, so add this for `_ellswift_create` as well. This seems the only instance where this is missing currently, see ``` $ git grep ecmult_gen_context_is_built $ git grep ctx:.*context_static ``` (note that in the musig and schnorr modules, two public functions for nonce generation / signing map to a single internal function where the context requirement is checked). Noted while reviewing #1698. ACKs for top commit: sipa: ACK 806de38 jonasnick: ACK 806de38 real-or-random: ACK 806de38 josibake: ACK 806de38 Tree-SHA512: 902e9e21060e09e8e7d72fec8cdc42e0ed18f95824d3220100d7b65720511f934d38e3e556e38bb510d98284bccc12b857f329997640d1c07edd5b55ef6d8e09
2 parents 03fb60a + 806de38 commit 4985ac0

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

include/secp256k1_ellswift.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ SECP256K1_API int secp256k1_ellswift_decode(
130130
*
131131
* Returns: 1: secret was valid, public key was stored.
132132
* 0: secret was invalid, try again.
133-
* Args: ctx: pointer to a context object
133+
* Args: ctx: pointer to a context object (not secp256k1_context_static)
134134
* Out: ell64: pointer to a 64-byte array to receive the ElligatorSwift
135135
* public key
136136
* In: seckey32: pointer to a 32-byte secret key

0 commit comments

Comments
 (0)