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.

Sign up for GitHub

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

feat(iroh-net): add deprecation notice, bump to 0.28.2 #3116

Merged
merged 2 commits into from
Jan 22, 2025
Merged

feat(iroh-net): add deprecation notice, bump to 0.28.2 #3116

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cab0bee
feat(iroh-net): add deprecation notice, bump to 0.28.2
flub Jan 10, 2025
e552a6e
try and mark as deprecated
flub Jan 13, 2025
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 Cargo.lock
View file
Open in desktop

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

4 changes: 2 additions & 2 deletions iroh-net/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[package]
name = "iroh-net"
version = "0.28.1"
version = "0.28.2"
edition = "2021"
readme = "README.md"
description = "networking support for iroh"
description = "networking support for iroh (deprecated, use the iroh crate)"
license = "MIT OR Apache-2.0"
authors = ["dignifiedquire <[email protected]>", "n0 team"]
repository = "https://github.com/n0-computer/iroh"
Expand Down
7 changes: 7 additions & 0 deletions iroh-net/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# iroh-net

<div class="warning">

The `iroh-net` crate has been renamed to `iroh`. Please use the
`iroh` crate instead.

</div>

This crate contains the networking support for iroh. Iroh networking is built on direct peer-to-peer [QUIC](https://en.wikipedia.org/wiki/QUIC) connections that use relays and holepunching. The main structure for connection is the `Endpoint` entrypoint.

Peer to peer connectivity is established with the help of a _relay server_. The relay server provides Session Traversal Utilities for NAT [(STUN)](https://en.wikipedia.org/wiki/STUN) for the peers and connection coordination using the [DERP protocol](https://pkg.go.dev/tailscale.com/derp) (Designated Relay for Encrypted Packets protocol). If no direct connection can be established, the connection is relayed via the server.
Expand Down
7 changes: 7 additions & 0 deletions iroh-net/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
//! Peer-to-peer QUIC connections.
//!
//! <div class="warning">
//!
//! The `iroh-net` crate has been renamed to `iroh`. Please use the
//! `iroh` crate instead.
//!
//! </div>
//!
//! iroh-net is a library to establish direct connectivity between peers. It exposes an
//! interface to [QUIC] connections and streams to the user, while implementing direct
//! connectivity using [hole punching] complemented by relay servers under the hood.
Expand Down
Loading