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 #2973

Merged
merged 6 commits into from
Nov 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ jobs:
# uses: obi1kenobi/cargo-semver-checks-action@v2
uses: n0-computer/cargo-semver-checks-action@feat-baseline
with:
package: iroh, iroh-base, iroh-dns-server, iroh-metrics, iroh-net, iroh-net-bench, iroh-node-util, iroh-router, netwatch, portmapper, iroh-relay, iroh-net-report
package: iroh, iroh-base, iroh-dns-server, iroh-metrics, iroh-net-bench, iroh-node-util, netwatch, portmapper, iroh-relay, iroh-net-report
baseline-rev: ${{ env.HEAD_COMMIT_SHA }}
use-cache: false

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ env:
RUSTFLAGS: -Dwarnings
RUSTDOCFLAGS: -Dwarnings
SCCACHE_CACHE_SIZE: "50G"
CRATES_LIST: "iroh,iroh-node-util,iroh-metrics,iroh-net,iroh-net-bench,iroh-test,iroh-dns-server,iroh-router,netwatch,portmapper,iroh-relay,iroh-net-report"
CRATES_LIST: "iroh,iroh-node-util,iroh-metrics,iroh-net-bench,iroh-test,iroh-dns-server,netwatch,portmapper,iroh-relay,iroh-net-report"
IROH_FORCE_STAGING_RELAYS: "1"

jobs:
Expand Down
210 changes: 89 additions & 121 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 3 additions & 6 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
[workspace]
members = [
"iroh",
"iroh-base",
"iroh-dns-server",
"iroh-metrics",
"iroh-net",
"iroh",
"iroh-test",
"iroh-net/bench",
"iroh/bench",
"iroh-relay",
"iroh-router",
"net-tools/netwatch",
"net-tools/portmapper",
"iroh-net-report",
Expand Down Expand Up @@ -50,8 +48,7 @@ unused-async = "warn"

# Temporary fix for dependencies
[patch.crates-io]
iroh = { path = "./iroh" }
iroh-base = { path = "./iroh-base" }
iroh-net = { path = "./iroh-net" }
iroh-metrics = { path = "./iroh-metrics" }
iroh-test = { path = "./iroh-test" }
iroh-router = { path = "./iroh-router" }
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,7 @@ If you want to use iroh from other languages, make sure to check out [iroh-ffi],
## Repository Structure

This repository contains a workspace of crates:
- `iroh`: Re-exports of stables APIs like `iroh-router` and `iroh-net`.
- `iroh-router`: APIs to compose multiple protocols in a node.
- `iroh-net`: The core networking code for hole-punching & connections to relays.
- `iroh`: The core library for hole-punching & communicating with relays.
- `iroh-relay`: The relay server implementation. This is the code we run in production (and you can, too!).
- `iroh-base`: Common types like `Hash`, key types or `RelayUrl`.
- `iroh-metrics`: Helper library for adding metrics support to crates.
Expand All @@ -140,8 +138,6 @@ This repository contains a workspace of crates:
- `iroh-net-report`: Analyzes your host's networking ability & NAT.
- `net-tools/*`: Networking utility crates

The main entry point for anyone interested in the inner workings should be `iroh-net`.

## License

Copyright 2024 N0, INC.
Expand Down
2 changes: 1 addition & 1 deletion iroh-base/src/key.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! Cryptographic key handling for `iroh-net`.
//! Cryptographic key handling for `iroh`.

mod encryption;

Expand Down
Loading
Loading