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

refactor: Move iroh-router into iroh-net and rename iroh-net to iroh #2970

Draft
wants to merge 3 commits into
base: refactor-simple-iroh
Choose a base branch
from

Conversation

matheus23
Copy link
Contributor

@matheus23 matheus23 commented Nov 27, 2024

Description

This merges iroh-net, iroh-router and iroh into simply one crate: iroh.

Breaking Changes

  • iroh-net got renamed to iroh
  • iroh-router moved into iroh
  • iroh-router::ProtocolHandler is now iroh::protocol::ProtocolHandler
  • iroh-router::ProtocolMap is now iroh::protocol::ProtocolMap
  • iroh-router::Router is now iroh::router::Router
  • iroh-router::RouterBuilder is now iroh::router::RouterBuilder

Notes & open questions

Minor Q: Do the iroh::protocol and iroh::router modules make sense?

Change checklist

  • Self-review.
  • Documentation updates following the style guide, if relevant.
  • Tests if relevant.
  • All breaking changes documented.

@matheus23 matheus23 self-assigned this Nov 27, 2024
@matheus23
Copy link
Contributor Author

I highly recommend viewing this PR via its two individual commits.

Copy link
Contributor

@flub flub left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, can we move on now?

@Arqu
Copy link
Collaborator

Arqu commented Nov 27, 2024

🤣

@matheus23 matheus23 changed the title fight me refactor: Move iroh-router into iroh-net and rename iroh-net to iroh Nov 27, 2024
Copy link

github-actions bot commented Nov 27, 2024

Netsim report & logs for this PR have been generated and is available at: LOGS
This report will remain available for 3 days.

Last updated for commit: 1a1dd07

@matheus23
Copy link
Contributor Author

FWIW: If we want to merge this for real, we should make sure that both these PRs are rebased on main. There's some changes to e.g. the README missing on this branch. It's likely they'd get lost if we're not careful about rebasing.

Copy link

Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/2970/docs/iroh/

Last updated: 2024-11-27T14:59:51Z

@dignifiedquire
Copy link
Contributor

Do the iroh::protocol and iroh::router modules make sense?

what about

  • iroh::protocol::ProtocolHandler
  • iroh::protocol::ProtocolMap
  • iroh::protocol::Router
  • iroh::protocol::RouterBuilder

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🏗 In progress
Development

Successfully merging this pull request may close these issues.

4 participants