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

Decoupling Message Generator and Deprecating Serde Variant in Binary_SV2 #1387

Open
1 task done
Shourya742 opened this issue Jan 23, 2025 · 3 comments
Open
1 task done
Labels
protocols Lowest level protocol logic refactor Implies refactoring code

Comments

@Shourya742
Copy link
Contributor

Shourya742 commented Jan 23, 2025

Currently, we maintain two variants of binary_sv2: the serde variant and the no-serde variant. The serde variant was originally retained to support the Message Generator. However, since we are now working to decouple the Message Generator into a separate repository, maintaining the serde variant of binary_sv2 is no longer necessary. This issue will serve as a tracker for all required changes to complete the migration and deprecate the serde variant.

Action Items:

  1. Decouple the Message Generator: Move the Message Generator to its own repository. The new repository will depend on protocol crates that reference a previously released version of the protocol where serde was still supported as a feature flag. This task is currently led by @plebhash, and the ongoing development can be tracked here: [GitHub Repository - Stratum Message Generator](https://github.com/stratum-mining/stratum-message-generator).

  2. Deprecate the serde variant of binary_sv2: Designate the no-serde variant as the primary and sole variant of binary_sv2. Additionally, remove all with_serde feature flags throughout the roles and protocol.

  3. Refining the current MG Test workflow to checkout the MG from its future repo

Both task 1 and 2 are disjoint, and share no dependence.

@jbesraa
Copy link
Contributor

jbesraa commented Jan 23, 2025

for (2) we should include roles workspace as well

@plebhash plebhash added refactor Implies refactoring code protocols Lowest level protocol logic labels Jan 23, 2025
@plebhash
Copy link
Collaborator

it's also important to highlight that (1) is not a pre-requisite for (2).

@GitGab19
Copy link
Collaborator

We should also add another point in this list which is:

  • refining the current MG Test workflow to checkout the MG from its future repo

In this way we could move it out and still run those tests in our CI, while migrating every test.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
protocols Lowest level protocol logic refactor Implies refactoring code
Projects
None yet
Development

No branches or pull requests

4 participants