Skip to content

docs(secp256k1): document local build loading and submodule init#123

Open
odudex wants to merge 1 commit into
diybitcoinhardware:masterfrom
odudex:secp256k1_build_instructions
Open

docs(secp256k1): document local build loading and submodule init#123
odudex wants to merge 1 commit into
diybitcoinhardware:masterfrom
odudex:secp256k1_build_instructions

Conversation

@odudex
Copy link
Copy Markdown
Collaborator

@odudex odudex commented May 12, 2026

  • Document git submodule update --recursive --init as a fallback when embit was cloned without --recursive.
  • Show how to symlink the local make output into secp256k1-zkp/.libs/ so Python picks up the native backend, with a one-liner to verify ecdh/rangeproof_rewind are exposed.

Test plan

  • Follow the README steps on Linux and confirm the verification command prints True True.
  • Repeat on macOS with the .dylib suffix.

@odudex odudex requested a review from miketlk as a code owner May 12, 2026 20:57
Copilot AI review requested due to automatic review settings May 12, 2026 20:57
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves the secp256k1 build documentation by adding guidance for initializing the secp256k1-zkp submodule after a non-recursive clone, and by documenting how to make a locally built libsecp256k1 discoverable by embit’s Python ctypes loader.

Changes:

  • Add a fallback git submodule update --recursive --init command for existing clones.
  • Document where make outputs the shared library artifact.
  • Add steps to symlink the local build into secp256k1-zkp/.libs and a Python one-liner to verify optional symbols (ECDH + rangeproof rewind) are available.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread secp256k1/README.md
Comment on lines +49 to +50
Run those commands from the `secp256k1/` directory. On macOS, replace the
`.so` suffix with `.dylib`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants