docs(proof): add documentation on terminating the bn128 curve to prevent resource leaks #998
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ent resource leaks
vplasencia
approved these changes
Oct 22, 2025
|
Congrats, your important contribution to this open-source project has earned you a GitPOAP! GitPOAP: 2025 Semaphore Contributor: Head to gitpoap.io & connect your GitHub account to mint! Learn more about GitPOAPs here. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a new section to the packages/proof/README.md explaining the importance of calling terminate() on the bn128 curve instance when using getCurveFromName("bn128") from the ffjavascript package. This prevents resource leaks (such as lingering MessagePort handles) and ensures Node.js processes exit cleanly, especially in test environments. Includes a usage example for proper resource management.
Fixes #318