libp2p / libp2p/py-libp2p

Migration to Coincurve for Non-Windows Systems

Open
#548 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
624
Forks
256
Avg merge
1d 34m
Merged PRs (30d)
47

Description

Description

This issue will track the continued migration to Coincurve for non-Windows systems, ensuring a smooth transition and addressing any challenges that arise during the process. Coincurve offers a more robust and efficient cryptographic backend, making it a valuable update for improving performance and compatibility across platforms.

Motivation

The current cryptographic library for non-Windows systems has limitations in terms of performance and compatibility for Py-libp2p. Migrating to Coincurve provides a more robust and efficient solution, aligning with our goal to enhance cross-platform support and maintain a modern codebase.

Current Implementation

Complete the migration to Coincurve for non-Windows systems, replacing any dependencies that are incompatible or suboptimal for these environments.

Key Tasks:

  • Audit Current Dependencies:

Identify existing cryptographic dependencies that Coincurve will replace.

Document where these dependencies are used in the codebase.

  • Implement Coincurve Integration:

Replace outdated dependencies with Coincurve in all relevant modules.

Ensure compatibility with the current codebase.

  • Testing:

Create unit tests to verify Coincurve integration.

Perform platform-specific testing on Linux and macOS to ensure there are no compatibility issues.

  • Documentation:

Update developer documentation to reflect the migration to Coincurve.

Include instructions for setting up and using Coincurve on non-Windows systems.

  • Community Feedback and Support:

Gather feedback from contributors and users during the migration process.

Address any questions or concerns related to Coincurve usage.

Resources:

Coincurve Documentation

How You Can Help:

If you’re familiar with Coincurve or cryptographic migrations, your expertise would be incredibly valuable! Please feel free to share insights, answer questions, or contribute code. You can also help by testing the changes on non-Windows systems and reporting any issues.

Let’s work together to make this migration as seamless as possible. Thank you to everyone involved in this effort!

Are you planning to do it yourself in a pull request ?

Maybe

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by auditing the repository's existing cryptographic dependencies and documenting where they are used; the issue does not name specific files or tests. Done means Coincurve replaces the relevant non-Windows dependencies, unit and Linux/macOS compatibility tests pass, and developer setup documentation is updated.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cryptography
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.