Language Bindings

While iroh is written in Rust, it can be used in many other languages and environments.

​

Language Bindings

The n0.computer engineering team can help build and maintain production-grade bindings for your language. Contact us discuss your needs.

​

Build Your Own Wrapper

If you’re comfortable with a little bit of Rust, you can write your own wrapper around iroh. This can be a small application-specific binary that exposes functionality over a local HTTP server or daemon, or a full FFI wrapper from Rust to your target language (Python, Go, etc.). Either way, this gives you:

• Full control over the API surface you expose
• The ability to tailor it to your specific use case
• Type-safe bindings for your language (with FFI)
• Can be called from any language (with an HTTP wrapper)

While it’s easy to get a first version working, ongoing maintenance and testing is the hard part. Iroh is under active development, and keeping wrappers up to date with new releases, testing across platforms, and handling edge cases takes sustained effort. The number0 team runs a testing lab for this purpose. If you need production-grade bindings, contact us to discuss your requirements.

​

Community Bindings

The community has built language bindings that are open source and available for use: TypeScript/JavaScript: iroh-ts - Community-maintained TypeScript bindings for iroh, enabling JavaScript and TypeScript developers to use iroh in their applications.

​

WebAssembly and Browsers

Iroh can be compiled to WebAssembly for use in browsers! As of the iroh 0.33 release, iroh can be used in projects that compile to WebAssembly. Add iroh to your browser project’s dependencies and keep building it using wasm-bindgen. For end-to-end examples of integrating iroh into a browser page, see these examples on our iroh-examples repository:

• An iroh echo server in the browser. Check it out in action
• An browser chat room UI based on the iroh gossip chat example. Check it out in action

​

Browser Limitations

When you’re in a browser context - as opposed to in a native app or on desktop, you’re in a strict “sandbox” that disallows a few things iroh relies upon, e.g. sending UDP packets directly. Thus, we need to work around these limitations and can’t provide you with the full magic of iroh just yet. We envision that most applications will use iroh browser support as an additional feature to complement existing deployments to desktops, native apps or servers, where they’ll be able to make use of everything that iroh offers. No direct connections: All connections from browsers to somewhere else need to flow via a relay server. This is because we can’t port our hole-punching logic in iroh to browsers: They don’t support sending UDP packets to IP addresses from inside the browser sandbox. Keep in mind that connections are end-to-end encrypted, as always with iroh. So even though traffic from browsers is always relayed, it can’t be decrypted by the relay. There are other ways of getting direct connections going, such as WebTransport with serverCertificateHashes, or WebRTC. We may expand iroh’s browser support to make use of these to try to generate direct connections even when a browser node is involved in the connection. iroh crate features: As of iroh version 0.33, you need to disable all optional features on iroh for the Wasm build to succeed. To do so, depend on iroh via iroh = { version = "0.33", default-features = false }. This will install a version of iroh with default features, except it doesn’t track metrics locally. We’ll get rid of this limitation very soon (likely with iroh version 0.34). Non-default features like discovery-local-network or discovery-dht will likely never be available in browsers, unless browser APIs making them possible are added. npm package: Currently we don’t bundle iroh’s Wasm build as an NPM package. There is no technical limitation for this: You could build this today! Should you need javascript APIs, we recommend that you write an application-specific rust wrapper crate that depends on iroh and exposes whatever the javascript side needs via wasm-bindgen.

​

Use in node.js/bun.js/deno

We check that the browser version of iroh works in node.js regularly. And it’s likely that Deno will work out of the box, too, given it closely resembles the browser’s Web APIs. We haven’t checked if bun.js works right now, and don’t have plans to check that continually. As these runtimes are outside the browser sandbox, it would technically be possible to ship bigger parts of iroh to these environments, such as all hole-punching related functionality. However, we currently don’t plan to expand the browser-related WebAssembly work to integrate with that. In the future, it’s more likely we’ll use NAPI or WASI to make these integrations possible.

​

Troubleshooting WebAssembly Builds

Getting rust code to successfully build for browsers can be tricky. We’ve started a discussion on github to collect common issues hit when trying to compile iroh or projects using iroh to WebAssembly. Take a look at answers in that discussion for any clues if you’re encountering build issues. Otherwise feel free to open a discussion or a thread on that discussion with your specific issue.

​

Contributing

If you’re interested in creating or maintaining bindings for other languages, we’d love to hear from you! Join the iroh Discord to connect with the community.