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

split roles bin lib #821

Closed
wants to merge 14 commits into from
Closed

Conversation

plebhash
Copy link
Collaborator

@plebhash plebhash commented Mar 28, 2024

close #820

as stated in #702, it is desirable to have some clear distinction between:

  • reference implementation for roles (bin)
  • reusable high-level APIs for roles implementations (lib)

so we should split the roles workspace in two distinct directories, one for lib (APIs) and one for bin (executable applications).

a *_bin suffix was added to the name of binary crates (to avoid name clash), which now have the following names:

  • jd_client_sv2_bin (also added _sv2 for consistency with other roles)
  • jd_server_sv2_bin (also added _sv2 for consistency with other roles)
  • proxy_sv2_bin (removed mining_ from the beginning to avoid redundancy)
  • pool_sv2_bin
  • translator_proxy_sv2_bin (added _proxy to make it clear this is another kind of proxy)

library crates now have the following names:

  • jd_client_sv2 (added _sv2 for consistency with other roles)
  • jd_server_sv2 (added _sv2 for consistency with other roles)
  • proxy_sv2 (removed mining_ from the beginning to avoid redundancy)
  • network_helpers_sv2
  • pool_sv2
  • rpc_sv2
  • translator_proxy_sv2 (added _proxy to make it clear this is another kind of proxy)

config-examples only exist for binary crates
main.rs and args.rs only exist for binary crates
lib.rs (+ all other internal logic) only exist for library crates

@lorbax
Copy link
Collaborator

lorbax commented Mar 29, 2024

Is this PR supposed to be against main?

@plebhash plebhash changed the base branch from main to dev March 29, 2024 15:00
@plebhash
Copy link
Collaborator Author

Is this PR supposed to be against main?

no, just fixed for dev

@plebhash plebhash changed the base branch from dev to main March 29, 2024 17:06
@plebhash plebhash changed the base branch from main to dev March 29, 2024 17:06
@plebhash plebhash force-pushed the split-roles-bin-lib branch 4 times, most recently from a7d016a to 6bc3c79 Compare March 29, 2024 20:20
@plebhash plebhash marked this pull request as ready for review March 29, 2024 20:29
@plebhash plebhash marked this pull request as draft March 29, 2024 22:17
@plebhash plebhash closed this Mar 30, 2024
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.

split roles crates into lib + bin
2 participants