Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extract secp256k1 code into a python package #24

Open
real-or-random opened this issue Jun 13, 2024 · 3 comments
Open

Extract secp256k1 code into a python package #24

real-or-random opened this issue Jun 13, 2024 · 3 comments
Milestone

Comments

@real-or-random
Copy link
Collaborator

"secp256k1-proto" sounds good to me

@real-or-random
Copy link
Collaborator Author

It's not yet entirely clear to me how this should like in the end.

  • Will we include the full code of the package in the BIP? Or just refer to it, possibly pinned to some commit. The latter sounds cleaner.
  • The package should at least have docstrings for all objects we import, to clarify the operations we rely on (like in BIP340, where we define stuff like lift_x). But then, if we don't include the full contents of the package, then the BIP is technically speaking not fully self-contained... Is that a problem? In theory, we could also run pydoc on the package and include the output in the BIP. But that sounds a bit like overkill.

@real-or-random real-or-random added this to the final milestone Jul 8, 2024
@real-or-random
Copy link
Collaborator Author

We discussed this somewhere else.

One additional insight is that we could also have a git subtree with the package. That would make the BIP self-contained (i.e., no external resources in external repos).

We think it's best to discuss this with the BIP editors before we take a decision.

@real-or-random
Copy link
Collaborator Author

@jonasnick in #52 (comment):

We discussed offline that requiring an external dependency is fine if secp256k1proto becomes a package. For now, secp256k1proto could also be a submodule instead of a package. Whatever is easier until we have a final deisionon this.

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

No branches or pull requests

1 participant