base on peer-2-peer that just works <h1 align="center"><a href="https://iroh.computer"><img alt="iroh" src="./.img/iroh_wordmark.svg" width="100" /></a></h1> <h3 align="center"> less net work for networks </h3> [](https://docs.rs/iroh/) [](https://crates.io/crates/iroh) [](https://crates.io/crates/iroh) [](https://discord.com/invite/DpmJgtU7cW) [](https://www.youtube.com/@n0computer) [](LICENSE-MIT) [](LICENSE-APACHE) [](https://github.com/n0-computer/iroh/actions/workflows/ci.yml) <div align="center"> <h3> <a href="https://iroh.computer/docs"> Docs Site </a> <span> | </span> <a href="https://docs.rs/iroh"> Rust Docs </a> </h3> </div> <br/> ## What is iroh? Iroh gives you an API for dialing by public key. You say “connect to that phone”, iroh will find & maintain the fastest connection for you, regardless of where it is. ### Hole-punching The fastest route is a direct connection, so if necessary, iroh tries to hole-punch. Should this fail, it can fall back to an open ecosystem of public relay servers. To ensure these connections are as fast as possible, we [continuously measure iroh][iroh-perf]. ### Built on [QUIC] Iroh uses [Quinn] to establish [QUIC] connections between nodes. This way you get authenticated encryption, concurrent streams with stream prioirities, a datagram transport and avoid head-of-line-blocking out of the box. ## Compose Protocols Use pre-existing protocols built on iroh instead of writing your own: - [iroh-blobs] for [BLAKE3]-based content-addressed blob transfer scaling from kilobytes to terrabytes - [iroh-gossip] for establishing publish-subscribe overlay networks that scale, requiring only resources that your average phone can handle - [iroh-docs] for an eventually-consistent key-value store of [iroh-blobs] blobs - [iroh-willow] for an (in-construction) implementation of the [willow protocol] ## Getting Started ### Rust Library It's easiest to use iroh from rust. Install it using `cargo add iroh`, then on the connecting side: ```rs const ALPN: &[u8] = b"iroh-example/echo/0"; let endpoint = Endpoint::builder().discovery_n0().bind().await?; // Open a connection to the accepting node let conn = endpoint.connect(addr, ALPN).await?; // Open a bidirectional QUIC stream let (mut send, mut recv) = conn.open_bi().await?; // Send some data to be echoed send.write_all(b"Hello, world!").await?; send.finish()?; // Receive the echo let response = recv.read_to_end(1000).await?; assert_eq!(&response, b"Hello, world!"); // Close the endpoint and all its connections endpoint.close().await?; ``` And on the accepting side: ```rs let endpoint = Endpoint::builder().discovery_n0().bind().await?; let router = Router::builder(endpoint) .accept(ALPN.to_vec(), Arc::new(Echo)) .spawn() .await?; // The protocol definition: #[derive(Debug, Clone)] struct Echo; impl ProtocolHandler for Echo { fn accept(self: Arc<Self>, connecting: Connecting) -> BoxedFuture<Result<()>> { Box::pin(async move { let connection = connecting.await?; let (mut send, mut recv) = connection.accept_bi().await?; // Echo any bytes received back directly. let bytes_sent = tokio::io::copy(&mut recv, &mut send).await?; send.finish()?; connection.closed().await; Ok(()) }) } } ``` The full example code with more comments can be found at [`echo.rs`][echo-rs]. Or use one of the pre-existing protocols, e.g. [iroh-blobs] or [iroh-gossip]. ### Other Languages If you want to use iroh from other languages, make sure to check out [iroh-ffi], the repository for FFI bindings. ### Links - [Introducing Iroh (video)][iroh-yt-video] - [Iroh Documentation][docs] - [Iroh Examples] - [Iroh Experiments] ## Repository Structure This repository contains a workspace of crates: - `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-test`: Test utilities. - `iroh-dns-server`: DNS server implementation powering the `n0_discovery` for NodeIds, running at dns.iroh.link. - `iroh-net-report`: Analyzes your host's networking ability & NAT. ## License Copyright 2024 N0, INC. This project is licensed under either of * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) at your option. ## Contribution Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. [QUIC]: https://en.wikipedia.org/wiki/QUIC [BLAKE3]: https://github.com/BLAKE3-team/BLAKE3 [Quinn]: https://github.com/quinn-rs/quinn [iroh-blobs]: https://github.com/n0-computer/iroh-blobs [iroh-gossip]: https://github.com/n0-computer/iroh-gossip [iroh-docs]: https://github.com/n0-computer/iroh-docs [iroh-willow]: https://github.com/n0-computer/iroh-willow [iroh-doctor]: https://github.com/n0-computer/iroh-doctor [willow protocol]: https://willowprotocol.org [iroh-ffi]: https://github.com/n0-computer/iroh-ffi [iroh-yt-video]: https://www.youtube.com/watch?v=RwAt36Xe3UI_ [Iroh Examples]: https://github.com/n0-computer/iroh-examples [Iroh Experiments]: https://github.com/n0-computer/iroh-experiments [echo-rs]: /iroh-router/examples/echo.rs [iroh-perf]: https://perf.iroh.computer [docs]: https://iroh.computer/docs ", Assign "at most 3 tags" to the expected json: {"id":"7077","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"