doc: mention ctx requirement for `_ellswift_create` (not secp256k1_context_static) #1737

pull theStack wants to merge 1 commits into bitcoin-core:master from theStack:doc-ctx-requirement-for-ellswift_create changing 1 files +1 −1
  1. theStack commented at 5:27 PM on September 5, 2025: contributor

    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.

  2. doc: mention ctx requirement for `_ellswift_create` (not secp256k1_context_static) 806de38bfc
  3. jonasnick approved
  4. jonasnick commented at 5:55 PM on September 5, 2025: contributor

    ACK 806de38bfc24b481c5858f1df011eb909208a674

  5. sipa commented at 5:56 PM on September 6, 2025: contributor

    Why "(not secp256k1_context_static)"?

  6. jonasnick commented at 8:14 AM on September 7, 2025: contributor

    @sipa Because ellswift_create requires the ecmult_gen_context to be built, which is not the case for the static context. The wording "(not secp256k1_context_static)" is consistent with the other functions that have the same requirement on the context.

  7. real-or-random approved
  8. real-or-random commented at 7:43 AM on September 8, 2025: contributor

    ACK 806de38bfc24b481c5858f1df011eb909208a674

  9. real-or-random added the label user-documentation on Sep 8, 2025
  10. real-or-random added the label tweak/refactor on Sep 8, 2025
  11. josibake commented at 9:26 AM on September 8, 2025: member

    ACK https://github.com/bitcoin-core/secp256k1/pull/1737/commits/806de38bfc24b481c5858f1df011eb909208a674

    Did a quick grep to verify this wording matches the wording used in other places, and in general agree we should consistently document this for functions that won't work with the static context.

  12. sipa commented at 2:34 PM on September 8, 2025: contributor

    ACK 806de38bfc24b481c5858f1df011eb909208a674

  13. real-or-random merged this on Sep 8, 2025
  14. real-or-random closed this on Sep 8, 2025

  15. vmta referenced this in commit 2b25f561a0 on Sep 21, 2025
  16. fanquake referenced this in commit 42c7d35d3a on Oct 14, 2025
  17. fanquake referenced this in commit 3cbf7cb3e6 on Oct 15, 2025
  18. Sjors referenced this in commit d5660d3a13 on Feb 16, 2026
  19. real-or-random referenced this in commit 42ae776d3b on Feb 25, 2026
  20. github-actions[bot] referenced this in commit c3f80fff5f on Mar 1, 2026
  21. github-actions[bot] referenced this in commit 758d4e90b4 on Mar 1, 2026
  22. github-actions[bot] referenced this in commit 4aeff8400e on Mar 1, 2026
  23. github-actions[bot] referenced this in commit 68a2178f22 on Mar 1, 2026
  24. github-actions[bot] referenced this in commit a8bc1a0b2b on Mar 1, 2026
  25. github-actions[bot] referenced this in commit 5f15eb0c55 on Mar 1, 2026
  26. 0x000000000019d6689c085ae165831e934ff76 referenced this in commit d54574beca on Mar 2, 2026
  27. 0x000000000019d6689c085ae165831e934ff76 referenced this in commit 3b9450150d on Mar 2, 2026
  28. csjones referenced this in commit fb3e16af04 on Mar 2, 2026
  29. csjones referenced this in commit a4d92824ae on Mar 2, 2026

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin-core/secp256k1. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-05-19 06:52 UTC