Skip to content

Commit cd54ac7

Browse files
schnorrsig: Improve docs of schnorrsig_sign_custom
1 parent 28687b0 commit cd54ac7

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

include/secp256k1_schnorrsig.h

+6-2
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,12 @@ SECP256K1_API int secp256k1_schnorrsig_sign(
141141
* variable length messages and accepts a pointer to an extraparams object that
142142
* allows customizing signing by passing additional arguments.
143143
*
144-
* Creates the same signatures as schnorrsig_sign if msglen is 32 and the
145-
* extraparams.ndata is the same as aux_rand32.
144+
* Equivalent to secp256k1_schnorrsig_sign32(..., aux_rand32) if msglen is 32
145+
* and extraparams is initialized as follows:
146+
* ```
147+
* secp256k1_schnorrsig_extraparams extraparams = SECP256K1_SCHNORRSIG_EXTRAPARAMS_INIT;
148+
* extraparams.ndata = (unsigned char*)aux_rand32;
149+
* ```
146150
*
147151
* Returns 1 on success, 0 on failure.
148152
* Args: ctx: pointer to a context object (not secp256k1_context_static).

0 commit comments

Comments
 (0)