We've seen some people attempting to use the library calling into random internal functions. That should be harder to do now... but now that the basic signature interface is relatively safe to use (as such things go) there should be some easy copy and paste examples for correct usage.
Documentation should provide example callers. #184
issue gmaxwell opened this issue on January 11, 2015-
gmaxwell commented at 4:52 AM on January 11, 2015: contributor
- gmaxwell added the label documentation on Jan 11, 2015
- gmaxwell assigned gmaxwell on Jan 11, 2015
- gmaxwell added this to the milestone initial release on Aug 27, 2015
-
jonasnick commented at 3:19 PM on February 21, 2019: contributor
As an example we have someting like this in secp256k1-zkp to demonstrate musig: https://github.com/ElementsProject/secp256k1-zkp/blob/secp256k1-zkp/src/modules/musig/example.c
-
nickfarrow commented at 11:46 PM on March 24, 2020: none
For anyone else interested in how to generate keys using this library, feel free to checkout my Bitcoin vanity address generator which I think provides a short and reasonably well commented example of how to generate private and public key pairs.
- jonasnick renamed this:
Docucmentation should provide example callers.
Documentation should provide example callers.
on Apr 28, 2020 -
jonasnick commented at 8:33 AM on April 28, 2020: contributor
I'd suggest to add a short and well documented example source file for every module and build and run it as part of
make check. We can list the modules in the README and from there link to the examples and include files for more documentation. - jonasnick closed this on Feb 23, 2022
- real-or-random referenced this in commit ac561601b8 on Feb 19, 2026
Contributors
Labels
Milestone
stable release (1.0.0-rc.1)